Skip to content

Commit ecc9aa0

Browse files
Merge pull request #213557 from CocoWang-wql/patch-19
Update OIDC GA part.md
2 parents 5709546 + 64df8bd commit ecc9aa0

File tree

4 files changed

+26
-34
lines changed

4 files changed

+26
-34
lines changed

articles/active-directory/develop/workload-identity-federation-create-trust-user-assigned-managed-identity.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -123,7 +123,7 @@ For a workflow triggered by a pull request event, specify an **Entity type** of
123123
124124
Fill in the **Cluster issuer URL**, **Namespace**, **Service account name**, and **Name** fields:
125125
126-
- **Cluster issuer URL** is the [OIDC issuer URL](../../aks/cluster-configuration.md#oidc-issuer-preview) for the managed cluster or the [OIDC Issuer URL](https://azure.github.io/azure-workload-identity/docs/installation/self-managed-clusters/oidc-issuer.html) for a self-managed cluster.
126+
- **Cluster issuer URL** is the [OIDC issuer URL](../../aks/cluster-configuration.md#oidc-issuer) for the managed cluster or the [OIDC Issuer URL](https://azure.github.io/azure-workload-identity/docs/installation/self-managed-clusters/oidc-issuer.html) for a self-managed cluster.
127127
- **Service account name** is the name of the Kubernetes service account, which provides an identity for processes that run in a Pod.
128128
- **Namespace** is the service account namespace.
129129
- **Name** is the name of the federated credential, which can't be changed later.
@@ -504,4 +504,4 @@ https://management.azure.com/subscriptions/<SUBSCRIPTION ID>/resourceGroups/<RES
504504

505505
## Next steps
506506

507-
- For information about the required format of JWTs created by external identity providers, read about the [assertion format](active-directory-certificate-credentials.md#assertion-format).
507+
- For information about the required format of JWTs created by external identity providers, read about the [assertion format](active-directory-certificate-credentials.md#assertion-format).

articles/active-directory/develop/workload-identity-federation-create-trust.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -128,7 +128,7 @@ Select the **Kubernetes accessing Azure resources** scenario from the dropdown m
128128
129129
Fill in the **Cluster issuer URL**, **Namespace**, **Service account name**, and **Name** fields:
130130
131-
- **Cluster issuer URL** is the [OIDC issuer URL](../../aks/cluster-configuration.md#oidc-issuer-preview) for the managed cluster or the [OIDC Issuer URL](https://azure.github.io/azure-workload-identity/docs/installation/self-managed-clusters/oidc-issuer.html) for a self-managed cluster.
131+
- **Cluster issuer URL** is the [OIDC issuer URL](../../aks/cluster-configuration.md#oidc-issuer) for the managed cluster or the [OIDC Issuer URL](https://azure.github.io/azure-workload-identity/docs/installation/self-managed-clusters/oidc-issuer.html) for a self-managed cluster.
132132
- **Service account name** is the name of the Kubernetes service account, which provides an identity for processes that run in a Pod.
133133
- **Namespace** is the service account namespace.
134134
- **Name** is the name of the federated credential, which can't be changed later.
@@ -202,7 +202,7 @@ az ad app federated-credential create --id f6475511-fd81-4965-a00e-41e7792b7b9c
202202

203203
### Kubernetes example
204204

205-
*issuer* is your service account issuer URL (the [OIDC issuer URL](../../aks/cluster-configuration.md#oidc-issuer-preview) for the managed cluster or the [OIDC Issuer URL](https://azure.github.io/azure-workload-identity/docs/installation/self-managed-clusters/oidc-issuer.html) for a self-managed cluster).
205+
*issuer* is your service account issuer URL (the [OIDC issuer URL](../../aks/cluster-configuration.md#oidc-issuer) for the managed cluster or the [OIDC Issuer URL](https://azure.github.io/azure-workload-identity/docs/installation/self-managed-clusters/oidc-issuer.html) for a self-managed cluster).
206206

207207
*subject* is the subject name in the tokens issued to the service account. Kubernetes uses the following format for subject names: `system:serviceaccount:<SERVICE_ACCOUNT_NAMESPACE>:<SERVICE_ACCOUNT_NAME>`.
208208

@@ -346,7 +346,7 @@ New-AzADAppFederatedCredential -ApplicationObjectId $appObjectId -Audience api:/
346346
### Kubernetes example
347347

348348
- *ApplicationObjectId*: the object ID of the app (not the application (client) ID) you previously registered in Azure AD.
349-
- *Issuer* is your service account issuer URL (the [OIDC issuer URL](../../aks/cluster-configuration.md#oidc-issuer-preview) for the managed cluster or the [OIDC Issuer URL](https://azure.github.io/azure-workload-identity/docs/installation/self-managed-clusters/oidc-issuer.html) for a self-managed cluster).
349+
- *Issuer* is your service account issuer URL (the [OIDC issuer URL](../../aks/cluster-configuration.md#oidc-issuer) for the managed cluster or the [OIDC Issuer URL](https://azure.github.io/azure-workload-identity/docs/installation/self-managed-clusters/oidc-issuer.html) for a self-managed cluster).
350350
- *Subject* is the subject name in the tokens issued to the service account. Kubernetes uses the following format for subject names: `system:serviceaccount:<SERVICE_ACCOUNT_NAMESPACE>:<SERVICE_ACCOUNT_NAME>`.
351351
- *Name* is the name of the federated credential, which can't be changed later.
352352
- *Audience* lists the audiences that can appear in the `aud` claim of the external token.
@@ -446,7 +446,7 @@ And you get the response:
446446

447447
Run the following method to configure a federated identity credential on an app and create a trust relationship with a Kubernetes service account. Specify the following parameters:
448448

449-
- *issuer* is your service account issuer URL (the [OIDC issuer URL](../../aks/cluster-configuration.md#oidc-issuer-preview) for the managed cluster or the [OIDC Issuer URL](https://azure.github.io/azure-workload-identity/docs/installation/self-managed-clusters/oidc-issuer.html) for a self-managed cluster).
449+
- *issuer* is your service account issuer URL (the [OIDC issuer URL](../../aks/cluster-configuration.md#oidc-issuer) for the managed cluster or the [OIDC Issuer URL](https://azure.github.io/azure-workload-identity/docs/installation/self-managed-clusters/oidc-issuer.html) for a self-managed cluster).
450450
- *subject* is the subject name in the tokens issued to the service account. Kubernetes uses the following format for subject names: `system:serviceaccount:<SERVICE_ACCOUNT_NAMESPACE>:<SERVICE_ACCOUNT_NAME>`.
451451
- *name* is the name of the federated credential, which can't be changed later.
452452
- *audiences* lists the audiences that can appear in the external token. This field is mandatory. The recommended value is "api://AzureADTokenExchange".
@@ -570,4 +570,4 @@ az rest -m DELETE -u 'https://graph.microsoft.com/applications/f6475511-fd81-49
570570
- To learn how to use workload identity federation for GitHub Actions, see [Configure a GitHub Actions workflow to get an access token](/azure/developer/github/connect-from-azure).
571571
- Read the [GitHub Actions documentation](https://docs.github.com/actions/deployment/security-hardening-your-deployments/configuring-openid-connect-in-azure) to learn more about configuring your GitHub Actions workflow to get an access token from Microsoft identity provider and access Azure resources.
572572
- For more information, read about how Azure AD uses the [OAuth 2.0 client credentials grant](v2-oauth2-client-creds-grant-flow.md#third-case-access-token-request-with-a-federated-credential) and a client assertion issued by another IdP to get a token.
573-
- For information about the required format of JWTs created by external identity providers, read about the [assertion format](active-directory-certificate-credentials.md#assertion-format).
573+
- For information about the required format of JWTs created by external identity providers, read about the [assertion format](active-directory-certificate-credentials.md#assertion-format).

articles/aks/cluster-configuration.md

Lines changed: 18 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ title: Cluster configuration in Azure Kubernetes Services (AKS)
33
description: Learn how to configure a cluster in Azure Kubernetes Service (AKS)
44
services: container-service
55
ms.topic: article
6-
ms.date: 09/29/2022
6+
ms.date: 10/04/2022
77
---
88

99
# Configure an AKS cluster
@@ -190,36 +190,17 @@ To remove Node Restriction from a cluster.
190190
az aks update -n aks -g myResourceGroup --disable-node-restriction
191191
```
192192

193-
## OIDC Issuer (Preview)
193+
## OIDC Issuer
194194

195195
This enables an OIDC Issuer URL of the provider which allows the API server to discover public signing keys.
196196

197197
> [!WARNING]
198-
> Enable/disable OIDC Issuer changes the current service account token issuer to a new value, which causes some down time and make API server restart. If the application pods based on service account token keep in failed status after enable/disable OIDC Issuer, it's recommended to restart the pods manually.
198+
> Enable or disable OIDC Issuer changes the current service account token issuer to a new value, which can cause down time and restarts the API server. If the application pods using a service token remain in a failed state after you enable or disable the OIDC Issuer, we recommend you manually restart the pods.
199199
200-
### Before you begin
201-
202-
You must have the following resource installed:
203-
204-
* The Azure CLI
205-
* The `aks-preview` extension version 0.5.50 or higher
206-
* Kubernetes version 1.19.x or higher
207-
208-
### Install the aks-preview Azure CLI extension
209-
210-
[!INCLUDE [preview features callout](includes/preview/preview-callout.md)]
211-
212-
To install the aks-preview extension, run the following command:
213-
214-
```azurecli
215-
az extension add --name aks-preview
216-
```
217-
218-
Run the following command to update to the latest version of the extension released:
200+
### Prerequisites
219201

220-
```azurecli
221-
az extension update --name aks-preview
222-
```
202+
* The Azure CLI version 2.42.0 or higher. Run `az --version` to find your version. If you need to install or upgrade, see [Install Azure CLI][azure-cli-install].
203+
* AKS version 1.22 and higher. If your cluster is running version 1.21 and the OIDC Issuer preview is enabled, we recommend you upgrade the cluster to the minimum required version supported.
223204

224205
### Create an AKS cluster with OIDC Issuer
225206

@@ -245,9 +226,20 @@ To get the OIDC Issuer URL, run the following command. Replace the default value
245226
az aks show -n myAKScluster -g myResourceGroup --query "oidcIssuerProfile.issuerUrl" -otsv
246227
```
247228

229+
### Rotate the OIDC key
230+
231+
To rotate the OIDC key, perform the following command. Replace the default values for the cluster name and the resource group name.
232+
233+
```azurecli-interactive
234+
az aks oidc-issuer rotate-signing-keys -n myAKSCluster -g myResourceGroup
235+
```
236+
237+
> [!Important]
238+
> Once you rotate the key, the old key (key1) expires after 24 hours. This means that both the old key (key1) and the new key (key2) are valid within the 24-hour period. If you want to invalidate the old key (key1) immediately, you need to rotate the OIDC key twice. Then key2 and key3 are valid, and key1 is invalid.
239+
248240
## Next steps
249241

250-
- Learn how [upgrade the node images](node-image-upgrade.md) in your cluster.
242+
- Learn how to [upgrade the node images](node-image-upgrade.md) in your cluster.
251243
- See [Upgrade an Azure Kubernetes Service (AKS) cluster](upgrade-cluster.md) to learn how to upgrade your cluster to the latest version of Kubernetes.
252244
- Read more about [`containerd` and Kubernetes](https://kubernetes.io/blog/2018/05/24/kubernetes-containerd-integration-goes-ga/)
253245
- See the list of [Frequently asked questions about AKS](faq.md) to find answers to some common AKS questions.

articles/aks/csi-secrets-store-identity-access.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -401,6 +401,6 @@ To validate that the secrets are mounted at the volume path that's specified in
401401
[az-aks-show]: /cli/azure/aks#az-aks-show
402402
[az-rest]: /cli/azure/reference-index#az-rest
403403
[az-identity-federated-credential-create]: /cli/azure/identity/federated-credential#az-identity-federated-credential-create
404-
[enable-oidc-issuer]: cluster-configuration.md#oidc-issuer-preview
404+
[enable-oidc-issuer]: cluster-configuration.md#oidc-issuer
405405
406406
<!-- LINKS EXTERNAL -->

0 commit comments

Comments
 (0)