Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: update docs for v1.0.0 and CRD version upgrades #781

Merged
merged 1 commit into from
Oct 14, 2021
Merged

docs: update docs for v1.0.0 and CRD version upgrades #781

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions docs/book/src/concepts.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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"
Expand Down
33 changes: 19 additions & 14 deletions docs/book/src/getting-started/upgrades.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,24 @@
# Upgrades

<aside class="note warning">
<h1>Warning</h1>
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 `v1.0.0`

Versions `v1.0.0-rc.1` and later use the `v1` version of the `SecretProviderClass` and `SecretProviderClassPodStatus`
`CustomResourceDefinition`s. `secrets-store.csi.x-k8s.io/v1alpha1` versioned `CRD`s will continue to work, but consider
updating your YAMLs to `secrets-store.csi.x-k8s.io/v1`.

## pre `v0.3.0`

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

Expand All @@ -15,18 +32,6 @@ helm repo update

</aside>

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.
Expand Down
2 changes: 1 addition & 1 deletion docs/book/src/getting-started/usage.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/book/src/topics/sync-as-kubernetes-secret.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down