vnfs/DAaaS/messaging/charts/strimzi-kafka-operator/README.md

   1 # Strimzi: Kafka as a Service
   2
   3 Strimzi provides a way to run an [Apache Kafka](https://kafka.apache.org/) cluster on
   4 [Kubernetes](https://kubernetes.io/) or [OpenShift](https://www.openshift.com/) in various deployment configurations.
   5 See our [website](https://github.com/strimzi/strimzi-kafka-operator) for more details about the project.
   6
   7 ## Introduction
   8
   9 This chart bootstraps the Strimzi Cluster Operator Deployment, Cluster Roles, Cluster Role Bindings, Service Accounts, and
  10 Custom Resource Definitions for running [Apache Kafka](https://kafka.apache.org/) on [Kubernetes](http://kubernetes.io)
  11 cluster using the [Helm](https://helm.sh) package manager.
  12
  13 ## Prerequisites
  14
  15 - Kubernetes 1.9+
  16 - PV provisioner support in the underlying infrastructure
  17
  18 ## Installing the Chart
  19
  20 Add the Strimzi Helm Chart repository:
  21
  22 ```bash
  23 $ helm repo add strimzi http://strimzi.io/charts/
  24 ```
  25
  26 To install the chart with the release name `my-release`:
  27
  28 ```bash
  29 $ helm install --name my-release strimzi/strimzi-kafka-operator
  30 ```
  31
  32 The command deploys the Strimzi Cluster Operator on the Kubernetes cluster with the default configuration.
  33 The [configuration](#configuration) section lists the parameters that can be configured during installation.
  34
  35 ## Uninstalling the Chart
  36
  37 To uninstall/delete the `my-release` deployment:
  38
  39 ```bash
  40 $ helm delete my-release
  41 ```
  42
  43 The command removes all the Kubernetes components associated with the operator and deletes the release.
  44
  45 ## Configuration
  46
  47 The following table lists the configurable parameters of the Strimzi chart and their default values.  Runtime
  48 configuration of Kafka and other components are defined within their respective Custom Resource Definitions.  See
  49 the documentation for more details.
  50
  51 | Parameter                            | Description                               | Default                                              |
  52 | ------------------------------------ | ----------------------------------------- | ---------------------------------------------------- |
  53 | `watchNamespaces`                    | Comma separated list of additional namespaces for the strimzi-operator to watch | []                    |
  54 | `image.repository`                   | Cluster Operator image repository         | `strimzi`                                            |
  55 | `image.name`                         | Cluster Operator image name               | `cluster-operator`                                   |
  56 | `image.tag`                          | Cluster Operator image tag                | `0.11.0`                                             |
  57 | `image.imagePullPolicy`              | Cluster Operator image pull policy        | `IfNotPresent`                                       |
  58 | `logLevel`                           | Cluster Operator log level                | `INFO`                                               |
  59 | `fullReconciliationIntervalMs`       | Full reconciliation interval in milliseconds | 120000                                            |
  60 | `operationTimeoutMs`                 | Operation timeout in milliseconds         | 300000                                               |
  61 | `zookeeper.image.repository`         | ZooKeeper image repository                | `strimzi`                                            |
  62 | `zookeeper.image.name`               | ZooKeeper image name                      | `zookeeper`                                          |
  63 | `zookeeper.image.tag`                | ZooKeeper image tag                       | `0.11.0`                                             |
  64 | `kafka.image.repository`             | Kafka image repository                    | `strimzi`                                            |
  65 | `kafka.image.name`                   | Kafka image name                          | `kafka`                                              |
  66 | `kafka.image.tagPrefix`              | Kafka image tag prefix                    | `0.11.0`                                             |
  67 | `kafkaConnect.image.repository`      | Kafka Connect image repository            | `strimzi`                                            |
  68 | `kafkaConnect.image.name`            | Kafka Connect image name                  | `kafka-connect`                                      |
  69 | `kafkaConnect.image.tagPrefix`       | Kafka Connect image tag prefix            | `0.11.0`                                             |
  70 | `kafkaConnects2i.image.repository`   | Kafka Connect s2i image repository        | `strimzi`                                            |
  71 | `kafkaConnects2i.image.name`         | Kafka Connect s2i image name              | `kafka-connect-s2i`                                  |
  72 | `kafkaConnects2i.image.tagPrefix`    | Kafka Connect s2i image tag prefix        | `0.11.0`                                             |
  73 | `kafkaMirrorMaker.image.repository`  | Kafka Mirror Maker image repository       | `strimzi`                                            |
  74 | `kafkaMirrorMaker.image.name`        | Kafka Mirror Maker image name             | `kafka`                                              |
  75 | `kafkaMirrorMaker.image.tagPrefix`   | Kafka Mirror Maker image tag prefix       | `0.11.0`                                             |
  76 | `topicOperator.image.repository`     | Topic Operator image repository           | `strimzi`                                            |
  77 | `topicOperator.image.name`           | Topic Operator s2i image name             | `topic-operator`                                     |
  78 | `topicOperator.image.tag`            | Topic Operator s2i image tag              | `0.11.0`                                             |
  79 | `kafkaInit.image.repository`         | Init Kafka image repository               | `strimzi`                                            |
  80 | `kafkaInit.image.name`               | Init Kafka image name                     | `kafka-init`                                         |
  81 | `kafkaInit.image.tag`                | Init Kafka image tag                      | `0.11.0`                                             |
  82 | `tlsSidecarZookeeper.image.repository` | TLS Sidecar for ZooKeeper image repository | `strimzi`                                         |
  83 | `tlsSidecarZookeeper.image.name`     | TLS Sidecar for ZooKeeper image name      | `zookeeper-stunnel`                                  |
  84 | `tlsSidecarZookeeper.image.tag`      | TLS Sidecar for ZooKeeper image tag       | `0.11.0`                                             |
  85 | `tlsSidecarKafka.image.repository`   | TLS Sidecar for Kafka image repository    | `strimzi`                                            |
  86 | `tlsSidecarKafka.image.name`         | TLS Sidecar for Kafka image name          | `kafka-stunnel`                                      |
  87 | `tlsSidecarKafka.image.tag`          | TLS Sidecar for Kafka image tag           | `0.11.0`                                             |
  88 | `tlsSidecarTopicOperator.image.repository` | TLS Sidecar for Topic Operator image repository | `strimzi`                                |
  89 | `tlsSidecarTopicOperator.image.name` | TLS Sidecar for Topic Operator image name | `topic-operator-stunnel`                             |
  90 | `tlsSidecarTopicOperator.image.tag`  | TLS Sidecar for Topic Operator image tag  | `0.11.0`                                             |
  91 | `resources.limits.memory`            | Memory constraint for limits              | `256Mi`                                              |
  92 | `resources.limits.cpu`               | CPU constraint for limits                 | `1000m`                                              |
  93 | `resources.requests.memory`          | Memory constraint for requests            | `256Mi`                                              |
  94 | `livenessProbe.initialDelaySeconds`  | Liveness probe initial delay in seconds   | 10                                                   |
  95 | `livenessProbe.periodSeconds`        | Liveness probe period in seconds          | 30                                                   |
  96 | `readinessProbe.initialDelaySeconds` | Readiness probe initial delay in seconds  | 10                                                   |
  97 | `readinessProbe.periodSeconds`       | Readiness probe period in seconds         | 30                                                   |
  98 | `imageRepositoryOverride`            | Override all image repository config      | `nil`                                                |
  99 | `imageTagOverride`                   | Override all image tag config             | `nil`                                                |
 100
 101 Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. For example,
 102
 103 ```bash
 104 $ helm install --name my-release --set logLevel=DEBUG,fullReconciliationIntervalMs=240000 strimzi/strimzi-kafka-operator
 105 ```