Skip to content

Commit

Permalink
chore(docs): installation
Browse files Browse the repository at this point in the history
  • Loading branch information
eshepelyuk committed Sep 8, 2020
1 parent 46d895b commit dc419b2
Showing 1 changed file with 9 additions and 4 deletions.
13 changes: 9 additions & 4 deletions README.adoc
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
= CMAK operator
:cmak-v: 0.2.1
:toc: macro
:icons: font

Expand All @@ -17,7 +18,8 @@ toc::[]
CMAK operator is a Helm chart and set of tools that allows to install
and configure https://github.com/yahoo/CMAK[CMAK (ex Kafka Manager)] into Kubernetes cluster.

https://github.com/yahoo/CMAK[CMAK (ex. Kafka Manager)] is well-known and mature tool for minitoring and managing https://kafka.apache.org/[Apache Kafka] clusters.
https://github.com/yahoo/CMAK[CMAK (ex. Kafka Manager)] is well-known
and mature tool for monitoring and managing https://kafka.apache.org/[Apache Kafka] clusters.

It's extremely easy to configure multiple clusters in CMAK,
as well as connection settings and enable optional authorization
Expand All @@ -34,9 +36,10 @@ To enable cleanup it is required to enable `TTLAfterFinished` https://kubernetes
It's recommended to install CMAK operator into a dedicated namespace.

[source]
[subs="attributes"]
----
$ git clone https://github.com/eshepelyuk/cmak-operator.git
$ helm install --create-namespace --namespace cmak-ns cmak ./cmak-operator
$ helm install --create-namespace --namespace cmak-ns cmak \
https://github.com/eshepelyuk/cmak-operator/releases/download/{cmak-v}/cmak-operator-{cmak-v}.tgz
----


Expand Down Expand Up @@ -102,8 +105,10 @@ cmak:
Configuration should be passed to helm via command line during installation or upgrade.

[source]
[subs="attributes"]
----
helm install --create-namespace --namespace cmak-ns -f cmak-values.yaml cmak ./cmak-operator
$ helm install --create-namespace --namespace cmak-ns -f cmak-values.yaml cmak \
https://github.com/eshepelyuk/cmak-operator/releases/download/{cmak-v}/cmak-operator-{cmak-v}.tgz
----

== Troubleshooting
Expand Down

0 comments on commit dc419b2

Please sign in to comment.