Skip to content

Commit 266273e

Browse files
Feedback
1 parent 5668240 commit 266273e

File tree

2 files changed

+11
-20
lines changed

2 files changed

+11
-20
lines changed

articles/azure-app-configuration/quickstart-azure-kubernetes-service.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -273,7 +273,7 @@ Add following key-values to the App Configuration store and leave **Label** and
273273
> - The ConfigMap will be reset based on the present data in your App Configuration store if it's deleted or modified by any other means.
274274
> - The ConfigMap will be deleted if the App Configuration Kubernetes Provider is uninstalled.
275275
276-
1. In this example, you use workload identity to authenticate with your App Configuration store. Follow these [instructions](./reference-kubernetes-provider.md#use-workload-identity) to set it up, and replace the serviceAccountName field with the name of the service account you created in the *appConfigurationProvider.yaml* file. For more information on other authentication methods, see the [Authentication](./reference-kubernetes-provider.md#authentication) section.
276+
1. In this example, you use workload identity to authenticate with your App Configuration store. Follow these [instructions](./reference-kubernetes-provider.md#use-workload-identity) to set it up, and replace the `serviceAccountName` field with the name of the service account you created in the *appConfigurationProvider.yaml* file. For more information on other authentication methods, see the [Authentication](./reference-kubernetes-provider.md#authentication) section.
277277
278278
1. Update the *deployment.yaml* file in the *Deployment* directory to use the ConfigMap `configmap-created-by-appconfig-provider` as a mounted data volume. It is important to ensure that the `volumeMounts.mountPath` matches the `WORKDIR` specified in your *Dockerfile* and the *config* directory created before.
279279

articles/azure-app-configuration/reference-kubernetes-provider.md

Lines changed: 10 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -52,20 +52,11 @@ The `spec.auth` property isn't required if the connection string of your App Con
5252
|workloadIdentity|The settings for using workload identity.|false|object|
5353
|managedIdentityClientId|The client ID of user-assigned managed identity of virtual machine scale set.|false|string|
5454

55-
The `spec.auth.workloadIdentity` property has the following child properties. One of them must be specified.
55+
The `spec.auth.workloadIdentity` property has the following child property.
5656

5757
|Name|Description|Required|Type|
5858
|---|---|---|---|
59-
|managedIdentityClientId|The client ID of the user-assigned managed identity associated with the workload identity.|alternative|string|
60-
|managedIdentityClientIdReference|The client ID of the user-assigned managed identity can be obtained from a ConfigMap. The ConfigMap must be in the same namespace as the Kubernetes provider.|alternative|object|
61-
|serviceAccountName|The name of the service account associated with the workload identity.|alternative|string|
62-
63-
The `spec.auth.workloadIdentity.managedIdentityClientIdReference` property has the following child properties.
64-
65-
|Name|Description|Required|Type|
66-
|---|---|---|---|
67-
|configMap|The name of the ConfigMap where the client ID of a user-assigned managed identity can be found.|true|string|
68-
|key|The key name that holds the value for the client ID of a user-assigned managed identity.|true|string|
59+
|serviceAccountName|The name of the service account associated with the workload identity.|true|string|
6960

7061
The `spec.configuration` has the following child properties.
7162

@@ -117,7 +108,7 @@ If the `spec.secret.auth` property isn't set, the system-assigned managed identi
117108
|Name|Description|Required|Type|
118109
|---|---|---|---|
119110
|servicePrincipalReference|The name of the Kubernetes Secret that contains the credentials of a service principal used for authentication with Key Vaults that don't have individual authentication methods specified.|false|string|
120-
|workloadIdentity|The settings of the workload identity used for authentication with Key Vaults that don't have individual authentication methods specified. It has the same child properties as `spec.auth.workloadIdentity`.|false|object|
111+
|workloadIdentity|The settings of the workload identity used for authentication with Key Vaults that don't have individual authentication methods specified. It has the same child property as `spec.auth.workloadIdentity`.|false|object|
121112
|managedIdentityClientId|The client ID of a user-assigned managed identity of virtual machine scale set used for authentication with Key Vaults that don't have individual authentication methods specified.|false|string|
122113
|keyVaults|The authentication methods for individual Key Vaults.|false|object array|
123114

@@ -127,7 +118,7 @@ The authentication method of each *Key Vault* can be specified with the followin
127118
|---|---|---|---|
128119
|uri|The URI of a Key Vault.|true|string|
129120
|servicePrincipalReference|The name of the Kubernetes Secret that contains the credentials of a service principal used for authentication with a Key Vault.|false|string|
130-
|workloadIdentity|The settings of the workload identity used for authentication with a Key Vault. It has the same child properties as `spec.auth.workloadIdentity`.|false|object|
121+
|workloadIdentity|The settings of the workload identity used for authentication with a Key Vault. It has the same child property as `spec.auth.workloadIdentity`.|false|object|
131122
|managedIdentityClientId|The client ID of a user-assigned managed identity of virtual machine scale set used for authentication with a Key Vault.|false|string|
132123

133124
The `spec.secret.refresh` property has the following child properties.
@@ -261,11 +252,11 @@ The software may collect information about you and your use of the software and
261252

262253
1. [Get the OIDC issuer URL](/azure/aks/workload-identity-deploy-cluster#retrieve-the-oidc-issuer-url) of the AKS cluster.
263254

264-
1. [Create a user-assigned managed identity](/azure/active-directory/managed-identities-azure-resources/how-manage-user-assigned-managed-identities#create-a-user-assigned-managed-identity) and note down its name and resource group.
265-
255+
1. [Create a user-assigned managed identity](/azure/active-directory/managed-identities-azure-resources/how-manage-user-assigned-managed-identities#create-a-user-assigned-managed-identity) and note down its client ID, tenant ID, name, and resource group.
256+
266257
1. [Grant the user-assigned managed identity **App Configuration Data Reader** role](/azure/azure-app-configuration/concept-enable-rbac#assign-azure-roles-for-access-rights) in Azure App Configuration.
267258

268-
1. Create a service account by applying the following sample yaml. Replace `<your-managed-identity-client-id>` with the client ID and `<your-tenant-id>` with the tenant ID of the user-assigned managed identity just been created. Replace `<your-service-account-name>` with your favorite name.
259+
1. Create a service account by applying the following sample yaml. Replace `<your-managed-identity-client-id>` with the client ID and `<your-tenant-id>` with the tenant ID of the user-assigned managed identity that has just been created. Replace `<your-service-account-name>` with your preferred name.
269260

270261
``` yaml
271262
apiVersion: v1
@@ -277,15 +268,15 @@ The software may collect information about you and your use of the software and
277268
azure.workload.identity/tenant-id: <your-tenant-id>
278269
```
279270

280-
1. Create federated identity credential for the user-assigned managed identity using the Azure CLI. Replace `<user-assigned-identity-name>` with name and `<resource-group>` with resource group of user-assigned managed identity just been created. Replace `<aks-oidc-issuer>` with the OIDC issuer URL of the AKS cluster. Replace `<your-service-account-name>` with the name of the service account just been created.
271+
1. Create a federated identity credential for the user-assigned managed identity using the Azure CLI. Replace `<user-assigned-identity-name>` with the name and `<resource-group>` with the resource group of the newly created user-assigned managed identity. Replace `<aks-oidc-issuer>` with the OIDC issuer URL of the AKS cluster. Replace `<your-service-account-name>` with the name of the newly created service account.
281272

282273
``` azurecli
283274
az identity federated-credential create --name appconfigCredential --identity-name "<user-assigned-identity-name>" --resource-group "<resource-group>" --issuer "<aks-oidc-issuer>" --subject system:serviceaccount:default:<your-service-account-name> --audience api://AzureADTokenExchange
284275
```
285276

286-
The subject of the federated identity credential should be in the format `system:serviceaccount:<service-account-namespace>:<service-account-name>`.
277+
Note that the subject of the federated identity credential should follow this format: `system:serviceaccount:<service-account-namespace>:<service-account-name>`.
287278

288-
1. Apply the following sample `AzureAppConfigurationProvider` resource to the Kubernetes cluster. Be sure it's in the same namespace as the service account. Replace `<your-app-configuration-store-endpoint>` with the endpoint of the Azure App Configuration store. Replace `<your-service-account-name>` with the name of the service account just been created.
279+
1. Apply the following sample `AzureAppConfigurationProvider` resource to the Kubernetes cluster. Be sure it's in the same namespace as the service account. Replace `<your-service-account-name>` with the name of the service account you just created.
289280

290281
``` yaml
291282
apiVersion: azconfig.io/v1

0 commit comments

Comments
 (0)