Skip to content

Commit d3c739a

Browse files
committed
resolve comments
1 parent 644a677 commit d3c739a

File tree

1 file changed

+30
-29
lines changed

1 file changed

+30
-29
lines changed

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

Lines changed: 30 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -90,7 +90,7 @@ The `spec.keyValues.keyVaults` property has the following child properties.
9090
|---|---|---|---|
9191
|target|The destination of the retrieved secrets in Kubernetes|true|object|
9292
|auth|The authentication method to access Key Vaults|false|object|
93-
|refresh|The settings for refreshing data from Key Vaults. If the property is absent, data from Key Vaults will not be refreshed|false|object|
93+
|refresh|The settings for refreshing data from Key Vaults. If the property is absent, data from Key Vaults will not be refreshed unless the corresponding Key Vault references are reloaded|false|object|
9494

9595
The `spec.keyValues.keyVaults.target` property has the following child property.
9696

@@ -293,9 +293,11 @@ spec:
293293
trimKeyPrefixes: [prefix1, prefix2]
294294
```
295295

296-
### Key Vault references
296+
### Dynamic configuration refresh
297297

298-
The following sample instructs using a service principal to authenticate with a specific vault and a user-assigned managed identity for all other vaults.
298+
Setting the `spec.keyValues.refresh` property enables dynamic configuration data refresh in ConfigMap and Secret by monitoring designated key-values. The provider periodically polls the key-values, if there is any value change, provider triggers ConfigMap and Secret refresh in accordance with the present data in Azure App Configuration.
299+
300+
The following sample instructs monitoring two key-values with 1 minute polling interval.
299301

300302
``` yaml
301303
apiVersion: azconfig.io/v1beta1
@@ -309,21 +311,22 @@ spec:
309311
keyValues:
310312
selectors:
311313
- keyFilter: app1*
312-
keyVaults:
313-
target:
314-
secretName: secret-created-by-appconfig-provider
315-
auth:
316-
managedIdentityClientId: <your-user-assigned-managed-identity-client-id>
317-
vaults:
318-
- uri: <your-key-vault-uri>
319-
servicePrincipalReference: <name-of-secret-containing-service-principal-credentials>
314+
labelFilter: common
315+
- keyFilter: app1*
316+
labelFilter: development
317+
refresh:
318+
interval: 1m
319+
monitoring:
320+
keyValues:
321+
- key: sentinelKey
322+
label: common
323+
- key: sentinelKey
324+
label: development
320325
```
321326

322-
### Dynamic configuration refresh
323-
324-
Setting the `spec.keyValues.refresh` property enables dynamic configuration data refresh in ConfigMap and Secret by monitoring designated key-values. The provider periodically polls the key-values, if there is any value change, provider triggers ConfigMap and Secret refresh in accordance with the present data in Azure App Configuration.
327+
### Key Vault references
325328

326-
The following sample instructs monitoring two key-values with 1 minute polling interval.
329+
The following sample instructs using a service principal to authenticate with a specific vault and a user-assigned managed identity for all other vaults.
327330

328331
``` yaml
329332
apiVersion: azconfig.io/v1beta1
@@ -337,23 +340,21 @@ spec:
337340
keyValues:
338341
selectors:
339342
- keyFilter: app1*
340-
labelFilter: common
341-
- keyFilter: app1*
342-
labelFilter: development
343-
refresh:
344-
interval: 1m
345-
monitoring:
346-
keyValues:
347-
- key: sentinelKey
348-
label: common
349-
- key: sentinelKey
350-
label: development
343+
keyVaults:
344+
target:
345+
secretName: secret-created-by-appconfig-provider
346+
auth:
347+
managedIdentityClientId: <your-user-assigned-managed-identity-client-id>
348+
vaults:
349+
- uri: <your-key-vault-uri>
350+
servicePrincipalReference: <name-of-secret-containing-service-principal-credentials>
351351
```
352352

353353
### Periodically reload KeyVault secrets
354-
Setting `spec.keyValues.keyVaults.refresh` property enables the provider periodically reload the latest version secrets from Azure Key Vault, and update the values for associated data items in generated Kubernetes secret accordingly.
355354

356-
The following sample instructs secret refresh with 10 minutes reloading interval.
355+
Refreshing secrets from Key Vaults usually requires reloading the corresponding Key Vault references from Azure App Configuration. However, with the `spec.keyValues.keyVaults.refresh` property, you can refresh the secrets from Key Vault independently. This is especially useful for ensuring that your workload automatically picks up any updated secrets from Key Vault during secret rotation. Note that to load the latest version of a secret, the Key Vault reference must not be a versioned secret.
356+
357+
The following sample refreshes all non-versioned secrets from Key Vault every hour.
357358

358359
``` yaml
359360
apiVersion: azconfig.io/v1beta1
@@ -374,7 +375,7 @@ spec:
374375
auth:
375376
managedIdentityClientId: <your-user-assigned-managed-identity-client-id>
376377
refresh:
377-
interval: 10m
378+
interval: 1h
378379
```
379380

380381
### Consume ConfigMap

0 commit comments

Comments
 (0)