You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: AKS-Arc/aks-edge-deployment-config-json.md
+2-1Lines changed: 2 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,7 +4,7 @@ description: Description of deployment configuration JSON parameters in AKS Edge
4
4
author: sethmanheim
5
5
ms.author: sethm
6
6
ms.topic: conceptual
7
-
ms.date: 07/11/2024
7
+
ms.date: 02/20/2025
8
8
ms.custom: template-concept
9
9
---
10
10
@@ -21,6 +21,7 @@ You can find the complete JSON schema file at `C:\Program Files\AksEdge\aksedge-
21
21
|`DeploymentType`|[`SingleMachineCluster` / `ScalableCluster`]| Specifies deployment type. In `ScalableCluster`, you can add more machines to the cluster infrastructure. |`SingleMachineCluster`|Single-machine and full deployment|
22
22
|`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|
23
23
|`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| Enables the KMS plugin | false |Single-machine and full deployment|
Copy file name to clipboardExpand all lines: AKS-Arc/aks-edge-howto-secret-encryption.md
+19-15Lines changed: 19 additions & 15 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,7 +4,7 @@ description: Learn how to enable the KMS plugin for AKS Edge Essentials clusters
4
4
author: sethmanheim
5
5
ms.author: sethm
6
6
ms.topic: how-to
7
-
ms.date: 02/13/2025
7
+
ms.date: 02/20/2025
8
8
ms.custom: template-how-to
9
9
ms.reviewer: leslielin
10
10
---
@@ -25,7 +25,7 @@ This article demonstrates how to activate the KMS plugin for AKS Edge Essentials
25
25
The KMS plugin is supported for all AKS Edge Essentials clusters, version 1.10.xxx.0 and later.
26
26
27
27
> [!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).
29
29
30
30
## Enable the KMS plugin
31
31
@@ -50,6 +50,22 @@ For deployment instructions, see [Single machine deployment](aks-edge-howto-sing
50
50
> [!NOTE]
51
51
> 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.
52
52
53
+
## Verify that the KMS plugin is enabled
54
+
55
+
To verify that the KMS plugin is enabled, run the following command and ensure that the health status of **kms-providers** is **OK**:
56
+
57
+
```powershell
58
+
kubectl get --raw='/readyz?verbose'
59
+
```
60
+
61
+
```output
62
+
[+]ping ok
63
+
[+]Log ok
64
+
[+]etcd ok
65
+
[+]kms-providers ok
66
+
[+]poststarthook/start-encryption-provider-config-automatic-reload ok
67
+
```
68
+
53
69
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.
54
70
55
71
If you encounter errors, see the [Troubleshooting](#troubleshooting) section.
@@ -66,19 +82,7 @@ If there are errors with the KMS plugin, follow this procedure:
66
82
67
83
If the version is older, upgrade to the latest version. For more information, see [Upgrade an AKS cluster](aks-edge-howto-update.md).
68
84
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
+
1. View the `readyz` API. If the problem persists, verify that the KMS plugin is enabled. See the [Verify that the KMS plugin is enabled](#verify-that-the-kms-plugin-is-enabled) section.
82
86
83
87
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).
description: The Repair-AksEdgeKms command repairs the KMS plugin for an existing cluster
4
+
author: sethmanheim
5
+
ms.topic: reference
6
+
ms.date: 2/20/2025
7
+
ms.author: sethm
8
+
ms.lastreviewed: 2/20/2025
9
+
ms.reviewer: khareanushka
10
+
11
+
---
12
+
13
+
14
+
# Repair-AksEdgeKms
15
+
16
+
Repairs 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. To get the KMS plugin back to a healthy state, the command rehydrates **nodeagent** tokens required for key rotation.
27
+
28
+
## Examples
29
+
30
+
### Repair the KMS plugin
31
+
32
+
```powershell
33
+
Repair-AksEdgeKms
34
+
```
35
+
36
+
### CommonParameters
37
+
38
+
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).
0 commit comments