From dc25e2485b26f9737d396cc118bcc6823ac7b367 Mon Sep 17 00:00:00 2001 From: Tommy Murphy Date: Wed, 13 Oct 2021 11:54:54 -0400 Subject: [PATCH] docs: update docs for v1.0.0 and CRD version upgrades --- docs/book/src/concepts.md | 4 +-- docs/book/src/getting-started/upgrades.md | 33 +++++++++++-------- docs/book/src/getting-started/usage.md | 2 +- .../src/topics/sync-as-kubernetes-secret.md | 2 +- 4 files changed, 23 insertions(+), 18 deletions(-) diff --git a/docs/book/src/concepts.md b/docs/book/src/concepts.md index 121630a5a..63e86462c 100644 --- a/docs/book/src/concepts.md +++ b/docs/book/src/concepts.md @@ -38,7 +38,7 @@ The `SecretProviderClass` is a namespaced resource in Secrets Store CSI Driver t `SecretProviderClass` custom resource should have the following components: ```yaml -apiVersion: secrets-store.csi.x-k8s.io/v1alpha1 +apiVersion: secrets-store.csi.x-k8s.io/v1 kind: SecretProviderClass metadata: name: my-provider @@ -99,7 +99,7 @@ The `SecretProviderClassPodStatus` is created by the CSI driver in the same name Here is an example of a `SecretProviderClassPodStatus` resource: ```yaml -apiVersion: secrets-store.csi.x-k8s.io/v1alpha1 +apiVersion: secrets-store.csi.x-k8s.io/v1 kind: SecretProviderClassPodStatus metadata: creationTimestamp: "2021-01-21T19:20:11Z" diff --git a/docs/book/src/getting-started/upgrades.md b/docs/book/src/getting-started/upgrades.md index 32561562c..04eeed667 100644 --- a/docs/book/src/getting-started/upgrades.md +++ b/docs/book/src/getting-started/upgrades.md @@ -1,7 +1,24 @@ # Upgrades - -This page includes instructions for upgrading the driver to the latest version. - -```bash -helm upgrade csi-secrets-store secrets-store-csi-driver/secrets-store-csi-driver --namespace=NAMESPACE -``` - -Set `NAMESPACE` to the same namespace where the driver was originally installed, -(i.e. `kube-system`) - -If you are upgrading from one of the following versions there may be additional -steps that you should take. - ## pre `v0.1.0` >**NOTE**: [CustomResourceDefinitions](https://kubernetes.io/docs/concepts/extend-kubernetes/api-extension/custom-resources/) (CRDs) have been moved from `templates` to `crds` directory in the helm charts. To manage the lifecycle of the CRDs during install/upgrade, helm `pre-install` and `pre-upgrade` hook has been added. This hook will create a pod that runs only on **linux** nodes and deploys the CRDs in the Kubernetes cluster. diff --git a/docs/book/src/getting-started/usage.md b/docs/book/src/getting-started/usage.md index c526e6809..7e60490c4 100644 --- a/docs/book/src/getting-started/usage.md +++ b/docs/book/src/getting-started/usage.md @@ -7,7 +7,7 @@ To use the Secrets Store CSI driver, create a `SecretProviderClass` custom resou A `SecretProviderClass` custom resource should have the following components: ```yaml -apiVersion: secrets-store.csi.x-k8s.io/v1alpha1 +apiVersion: secrets-store.csi.x-k8s.io/v1 kind: SecretProviderClass metadata: name: my-provider diff --git a/docs/book/src/topics/sync-as-kubernetes-secret.md b/docs/book/src/topics/sync-as-kubernetes-secret.md index 70d44db4d..eff142d48 100644 --- a/docs/book/src/topics/sync-as-kubernetes-secret.md +++ b/docs/book/src/topics/sync-as-kubernetes-secret.md @@ -6,7 +6,7 @@ - `SecretProviderClass` ```yaml -apiVersion: secrets-store.csi.x-k8s.io/v1alpha1 +apiVersion: secrets-store.csi.x-k8s.io/v1 kind: SecretProviderClass metadata: name: azure-sync