diff options
Diffstat (limited to 'vnfs/DAaaS/messaging/charts/strimzi-kafka-operator/README.md')
| -rw-r--r-- | vnfs/DAaaS/messaging/charts/strimzi-kafka-operator/README.md | 105 |
1 files changed, 105 insertions, 0 deletions
diff --git a/vnfs/DAaaS/messaging/charts/strimzi-kafka-operator/README.md b/vnfs/DAaaS/messaging/charts/strimzi-kafka-operator/README.md new file mode 100644 index 00000000..35226be0 --- /dev/null +++ b/vnfs/DAaaS/messaging/charts/strimzi-kafka-operator/README.md @@ -0,0 +1,105 @@ +# Strimzi: Kafka as a Service + +Strimzi provides a way to run an [Apache Kafka](https://kafka.apache.org/) cluster on +[Kubernetes](https://kubernetes.io/) or [OpenShift](https://www.openshift.com/) in various deployment configurations. +See our [website](https://github.com/strimzi/strimzi-kafka-operator) for more details about the project. + +## Introduction + +This chart bootstraps the Strimzi Cluster Operator Deployment, Cluster Roles, Cluster Role Bindings, Service Accounts, and +Custom Resource Definitions for running [Apache Kafka](https://kafka.apache.org/) on [Kubernetes](http://kubernetes.io) +cluster using the [Helm](https://helm.sh) package manager. + +## Prerequisites + +- Kubernetes 1.9+ +- PV provisioner support in the underlying infrastructure + +## Installing the Chart + +Add the Strimzi Helm Chart repository: + +```bash +$ helm repo add strimzi http://strimzi.io/charts/ +``` + +To install the chart with the release name `my-release`: + +```bash +$ helm install --name my-release strimzi/strimzi-kafka-operator +``` + +The command deploys the Strimzi Cluster Operator on the Kubernetes cluster with the default configuration. +The [configuration](#configuration) section lists the parameters that can be configured during installation. + +## Uninstalling the Chart + +To uninstall/delete the `my-release` deployment: + +```bash +$ helm delete my-release +``` + +The command removes all the Kubernetes components associated with the operator and deletes the release. + +## Configuration + +The following table lists the configurable parameters of the Strimzi chart and their default values. Runtime +configuration of Kafka and other components are defined within their respective Custom Resource Definitions. See +the documentation for more details. + +| Parameter | Description | Default | +| ------------------------------------ | ----------------------------------------- | ---------------------------------------------------- | +| `watchNamespaces` | Comma separated list of additional namespaces for the strimzi-operator to watch | [] | +| `image.repository` | Cluster Operator image repository | `strimzi` | +| `image.name` | Cluster Operator image name | `cluster-operator` | +| `image.tag` | Cluster Operator image tag | `0.11.0` | +| `image.imagePullPolicy` | Cluster Operator image pull policy | `IfNotPresent` | +| `logLevel` | Cluster Operator log level | `INFO` | +| `fullReconciliationIntervalMs` | Full reconciliation interval in milliseconds | 120000 | +| `operationTimeoutMs` | Operation timeout in milliseconds | 300000 | +| `zookeeper.image.repository` | ZooKeeper image repository | `strimzi` | +| `zookeeper.image.name` | ZooKeeper image name | `zookeeper` | +| `zookeeper.image.tag` | ZooKeeper image tag | `0.11.0` | +| `kafka.image.repository` | Kafka image repository | `strimzi` | +| `kafka.image.name` | Kafka image name | `kafka` | +| `kafka.image.tagPrefix` | Kafka image tag prefix | `0.11.0` | +| `kafkaConnect.image.repository` | Kafka Connect image repository | `strimzi` | +| `kafkaConnect.image.name` | Kafka Connect image name | `kafka-connect` | +| `kafkaConnect.image.tagPrefix` | Kafka Connect image tag prefix | `0.11.0` | +| `kafkaConnects2i.image.repository` | Kafka Connect s2i image repository | `strimzi` | +| `kafkaConnects2i.image.name` | Kafka Connect s2i image name | `kafka-connect-s2i` | +| `kafkaConnects2i.image.tagPrefix` | Kafka Connect s2i image tag prefix | `0.11.0` | +| `kafkaMirrorMaker.image.repository` | Kafka Mirror Maker image repository | `strimzi` | +| `kafkaMirrorMaker.image.name` | Kafka Mirror Maker image name | `kafka` | +| `kafkaMirrorMaker.image.tagPrefix` | Kafka Mirror Maker image tag prefix | `0.11.0` | +| `topicOperator.image.repository` | Topic Operator image repository | `strimzi` | +| `topicOperator.image.name` | Topic Operator s2i image name | `topic-operator` | +| `topicOperator.image.tag` | Topic Operator s2i image tag | `0.11.0` | +| `kafkaInit.image.repository` | Init Kafka image repository | `strimzi` | +| `kafkaInit.image.name` | Init Kafka image name | `kafka-init` | +| `kafkaInit.image.tag` | Init Kafka image tag | `0.11.0` | +| `tlsSidecarZookeeper.image.repository` | TLS Sidecar for ZooKeeper image repository | `strimzi` | +| `tlsSidecarZookeeper.image.name` | TLS Sidecar for ZooKeeper image name | `zookeeper-stunnel` | +| `tlsSidecarZookeeper.image.tag` | TLS Sidecar for ZooKeeper image tag | `0.11.0` | +| `tlsSidecarKafka.image.repository` | TLS Sidecar for Kafka image repository | `strimzi` | +| `tlsSidecarKafka.image.name` | TLS Sidecar for Kafka image name | `kafka-stunnel` | +| `tlsSidecarKafka.image.tag` | TLS Sidecar for Kafka image tag | `0.11.0` | +| `tlsSidecarTopicOperator.image.repository` | TLS Sidecar for Topic Operator image repository | `strimzi` | +| `tlsSidecarTopicOperator.image.name` | TLS Sidecar for Topic Operator image name | `topic-operator-stunnel` | +| `tlsSidecarTopicOperator.image.tag` | TLS Sidecar for Topic Operator image tag | `0.11.0` | +| `resources.limits.memory` | Memory constraint for limits | `256Mi` | +| `resources.limits.cpu` | CPU constraint for limits | `1000m` | +| `resources.requests.memory` | Memory constraint for requests | `256Mi` | +| `livenessProbe.initialDelaySeconds` | Liveness probe initial delay in seconds | 10 | +| `livenessProbe.periodSeconds` | Liveness probe period in seconds | 30 | +| `readinessProbe.initialDelaySeconds` | Readiness probe initial delay in seconds | 10 | +| `readinessProbe.periodSeconds` | Readiness probe period in seconds | 30 | +| `imageRepositoryOverride` | Override all image repository config | `nil` | +| `imageTagOverride` | Override all image tag config | `nil` | + +Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. For example, + +```bash +$ helm install --name my-release --set logLevel=DEBUG,fullReconciliationIntervalMs=240000 strimzi/strimzi-kafka-operator +``` |