From c1a269191c9703eaba4d83bb5f56d68a8a691f31 Mon Sep 17 00:00:00 2001 From: Humble Chirammal Date: Wed, 10 Jun 2020 11:53:03 +0530 Subject: [PATCH] doc: make sure configmap object referred or documented correctly Signed-off-by: Humble Chirammal --- docs/deploy-rbd.md | 6 +++--- docs/design/proposals/encrypted-pvc.md | 2 +- e2e/deploy-vault.go | 2 +- examples/README.md | 4 ++-- examples/cephfs/storageclass.yaml | 2 +- examples/csi-config-map-sample.yaml | 10 +++++----- examples/rbd/snapshotclass.yaml | 2 +- examples/rbd/storageclass.yaml | 4 ++-- 8 files changed, 16 insertions(+), 16 deletions(-) diff --git a/docs/deploy-rbd.md b/docs/deploy-rbd.md index 676073db3..5d50681f6 100644 --- a/docs/deploy-rbd.md +++ b/docs/deploy-rbd.md @@ -113,7 +113,7 @@ kubectl create -f csi-nodeplugin-psp.yaml kubectl create -f csi-config-map.yaml ``` -The config map deploys an empty CSI configuration that is mounted as a volume +The configmap deploys an empty CSI configuration that is mounted as a volume within the Ceph CSI plugin pods. To add a specific Ceph clusters configuration details, refer to [Creating CSI configuration for RBD based provisioning](../examples/README.md#creating-csi-configuration-for-rbd-based-provisioning) @@ -232,8 +232,8 @@ Configuration must include `encryptionKMSType: "vault"`. In order for ceph-csi to be able to access the configuration you will need to have it mounted to csi-rbdplugin containers in both daemonset (so kms client can be instantiated to encrypt/decrypt volumes) and deployment pods (so kms client can be instantiated -to delete passphrase on volume delete) `ceph-csi-encryption-kms-config` config -map. +to delete passphrase on volume delete) `ceph-csi-encryption-kms-config` +configmap. > Note: kms configuration must be a map of string values only > (`map[string]string`) so for numerical and boolean values make sure to put diff --git a/docs/design/proposals/encrypted-pvc.md b/docs/design/proposals/encrypted-pvc.md index de5ed7baa..2178322e0 100644 --- a/docs/design/proposals/encrypted-pvc.md +++ b/docs/design/proposals/encrypted-pvc.md @@ -104,7 +104,7 @@ parameters: # Use external key management system for encryption passphrases by specifying # a unique ID matching KMS ConfigMap. The ID is only used for correlation to - # config map entry. + # configmap entry. encryptionKMSID: reclaimPolicy: Delete diff --git a/e2e/deploy-vault.go b/e2e/deploy-vault.go index 987dcc614..dddb06ec4 100644 --- a/e2e/deploy-vault.go +++ b/e2e/deploy-vault.go @@ -72,7 +72,7 @@ func createORDeleteVault(action string) { data = strings.ReplaceAll(data, "default", cephCSINamespace) _, err = framework.RunKubectlInput(cephCSINamespace, data, action, ns, "-f", "-") if err != nil { - e2elog.Logf("failed to %s vault config map %v", action, err) + e2elog.Logf("failed to %s vault configmap %v", action, err) } data, err = replaceNamespaceInTemplate(vaultExamplePath + vaultPSPPath) diff --git a/examples/README.md b/examples/README.md index 2c67ad89e..8137f3461 100644 --- a/examples/README.md +++ b/examples/README.md @@ -28,9 +28,9 @@ Gather the following information from the Ceph cluster(s) of choice, * Alternatively, choose a `` value that is distinct per Ceph cluster in use by this kubernetes cluster -Update the [sample config map](./csi-config-map-sample.yaml) with values +Update the [sample configmap](./csi-config-map-sample.yaml) with values from a Ceph cluster and replace `` with the chosen clusterID, to -create the manifest for the config map which can be updated in the cluster +create the manifest for the configmap which can be updated in the cluster using the following command, * `kubectl replace -f ./csi-config-map-sample.yaml` diff --git a/examples/cephfs/storageclass.yaml b/examples/cephfs/storageclass.yaml index 33e5354d5..965c8ce8e 100644 --- a/examples/cephfs/storageclass.yaml +++ b/examples/cephfs/storageclass.yaml @@ -9,7 +9,7 @@ parameters: # Should be unique across all Ceph clusters in use for provisioning, # cannot be greater than 36 bytes in length, and should remain immutable for # the lifetime of the StorageClass in use. - # Ensure to create an entry in the config map named ceph-csi-config, based on + # Ensure to create an entry in the configmap named ceph-csi-config, based on # csi-config-map-sample.yaml, to accompany the string chosen to # represent the Ceph cluster in clusterID below clusterID: diff --git a/examples/csi-config-map-sample.yaml b/examples/csi-config-map-sample.yaml index 77965a2a6..1ec7e304a 100644 --- a/examples/csi-config-map-sample.yaml +++ b/examples/csi-config-map-sample.yaml @@ -1,5 +1,5 @@ --- -# This is a sample config map that helps define a Ceph cluster configuration +# This is a sample configmap that helps define a Ceph cluster configuration # as required by the CSI plugins. apiVersion: v1 kind: ConfigMap @@ -10,12 +10,12 @@ kind: ConfigMap # identified by the # If a CSI plugin is using more than one Ceph cluster, repeat the section for # each such cluster in use. -# To add more clusters or edit MON addresses in an existing config map, use +# To add more clusters or edit MON addresses in an existing configmap, use # the `kubectl replace` command. # The field "cephFS.subvolumeGroup" is optional and defaults to "csi". -# NOTE: Changes to the config map is automatically updated in the running pods, -# thus restarting existing pods using the config map is NOT required on edits -# to the config map. +# NOTE: Changes to the configmap is automatically updated in the running pods, +# thus restarting existing pods using the configmap is NOT required on edits +# to the configmap. data: config.json: |- [ diff --git a/examples/rbd/snapshotclass.yaml b/examples/rbd/snapshotclass.yaml index b44d86685..0e8fc3daa 100644 --- a/examples/rbd/snapshotclass.yaml +++ b/examples/rbd/snapshotclass.yaml @@ -9,7 +9,7 @@ parameters: # Should be unique across all Ceph clusters in use for provisioning, # cannot be greater than 36 bytes in length, and should remain immutable for # the lifetime of the StorageClass in use. - # Ensure to create an entry in the config map named ceph-csi-config, based on + # Ensure to create an entry in the configmap named ceph-csi-config, based on # csi-config-map-sample.yaml, to accompany the string chosen to # represent the Ceph cluster in clusterID below clusterID: diff --git a/examples/rbd/storageclass.yaml b/examples/rbd/storageclass.yaml index f37a9773f..83d7307df 100644 --- a/examples/rbd/storageclass.yaml +++ b/examples/rbd/storageclass.yaml @@ -13,7 +13,7 @@ parameters: # Should be unique across all Ceph clusters in use for provisioning, # cannot be greater than 36 bytes in length, and should remain immutable for # the lifetime of the StorageClass in use. - # Ensure to create an entry in the config map named ceph-csi-config, based on + # Ensure to create an entry in the configmap named ceph-csi-config, based on # csi-config-map-sample.yaml, to accompany the string chosen to # represent the Ceph cluster in clusterID below clusterID: @@ -54,7 +54,7 @@ parameters: # Use external key management system for encryption passphrases by specifying # a unique ID matching KMS ConfigMap. The ID is only used for correlation to - # config map entry. + # configmap entry. # encryptionKMSID: # Add topology constrained pools configuration, if topology based pools