mirror of
https://github.com/ceph/ceph-csi.git
synced 2024-11-22 06:10:22 +00:00
doc: make sure configmap object referred or documented correctly
Signed-off-by: Humble Chirammal <hchiramm@redhat.com>
This commit is contained in:
parent
8b606f538f
commit
c1a269191c
@ -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
|
||||
|
@ -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: <kms-id>
|
||||
|
||||
reclaimPolicy: Delete
|
||||
|
@ -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)
|
||||
|
@ -28,9 +28,9 @@ Gather the following information from the Ceph cluster(s) of choice,
|
||||
* Alternatively, choose a `<cluster-id>` 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 `<cluster-id>` 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`
|
||||
|
@ -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: <cluster-id>
|
||||
|
@ -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 <cluster-id>
|
||||
# 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: |-
|
||||
[
|
||||
|
@ -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: <cluster-id>
|
||||
|
@ -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: <cluster-id>
|
||||
@ -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: <kms-config-id>
|
||||
|
||||
# Add topology constrained pools configuration, if topology based pools
|
||||
|
Loading…
Reference in New Issue
Block a user