Skip to content

Commit 2f3ddf5

Browse files
Revert "Update AKS EE KMS plugin deployment instructions"
This reverts commit 14d9e9d.
1 parent 14d9e9d commit 2f3ddf5

File tree

1 file changed

+22
-16
lines changed

1 file changed

+22
-16
lines changed

AKS-Arc/aks-edge-howto-add-secrets-encryption-preview.md

Lines changed: 22 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -28,40 +28,46 @@ The KMS plugin will be supported for all AKS EE clusters version 1.10.xxx.0 and
2828
> [!NOTE]
2929
> You can only enable or disable the KMS Plugin when creating a new deployment. Once you set the flag, it can't be changed unless you remove the deployment or node.
3030
31-
1. Deploying the AKS EE clusters
32-
Refer to the [AKS EE deployment guide](aks-edge-howto-deploy.md) to create a new AKS EE cluster.
33-
The following line will be present if KMS plugin is enabled:
34-
```powershell
35-
Preparing to install kms-plugin as encryption provider...
31+
1. Installing the KMS Plugin
32+
- Install the single machine deployment using the [Single Machine Kubernetes guide](aks-edge-concept-clusters-nodes.md) guide
33+
- During the first step in the single machine deployment process, create an **aksedge-config.json** file. In the **aksedge-config file**, in the Init section, set Init.KmsPlugin.Enable to True as shown below:
34+
35+
```JSON
36+
"Init": {
37+
"KmsPlugin": {
38+
"Enable": true
39+
}
40+
}
3641
```
42+
A new deployment has been created when you see the following message:
43+
:::image type="content" source="media/aks-edge/aks-ee-successful-deployement.jpg" alt-text="Screenshot showing new deployement." lightbox="media/aks-edge/aks-ee-successful-deployement.jpg":::
44+
45+
2. Validating KMS Installation
46+
The following sections describe how to validate the KMS plugin installation for AKS EE cluster
3747

3848
**Create and retrieve a secret which is encrypted using KMS**
3949
```powershell
4050
# Create a new secret encrypted by KMS
41-
kubectl create secret generic db-user-pass --from-literal=username=<username> --from-literal=password='<your-secret>'
51+
kubectl create secret generic db-user-pass --from-literal=username=admin --from-literal=password='your-secret'
4252
```
43-
If successful the terminal will show the following output:
44-
```output
45-
secret/db-user-pass1 created
46-
```
53+
4754
**Retrieve the secret which has been created**
4855
```powershell
4956
# Retrieve secret to test decryption
5057
kubectl get secret db-user-pass -o jsonpath='{.data}'
5158
```
5259
If successful the terminal will show the following output:
53-
```output
54-
["password": "<your-secret>", "username": "<username>"}
60+
:::image type="content" source="media/aks-edge/aks-ee-successful-secret-create.jpg" alt-text="Screenshot showing secret creation and retrieval." lightbox="media/aks-edge/aks-ee-successful-secret-create.jpg":::
5561

56-
```
5762

5863
## Troubleshooting
5964
If there are errors with the KMS plugin, please run the following commands.
6065

6166
1. Check that the AKS version is **1.10.xxx.0** and later
6267
Use the following command to check for upgrades for Kubernetes Cluster. Please refer to [upgrade an AKS Cluster](aks-edge-howto-update.md) for more information.
63-
```powershell
64-
Get-AksEdgeCluster -Name <cluster-name> | Select-Object -ExpandProperty Version
68+
69+
```shell
70+
az aks get-upgrades --resource-group myResourceGroup --name myAKSCluster --output table
6571
```
6672
2. View readyz api
6773
If the problem persists, then validate that installation succeeded and to check the health of the KMS plugin run the following command and ensure that the health status of kms-providers is "ok"
@@ -71,7 +77,7 @@ If the problem persists, then validate that installation succeeded and to check
7177

7278
:::image type="content" source="media/aks-edge/aks-ee-kms-plugin-ok.jpg" alt-text="Screenshot showing readyz api." lightbox="media/aks-edge/aks-ee-kms-plugin-ok.jpg":::
7379

74-
If you receive [-] before the 'kms-provider' field then collect Diagnostic Logs for debugging. Refer to the link instructions [here](aks-get-kubelet-logs.md) for more information.
80+
If you receive [-] before the output then collect Diagnostic Logs for debugging. Refer to the link instructions [here](aks-get-kubelet-logs.md) for more information.
7581

7682
3. Repair KMS
7783
If there are still errors then the machine running the AKS EE cluster could have been paused or turned off for extended periods of time (over 30 days) the Repair-Kms command can be run to rehydrates any necessary tokens to get KMS back in a healthy state.

0 commit comments

Comments
 (0)