Skip to content

Commit 61e4006

Browse files
committed
add admonitions in docs for amazon_web_services.eks_kms_arn config option
1 parent 55f8394 commit 61e4006

File tree

1 file changed

+6
-0
lines changed

1 file changed

+6
-0
lines changed

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

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -112,25 +112,31 @@ Nebari supports setting an existing KMS key while deploying Nebari to implement
112112
created in Nebari's EKS cluster. The KMS key must be a **Symmetric** key set to **encrypt and decrypt** data.
113113

114114
:::warning
115+
115116
Enabling EKS cluster secrets encryption, by setting `amazon_web_services.eks_kms_arn`, is an
116117
_irreversible_ action and re-deploying Nebari to try to remove a previously set `eks_kms_arn` will fail.
117118
On the other hand, if you try to change the KMS key in use for cluster encryption, by re-deploying Nebari
118119
after setting a _different_ key ARN, the re-deploy should succeed but the KMS key used for encryption will
119120
not actually change in the cluster config and the original key will remain set. The integrity of a faulty
120121
deployment can be restored, following a failed re-deploy attempt to remove a previously set KMS key, by
121122
simply re-deploying Nebari while ensuring `eks_kms_arn` is set to the original KMS key ARN.
123+
122124
:::
123125

124126
:::danger
127+
125128
If the KMS key used for envelope encryption of secrets is ever deleted, then there is no way to recover
126129
the EKS cluster.
130+
127131
:::
128132

129133
:::note
134+
130135
After enabling cluster encryption on your cluster, you must encrypt all existing secrets with the
131136
new key by running the following command:
132137
`kubectl get secrets --all-namespaces -o json | kubectl annotate --overwrite -f - kms-encryption-timestamp="time value"`
133138
Consult [Encrypt K8s secrets with AWS KMS on existing clusters](https://docs.aws.amazon.com/eks/latest/userguide/enable-kms.html) for more information.
139+
134140
:::
135141

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

0 commit comments

Comments
 (0)