Skip to content

Commit 81259d2

Browse files
authored
Merge pull request #5986 from ClickHouse/azure-tde
Add Azure CMEK
2 parents fe2c604 + a65b201 commit 81259d2

1 file changed

Lines changed: 32 additions & 1 deletion

File tree

docs/cloud/guides/security/04_cmek.md

Lines changed: 32 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -100,9 +100,40 @@ Once a service is encrypted with TDE, customers may update the key to enable CME
100100

101101
</details>
102102

103+
<details>
104+
<summary>Enable CMEK with Azure KMS</summary>
105+
106+
1. In ClickHouse Cloud, select the encrypted service
107+
2. Click on `Settings` on the left
108+
3. At the bottom of the screen, expand `Network security information`
109+
4. Copy the `Cross Tenant App Client ID` - you will need this in the next step
110+
5. Sign into your Azure subscription and use the following command via the Azure CLI to create a new service principal; replace `{azure_cross_tenant_app_client_id}` with the value you copied in the previous step \
111+
`az ad sp create --id {azure_cross_tenant_app_client_id}`
112+
6. Copy the `Name` of the new service principal created - you will need this in a future step
113+
7. [Create an Azure Key Vault](https://learn.microsoft.com/en-us/azure/key-vault/general/quick-create-portal)
114+
8. [Create a Key Vault key in Azure](https://learn.microsoft.com/en-us/azure/key-vault/keys/quick-create-portal)
115+
9. From the Key Vault key, select `Access control (IAM)` on the left
116+
10. Select `Role assignments` from the top menu
117+
11. Click `Add` then `Add role assignment` from the top menu
118+
12. Select the `Key Vault Crypto User` role, then click `Next`
119+
13. Leave the default selections on the `Add role assignment` screen and click `+Select members`
120+
14. Paste the service principal name you copied in step 6 (it starts with CH-TDE), select the service principal and click `Select`
121+
15. Click `Next` then `Review + assign`
122+
16. Return to your Azure Key Vault and copy the following values:
123+
- From the Overview page, copy your Vault URI
124+
- From the Overview page, copy your Directory ID
125+
- From the Keys page, copy your key Name
126+
17. Return to your service settings in ClickHouse Cloud and paste the values from step 16 in the following fields:
127+
- Key ID > paste your key Name
128+
- Key Vault URI > paste your Vault URI
129+
- Key Tenant ID > paste your Directory ID
130+
18. Click Rotate KMS, wait a few minutes as this will result in a rolling restart and verify your service is running
131+
132+
</details>
133+
103134
#### Key rotation {#key-rotation}
104135

105-
Once you set up CMEK, rotate the key by following the procedures above for creating a new KMS key and granting permissions. Return to the service settings to paste the new ARN (AWS) or Key Resource Path (GCP) and save the settings. The service will restart to apply the new key.
136+
Once you set up CMEK, rotate the key by following the procedures above for creating a new KMS key and granting permissions. Return to the service settings to paste the new ARN (AWS), Key Resource Path (GCP) or Key Name (Azure) and save the settings. The service will restart to apply the new key.
106137

107138
#### KMS key poller {#kms-key-poller}
108139

0 commit comments

Comments
 (0)