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: articles/aks/update-credentials.md
+13-8Lines changed: 13 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,7 +2,7 @@
2
2
title: Update or rotate the credentials for an Azure Kubernetes Service (AKS) cluster
3
3
description: Learn how update or rotate the service principal or Azure AD Application credentials for an Azure Kubernetes Service (AKS) cluster.
4
4
ms.topic: article
5
-
ms.date: 02/28/2023
5
+
ms.date: 03/01/2023
6
6
---
7
7
8
8
# Update or rotate the credentials for an Azure Kubernetes Service (AKS) cluster
@@ -14,7 +14,7 @@ AKS clusters created with a service principal have a one-year expiration time. A
14
14
15
15
## Before you begin
16
16
17
-
You need the Azure CLI version 2.0.65 or later installed and configured. Run`az --version` to find the version. If you need to install or upgrade, see[Install Azure CLI][install-azure-cli].
17
+
You need the Azure CLI version 2.0.65 or later installed and configured. Run`az --version` to find the version. If you need to install or upgrade, see[Install Azure CLI][install-azure-cli].
18
18
19
19
## Update or create a new service principal for your AKS cluster
20
20
@@ -38,7 +38,7 @@ az ad app credential list --id "$SP_ID" --query "[].endDateTime" -o tsv
38
38
39
39
### Reset the existing service principal credentials
40
40
41
-
To update the credentials for the existing service principal, get the service principal ID of your cluster using the [`az aks show`][az-aks-show] command. The following example gets the ID for the cluster named *myAKSCluster* in the *myResourceGroup* resource group. The service principal ID is set as a variable named *SP_ID*to use in additional command. These commands use Bash syntax.
41
+
To update the credentials for an existing service principal, get the service principal ID of your cluster using the [`az aks show`][az-aks-show] command. The following example gets the ID for the cluster named *myAKSCluster* in the *myResourceGroup* resource group. The variable named *SP_ID*stores the service principal ID used in the next step. These commands use the Bash command language.
42
42
43
43
> [!WARNING]
44
44
> When you reset your cluster credentials on an AKS cluster that uses Azure Virtual Machine Scale Sets, a [node image upgrade][node-image-upgrade] is performed to update your nodes with the new credential information.
@@ -48,18 +48,21 @@ SP_ID=$(az aks show --resource-group myResourceGroup --name myAKSCluster \
48
48
--query servicePrincipalProfile.clientId -o tsv)
49
49
```
50
50
51
-
Use the variable containing the service principal ID to reset the credentials using the [`az ad app credential reset`][az-ad-app-credential-reset] command. The following example enables the Azure platform to generate a new secure secret for the service principal and stores it as a variable named *SP_SECRET*.
51
+
Use the variable *SP_ID*containing the service principal ID to reset the credentials using the [`az ad app credential reset`][az-ad-app-credential-reset] command. The following example enables the Azure platform to generate a new secure secret for the service principal and store it as a variable named *SP_SECRET*.
Next, you can [update AKS cluster with new service principal credentials](#update-aks-cluster-with-new-service-principal-credentials). This step is necessary for the Service Principal changes to reflect on the AKS cluster.
57
+
Next, you [update AKS cluster with new service principal credentials][update-cluster-new-service-principal-credentials]. This step is necessary to update the service principal on your AKS cluster.
58
+
59
+
>[!IMPORTANT]
60
+
>For large clusters, updating your AKS cluster with a new service principal may take a long time to complete. Consider reviewing and customizing the [node surge upgrade settings][node-surge-upgrade] to minimize disruption during the update. For small and midsize clusters, it takes a several minutes for the new credentials to update in the cluster.
58
61
59
62
### Create a new service principal
60
63
61
64
> [!NOTE]
62
-
> If you updated the existing service principal credentials in the previous section, skip this section and instead [update the AKS cluster with new service principal credentials](#update-aks-cluster-with-new-service-principal-credentials).
65
+
> If you updated the existing service principal credentials in the previous section, skip this section and instead [update the AKS cluster with new service principal credentials][update-cluster-new-service-principal-credentials].
63
66
64
67
To create a service principal and update the AKS cluster to use the new credentials, use the [`az ad sp create-for-rbac`][az-ad-sp-create] command.
Next, you can [update AKS cluster with new service principal credentials](#update-aks-cluster-with-new-service-principal-credentials). This step is necessary for the Service Principal changes to reflect on the AKS cluster.
91
+
Next, you can [update AKS cluster with new service principal credentials][update-cluster-new-service-principal-credentials]. This step is necessary for the Service Principal changes to reflect on the AKS cluster.
89
92
90
93
## Update AKS cluster with new service principal credentials
91
94
@@ -105,7 +108,7 @@ az aks update-credentials \
105
108
106
109
## Update AKS cluster with new Azure AD application credentials
107
110
108
-
You can create new Azure AD server and client applications by following the [Azure AD integration steps][create-aad-app], or reset your existing Azure AD applications following the [same method as for service principal reset](#reset-the-existing-service-principal-credentials). After that, you need to update your cluster Azure AD application credentials using the [`az aks update-credentials`][az-aks-update-credentials] command with the *--reset-aad* variables.
111
+
You can create new Azure AD server and client applications by following the [Azure AD integration steps][create-aad-app], or reset your existing Azure AD applications following the [same method as for service principal reset][reset-existing-service-principal-credentials]. After that, you need to update your cluster Azure AD application credentials using the [`az aks update-credentials`][az-aks-update-credentials] command with the *--reset-aad* variables.
109
112
110
113
```azurecli-interactive
111
114
az aks update-credentials \
@@ -133,3 +136,5 @@ In this article, you learned how to update or rotate service principal and Azure
0 commit comments