diff --git a/Documentation/Storage-Configuration/Advanced/key-management-system.md b/Documentation/Storage-Configuration/Advanced/key-management-system.md index bf1115a6e..9877c91ce 100644 --- a/Documentation/Storage-Configuration/Advanced/key-management-system.md +++ b/Documentation/Storage-Configuration/Advanced/key-management-system.md @@ -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: diff --git a/deploy/examples/cluster-on-pvc.yaml b/deploy/examples/cluster-on-pvc.yaml index 290f0c930..0b78c0959 100644 --- a/deploy/examples/cluster-on-pvc.yaml +++ b/deploy/examples/cluster-on-pvc.yaml @@ -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