Skip to content

Commit 96f1ef1

Browse files
committed
add note in docs for amazon_web_services.eks_kms_arn config to apply encryption
1 parent 1b4e6ed commit 96f1ef1

File tree

1 file changed

+7
-0
lines changed

1 file changed

+7
-0
lines changed

docs/docs/explanations/advanced-provider-configuration.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -114,6 +114,13 @@ created in Nebari's EKS cluster. The KMS key must be a `Symmetric` key set to `e
114114
Warning: Enabling EKS cluster secrets encryption, by setting `amazon_web_services.eks_kms_arn`, is an
115115
irreversible action, and if the KMS key used for envelope encryption of secrets is ever deleted, then
116116
there is no way to recover the EKS cluster.
117+
Additionally, if you try to change the KMS key in use for cluster encryption, by setting a different
118+
key ARN and re-deploying Nebari, the re-deploy should succeed but the KMS key used for encryption will
119+
not actually change the cluster config and the original key will remain set.
120+
121+
Note: After enabling cluster encryption on your cluster, you must encrypt all existing secrets with the
122+
new key by running the following command:
123+
`kubectl get secrets --all-namespaces -o json | kubectl annotate --overwrite -f - kms-encryption-timestamp="time value"`
117124
Consult [Encrypt K8s secrets with AWS KMS on existing clusters](https://docs.aws.amazon.com/eks/latest/userguide/enable-kms.html) for more information.
118125

119126
Here is an example of how you would set KMS key ARN in `nebari-config.yaml`.

0 commit comments

Comments
 (0)