From bfc32776026ab077b68f374dc71f3399000f2932 Mon Sep 17 00:00:00 2001 From: Casey Buto Date: Thu, 16 Dec 2021 00:33:18 -0500 Subject: [PATCH] docs: Update zookeeper-operator helm configuration docs (#423) Signed-off-by: Casey Buto --- charts/zookeeper-operator/README.md | 28 +++++++++++++++++----------- 1 file changed, 17 insertions(+), 11 deletions(-) diff --git a/charts/zookeeper-operator/README.md b/charts/zookeeper-operator/README.md index 0de315d63..3fd2e70b9 100644 --- a/charts/zookeeper-operator/README.md +++ b/charts/zookeeper-operator/README.md @@ -41,20 +41,26 @@ The following table lists the configurable parameters of the zookeeper-operator | Parameter | Description | Default | | ----- | ----------- | ------ | +| `additionalEnv` | Additional Environment Variables | `[]` | +| `additionalSidecars` | Additional Sidecars Configuration | `[]` | +| `additionalVolumes` | Additional volumes required for sidecars | `[]` | +| `affinity` | Specifies scheduling constraints on pods | `{}` | +| `annotations` | Operator pod annotations | `{}` | +| `crd.create` | Create zookeeper CRD | `true` | +| `disableFinalizer` | Disable finalizer for zookeeper clusters, PVCs clean-up will be skipped.| `false` | +| `global.imagePullSecrets` | Lists of secrets to use to pull zookeeper-operator image from a private registry | `[]` | +| `hooks.backoffLimit` | backoffLimit for batch jobs | `10` | +| `hooks.delete` | Create pre-delete hook which ensures that the operator cannot be deleted until the zookeeper cluster custom resources have been cleaned up | `true` | +| `hooks.image.repository` | Image repository for batch jobs | `"lachlanevenson/k8s-kubectl"` | +| `hooks.image.tag` | Image tag for batch jobs | `"v1.16.10"` | +| `image.pullPolicy` | Image pull policy | `IfNotPresent` | | `image.repository` | Image repository | `pravega/zookeeper-operator` | | `image.tag` | Image tag | `0.2.13` | -| `image.pullPolicy` | Image pull policy | `IfNotPresent` | -| `crd.create` | Create zookeeper CRD | `true` | +| `labels` | Operator pod labels | `{}` | +| `nodeSelector` | Map of key-value pairs to be present as labels in the node in which the pod should run | `{}` | | `rbac.create` | Create RBAC resources | `true` | +| `resources` | Specifies resource requirements for the container | `{}` | | `serviceAccount.create` | Create service account | `true` | | `serviceAccount.name` | Name for the service account | `zookeeper-operator` | -| `watchNamespace` | Namespaces to be watched | `""` | -| `resources` | Specifies resource requirements for the container | `{}` | -| `nodeSelector` | Map of key-value pairs to be present as labels in the node in which the pod should run | `{}` | -| `affinity` | Specifies scheduling constraints on pods | `{}` | | `tolerations` | Specifies the pod's tolerations | `[]` | -| `additionalEnv` | Additional Environment Variables | `[]` | -| `additionalSidecars` | Additional Sidecars Configuration | `[]` | -| `additionalVolumes` | Additional volumes required for sidecars | `[]` | -| `disableFinalizer` | Disable finalizer for zookeeper clusters, PVCs clean-up will be skipped.| `false` | - +| `watchNamespace` | Namespaces to be watched | `""` |