-
-
Notifications
You must be signed in to change notification settings - Fork 228
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: generate chart README from helm-docs (#1041)
* docs: generate chart README from helm-docs Signed-off-by: drivebyer <[email protected]> * update Signed-off-by: drivebyer <[email protected]> --------- Signed-off-by: drivebyer <[email protected]>
- Loading branch information
Showing
11 changed files
with
787 additions
and
196 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,45 @@ | ||
| # redis | ||
|
|
||
| Redis is a key-value based distributed database, this helm chart is for redis cluster setup. This helm chart needs [Redis Operator](../redis-operator) inside Kubernetes cluster. The redis cluster definition can be modified or changed by [values.yaml](./values.yaml). | ||
|
|
||
| **Homepage:** <https://github.com/ot-container-kit/redis-operator> | ||
|
|
||
| ## Maintainers | ||
|
|
||
| | Name | Email | Url | | ||
| | ---- | ------ | --- | | ||
| | iamabhishek-dubey | | | | ||
| | sandy724 | | | | ||
| | shubham-cmyk | | | | ||
|
|
||
| ## Pre-Requisities | ||
|
|
||
| - Kubernetes 1.15+ | ||
| - Helm 3.X | ||
| - Redis Operator 0.7.0 | ||
|
|
||
| ## Source Code | ||
|
|
||
| * <https://github.com/ot-container-kit/redis-operator> | ||
|
|
||
| ```shell | ||
| helm repo add ot-helm https://ot-container-kit.github.io/helm-charts/ | ||
|
|
||
| helm install <my-release> ot-helm/redis-cluster \ | ||
| --set redisCluster.clusterSize=3 --namespace <namespace> | ||
| ``` | ||
|
|
||
| Redis setup can be upgraded by using `helm upgrade` command:- | ||
|
|
||
| ```shell | ||
| helm upgrade <my-release> ot-helm/redis-cluster --install \ | ||
| --set redisCluster.clusterSize=5 --namespace <namespace> | ||
| ``` | ||
|
|
||
| For uninstalling the chart:- | ||
|
|
||
| ```shell | ||
| helm delete <my-release> --namespace <namespace> | ||
| ``` | ||
|
|
||
| {{ template "chart.valuesSection" . }} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,128 @@ | ||
| # redis | ||
|
|
||
| This Helm chart deploys the redis-operator into your Kubernetes cluster. The operator facilitates the deployment, scaling, and management of Redis clusters and other Redis resources provided by the OpsTree Solutions team. | ||
|
|
||
| **Homepage:** <https://github.com/ot-container-kit/redis-operator> | ||
|
|
||
| ## Maintainers | ||
|
|
||
| | Name | Email | Url | | ||
| | ---- | ------ | --- | | ||
| | iamabhishek-dubey | | | | ||
| | sandy724 | | | | ||
| | shubham-cmyk | | | | ||
|
|
||
| ## Pre-Requisities | ||
|
|
||
| - Helm v3+ | ||
| - Kubernetes v1.16+ | ||
| - If you intend to use the cert-manager, ensure that the cert-manager CRDs are installed before deploying the redis-operator. | ||
|
|
||
| ## Source Code | ||
|
|
||
| * <https://github.com/ot-container-kit/redis-operator> | ||
|
|
||
| ## Installation Steps | ||
|
|
||
| ### 1. Add Helm Repository | ||
|
|
||
| ```bash | ||
| helm repo add ot-helm https://ot-container-kit.github.io/helm-charts | ||
| ``` | ||
|
|
||
| ### 2. Install Cert-Manager CRDs (if using cert-manager) | ||
|
|
||
| If you plan to use cert-manager with the redis-operator, you need to install the cert-manager CRDs before deploying the operator. | ||
|
|
||
| ```bash | ||
| kubectl apply -f https://github.com/cert-manager/cert-manager/releases/download/v1.12.4/cert-manager.crds.yaml | ||
| ``` | ||
|
|
||
| ### 3. Install Redis Operator | ||
|
|
||
| Replace `<YourCertSecretName>` and `<YourPrivateKey>` with your specific values. | ||
|
|
||
| ```bash | ||
| helm install <redis-operator> ot-helm/redis-operator --version=0.15.5 --appVersion=0.15.1 --set certificate.secretName=<YourCertSecretName> --set certmanager.enabled=true --set redisOperator.webhook=true --namespace <redis-operator> --create-namespace | ||
| ``` | ||
|
|
||
| > Note: If `certificate.secretName` is not provided, the operator will generate a self-signed certificate and use it for webhook server. | ||
| --- | ||
| > Note : If you want to disable the webhook you have to pass the `--set webhook=false` and `--set certmanager.enabled=false` while installing the redis-operator. | ||
| ### 4. Patch the CA Bundle (if using cert-manager) | ||
|
|
||
| Cert-manager injects the CA bundle into the webhook configuration. | ||
|
|
||
| ```bash | ||
| kubectl patch crd redis.redis.redis.opstreelabs.in -p '{"metadata":{"annotations":{"cert-manager.io/inject-ca-from":"<redis-operator>/<serving-cert>"}}}' | ||
|
|
||
| kubectl patch crd redisclusters.redis.redis.opstreelabs.in -p '{"metadata":{"annotations":{"cert-manager.io/inject-ca-from":"<redis-operator>/<serving-cert>"}}}' | ||
|
|
||
| kubectl patch crd redisreplications.redis.redis.opstreelabs.in -p '{"metadata":{"annotations":{"cert-manager.io/inject-ca-from":"<redis-operator>/<serving-cert>"}}}' | ||
|
|
||
| kubectl patch crd redissentinels.redis.redis.opstreelabs.in -p '{"metadata":{"annotations":{"cert-manager.io/inject-ca-from":"<redis-operator>/<serving-cert>"}}}' | ||
| ``` | ||
|
|
||
| > Note: Replace `<redis-operator>` and `<serving-cert>` with your specific values i.e. release name and certificate name. | ||
| #### You can verify the patch by running the following commands | ||
|
|
||
| ```bash | ||
| kubectl get crd redis.redis.redis.opstreelabs.in -o=jsonpath='{.metadata.annotations}' | ||
| kubectl get crd redisclusters.redis.redis.opstreelabs.in -o=jsonpath='{.metadata.annotations}' | ||
| kubectl get crd redisreplications.redis.redis.opstreelabs.in -o=jsonpath='{.metadata.annotations}' | ||
| kubectl get crd redissentinels.redis.redis.opstreelabs.in -o=jsonpath='{.metadata.annotations}' | ||
| ``` | ||
|
|
||
| ### How to generate private key( Optional ) | ||
|
|
||
| ```bash | ||
| openssl req -x509 -nodes -days 365 -newkey rsa:2048 -keyout tls.key -out tls.crt | ||
| kubectl create secret tls <webhook-server-cert> --key tls.key --cert tls.crt -n <redis-operator> | ||
| ``` | ||
|
|
||
| > Note: This secret will be used for webhook server certificate so generate it before installing the redis-operator. | ||
| ## Values | ||
|
|
||
| | Key | Type | Default | Description | | ||
| |-----|------|---------|-------------| | ||
| | affinity | object | `{}` | | | ||
| | certificate.name | string | `"serving-cert"` | | | ||
| | certificate.secretName | string | `"webhook-server-cert"` | | | ||
| | certmanager.enabled | bool | `false` | | | ||
| | issuer.email | string | `"[email protected]"` | | | ||
| | issuer.name | string | `"redis-operator-issuer"` | | | ||
| | issuer.privateKeySecretName | string | `"letsencrypt-prod"` | | | ||
| | issuer.server | string | `"https://acme-v02.api.letsencrypt.org/directory"` | | | ||
| | issuer.solver.enabled | bool | `true` | | | ||
| | issuer.solver.ingressClass | string | `"nginx"` | | | ||
| | issuer.type | string | `"selfSigned"` | | | ||
| | nodeSelector | object | `{}` | | | ||
| | podSecurityContext | object | `{}` | | | ||
| | priorityClassName | string | `""` | | | ||
| | rbac.enabled | bool | `true` | | | ||
| | redisOperator.automountServiceAccountToken | bool | `true` | | | ||
| | redisOperator.env | list | `[]` | | | ||
| | redisOperator.extraArgs | list | `[]` | | | ||
| | redisOperator.imageName | string | `"ghcr.io/ot-container-kit/redis-operator/redis-operator"` | | | ||
| | redisOperator.imagePullPolicy | string | `"Always"` | | | ||
| | redisOperator.imageTag | string | `""` | | | ||
| | redisOperator.name | string | `"redis-operator"` | | | ||
| | redisOperator.podAnnotations | object | `{}` | | | ||
| | redisOperator.podLabels | object | `{}` | | | ||
| | redisOperator.watchNamespace | string | `""` | | | ||
| | redisOperator.webhook | bool | `false` | | | ||
| | replicas | int | `1` | | | ||
| | resources.limits.cpu | string | `"500m"` | | | ||
| | resources.limits.memory | string | `"500Mi"` | | | ||
| | resources.requests.cpu | string | `"500m"` | | | ||
| | resources.requests.memory | string | `"500Mi"` | | | ||
| | securityContext | object | `{}` | | | ||
| | service.name | string | `"webhook-service"` | | | ||
| | service.namespace | string | `"redis-operator"` | | | ||
| | serviceAccount.automountServiceAccountToken | bool | `true` | | | ||
| | serviceAccountName | string | `"redis-operator"` | | | ||
| | tolerateAllTaints | bool | `false` | | | ||
| | tolerations | list | `[]` | | |
Oops, something went wrong.