docs: add documentation for encryption key rotation

Signed-off-by: Rakshith R <rar@redhat.com>
This commit is contained in:
Rakshith R committed 2023-03-08 12:07:26 +05:30
1 parent f39a32fcdb
commit 340dbe05b4
2 files changed
+16

No files matched your search

@@ -3,6 +3,7 @@ title: Key Management System
---
Rook has the ability to encrypt OSDs of clusters running on PVC via the flag (`encrypted: true`) in your `storageClassDeviceSets` [template](#pvc-based-cluster).
Rook also has the ability to rotate encryption keys of OSDs using a cron job per OSD.
By default, the Key Encryption Keys (also known as Data Encryption Keys) are stored in a Kubernetes Secret.
However, if a Key Management System exists Rook is capable of using it.
@@ -12,6 +13,12 @@ The `security` section contains settings related to encryption of the cluster.
* `kms`: Key Management System settings
* `connectionDetails`: the list of parameters representing kms connection details
* `tokenSecretName`: the name of the Kubernetes Secret containing the kms authentication token
* `keyRotation`: Key Rotation settings
* `enabled`: whether key rotation is enabled or not, default is `false`
* `schedule`: the schedule, written in [cron format](https://en.wikipedia.org/wiki/Cron), with which key rotation [CronJob](https://kubernetes.io/docs/concepts/workloads/controllers/cron-jobs/) is created, default value is `"@weekly"`.
!!! note
Currently key rotation is only supported for the default type, where the Key Encryption Keys are stored in a Kubernetes Secret.
Supported KMS providers:
+9
View File
@@ -185,6 +185,15 @@ spec:
pgHealthCheckTimeout: 0
# security oriented settings
# security:
# Settings to enable key rotation for KEK(Key Encryption Key).
# Currently, this is supported only for the default encryption type,
# using kubernetes secrets.
# keyRotation:
# enabled: true
# # The schedule, written in [cron format](https://en.wikipedia.org/wiki/Cron),
# # with which key rotation [CronJob](https://kubernetes.io/docs/concepts/workloads/controllers/cron-jobs/)
# # is created. The default value is `"@weekly"`.
# schedule: "@monthly"
# To enable the KMS configuration properly don't forget to uncomment the Secret at the end of the file
# kms:
# # name of the config map containing all the kms connection details