@@ -109,16 +109,23 @@ best practice of [defense-in-depth strategy](https://aws.amazon.com/blogs/contai
109109that the user manages.
110110
111111Nebari supports setting an existing KMS key while deploying Nebari to implement encryption of secrets
112- created in Nebari's EKS cluster. The KMS key must be a ` Symmetric` key set to ` encrypt and decrypt` data.
112+ created in Nebari's EKS cluster. The KMS key must be a ** Symmetric** key set to ** encrypt and decrypt** data.
113113
114- Warning : Enabling EKS cluster secrets encryption, by setting `amazon_web_services.eks_kms_arn`, is an
115- irreversible action, and if the KMS key used for envelope encryption of secrets is ever deleted, then
116- 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.
114+ :::warning
115+ Enabling EKS cluster secrets encryption, by setting `amazon_web_services.eks_kms_arn`, is an
116+ _irreversible_ action and re-deploying Nebari to try to remove a previously set `eks_kms_arn` will fail.
117+ On the other hand, if you try to change the KMS key in use for cluster encryption, by re-deploying Nebari
118+ after setting a _different_ key ARN, the re-deploy should succeed but the KMS key used for encryption will
119+ not actually change in the cluster config and the original key will remain set. The integrity of a faulty
120+ deployment can be restored, following a failed re-deploy attempt to remove a previously set KMS key, by
121+ simply re-deploying Nebari while ensuring `eks_kms_arn` is set to the original KMS key ARN.
122+
123+ :::danger
124+ If the KMS key used for envelope encryption of secrets is ever deleted, then there is no way to recover
125+ the EKS cluster.
120126
121- Note : After enabling cluster encryption on your cluster, you must encrypt all existing secrets with the
127+ :::note
128+ After enabling cluster encryption on your cluster, you must encrypt all existing secrets with the
122129new key by running the following command :
123130` kubectl get secrets --all-namespaces -o json | kubectl annotate --overwrite -f - kms-encryption-timestamp="time value"`
124131Consult [Encrypt K8s secrets with AWS KMS on existing clusters](https://docs.aws.amazon.com/eks/latest/userguide/enable-kms.html) for more information.
0 commit comments