mirrors/ceph-csi
1
0
Fork 0
mirror of https://github.com/ceph/ceph-csi.git synced 2024-11-26 00:00:23 +00:00
Code Issues Packages Projects Releases Wiki Activity

doc: add info about metadata rbd volume encryption

Browse Source 
Signed-off-by: Rakshith R <rar@redhat.com>
This commit is contained in:
Rakshith R 2021-07-05 14:46:46 +05:30 committed by mergify[bot]
parent 853d77d793
commit c4060b8aa2
1 changed files with 24 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
docs/deploy-rbd.md
View File

@ -239,6 +239,30 @@ to a different K8s secrets `csi.storage.k8s.io/node-stage-secret-name`
and `csi.storage.k8s.io/provisioner-secret-name` which carry new passphrase value
for `encryptionPassphrase` key in these secrets.
### Encryption `metadata` configuration
CephCSI can generate unique passphrase (DEK Data-Encryption-Key) for each volume
to be used to encrypt/decrypt data. The passphrase (DEK) is encrypted by
`encryptionPassphrase` (KEK Key-Encryption-Key) and stored in the image metadata
of the volume.
To encrypt rbd volumes with `metadata` encryption, users need to set
`encrypted: "true"` and `encryptionKMSID` to a unique identifier in storageclass.
This unique identifier should be similar to the
[examples](../examples/kms/vault/csi-kms-connection-details.yaml).
The configuration must include `"encryptionKMSType": "metadata"`. The
`encryptionPassphrase` is fetched based on the following conditions:
* if `"secretName"` key is specified, `encryptionPassphrase` is fetched from this
secret and `"secretNamespace"` value is used for namespace if specified else
Tenant/Kubernetes namespace (i.e., namespace where the PVC was created) is used.
* if `"secretName"` key is not specified, `encryptionPassphrase` is fetched from
storageclass secrets `csi.storage.k8s.io/provisioner-secret-namespace` /
`csi.storage.k8s.io/provisioner-secret-name` and
`csi.storage.k8s.io/node-stage-secret-namespace` /
`csi.storage.k8s.io/node-stage-secret-name`
similar to the previous [Encryption Configuration](#encryption-configuration).
### Encryption KMS configuration
To further improve security robustness it is possible to use unique passphrases