Skip to content

Commit 0086fc6

Browse files
authored
Merge pull request #45757 from drewhagen/kep_4192_svm_v1alpha1_docs_v1.30_dh
docs: incorporating more PR feedback on storage version migration
2 parents a9be017 + 6f8db3b commit 0086fc6

File tree

1 file changed

+8
-8
lines changed

1 file changed

+8
-8
lines changed

content/en/docs/tasks/manage-kubernetes-objects/storage-version-migration.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ Install [`kubectl`](/docs/tasks/tools/#kubectl).
3232

3333
## Re-encrypt Kubernetes secrets using storage version migration
3434
- To begin with, [configure KMS provider](/docs/tasks/administer-cluster/kms-provider/)
35-
to encrypt data at rest in etcd using following encryption configuration.
35+
to encrypt data at rest in etcd using following encryption configuration.
3636
```yaml
3737
kind: EncryptionConfiguration
3838
apiVersion: apiserver.config.k8s.io/v1
@@ -89,14 +89,14 @@ with new key `key2`, you will use _Storage Version Migration_.
8989
kubectl apply -f migrate-secret.yaml
9090
```
9191
- Monitor migration of Secrets by checking the `.status` of the StorageVersionMigration.
92-
A successful migration should have its
92+
A successful migration should have its
9393
`Succeeded` condition set to true. Get the StorageVersionMigration object
9494
as follows:
9595
```shell
9696
kubectl get storageversionmigration.storagemigration.k8s.io/secrets-migration -o yaml
9797
```
9898

99-
The output is similar to:
99+
The output is similar to:
100100
```yaml
101101
kind: StorageVersionMigration
102102
apiVersion: storagemigration.k8s.io/v1alpha1
@@ -125,7 +125,7 @@ as follows:
125125
- [Verify](/docs/tasks/administer-cluster/kms-provider/#verifying-that-the-data-is-encrypted)
126126
the stored secret is now prefixed with `k8s:enc:aescbc:v1:key2`.
127127

128-
## Update the preferred storage schema of the resource while moving from _v1_ to _v2_
128+
## Update the preferred storage schema of a CRD
129129
Consider a scenario where a {{< glossary_tooltip term_id="CustomResourceDefinition" text="CustomResourceDefinition" >}}
130130
(CRD) is created to serve custom resources (CRs) and is set as the preferred storage schema. When it's time
131131
to introduce v2 of the CRD, it can be added for serving only with a conversion
@@ -189,7 +189,7 @@ This migration can be achieved through _Storage Version Migration_ to migrate al
189189
```shell
190190
ETCDCTL_API=3 etcdctl get /kubernetes.io/stable.example.com/testcrds/default/cr1 [...] | hexdump -C
191191
```
192-
where [...] contains the additional arguments for connecting to the etcd server.
192+
where `[...]` contains the additional arguments for connecting to the etcd server.
193193
- Update the CRD `test-crd.yaml` to include v2 version for serving and storage
194194
and v1 as serving only, as follows:
195195
```yaml
@@ -256,7 +256,7 @@ This migration can be achieved through _Storage Version Migration_ to migrate al
256256
```shell
257257
ETCDCTL_API=3 etcdctl get /kubernetes.io/stable.example.com/testcrds/default/cr2 [...] | hexdump -C
258258
```
259-
where [...] contains the additional arguments for connecting to the etcd server.
259+
where `[...]` contains the additional arguments for connecting to the etcd server.
260260
- Create a StorageVersionMigration manifest named `migrate-crd.yaml`, with the contents as follows:
261261
```yaml
262262
kind: StorageVersionMigration
@@ -274,7 +274,7 @@ This migration can be achieved through _Storage Version Migration_ to migrate al
274274
kubectl apply -f migrate-crd.yaml
275275
```
276276
- Monitor migration of secrets using status. Successful migration should have
277-
_Succeeded_ condition set to _true_ in the status field. Get the migration resource
277+
`Succeeded` condition set to "True" in the status field. Get the migration resource
278278
as follows:
279279
```shell
280280
kubectl get storageversionmigration.storagemigration.k8s.io/crdsvm -o yaml
@@ -310,4 +310,4 @@ This migration can be achieved through _Storage Version Migration_ to migrate al
310310
```shell
311311
ETCDCTL_API=3 etcdctl get /kubernetes.io/stable.example.com/testcrds/default/cr1 [...] | hexdump -C
312312
```
313-
where [...] contains the additional arguments for connecting to the etcd server.
313+
where `[...]` contains the additional arguments for connecting to the etcd server.

0 commit comments

Comments
 (0)