Skip to content

Commit d3627d7

Browse files
committed
Merge branch 'release-aks-ee-feb' of https://github.com/AnushkaKhare-Eng/azure-stack-docs-pr into kmsupd2-20
2 parents 491117d + 71a7a41 commit d3627d7

File tree

4 files changed

+65
-16
lines changed

4 files changed

+65
-16
lines changed

AKS-Arc/aks-edge-deployment-config-json.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,7 @@ You can find the complete JSON schema file at `C:\Program Files\AksEdge\aksedge-
2121
| `DeploymentType` |[`SingleMachineCluster` / `ScalableCluster`]| Specifies deployment type. In `ScalableCluster`, you can add more machines to the cluster infrastructure. | `SingleMachineCluster` |Single-machine and full deployment|
2222
| `Init.ServiceIPRangeStart` |IPv4 address `A.B.C.x`.|Reserved IP start address for your Kubernetes services. This IP range must be free on your subnet **A.B.C.0**.| None |Single-machine and full deployment|
2323
| `Init.ServiceIPRangeSize` |`[0-127]`|Number of reserved IP start addresses for your Kubernetes services. Based on the size, we allocate a range of free IP addresses on your subnet. | `0` |Single-machine and full deployment|
24+
| `Init.KmsPlugin.Enable` |Boolean| Enabling the KMS Plugin | false |Single-machine and full deployment|
2425
| `Join.ClusterJoinToken` |String|`Reserved` | None |Full deployment only|
2526
| `Join.DiscoveryTokenHash` |String|`Reserved`| None |Full deployment only|
2627
| `Join.CertificateKey` |String|`Reserved`| None |Full deployment only|

AKS-Arc/aks-edge-howto-secret-encryption.md

Lines changed: 20 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ This article demonstrates how to activate the KMS plugin for AKS Edge Essentials
2525
The KMS plugin is supported for all AKS Edge Essentials clusters, version 1.10.xxx.0 and later.
2626

2727
> [!NOTE]
28-
> The KMS plugin can only be used for single node clusters. The plugin can't be used with [experimental features such as multi-node and Windows node](aks-edge-system-requirements.md#experimental-or-prerelease-features).
28+
> The KMS plugin can only be used for single node clusters. The plugin can't be used with [experimental features such as multi-node](aks-edge-system-requirements.md#experimental-or-prerelease-features).
2929
3030
## Enable the KMS plugin
3131

@@ -50,6 +50,22 @@ For deployment instructions, see [Single machine deployment](aks-edge-howto-sing
5050
> [!NOTE]
5151
> You can only enable or disable the KMS plugin when you create a new deployment. Once you set the flag, it can't be changed.
5252
53+
## Verify the KMS plugin is enabled
54+
To verify that the KMS plugin is enabled, run the command below and ensure that the health status of **kms-providers** is **OK**:
55+
56+
```powershell
57+
kubectl get --raw='/readyz?verbose'
58+
```
59+
60+
```output
61+
[+]ping ok
62+
[+]Log ok
63+
[+]etcd ok
64+
[+]kms-providers ok
65+
[+]poststarthook/start-encryption-provider-config-automatic-reload ok
66+
```
67+
68+
5369
To create secrets in AKS Edge Essentials clusters, see [Managing Secrets using kubectl](https://kubernetes.io/docs/tasks/configmap-secret/managing-secret-using-kubectl/#use-raw-data) in the Kubernetes documentation.
5470

5571
If you encounter errors, see the [Troubleshooting](#troubleshooting) section.
@@ -66,29 +82,17 @@ If there are errors with the KMS plugin, follow this procedure:
6682

6783
If the version is older, upgrade to the latest version. For more information, see [Upgrade an AKS cluster](aks-edge-howto-update.md).
6884

69-
1. View the `readyz` API. If the problem persists, validate that the installation succeeded. To check the health of the KMS plugin, run the following command and ensure that the health status of **kms-providers** is **OK**:
70-
71-
```powershell
72-
kubectl get --raw='/readyz?verbose'
73-
```
74-
75-
```output
76-
[+]ping ok
77-
[+]Log ok
78-
[+]etcd ok
79-
[+]kms-providers ok
80-
[+]poststarthook/start-encryption-provider-config-automatic-reload ok
81-
```
85+
2. View the `readyz` API. If the problem persists, verify that the KMS plugin is enabled. Please refer to the [Verify the KMS plugin is enabled](#verify-the-kms-plugin-is-enabled) above
8286

8387
If you receive "**[-]**" before the `kms-providers` field, collect diagnostic logs for debugging. For more information, see [Get kubelet logs from cluster nodes](aks-get-kubelet-logs.md).
8488

85-
1. Repair KMS. If there are still errors, the machine running the AKS Edge Essentials cluster might be paused or turned off for an extended period of time (over 30 days). To get KMS back into a healthy state, you can use the `Repair-Kms` command to restore any necessary tokens:
89+
3. Repair KMS. If there are still errors, the machine running the AKS Edge Essentials cluster might be paused or turned off for an extended period of time (over 30 days). To get KMS back into a healthy state, you can use the `Repair-Kms` command to restore any necessary tokens:
8690

8791
```powershell
8892
Repair-AksEdgeKms
8993
```
9094

91-
1. If you still encounter errors, contact [Microsoft Customer Support](aks-edge-troubleshoot-overview.md) and [collect logs](aks-get-kubelet-logs.md).
95+
4. If you still encounter errors, contact [Microsoft Customer Support](aks-edge-troubleshoot-overview.md) and [collect logs](aks-get-kubelet-logs.md).
9296

9397
## Next steps
9498

AKS-Arc/reference/aks-edge-ps/index.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -90,6 +90,9 @@ Removes the deployment from an existing cluster.
9090
### [Remove-AksEdgeNode](./remove-aksedgenode.md)
9191

9292
Removes a local node from an existing cluster.
93+
### [Repair-AksEdgeKms](./repair-aksedgekms.md)
94+
95+
Repair the KMS plugin for an existing cluster
9396

9497
### [Set-AksEdgeBillingPodState](./set-aksedgebillingpodstate.md)
9598

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
---
2+
title: Repair-AksEdgeKms for AKS Edge
3+
author: AnushkaKhare-Eng
4+
description: The Repair-AksEdgeKms command repairs the KMS plugin for an existing cluster
5+
ms.topic: reference
6+
ms.date: 2/18/2025
7+
ms.author: khareanushka
8+
ms.lastreviewed: 2/18/2025
9+
ms.reviewer:
10+
11+
---
12+
13+
14+
# Repair-AksEdgeKms
15+
16+
Repair the KMS plugin for an existing cluster.
17+
18+
## Syntax
19+
20+
```powershell
21+
Repair-AksEdgeKms
22+
```
23+
24+
## Description
25+
26+
This command repairs the KMS plugin for an existing cluster. This function is supported only for single node and scalable clusters.The command below rehydrates nodeagent tokens required for key rotation to get KMS back in a healthy state.
27+
28+
## Examples
29+
### Repairing the KMS plugin
30+
31+
```powershell
32+
Repair-AksEdgeKms
33+
```
34+
35+
### CommonParameters
36+
37+
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216).
38+
39+
## Next steps
40+
41+
[AksEdge PowerShell Reference](./index.md)

0 commit comments

Comments
 (0)