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/operator-nexus/howto-service-principal-rotation.md
+15-14Lines changed: 15 additions & 14 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,14 +4,15 @@ description: Instructions on service principal rotation lifecycle management.
4
4
ms.service: azure-operator-nexus
5
5
ms.custom: template-how-to
6
6
ms.topic: how-to
7
-
ms.date: 02/05/2024
7
+
ms.date: 03/05/2024
8
8
author: sbatchu0108
9
9
ms.author: sbatchu
10
10
---
11
11
12
-
# Service principal rotation on the target cluster
12
+
# Service Principal rotation on the target Cluster
13
13
14
-
This document provides an overview on the process of performing service principal rotation on the target cluster.
14
+
This document provides an overview on the process of performing Service Principal rotation on the target Nexus cluster.
15
+
In alignment with security best practices, a Security Principal should be rotated periodically. Anytime the integrity of the Service Principal is suspected or known to be compromised, it should be rotated immediately.
15
16
16
17
## Prerequisites
17
18
@@ -23,38 +24,38 @@ This document provides an overview on the process of performing service principa
23
24
6. Service Principal rotation should be performed prior to the configured credentials expiring.
24
25
7. Service Principal should have owner privilege on the subscription of the target cluster.
25
26
26
-
## Append secondary credential to the existing service principal
27
+
## Append secondary credential to the existing Service Principal
27
28
28
-
List existing credentials info for the service principal
29
+
List existing credentials info for the Service Principal
29
30
30
31
```azurecli
31
32
az ad app credential list --id "<SP Application (client) ID>"
32
33
```
33
34
34
-
Append secondary credential to the service principal. Please copy the resulting generated password somewhere safe.
35
+
Append secondary credential to the Service Principal. Please copy the resulting generated password somewhere safe, following best practices.
35
36
36
37
```azurecli
37
38
az ad app credential reset --id "<SP Application (client) ID>" --append --display-name "<human-readable description>"
38
39
```
39
-
## Create a new service principal
40
+
## Create a new Service Principal
40
41
41
-
New service principal should have owner privilege scope on the target cluster subscription.
42
+
New Service Principal should have owner privilege scope on the target Cluster subscription.
42
43
43
44
```azurecli
44
45
az ad sp create-for-rbac -n "<service principal display name>" --role owner --scopes /subscriptions/<subscription-id>
45
46
```
46
47
47
-
## Rotate service principal on the target cluster
48
+
## Rotate Service Principal on the target Cluster
48
49
49
-
Service principal can be rotated on the target cluster by supplying the new information, which can either be only secondary credential update or it could be the new service principal for the target cluster.
50
+
Service Principal can be rotated on the target Cluster by supplying the new information, which can either be only secondary credential update or it could be the new Service Principal for the target Cluster.
## Verify new service principal update on the target cluster
56
+
## Verify new Service Principal update on the target Cluster
56
57
57
-
Cluster show will list the new service principal changes if its rotated on the target cluster.
58
+
Cluster show will list the new Service Principal changes if its rotated on the target Cluster.
58
59
59
60
```azurecli
60
61
az networkcloud cluster show --name "clusterName" --resource-group "resourceGroup"
@@ -71,9 +72,9 @@ In the output, you can find the details under `clusterServicePrincipal` property
71
72
```
72
73
73
74
> [!NOTE]
74
-
> Ensure you're using the correct service principal ID(object ID in Azure) when updating it. There are two different object IDs retrievable from Azure for the same Service Principal name, follow these steps to find the right one:
75
+
> Ensure you're using the correct Service Principal ID(object ID in Azure) when updating it. There are two different object IDs retrievable from Azure for the same Service Principal name, follow these steps to find the right one:
75
76
> 1. Avoid retrieving the object ID from the Service Principal of type application that appears when you search for service principal on the Azure portal search bar.
76
77
> 2. Instead, Search for the service principal name under "Enterprise applications" in Azure Services to find the correct object ID and use it as principal ID.
77
78
78
79
If you still have questions, [contact support](https://portal.azure.com/?#blade/Microsoft_Azure_Support/HelpAndSupportBlade).
79
-
For more information about Support plans, see [Azure Support plans](https://azure.microsoft.com/support/plans/response/).
80
+
For more information about Support plans, see [Azure Support plans](https://azure.microsoft.com/support/plans/response/).
0 commit comments