From 7e3646ddcd5039bfdd6617d2c2e96cbdbbce3a5b Mon Sep 17 00:00:00 2001 From: Maidul Islam Date: Thu, 13 Jul 2023 17:53:59 -0400 Subject: [PATCH] add docs on how to pin k8 operator to avoid breaking changes --- docs/integrations/platforms/kubernetes.mdx | 29 +++++++++++++++++----- 1 file changed, 23 insertions(+), 6 deletions(-) diff --git a/docs/integrations/platforms/kubernetes.mdx b/docs/integrations/platforms/kubernetes.mdx index 75715e144..01e011f79 100644 --- a/docs/integrations/platforms/kubernetes.mdx +++ b/docs/integrations/platforms/kubernetes.mdx @@ -15,23 +15,40 @@ The operator continuously updates secrets and can also reload dependent deployme The operator can be install via [Helm](helm.sh) or [kubectl](https://github.com/kubernetes/kubectl) - - Install Infisical Helm repository + + **Install the latest Infisical Helm repository** ```bash helm repo add infisical-helm-charts 'https://dl.cloudsmith.io/public/infisical/helm-charts/helm/charts/' helm repo update ``` - Install the Helm chart + **Install the Helm chart** + + For production deployments, it is highly recommended to set the chart version and the application version during installs and upgrades. + This will prevent the operator from being accidentally updated to the latest version and introduce unintended breaking changes. + + View application versions [here](https://hub.docker.com/r/infisical/kubernetes-operator/tags) and chart versions [here](https://cloudsmith.io/~infisical/repos/helm-charts/packages/detail/helm/secrets-operator/#versions) + ```bash - helm install --generate-name infisical-helm-charts/secrets-operator + helm install --generate-name infisical-helm-charts/secrets-operator --version= --set controllerManager.manager.image.tag= + + # Example installing app version v0.2.0 and chart version 0.1.4 + helm install --generate-name infisical-helm-charts/secrets-operator --version=0.1.4 --set controllerManager.manager.image.tag=v0.2.0 ``` - The operator will be installed in `infisical-operator-system` namespace - ``` + For production deployments, it is highly recommended to set the version of the Kubernetes operator manually instead of pointing to the latest version. + Doing so will help you avoid accidental updates to the newest release which may introduce unintended breaking changes. View all application versions [here](https://hub.docker.com/r/infisical/kubernetes-operator/tags). + + + The command below will install the most recent version of the Kubernetes operator. + However, to set the version manually, download the manifest and set the image tag version of `infisical/kubernetes-operator` according to your desired version. + + Once you apply the manifest, the operator will be installed in `infisical-operator-system` namespace. + + ``` kubectl apply -f https://raw.githubusercontent.com/Infisical/infisical/main/k8-operator/kubectl-install/install-secrets-operator.yaml ```