Skip to content

Commit fbf47e2

Browse files
committed
resolve comments
1 parent 40ae416 commit fbf47e2

File tree

1 file changed

+23
-21
lines changed

1 file changed

+23
-21
lines changed

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

Lines changed: 23 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -45,8 +45,8 @@ The `spec.keyValues` has the following child properties. The `spec.keyValues.key
4545
|---|---|---|---|
4646
|selectors|The list of selectors for key-value filtering|false|object array|
4747
|trimKeyPrefixes|The list of key prefixes to be trimmed|false|string array|
48+
|refresh|The settings for refreshing data from Azure App Configuration. If the property is absent, data from Azure App Configuration will not be refreshed|false|object|
4849
|keyVaults|The settings for Key Vault references|conditional|object|
49-
|refresh|The settings for refreshing the key-values in ConfigMap or Secret|false|object|
5050

5151
If the `spec.keyValues.selectors` property isn't set, all key-values with no label will be downloaded. It contains an array of *selector* objects, which have the following child properties.
5252

@@ -55,13 +55,29 @@ If the `spec.keyValues.selectors` property isn't set, all key-values with no lab
5555
|keyFilter|The key filter for querying key-values|true|string|
5656
|labelFilter|The label filter for querying key-values|false|string|
5757

58+
59+
60+
The `spec.keyValues.refresh` property has the following child properties.
61+
62+
|Name|Description|Required|Type|
63+
|---|---|---|---|
64+
|monitoring|The key-values monitored for change detection, aka sentinel keys. The data from Azure App Configuration will be refreshed only if at least one of the monitored key-values is changed|true|object|
65+
|interval|The interval at which the data will be refreshed from Azure App Configuration. It must be greater than or equal to 1 second. If the property is absent, a default value of 30 seconds will be used|false|duration string|
66+
67+
The `spec.keyValues.refresh.monitoring.keyValues` is an array of objects, which have the following child properties.
68+
69+
|Name|Description|Required|Type|
70+
|---|---|---|---|
71+
|key|The key of a key-value|true|string|
72+
|label|The label of a key-value|false|string|
73+
5874
The `spec.keyValues.keyVaults` property has the following child properties.
5975

6076
|Name|Description|Required|Type|
6177
|---|---|---|---|
62-
|target|The destination of resolved Key Vault references in Kubernetes|true|object|
78+
|target|The destination of the retrieved secrets in Kubernetes|true|object|
6379
|auth|The authentication method to access Key Vaults|false|object|
64-
|refresh|The settings for periodically resolving Key Vault references|false|object|
80+
|refresh|The settings for refreshing data from Key Vaults. If the property is absent, data from Key Vaults will not be refreshed|false|object|
6581

6682
The `spec.keyValues.keyVaults.target` property has the following child property.
6783

@@ -89,21 +105,7 @@ The `spec.keyValues.keyVaults.refresh` property has the following child property
89105

90106
|Name|Description|Required|Type|
91107
|---|---|---|---|
92-
|interval|The interval for Secret's refresh, must be greater than 1 minute|true|duration string|
93-
94-
The `spec.keyValues.refresh` property has the following child properties.
95-
96-
|Name|Description|Required|Type|
97-
|---|---|---|---|
98-
|monitoring|The key-values that are monitored by the provider, provider automatically refreshes the ConfigMap or Secret if value change in any designated key-value|true|object|
99-
|interval|The interval for refreshing, default value is 30 seconds, must be greater than 1 second|false|duration string|
100-
101-
The `spec.keyValues.refresh.monitoring.keyValues` is an array of objects, which have the following child properties.
102-
103-
|Name|Description|Required|Type|
104-
|---|---|---|---|
105-
|key|The key of a key-value|true|string|
106-
|label|The label of a key-value|false|string|
108+
|interval|The interval at which the data will be refreshed from Key Vault. It must be greater than or equal to 1 minute. The Key Vault refresh is independent of the App Configuration refresh configured via `spec.keyValues.refresh`|true|duration string|
107109

108110
## Examples
109111

@@ -292,10 +294,10 @@ spec:
292294
label: development
293295
```
294296

295-
### Periodically resolve KeyVault References
296-
Setting `spec.keyValues.keyVaults.refresh` property enables the provider periodically resolve Key Vault references to get the latest version secrets from Azure Key Vault, and update the values for associated data items in generated Kubernetes secret accordingly.
297+
### Periodically reload KeyVault secrets
298+
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.
297299

298-
The following sample instructs secret refresh with 10 mintues resolving interval.
300+
The following sample instructs secret refresh with 10 minutes reloading interval.
299301

300302
``` yaml
301303
apiVersion: azconfig.io/v1beta1

0 commit comments

Comments
 (0)