Skip to content

Commit dc25e24

Browse files
committed
docs: update docs for v1.0.0 and CRD version upgrades
1 parent 7a027a8 commit dc25e24

File tree

4 files changed

+23
-18
lines changed

4 files changed

+23
-18
lines changed

docs/book/src/concepts.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ The `SecretProviderClass` is a namespaced resource in Secrets Store CSI Driver t
3838
`SecretProviderClass` custom resource should have the following components:
3939

4040
```yaml
41-
apiVersion: secrets-store.csi.x-k8s.io/v1alpha1
41+
apiVersion: secrets-store.csi.x-k8s.io/v1
4242
kind: SecretProviderClass
4343
metadata:
4444
name: my-provider
@@ -99,7 +99,7 @@ The `SecretProviderClassPodStatus` is created by the CSI driver in the same name
9999
Here is an example of a `SecretProviderClassPodStatus` resource:
100100

101101
```yaml
102-
apiVersion: secrets-store.csi.x-k8s.io/v1alpha1
102+
apiVersion: secrets-store.csi.x-k8s.io/v1
103103
kind: SecretProviderClassPodStatus
104104
metadata:
105105
creationTimestamp: "2021-01-21T19:20:11Z"

docs/book/src/getting-started/upgrades.md

Lines changed: 19 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,24 @@
11
# Upgrades
22

3-
<aside class="note warning">
4-
<h1>Warning</h1>
3+
This page includes instructions for upgrading the driver to the latest version.
4+
5+
```bash
6+
helm upgrade csi-secrets-store secrets-store-csi-driver/secrets-store-csi-driver --namespace=NAMESPACE
7+
```
8+
9+
Set `NAMESPACE` to the same namespace where the driver was originally installed,
10+
(i.e. `kube-system`)
11+
12+
If you are upgrading from one of the following versions there may be additional
13+
steps that you should take.
14+
15+
## pre `v1.0.0`
16+
17+
Versions `v1.0.0-rc.1` and later use the `v1` version of the `SecretProviderClass` and `SecretProviderClassPodStatus`
18+
`CustomResourceDefinition`s. `secrets-store.csi.x-k8s.io/v1alpha1` versioned `CRD`s will continue to work, but consider
19+
updating your YAMLs to `secrets-store.csi.x-k8s.io/v1`.
20+
21+
## pre `v0.3.0`
522

623
The helm chart repository URL has changed to `https://kubernetes-sigs.github.io/secrets-store-csi-driver/charts`.
724

@@ -15,18 +32,6 @@ helm repo update
1532

1633
</aside>
1734

18-
This page includes instructions for upgrading the driver to the latest version.
19-
20-
```bash
21-
helm upgrade csi-secrets-store secrets-store-csi-driver/secrets-store-csi-driver --namespace=NAMESPACE
22-
```
23-
24-
Set `NAMESPACE` to the same namespace where the driver was originally installed,
25-
(i.e. `kube-system`)
26-
27-
If you are upgrading from one of the following versions there may be additional
28-
steps that you should take.
29-
3035
## pre `v0.1.0`
3136

3237
>**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.

docs/book/src/getting-started/usage.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ To use the Secrets Store CSI driver, create a `SecretProviderClass` custom resou
77
A `SecretProviderClass` custom resource should have the following components:
88

99
```yaml
10-
apiVersion: secrets-store.csi.x-k8s.io/v1alpha1
10+
apiVersion: secrets-store.csi.x-k8s.io/v1
1111
kind: SecretProviderClass
1212
metadata:
1313
name: my-provider

docs/book/src/topics/sync-as-kubernetes-secret.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
- `SecretProviderClass`
77

88
```yaml
9-
apiVersion: secrets-store.csi.x-k8s.io/v1alpha1
9+
apiVersion: secrets-store.csi.x-k8s.io/v1
1010
kind: SecretProviderClass
1111
metadata:
1212
name: azure-sync

0 commit comments

Comments
 (0)