Skip to content

Commit 96f8243

Browse files
committed
Updates
1 parent d3627d7 commit 96f8243

File tree

6 files changed

+32
-28
lines changed

6 files changed

+32
-28
lines changed

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ description: Description of deployment configuration JSON parameters in AKS Edge
44
author: sethmanheim
55
ms.author: sethm
66
ms.topic: conceptual
7-
ms.date: 07/11/2024
7+
ms.date: 02/20/2025
88
ms.custom: template-concept
99
---
1010

@@ -21,7 +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|
24+
| `Init.KmsPlugin.Enable` |Boolean| Enables the KMS plugin | false |Single-machine and full deployment|
2525
| `Join.ClusterJoinToken` |String|`Reserved` | None |Full deployment only|
2626
| `Join.DiscoveryTokenHash` |String|`Reserved`| None |Full deployment only|
2727
| `Join.CertificateKey` |String|`Reserved`| None |Full deployment only|

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

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ description: Learn how to enable the KMS plugin for AKS Edge Essentials clusters
44
author: sethmanheim
55
ms.author: sethm
66
ms.topic: how-to
7-
ms.date: 02/13/2025
7+
ms.date: 02/20/2025
88
ms.custom: template-how-to
99
ms.reviewer: leslielin
1010
---
@@ -50,21 +50,21 @@ 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**:
53+
## Verify that the KMS plugin is enabled
5554

56-
```powershell
57-
kubectl get --raw='/readyz?verbose'
58-
```
55+
To verify that the KMS plugin is enabled, run the following command and ensure that the health status of **kms-providers** is **OK**:
5956

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-
```
57+
```powershell
58+
kubectl get --raw='/readyz?verbose'
59+
```
6760

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+
```
6868

6969
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.
7070

@@ -82,17 +82,17 @@ If there are errors with the KMS plugin, follow this procedure:
8282

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

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
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.
8686

8787
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).
8888

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:
89+
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:
9090

9191
```powershell
9292
Repair-AksEdgeKms
9393
```
9494

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

9797
## Next steps
9898

AKS-Arc/aks-edge-workload-identity.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ description: Learn how to configure an AKS Edge Essentials cluster with workload
44
author: sethmanheim
55
ms.author: sethm
66
ms.topic: how-to
7-
ms.date: 02/12/2025
7+
ms.date: 02/20/2025
88
ms.reviewer: leslielin
99

1010
---

AKS-Arc/reference/aks-edge-ps/TOC.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,8 @@
4242
href: remove-aksedgedeployment.md
4343
- name: Remove-AksEdgeNode
4444
href: remove-aksedgenode.md
45+
- name: Repair-AksEdgeKms
46+
href: repair-aksedgekms.md
4547
- name: Set-AksEdgeNodeToDrain
4648
href: set-aksedgenodetodrain.md
4749
- name: Set-AksEdgeUpgrade

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

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ description: PowerShell cmdlets for AKS Edge Essentials
44
author: rcheeran
55
ms.author: rcheeran
66
ms.topic: reference
7-
ms.date: 01/31/2023
7+
ms.date: 02/20/2025
88
---
99

1010
# AKS Edge Essentials PowerShell module
@@ -90,6 +90,7 @@ Removes the deployment from an existing cluster.
9090
### [Remove-AksEdgeNode](./remove-aksedgenode.md)
9191

9292
Removes a local node from an existing cluster.
93+
9394
### [Repair-AksEdgeKms](./repair-aksedgekms.md)
9495

9596
Repair the KMS plugin for an existing cluster

AKS-Arc/reference/aks-edge-ps/repair-aksedgekms.md

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,19 @@
11
---
22
title: Repair-AksEdgeKms for AKS Edge
3-
author: AnushkaKhare-Eng
43
description: The Repair-AksEdgeKms command repairs the KMS plugin for an existing cluster
4+
author: sethmanheim
55
ms.topic: reference
6-
ms.date: 2/18/2025
7-
ms.author: khareanushka
8-
ms.lastreviewed: 2/18/2025
9-
ms.reviewer:
6+
ms.date: 2/20/2025
7+
ms.author: sethm
8+
ms.lastreviewed: 2/20/2025
9+
ms.reviewer: khareanushka
1010

1111
---
1212

1313

1414
# Repair-AksEdgeKms
1515

16-
Repair the KMS plugin for an existing cluster.
16+
Repairs the KMS plugin for an existing cluster.
1717

1818
## Syntax
1919

@@ -23,10 +23,11 @@ Repair-AksEdgeKms
2323

2424
## Description
2525

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.
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.
2727

2828
## Examples
29-
### Repairing the KMS plugin
29+
30+
### Repair the KMS plugin
3031

3132
```powershell
3233
Repair-AksEdgeKms

0 commit comments

Comments
 (0)