@sap/cds-dk 6.7.0 → 6.7.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +20 -8
- package/lib/cds.js +12 -0
- package/lib/init/constants.js +1 -1
- package/lib/init/template/helm/subcharts/web-application/templates/_helpers.tpl +21 -31
- package/lib/init/template/helm/subcharts/web-application/templates/api-rule.yaml +3 -12
- package/lib/init/template/helm/subcharts/web-application/templates/deployment.yaml +12 -14
- package/lib/init/template/helm/subcharts/web-application/templates/network-policy.yaml +27 -4
- package/lib/init/template/helm/subcharts/web-application/templates/pod-disruption-budget.yaml +0 -2
- package/lib/init/template/helm/subcharts/web-application/templates/secret.yaml +2 -2
- package/lib/init/template/helm/subcharts/web-application/templates/service-account.yaml +2 -2
- package/lib/init/template/helm/subcharts/web-application/templates/service-binding.yaml +16 -13
- package/lib/init/template/helm/subcharts/web-application/templating.md +16 -9
- package/lib/init/template/helm/subcharts/web-application/values.md +317 -379
- package/lib/init/template/helm/subcharts/web-application/values.schema.json +87 -107
- package/lib/init/template/helm/subcharts/web-application/values.yaml +28 -2
- package/lib/init/template/multitenancy/files/values.yaml.hbs +1 -1
- package/npm-shrinkwrap.json +25 -22
- package/package.json +1 -1
|
@@ -5,32 +5,30 @@
|
|
|
5
5
|
| **Type** | `object` |
|
|
6
6
|
| **Additional properties** | [](# "Additional Properties not allowed.") |
|
|
7
7
|
|
|
8
|
-
| Property | Pattern | Type | Deprecated
|
|
9
|
-
| ------------------------------------------------------------------ | ------- | --------------- |
|
|
10
|
-
| - [global](#global ) | No | object | No
|
|
11
|
-
| - [nameOverride](#nameOverride ) | No | string | No
|
|
12
|
-
| - [fullnameOverride](#fullnameOverride ) | No | string | No
|
|
13
|
-
| - [replicaCount](#replicaCount ) | No | integer | No
|
|
14
|
-
| - [port](#port ) | No | integer | No
|
|
15
|
-
| - [serviceAccountName](#serviceAccountName ) | No | string | No
|
|
16
|
-
| + [image](#image ) | No | object | No
|
|
17
|
-
| - [imagePullSecret](#imagePullSecret ) | No | object | No
|
|
18
|
-
| - [additionalVolumes](#additionalVolumes ) | No | array of object | No
|
|
19
|
-
|
|
|
20
|
-
|
|
|
21
|
-
| - [
|
|
22
|
-
| - [
|
|
23
|
-
| - [
|
|
24
|
-
| - [
|
|
25
|
-
| - [
|
|
26
|
-
| - [
|
|
27
|
-
| - [
|
|
28
|
-
| - [
|
|
29
|
-
| - [
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
## <a name="global"></a>1.  Property `global`
|
|
8
|
+
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|
|
9
|
+
| ------------------------------------------------------------------ | ------- | --------------- | ---------- | ---------- | ------------------------------------------------------------------------------------------------------ |
|
|
10
|
+
| - [global](#global ) | No | object | No | - | Helm global values |
|
|
11
|
+
| - [nameOverride](#nameOverride ) | No | string | No | - | Chart name override |
|
|
12
|
+
| - [fullnameOverride](#fullnameOverride ) | No | string | No | - | Override for the \`.fullname\` helper function. |
|
|
13
|
+
| - [replicaCount](#replicaCount ) | No | integer | No | - | Replica count |
|
|
14
|
+
| - [port](#port ) | No | integer | No | - | Port |
|
|
15
|
+
| - [serviceAccountName](#serviceAccountName ) | No | string | No | - | Service Account name |
|
|
16
|
+
| + [image](#image ) | No | object | No | - | Image configuration |
|
|
17
|
+
| - [imagePullSecret](#imagePullSecret ) | No | object | No | - | Image Pull Secret configuration |
|
|
18
|
+
| - [additionalVolumes](#additionalVolumes ) | No | array of object | No | - | Additional Pod volumes |
|
|
19
|
+
| + [resources](#resources ) | No | object | No | - | Pod resources configuration |
|
|
20
|
+
| - [availability](#availability ) | No | object | No | - | Availability related configuration |
|
|
21
|
+
| - [health](#health ) | No | object | No | - | Health-check configuration |
|
|
22
|
+
| - [startupTimeoutSeconds](#startupTimeoutSeconds ) | No | integer | No | - | Initial timeout in seconds, during which the app must start giving the response to the liveness-probe. |
|
|
23
|
+
| - [readOnlyRootFilesystem](#readOnlyRootFilesystem ) | No | boolean | No | - | Use read only filesystem for the Deployment. |
|
|
24
|
+
| - [terminationGracePeriodSeconds](#terminationGracePeriodSeconds ) | No | integer | No | - | Time in seconds after which the pod will be forcefully stopped after receiving SIGTERM. |
|
|
25
|
+
| - [env](#env ) | No | Combination | No | - | Key-value map of environment variables, which should be added to the Pod spec. |
|
|
26
|
+
| - [envFrom](#envFrom ) | No | array of object | No | - | List of sources to populate environment variables in the pod. |
|
|
27
|
+
| - [expose](#expose ) | No | object | No | - | - |
|
|
28
|
+
| - [networkSecurity](#networkSecurity ) | No | object | No | - | Network Security configuration |
|
|
29
|
+
| - [bindings](#bindings ) | No | object | No | - | Service Binding configuration |
|
|
30
|
+
|
|
31
|
+
## <a name="global"></a>1.  Property `global<br />`
|
|
34
32
|
|
|
35
33
|
**Title:** Helm global values
|
|
36
34
|
|
|
@@ -41,13 +39,13 @@
|
|
|
41
39
|
|
|
42
40
|
**Description:** For more information, see https://helm.sh/docs/chart_template_guide/subcharts_and_globals/#global-chart-values
|
|
43
41
|
|
|
44
|
-
| Property
|
|
45
|
-
|
|
|
46
|
-
| - [imagePullSecret](#global_imagePullSecret )
|
|
47
|
-
| - [image](#global_image )
|
|
48
|
-
| - [
|
|
42
|
+
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|
|
43
|
+
| --------------------------------------------- | ------- | ------ | ---------- | ---------- | ------------------------------- |
|
|
44
|
+
| - [imagePullSecret](#global_imagePullSecret ) | No | object | No | - | Image Pull Secret configuration |
|
|
45
|
+
| - [image](#global_image ) | No | object | No | - | Image configuration |
|
|
46
|
+
| - [](#global_additionalProperties ) | No | object | No | - | - |
|
|
49
47
|
|
|
50
|
-
### <a name="global_imagePullSecret"></a>1.1.  Property `imagePullSecret
|
|
48
|
+
### <a name="global_imagePullSecret"></a>1.1.  Property `imagePullSecret<br />`
|
|
51
49
|
|
|
52
50
|
**Title:** Image Pull Secret configuration
|
|
53
51
|
|
|
@@ -58,13 +56,13 @@
|
|
|
58
56
|
|
|
59
57
|
**Description:** For more information, see https://kubernetes.io/docs/tasks/configure-pod-container/pull-image-private-registry/
|
|
60
58
|
|
|
61
|
-
| Property
|
|
62
|
-
|
|
|
63
|
-
| - [name](#global_imagePullSecret_name )
|
|
64
|
-
| - [dockerconfigjson](#global_imagePullSecret_dockerconfigjson )
|
|
65
|
-
| - [
|
|
59
|
+
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|
|
60
|
+
| --------------------------------------------------------------- | ------- | ------ | ---------- | ------------------------------- | ----------------- |
|
|
61
|
+
| - [name](#global_imagePullSecret_name ) | No | string | No | In #/definitions/KubernetesName | Secret name |
|
|
62
|
+
| - [dockerconfigjson](#global_imagePullSecret_dockerconfigjson ) | No | string | No | - | Secret content |
|
|
63
|
+
| - [](#global_imagePullSecret_additionalProperties ) | No | object | No | - | - |
|
|
66
64
|
|
|
67
|
-
#### <a name="global_imagePullSecret_name"></a>1.1.1.  Property `name
|
|
65
|
+
#### <a name="global_imagePullSecret_name"></a>1.1.1.  Property `name<br />`
|
|
68
66
|
|
|
69
67
|
**Title:** Secret name
|
|
70
68
|
|
|
@@ -79,7 +77,7 @@
|
|
|
79
77
|
| --------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
80
78
|
| **Must match regular expression** | ```^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$``` [Test](https://regex101.com/?regex=%5E%5Ba-z0-9%5D%28%5B-a-z0-9%5D%2A%5Ba-z0-9%5D%29%3F%28%5C.%5Ba-z0-9%5D%28%5B-a-z0-9%5D%2A%5Ba-z0-9%5D%29%3F%29%2A%24) |
|
|
81
79
|
|
|
82
|
-
#### <a name="global_imagePullSecret_dockerconfigjson"></a>1.1.2.  Property `dockerconfigjson
|
|
80
|
+
#### <a name="global_imagePullSecret_dockerconfigjson"></a>1.1.2.  Property `dockerconfigjson<br />`
|
|
83
81
|
|
|
84
82
|
**Title:** Secret content
|
|
85
83
|
|
|
@@ -89,7 +87,7 @@
|
|
|
89
87
|
|
|
90
88
|
**Description:** The content for the dynamically generated Kubernetes Secret, which will be used as an image pull secret. Can't be used with the `name` option.
|
|
91
89
|
|
|
92
|
-
### <a name="global_image"></a>1.2.  Property `image
|
|
90
|
+
### <a name="global_image"></a>1.2.  Property `image<br />`
|
|
93
91
|
|
|
94
92
|
**Title:** Image configuration
|
|
95
93
|
|
|
@@ -100,13 +98,13 @@
|
|
|
100
98
|
|
|
101
99
|
**Description:** Either name or repository is required.
|
|
102
100
|
|
|
103
|
-
| Property
|
|
104
|
-
|
|
|
105
|
-
| - [tag](#global_image_tag )
|
|
106
|
-
| - [registry](#global_image_registry )
|
|
107
|
-
| - [
|
|
101
|
+
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|
|
102
|
+
| ----------------------------------------- | ------- | ------ | ---------- | ------------------------------ | ----------------------------------------------------------------------------------------------------------------------- |
|
|
103
|
+
| - [tag](#global_image_tag ) | No | string | No | In #/definitions/ImageTag | Image tag without the name (everything after the \`:\` sign, potentially including the \`@sha256\` section at the end). |
|
|
104
|
+
| - [registry](#global_image_registry ) | No | string | No | In #/definitions/ImageRegistry | Image registry e.g. docker.io |
|
|
105
|
+
| - [](#global_image_additionalProperties ) | No | object | No | - | - |
|
|
108
106
|
|
|
109
|
-
#### <a name="global_image_tag"></a>1.2.1.  Property `tag
|
|
107
|
+
#### <a name="global_image_tag"></a>1.2.1.  Property `tag<br />`
|
|
110
108
|
|
|
111
109
|
| | |
|
|
112
110
|
| -------------- | ---------------------- |
|
|
@@ -119,7 +117,7 @@
|
|
|
119
117
|
| --------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
120
118
|
| **Must match regular expression** | ```^((?:(?:[a-zA-Z0-9]\|[a-zA-Z0-9][a-zA-Z0-9-]*[a-zA-Z0-9])(?:(?:\.(?:[a-zA-Z0-9]\|[a-zA-Z0-9][a-zA-Z0-9-]*[a-zA-Z0-9]))+)?(?::[0-9]+)?/)?[a-z0-9]+(?:(?:(?:[._]\|__\|[-]*)[a-z0-9]+)+)?(?:(?:/[a-z0-9]+(?:(?:(?:[._]\|__\|[-]*)[a-z0-9]+)+)?)+)?)(?::([\w][\w.-]{0,127}))?(?:@([A-Za-z][A-Za-z0-9]*(?:[-_+.][A-Za-z][A-Za-z0-9]*)*[:][[:xdigit:]]{32,}))?$``` [Test](https://regex101.com/?regex=%5E%28%28%3F%3A%28%3F%3A%5Ba-zA-Z0-9%5D%7C%5Ba-zA-Z0-9%5D%5Ba-zA-Z0-9-%5D%2A%5Ba-zA-Z0-9%5D%29%28%3F%3A%28%3F%3A%5C.%28%3F%3A%5Ba-zA-Z0-9%5D%7C%5Ba-zA-Z0-9%5D%5Ba-zA-Z0-9-%5D%2A%5Ba-zA-Z0-9%5D%29%29%2B%29%3F%28%3F%3A%3A%5B0-9%5D%2B%29%3F%2F%29%3F%5Ba-z0-9%5D%2B%28%3F%3A%28%3F%3A%28%3F%3A%5B._%5D%7C__%7C%5B-%5D%2A%29%5Ba-z0-9%5D%2B%29%2B%29%3F%28%3F%3A%28%3F%3A%2F%5Ba-z0-9%5D%2B%28%3F%3A%28%3F%3A%28%3F%3A%5B._%5D%7C__%7C%5B-%5D%2A%29%5Ba-z0-9%5D%2B%29%2B%29%3F%29%2B%29%3F%29%28%3F%3A%3A%28%5B%5Cw%5D%5B%5Cw.-%5D%7B0%2C127%7D%29%29%3F%28%3F%3A%40%28%5BA-Za-z%5D%5BA-Za-z0-9%5D%2A%28%3F%3A%5B-_%2B.%5D%5BA-Za-z%5D%5BA-Za-z0-9%5D%2A%29%2A%5B%3A%5D%5B%5B%3Axdigit%3A%5D%5D%7B32%2C%7D%29%29%3F%24) |
|
|
121
119
|
|
|
122
|
-
#### <a name="global_image_registry"></a>1.2.2.  Property `registry
|
|
120
|
+
#### <a name="global_image_registry"></a>1.2.2.  Property `registry<br />`
|
|
123
121
|
|
|
124
122
|
| | |
|
|
125
123
|
| -------------- | --------------------------- |
|
|
@@ -132,7 +130,7 @@
|
|
|
132
130
|
| --------------------------------- | ----------------------------------------------------------------------------- |
|
|
133
131
|
| **Must match regular expression** | ```^[\w-./]+$``` [Test](https://regex101.com/?regex=%5E%5B%5Cw-.%2F%5D%2B%24) |
|
|
134
132
|
|
|
135
|
-
## <a name="nameOverride"></a>2.  Property `nameOverride
|
|
133
|
+
## <a name="nameOverride"></a>2.  Property `nameOverride<br />`
|
|
136
134
|
|
|
137
135
|
**Title:** Chart name override
|
|
138
136
|
|
|
@@ -146,7 +144,7 @@
|
|
|
146
144
|
| --------------------------------- | ------------------------------------------------------------------------------------------- |
|
|
147
145
|
| **Must match regular expression** | ```[0-9a-z][0-9a-z-.]*``` [Test](https://regex101.com/?regex=%5B0-9a-z%5D%5B0-9a-z-.%5D%2A) |
|
|
148
146
|
|
|
149
|
-
## <a name="fullnameOverride"></a>3.  Property `fullnameOverride
|
|
147
|
+
## <a name="fullnameOverride"></a>3.  Property `fullnameOverride<br />`
|
|
150
148
|
|
|
151
149
|
**Title:** Override for the `.fullname` helper function.
|
|
152
150
|
|
|
@@ -160,7 +158,7 @@
|
|
|
160
158
|
| --------------------------------- | ------------------------------------------------------------------------------------------- |
|
|
161
159
|
| **Must match regular expression** | ```[0-9a-z][0-9a-z-.]*``` [Test](https://regex101.com/?regex=%5B0-9a-z%5D%5B0-9a-z-.%5D%2A) |
|
|
162
160
|
|
|
163
|
-
## <a name="replicaCount"></a>4.  Property `replicaCount
|
|
161
|
+
## <a name="replicaCount"></a>4.  Property `replicaCount<br />`
|
|
164
162
|
|
|
165
163
|
**Title:** Replica count
|
|
166
164
|
|
|
@@ -175,7 +173,7 @@
|
|
|
175
173
|
| ------------ | ------ |
|
|
176
174
|
| **Minimum** | ≥ 1 |
|
|
177
175
|
|
|
178
|
-
## <a name="port"></a>5.  Property `port
|
|
176
|
+
## <a name="port"></a>5.  Property `port<br />`
|
|
179
177
|
|
|
180
178
|
**Title:** Port
|
|
181
179
|
|
|
@@ -191,7 +189,7 @@
|
|
|
191
189
|
| **Minimum** | ≥ 1 |
|
|
192
190
|
| **Maximum** | ≤ 65535 |
|
|
193
191
|
|
|
194
|
-
## <a name="serviceAccountName"></a>6.  Property `serviceAccountName
|
|
192
|
+
## <a name="serviceAccountName"></a>6.  Property `serviceAccountName<br />`
|
|
195
193
|
|
|
196
194
|
**Title:** Service Account name
|
|
197
195
|
|
|
@@ -201,7 +199,7 @@
|
|
|
201
199
|
|
|
202
200
|
**Description:** Name of the Service Account assigned to pods.
|
|
203
201
|
|
|
204
|
-
## <a name="image"></a>7.  Property `image
|
|
202
|
+
## <a name="image"></a>7.  Property `image<br />`
|
|
205
203
|
|
|
206
204
|
**Title:** Image configuration
|
|
207
205
|
|
|
@@ -216,7 +214,7 @@
|
|
|
216
214
|
| - [tag](#image_tag ) | No | string | No | Same as [tag](#global_image_tag ) | Image tag without the name (everything after the \`:\` sign, potentially including the \`@sha256\` section at the end). |
|
|
217
215
|
| - [registry](#image_registry ) | No | string | No | Same as [registry](#global_image_registry ) | Image registry e.g. docker.io |
|
|
218
216
|
|
|
219
|
-
### <a name="image_repository"></a>7.1.  Property `repository
|
|
217
|
+
### <a name="image_repository"></a>7.1.  Property `repository<br />`
|
|
220
218
|
|
|
221
219
|
**Title:** Repository of the image
|
|
222
220
|
|
|
@@ -230,7 +228,7 @@
|
|
|
230
228
|
| --------------------------------- | ------------------------------------------------------------------------------------------------------------- |
|
|
231
229
|
| **Must match regular expression** | ```^[\w-./:]*[@sha256]*$``` [Test](https://regex101.com/?regex=%5E%5B%5Cw-.%2F%3A%5D%2A%5B%40sha256%5D%2A%24) |
|
|
232
230
|
|
|
233
|
-
### <a name="image_tag"></a>7.2.  Property `tag
|
|
231
|
+
### <a name="image_tag"></a>7.2.  Property `tag<br />`
|
|
234
232
|
|
|
235
233
|
| | |
|
|
236
234
|
| ---------------------- | ------------------------ |
|
|
@@ -239,7 +237,7 @@
|
|
|
239
237
|
|
|
240
238
|
**Description:** Image tag without the name (everything after the `:` sign, potentially including the `@sha256` section at the end).
|
|
241
239
|
|
|
242
|
-
### <a name="image_registry"></a>7.3.  Property `registry
|
|
240
|
+
### <a name="image_registry"></a>7.3.  Property `registry<br />`
|
|
243
241
|
|
|
244
242
|
| | |
|
|
245
243
|
| ---------------------- | ---------------------------------- |
|
|
@@ -248,7 +246,7 @@
|
|
|
248
246
|
|
|
249
247
|
**Description:** Image registry e.g. docker.io
|
|
250
248
|
|
|
251
|
-
## <a name="imagePullSecret"></a>8.  Property `imagePullSecret
|
|
249
|
+
## <a name="imagePullSecret"></a>8.  Property `imagePullSecret<br />`
|
|
252
250
|
|
|
253
251
|
**Title:** Image Pull Secret configuration
|
|
254
252
|
|
|
@@ -264,7 +262,7 @@
|
|
|
264
262
|
| - [name](#imagePullSecret_name ) | No | string | No | Same as [name](#global_imagePullSecret_name ) | Secret name |
|
|
265
263
|
| - [dockerconfigjson](#imagePullSecret_dockerconfigjson ) | No | string | No | - | Secret content |
|
|
266
264
|
|
|
267
|
-
### <a name="imagePullSecret_name"></a>8.1.  Property `name
|
|
265
|
+
### <a name="imagePullSecret_name"></a>8.1.  Property `name<br />`
|
|
268
266
|
|
|
269
267
|
**Title:** Secret name
|
|
270
268
|
|
|
@@ -275,7 +273,7 @@
|
|
|
275
273
|
|
|
276
274
|
**Description:** Name of the Kubernetes Secret, used as an image pull secret (must be of type kubernetes.io/dockerconfigjson). Can't be used with the `dockerconfigjson` option.
|
|
277
275
|
|
|
278
|
-
### <a name="imagePullSecret_dockerconfigjson"></a>8.2.  Property `dockerconfigjson
|
|
276
|
+
### <a name="imagePullSecret_dockerconfigjson"></a>8.2.  Property `dockerconfigjson<br />`
|
|
279
277
|
|
|
280
278
|
**Title:** Secret content
|
|
281
279
|
|
|
@@ -285,7 +283,7 @@
|
|
|
285
283
|
|
|
286
284
|
**Description:** The content for the dynamically generated Kubernetes Secret, which will be used as an image pull secret. Can't be used with the `name` option.
|
|
287
285
|
|
|
288
|
-
## <a name="additionalVolumes"></a>9.  Property `additionalVolumes
|
|
286
|
+
## <a name="additionalVolumes"></a>9.  Property `additionalVolumes<br />`
|
|
289
287
|
|
|
290
288
|
**Title:** Additional Pod volumes
|
|
291
289
|
|
|
@@ -300,7 +298,7 @@
|
|
|
300
298
|
| ----------------------------------------------------------- | ----------- |
|
|
301
299
|
| [Additional volume configuration](#additionalVolumes_items) | - |
|
|
302
300
|
|
|
303
|
-
### <a name="autogenerated_heading_2"></a>9.1.
|
|
301
|
+
### <a name="autogenerated_heading_2"></a>9.1. Additional volume configuration<br />
|
|
304
302
|
|
|
305
303
|
**Title:** Additional volume configuration
|
|
306
304
|
|
|
@@ -309,13 +307,13 @@
|
|
|
309
307
|
| **Type** | `object` |
|
|
310
308
|
| **Additional properties** | [](# "Additional Properties of any type are allowed.") |
|
|
311
309
|
|
|
312
|
-
| Property
|
|
313
|
-
|
|
|
314
|
-
| + [name](#additionalVolumes_items_name )
|
|
315
|
-
| + [volumeMount](#additionalVolumes_items_volumeMount )
|
|
316
|
-
| - [
|
|
310
|
+
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|
|
311
|
+
| ------------------------------------------------------ | ------- | ------ | ---------- | --------------------------------------------- | -------------------------- |
|
|
312
|
+
| + [name](#additionalVolumes_items_name ) | No | string | No | Same as [name](#global_imagePullSecret_name ) | Name of the volume |
|
|
313
|
+
| + [volumeMount](#additionalVolumes_items_volumeMount ) | No | object | No | - | Volume mount configuration |
|
|
314
|
+
| - [](#additionalVolumes_items_additionalProperties ) | No | object | No | - | - |
|
|
317
315
|
|
|
318
|
-
#### <a name="additionalVolumes_items_name"></a>9.1.1. Property `name
|
|
316
|
+
#### <a name="additionalVolumes_items_name"></a>9.1.1. Property `name<br />`
|
|
319
317
|
|
|
320
318
|
**Title:** Name of the volume
|
|
321
319
|
|
|
@@ -324,7 +322,7 @@
|
|
|
324
322
|
| **Type** | `string` |
|
|
325
323
|
| **Same definition as** | [name](#global_imagePullSecret_name) |
|
|
326
324
|
|
|
327
|
-
#### <a name="additionalVolumes_items_volumeMount"></a>9.1.2. Property `volumeMount
|
|
325
|
+
#### <a name="additionalVolumes_items_volumeMount"></a>9.1.2. Property `volumeMount<br />`
|
|
328
326
|
|
|
329
327
|
**Title:** Volume mount configuration
|
|
330
328
|
|
|
@@ -341,7 +339,7 @@
|
|
|
341
339
|
| - [subPath](#additionalVolumes_items_volumeMount_subPath ) | No | string | No | - | Sub-path inside the referenced volume instead of its root. |
|
|
342
340
|
| - [subPathExpr](#additionalVolumes_items_volumeMount_subPathExpr ) | No | string | No | - | Similar to the \`subPath\`, but can be constructed using the downward API environment variables. For more info, see https://kubernetes.io/docs/concepts/storage/volumes/#using-subpath-expanded-environment |
|
|
343
341
|
|
|
344
|
-
##### <a name="additionalVolumes_items_volumeMount_mountPath"></a>9.1.2.1. Property `mountPath
|
|
342
|
+
##### <a name="additionalVolumes_items_volumeMount_mountPath"></a>9.1.2.1. Property `mountPath<br />`
|
|
345
343
|
|
|
346
344
|
| | |
|
|
347
345
|
| -------- | -------- |
|
|
@@ -353,7 +351,7 @@
|
|
|
353
351
|
| --------------------------------- | ----------------------------------------------------------------------- |
|
|
354
352
|
| **Must match regular expression** | ```^[^:]*$``` [Test](https://regex101.com/?regex=%5E%5B%5E%3A%5D%2A%24) |
|
|
355
353
|
|
|
356
|
-
##### <a name="additionalVolumes_items_volumeMount_mountPropagation"></a>9.1.2.2. Property `mountPropagation
|
|
354
|
+
##### <a name="additionalVolumes_items_volumeMount_mountPropagation"></a>9.1.2.2. Property `mountPropagation<br />`
|
|
357
355
|
|
|
358
356
|
| | |
|
|
359
357
|
| -------- | ------------------ |
|
|
@@ -365,7 +363,7 @@ Must be one of:
|
|
|
365
363
|
* "None"
|
|
366
364
|
* "HostToContainer"
|
|
367
365
|
|
|
368
|
-
##### <a name="additionalVolumes_items_volumeMount_readOnly"></a>9.1.2.3. Property `readOnly
|
|
366
|
+
##### <a name="additionalVolumes_items_volumeMount_readOnly"></a>9.1.2.3. Property `readOnly<br />`
|
|
369
367
|
|
|
370
368
|
| | |
|
|
371
369
|
| -------- | --------- |
|
|
@@ -373,7 +371,7 @@ Must be one of:
|
|
|
373
371
|
|
|
374
372
|
**Description:** Whether mounted volume should be in read-only mode.
|
|
375
373
|
|
|
376
|
-
##### <a name="additionalVolumes_items_volumeMount_subPath"></a>9.1.2.4. Property `subPath
|
|
374
|
+
##### <a name="additionalVolumes_items_volumeMount_subPath"></a>9.1.2.4. Property `subPath<br />`
|
|
377
375
|
|
|
378
376
|
| | |
|
|
379
377
|
| -------- | -------- |
|
|
@@ -381,7 +379,7 @@ Must be one of:
|
|
|
381
379
|
|
|
382
380
|
**Description:** Sub-path inside the referenced volume instead of its root.
|
|
383
381
|
|
|
384
|
-
##### <a name="additionalVolumes_items_volumeMount_subPathExpr"></a>9.1.2.5. Property `subPathExpr
|
|
382
|
+
##### <a name="additionalVolumes_items_volumeMount_subPathExpr"></a>9.1.2.5. Property `subPathExpr<br />`
|
|
385
383
|
|
|
386
384
|
| | |
|
|
387
385
|
| -------- | -------- |
|
|
@@ -389,29 +387,7 @@ Must be one of:
|
|
|
389
387
|
|
|
390
388
|
**Description:** Similar to the `subPath`, but can be constructed using the downward API environment variables. For more info, see https://kubernetes.io/docs/concepts/storage/volumes/#using-subpath-expanded-environment
|
|
391
389
|
|
|
392
|
-
## <a name="
|
|
393
|
-
|
|
394
|
-
**Title:** High Availability configuration
|
|
395
|
-
|
|
396
|
-
| | |
|
|
397
|
-
| ------------------------- | -------------------------------------------------------------------------------------------------------- |
|
|
398
|
-
| **Type** | `object` |
|
|
399
|
-
| **Additional properties** | [](# "Additional Properties not allowed.") |
|
|
400
|
-
|
|
401
|
-
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|
|
402
|
-
| ------------------------- | ------- | ------- | ---------------------------------------------------------- | ---------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
403
|
-
| - [enabled](#ha_enabled ) | No | boolean |  | - | [Deprecated: Will be always enabled in future] Enables additional high-availability related configuration, like Pod Disruption Budget and Topology Spread Constraints. |
|
|
404
|
-
|
|
405
|
-
### <a name="ha_enabled"></a>10.1. ~~ Property `enabled`~~
|
|
406
|
-
|
|
407
|
-
| | |
|
|
408
|
-
| -------------- | ---------------------------------------------------------- |
|
|
409
|
-
| **Type** | `boolean` |
|
|
410
|
-
| **Deprecated** |  |
|
|
411
|
-
|
|
412
|
-
**Description:** [Deprecated: Will be always enabled in future] Enables additional high-availability related configuration, like Pod Disruption Budget and Topology Spread Constraints.
|
|
413
|
-
|
|
414
|
-
## <a name="resources"></a>11.  Property `resources`
|
|
390
|
+
## <a name="resources"></a>10.  Property `resources<br />`
|
|
415
391
|
|
|
416
392
|
**Title:** Pod resources configuration
|
|
417
393
|
|
|
@@ -425,7 +401,7 @@ Must be one of:
|
|
|
425
401
|
| + [requests](#resources_requests ) | No | object | No | - | Minimal required resources for the application to operate, that will be reserved for each replica. |
|
|
426
402
|
| + [limits](#resources_limits ) | No | object | No | - | - |
|
|
427
403
|
|
|
428
|
-
### <a name="resources_requests"></a>
|
|
404
|
+
### <a name="resources_requests"></a>10.1.  Property `requests<br />`
|
|
429
405
|
|
|
430
406
|
| | |
|
|
431
407
|
| ------------------------- | -------------------------------------------------------------------------------------------------------- |
|
|
@@ -440,7 +416,7 @@ Must be one of:
|
|
|
440
416
|
| - [ephemeral-storage](#resources_requests_ephemeral-storage ) | No | string | No | - | Size of the local ephemeral storage, measured in bytes. For more info, see https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/#local-ephemeral-storage |
|
|
441
417
|
| + [memory](#resources_requests_memory ) | No | string | No | - | Amount of memory, mesaured in bytes. For more info, see https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/#meaning-of-memory |
|
|
442
418
|
|
|
443
|
-
#### <a name="resources_requests_cpu"></a>
|
|
419
|
+
#### <a name="resources_requests_cpu"></a>10.1.1.  Property `cpu<br />`
|
|
444
420
|
|
|
445
421
|
| | |
|
|
446
422
|
| -------- | ------------------ |
|
|
@@ -448,7 +424,7 @@ Must be one of:
|
|
|
448
424
|
|
|
449
425
|
**Description:** CPU resource units, as described here https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/#meaning-of-cpu
|
|
450
426
|
|
|
451
|
-
#### <a name="resources_requests_ephemeral-storage"></a>
|
|
427
|
+
#### <a name="resources_requests_ephemeral-storage"></a>10.1.2.  Property `ephemeral-storage<br />`
|
|
452
428
|
|
|
453
429
|
| | |
|
|
454
430
|
| -------- | -------- |
|
|
@@ -456,7 +432,7 @@ Must be one of:
|
|
|
456
432
|
|
|
457
433
|
**Description:** Size of the local ephemeral storage, measured in bytes. For more info, see https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/#local-ephemeral-storage
|
|
458
434
|
|
|
459
|
-
#### <a name="resources_requests_memory"></a>
|
|
435
|
+
#### <a name="resources_requests_memory"></a>10.1.3.  Property `memory<br />`
|
|
460
436
|
|
|
461
437
|
| | |
|
|
462
438
|
| -------- | -------- |
|
|
@@ -464,7 +440,7 @@ Must be one of:
|
|
|
464
440
|
|
|
465
441
|
**Description:** Amount of memory, mesaured in bytes. For more info, see https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/#meaning-of-memory
|
|
466
442
|
|
|
467
|
-
### <a name="resources_limits"></a>
|
|
443
|
+
### <a name="resources_limits"></a>10.2.  Property `limits<br />`
|
|
468
444
|
|
|
469
445
|
| | |
|
|
470
446
|
| ------------------------- | -------------------------------------------------------------------------------------------------------- |
|
|
@@ -477,7 +453,7 @@ Must be one of:
|
|
|
477
453
|
| - [ephemeral-storage](#resources_limits_ephemeral-storage ) | No | string | No | - | Size of the local ephemeral storage, measured in bytes. For more info, see https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/#local-ephemeral-storage |
|
|
478
454
|
| + [memory](#resources_limits_memory ) | No | string | No | - | Amount of memory, mesaured in bytes. For more info, see https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/#meaning-of-memory |
|
|
479
455
|
|
|
480
|
-
#### <a name="resources_limits_cpu"></a>
|
|
456
|
+
#### <a name="resources_limits_cpu"></a>10.2.1.  Property `cpu<br />`
|
|
481
457
|
|
|
482
458
|
| | |
|
|
483
459
|
| -------- | ------------------ |
|
|
@@ -485,7 +461,7 @@ Must be one of:
|
|
|
485
461
|
|
|
486
462
|
**Description:** CPU resource units, as described here https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/#meaning-of-cpu
|
|
487
463
|
|
|
488
|
-
#### <a name="resources_limits_ephemeral-storage"></a>
|
|
464
|
+
#### <a name="resources_limits_ephemeral-storage"></a>10.2.2.  Property `ephemeral-storage<br />`
|
|
489
465
|
|
|
490
466
|
| | |
|
|
491
467
|
| -------- | -------- |
|
|
@@ -493,7 +469,7 @@ Must be one of:
|
|
|
493
469
|
|
|
494
470
|
**Description:** Size of the local ephemeral storage, measured in bytes. For more info, see https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/#local-ephemeral-storage
|
|
495
471
|
|
|
496
|
-
#### <a name="resources_limits_memory"></a>
|
|
472
|
+
#### <a name="resources_limits_memory"></a>10.2.3.  Property `memory<br />`
|
|
497
473
|
|
|
498
474
|
| | |
|
|
499
475
|
| -------- | -------- |
|
|
@@ -501,66 +477,7 @@ Must be one of:
|
|
|
501
477
|
|
|
502
478
|
**Description:** Amount of memory, mesaured in bytes. For more info, see https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/#meaning-of-memory
|
|
503
479
|
|
|
504
|
-
## <a name="
|
|
505
|
-
|
|
506
|
-
**Title:** Health-check configuration
|
|
507
|
-
|
|
508
|
-
| | |
|
|
509
|
-
| ------------------------- | -------------------------------------------------------------------------------------------------------- |
|
|
510
|
-
| **Type** | `object` |
|
|
511
|
-
| **Deprecated** |  |
|
|
512
|
-
| **Additional properties** | [](# "Additional Properties not allowed.") |
|
|
513
|
-
|
|
514
|
-
**Description:** [Deprecated] Use health instead
|
|
515
|
-
|
|
516
|
-
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|
|
517
|
-
| --------------------------------------- | ------- | ------ | ---------- | ---------- | ------------------------------ |
|
|
518
|
-
| - [liveness](#health_check_liveness ) | No | object | No | - | Liveness-probe configuration. |
|
|
519
|
-
| - [readiness](#health_check_readiness ) | No | object | No | - | Readiness-probe configuration. |
|
|
520
|
-
|
|
521
|
-
### <a name="health_check_liveness"></a>12.1.  Property `liveness`
|
|
522
|
-
|
|
523
|
-
| | |
|
|
524
|
-
| ------------------------- | -------------------------------------------------------------------------------------------------------- |
|
|
525
|
-
| **Type** | `object` |
|
|
526
|
-
| **Additional properties** | [](# "Additional Properties not allowed.") |
|
|
527
|
-
|
|
528
|
-
**Description:** Liveness-probe configuration.
|
|
529
|
-
|
|
530
|
-
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|
|
531
|
-
| -------------------------------------- | ------- | ------ | ---------- | ---------- | ------------------------------------------------------------ |
|
|
532
|
-
| - [path](#health_check_liveness_path ) | No | string | No | - | HTTP path used by Kubernetes, to perform health-check calls. |
|
|
533
|
-
|
|
534
|
-
#### <a name="health_check_liveness_path"></a>12.1.1.  Property `path`
|
|
535
|
-
|
|
536
|
-
| | |
|
|
537
|
-
| -------- | -------- |
|
|
538
|
-
| **Type** | `string` |
|
|
539
|
-
|
|
540
|
-
**Description:** HTTP path used by Kubernetes, to perform health-check calls.
|
|
541
|
-
|
|
542
|
-
### <a name="health_check_readiness"></a>12.2.  Property `readiness`
|
|
543
|
-
|
|
544
|
-
| | |
|
|
545
|
-
| ------------------------- | -------------------------------------------------------------------------------------------------------- |
|
|
546
|
-
| **Type** | `object` |
|
|
547
|
-
| **Additional properties** | [](# "Additional Properties not allowed.") |
|
|
548
|
-
|
|
549
|
-
**Description:** Readiness-probe configuration.
|
|
550
|
-
|
|
551
|
-
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|
|
552
|
-
| --------------------------------------- | ------- | ------ | ---------- | ---------- | ------------------------------------------------------------ |
|
|
553
|
-
| - [path](#health_check_readiness_path ) | No | string | No | - | HTTP path used by Kubernetes, to perform health-check calls. |
|
|
554
|
-
|
|
555
|
-
#### <a name="health_check_readiness_path"></a>12.2.1.  Property `path`
|
|
556
|
-
|
|
557
|
-
| | |
|
|
558
|
-
| -------- | -------- |
|
|
559
|
-
| **Type** | `string` |
|
|
560
|
-
|
|
561
|
-
**Description:** HTTP path used by Kubernetes, to perform health-check calls.
|
|
562
|
-
|
|
563
|
-
## <a name="availability"></a>13.  Property `availability`
|
|
480
|
+
## <a name="availability"></a>11.  Property `availability<br />`
|
|
564
481
|
|
|
565
482
|
**Title:** Availability related configuration
|
|
566
483
|
|
|
@@ -574,7 +491,7 @@ Must be one of:
|
|
|
574
491
|
| - [podDisruptionBudget](#availability_podDisruptionBudget ) | No | object | No | - | The max disruption to the pods. |
|
|
575
492
|
| - [topologySpreadConstraints](#availability_topologySpreadConstraints ) | No | object | No | - | How pods ought to spread across topology domains. |
|
|
576
493
|
|
|
577
|
-
### <a name="availability_podDisruptionBudget"></a>
|
|
494
|
+
### <a name="availability_podDisruptionBudget"></a>11.1.  Property `podDisruptionBudget<br />`
|
|
578
495
|
|
|
579
496
|
| | |
|
|
580
497
|
| ------------------------- | -------------------------------------------------------------------------------------------------------- |
|
|
@@ -587,7 +504,7 @@ Must be one of:
|
|
|
587
504
|
| --------------------------------------------------------------------- | ------- | ------ | ---------- | ---------- | --------------------------------------------------------------- |
|
|
588
505
|
| - [maxUnavailable](#availability_podDisruptionBudget_maxUnavailable ) | No | string | No | - | An eviction is allowed if this maximum of pods are unavailable. |
|
|
589
506
|
|
|
590
|
-
#### <a name="availability_podDisruptionBudget_maxUnavailable"></a>
|
|
507
|
+
#### <a name="availability_podDisruptionBudget_maxUnavailable"></a>11.1.1.  Property `maxUnavailable<br />`
|
|
591
508
|
|
|
592
509
|
| | |
|
|
593
510
|
| ----------- | -------- |
|
|
@@ -596,7 +513,7 @@ Must be one of:
|
|
|
596
513
|
|
|
597
514
|
**Description:** An eviction is allowed if this maximum of pods are unavailable.
|
|
598
515
|
|
|
599
|
-
### <a name="availability_topologySpreadConstraints"></a>
|
|
516
|
+
### <a name="availability_topologySpreadConstraints"></a>11.2.  Property `topologySpreadConstraints<br />`
|
|
600
517
|
|
|
601
518
|
| | |
|
|
602
519
|
| ------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
@@ -606,7 +523,7 @@ Must be one of:
|
|
|
606
523
|
|
|
607
524
|
**Description:** How pods ought to spread across topology domains.
|
|
608
525
|
|
|
609
|
-
## <a name="health"></a>
|
|
526
|
+
## <a name="health"></a>12.  Property `health<br />`
|
|
610
527
|
|
|
611
528
|
**Title:** Health-check configuration
|
|
612
529
|
|
|
@@ -620,7 +537,7 @@ Must be one of:
|
|
|
620
537
|
| - [liveness](#health_liveness ) | No | object | No | - | Liveness-probe configuration. |
|
|
621
538
|
| - [readiness](#health_readiness ) | No | object | No | - | Readiness-probe configuration. |
|
|
622
539
|
|
|
623
|
-
### <a name="health_liveness"></a>
|
|
540
|
+
### <a name="health_liveness"></a>12.1.  Property `liveness<br />`
|
|
624
541
|
|
|
625
542
|
| | |
|
|
626
543
|
| ------------------------- | -------------------------------------------------------------------------------------------------------- |
|
|
@@ -633,7 +550,7 @@ Must be one of:
|
|
|
633
550
|
| -------------------------------- | ------- | ------ | ---------- | ---------- | -------------------------------------------------------------- |
|
|
634
551
|
| - [path](#health_liveness_path ) | No | string | No | - | HTTP path used by Kubernetes, to perform liveness-probe calls. |
|
|
635
552
|
|
|
636
|
-
#### <a name="health_liveness_path"></a>
|
|
553
|
+
#### <a name="health_liveness_path"></a>12.1.1.  Property `path<br />`
|
|
637
554
|
|
|
638
555
|
| | |
|
|
639
556
|
| ----------- | ------------ |
|
|
@@ -642,7 +559,7 @@ Must be one of:
|
|
|
642
559
|
|
|
643
560
|
**Description:** HTTP path used by Kubernetes, to perform liveness-probe calls.
|
|
644
561
|
|
|
645
|
-
### <a name="health_readiness"></a>
|
|
562
|
+
### <a name="health_readiness"></a>12.2.  Property `readiness<br />`
|
|
646
563
|
|
|
647
564
|
| | |
|
|
648
565
|
| ------------------------- | -------------------------------------------------------------------------------------------------------- |
|
|
@@ -655,7 +572,7 @@ Must be one of:
|
|
|
655
572
|
| --------------------------------- | ------- | ------ | ---------- | ---------- | --------------------------------------------------------------- |
|
|
656
573
|
| - [path](#health_readiness_path ) | No | string | No | - | HTTP path used by Kubernetes, to perform readiness-probe calls. |
|
|
657
574
|
|
|
658
|
-
#### <a name="health_readiness_path"></a>
|
|
575
|
+
#### <a name="health_readiness_path"></a>12.2.1.  Property `path<br />`
|
|
659
576
|
|
|
660
577
|
| | |
|
|
661
578
|
| ----------- | ------------ |
|
|
@@ -664,20 +581,7 @@ Must be one of:
|
|
|
664
581
|
|
|
665
582
|
**Description:** HTTP path used by Kubernetes, to perform readiness-probe calls.
|
|
666
583
|
|
|
667
|
-
## <a name="
|
|
668
|
-
|
|
669
|
-
| | |
|
|
670
|
-
| -------------- | ---------------------------------------------------------- |
|
|
671
|
-
| **Type** | `integer` |
|
|
672
|
-
| **Deprecated** |  |
|
|
673
|
-
|
|
674
|
-
**Description:** [Deprecated] use startupTimeoutSeconds instead
|
|
675
|
-
|
|
676
|
-
| Restrictions | |
|
|
677
|
-
| ------------ | ------ |
|
|
678
|
-
| **Minimum** | ≥ 1 |
|
|
679
|
-
|
|
680
|
-
## <a name="startupTimeoutSeconds"></a>16.  Property `startupTimeoutSeconds`
|
|
584
|
+
## <a name="startupTimeoutSeconds"></a>13.  Property `startupTimeoutSeconds<br />`
|
|
681
585
|
|
|
682
586
|
| | |
|
|
683
587
|
| ----------- | --------- |
|
|
@@ -690,7 +594,15 @@ Must be one of:
|
|
|
690
594
|
| ------------ | ------ |
|
|
691
595
|
| **Minimum** | ≥ 1 |
|
|
692
596
|
|
|
693
|
-
## <a name="
|
|
597
|
+
## <a name="readOnlyRootFilesystem"></a>14.  Property `readOnlyRootFilesystem<br />`
|
|
598
|
+
|
|
599
|
+
| | |
|
|
600
|
+
| -------- | --------- |
|
|
601
|
+
| **Type** | `boolean` |
|
|
602
|
+
|
|
603
|
+
**Description:** Use read only filesystem for the Deployment.
|
|
604
|
+
|
|
605
|
+
## <a name="terminationGracePeriodSeconds"></a>15.  Property `terminationGracePeriodSeconds<br />`
|
|
694
606
|
|
|
695
607
|
| | |
|
|
696
608
|
| ----------- | --------- |
|
|
@@ -703,7 +615,7 @@ Must be one of:
|
|
|
703
615
|
| ------------ | ------ |
|
|
704
616
|
| **Minimum** | ≥ 0 |
|
|
705
617
|
|
|
706
|
-
## <a name="env"></a>
|
|
618
|
+
## <a name="env"></a>16.  Property `env<br />`
|
|
707
619
|
|
|
708
620
|
| | |
|
|
709
621
|
| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- |
|
|
@@ -718,7 +630,7 @@ Must be one of:
|
|
|
718
630
|
| [item 0](#env_anyOf_i0) |
|
|
719
631
|
| [item 1](#env_anyOf_i1) |
|
|
720
632
|
|
|
721
|
-
### <a name="env_anyOf_i0"></a>
|
|
633
|
+
### <a name="env_anyOf_i0"></a>16.1. Property `item 0<br />`
|
|
722
634
|
|
|
723
635
|
| | |
|
|
724
636
|
| ------------------------- | -------------------------------------------------------------------------------------------------------- |
|
|
@@ -730,7 +642,7 @@ Must be one of:
|
|
|
730
642
|
| --------------------------------------------------------- | ------- | ----------- | ---------- | ---------- | ----------------- |
|
|
731
643
|
| - [^[-._a-zA-Z][-._a-zA-Z0-9]*$](#env_anyOf_i0_pattern1 ) | Yes | Combination | No | - | - |
|
|
732
644
|
|
|
733
|
-
#### <a name="env_anyOf_i0_pattern1"></a>
|
|
645
|
+
#### <a name="env_anyOf_i0_pattern1"></a>16.1.1. Pattern Property `^[-._a-zA-Z][-._a-zA-Z0-9]*$<br />`
|
|
734
646
|
> All properties whose name matches the regular expression
|
|
735
647
|
```^[-._a-zA-Z][-._a-zA-Z0-9]*$``` ([Test](https://regex101.com/?regex=%5E%5B-._a-zA-Z%5D%5B-._a-zA-Z0-9%5D%2A%24))
|
|
736
648
|
must respect the following conditions
|
|
@@ -740,12 +652,12 @@ must respect the following conditions
|
|
|
740
652
|
| **Type** | `combining` |
|
|
741
653
|
| **Additional properties** | [](# "Additional Properties of any type are allowed.") |
|
|
742
654
|
|
|
743
|
-
| Any of(Option)
|
|
744
|
-
|
|
|
745
|
-
| [item 0](#
|
|
746
|
-
| [item 1](#
|
|
655
|
+
| Any of(Option) |
|
|
656
|
+
| -------------------------------------------- |
|
|
657
|
+
| [item 0](#env_anyOf_i0_pattern1_pattern2_i0) |
|
|
658
|
+
| [item 1](#env_anyOf_i0_pattern1_pattern2_i1) |
|
|
747
659
|
|
|
748
|
-
##### <a name="
|
|
660
|
+
##### <a name="env_anyOf_i0_pattern1_pattern2_i0"></a>16.1.1.1. Property `item 0<br />`
|
|
749
661
|
|
|
750
662
|
| | |
|
|
751
663
|
| -------- | ------------------- |
|
|
@@ -753,7 +665,7 @@ must respect the following conditions
|
|
|
753
665
|
|
|
754
666
|
**Description:** Plain value of an environment variable.
|
|
755
667
|
|
|
756
|
-
##### <a name="
|
|
668
|
+
##### <a name="env_anyOf_i0_pattern1_pattern2_i1"></a>16.1.1.2. Property `item 1<br />`
|
|
757
669
|
|
|
758
670
|
| | |
|
|
759
671
|
| ------------------------- | -------------------------------------------------------------------------------------------------------- |
|
|
@@ -762,14 +674,14 @@ must respect the following conditions
|
|
|
762
674
|
|
|
763
675
|
**Description:** `valueFrom` configuration for the environment variable https://kubernetes.io/docs/tasks/inject-data-application/environment-variable-expose-pod-information/
|
|
764
676
|
|
|
765
|
-
| Property
|
|
766
|
-
|
|
|
767
|
-
| - [configMapKeyRef](#
|
|
768
|
-
| - [secretKeyRef](#
|
|
769
|
-
| - [resourceFieldRef](#
|
|
770
|
-
| - [fieldRef](#
|
|
677
|
+
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|
|
678
|
+
| -------------------------------------------------------------------------- | ------- | ------ | ---------- | ---------- | ------------------------------------ |
|
|
679
|
+
| - [configMapKeyRef](#env_anyOf_i0_pattern1_pattern2_i1_configMapKeyRef ) | No | object | No | - | Selects a key of a ConfigMap. |
|
|
680
|
+
| - [secretKeyRef](#env_anyOf_i0_pattern1_pattern2_i1_secretKeyRef ) | No | object | No | - | Selects a key of a Secret. |
|
|
681
|
+
| - [resourceFieldRef](#env_anyOf_i0_pattern1_pattern2_i1_resourceFieldRef ) | No | object | No | - | Selects a resource of the container. |
|
|
682
|
+
| - [fieldRef](#env_anyOf_i0_pattern1_pattern2_i1_fieldRef ) | No | object | No | - | Selects a field of the pod. |
|
|
771
683
|
|
|
772
|
-
##### <a name="
|
|
684
|
+
##### <a name="env_anyOf_i0_pattern1_pattern2_i1_configMapKeyRef"></a>16.1.1.2.1. Property `configMapKeyRef<br />`
|
|
773
685
|
|
|
774
686
|
| | |
|
|
775
687
|
| ------------------------- | -------------------------------------------------------------------------------------------------------- |
|
|
@@ -778,12 +690,12 @@ must respect the following conditions
|
|
|
778
690
|
|
|
779
691
|
**Description:** Selects a key of a ConfigMap.
|
|
780
692
|
|
|
781
|
-
| Property
|
|
782
|
-
|
|
|
783
|
-
| - [name](#
|
|
784
|
-
| - [key](#
|
|
693
|
+
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|
|
694
|
+
| ------------------------------------------------------------------ | ------- | ------ | ---------- | ---------- | ------------------------------------------------ |
|
|
695
|
+
| - [name](#env_anyOf_i0_pattern1_pattern2_i1_configMapKeyRef_name ) | No | string | No | - | Name of a ConfigMap. |
|
|
696
|
+
| - [key](#env_anyOf_i0_pattern1_pattern2_i1_configMapKeyRef_key ) | No | string | No | - | Key in that ConfigMap, which value will be used. |
|
|
785
697
|
|
|
786
|
-
##### <a name="
|
|
698
|
+
##### <a name="env_anyOf_i0_pattern1_pattern2_i1_configMapKeyRef_name"></a>16.1.1.2.1.1. Property `name<br />`
|
|
787
699
|
|
|
788
700
|
| | |
|
|
789
701
|
| -------- | -------- |
|
|
@@ -791,7 +703,7 @@ must respect the following conditions
|
|
|
791
703
|
|
|
792
704
|
**Description:** Name of a ConfigMap.
|
|
793
705
|
|
|
794
|
-
##### <a name="
|
|
706
|
+
##### <a name="env_anyOf_i0_pattern1_pattern2_i1_configMapKeyRef_key"></a>16.1.1.2.1.2. Property `key<br />`
|
|
795
707
|
|
|
796
708
|
| | |
|
|
797
709
|
| -------- | -------- |
|
|
@@ -799,7 +711,7 @@ must respect the following conditions
|
|
|
799
711
|
|
|
800
712
|
**Description:** Key in that ConfigMap, which value will be used.
|
|
801
713
|
|
|
802
|
-
##### <a name="
|
|
714
|
+
##### <a name="env_anyOf_i0_pattern1_pattern2_i1_secretKeyRef"></a>16.1.1.2.2. Property `secretKeyRef<br />`
|
|
803
715
|
|
|
804
716
|
| | |
|
|
805
717
|
| ------------------------- | -------------------------------------------------------------------------------------------------------- |
|
|
@@ -808,12 +720,12 @@ must respect the following conditions
|
|
|
808
720
|
|
|
809
721
|
**Description:** Selects a key of a Secret.
|
|
810
722
|
|
|
811
|
-
| Property
|
|
812
|
-
|
|
|
813
|
-
| - [name](#
|
|
814
|
-
| - [key](#
|
|
723
|
+
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|
|
724
|
+
| --------------------------------------------------------------- | ------- | ------ | ---------- | ---------- | --------------------------------------------- |
|
|
725
|
+
| - [name](#env_anyOf_i0_pattern1_pattern2_i1_secretKeyRef_name ) | No | string | No | - | Name of a Secret. |
|
|
726
|
+
| - [key](#env_anyOf_i0_pattern1_pattern2_i1_secretKeyRef_key ) | No | string | No | - | Key in that Secret, which value will be used. |
|
|
815
727
|
|
|
816
|
-
##### <a name="
|
|
728
|
+
##### <a name="env_anyOf_i0_pattern1_pattern2_i1_secretKeyRef_name"></a>16.1.1.2.2.1. Property `name<br />`
|
|
817
729
|
|
|
818
730
|
| | |
|
|
819
731
|
| -------- | -------- |
|
|
@@ -821,7 +733,7 @@ must respect the following conditions
|
|
|
821
733
|
|
|
822
734
|
**Description:** Name of a Secret.
|
|
823
735
|
|
|
824
|
-
##### <a name="
|
|
736
|
+
##### <a name="env_anyOf_i0_pattern1_pattern2_i1_secretKeyRef_key"></a>16.1.1.2.2.2. Property `key<br />`
|
|
825
737
|
|
|
826
738
|
| | |
|
|
827
739
|
| -------- | -------- |
|
|
@@ -829,7 +741,7 @@ must respect the following conditions
|
|
|
829
741
|
|
|
830
742
|
**Description:** Key in that Secret, which value will be used.
|
|
831
743
|
|
|
832
|
-
##### <a name="
|
|
744
|
+
##### <a name="env_anyOf_i0_pattern1_pattern2_i1_resourceFieldRef"></a>16.1.1.2.3. Property `resourceFieldRef<br />`
|
|
833
745
|
|
|
834
746
|
| | |
|
|
835
747
|
| ------------------------- | -------------------------------------------------------------------------------------------------------- |
|
|
@@ -838,12 +750,12 @@ must respect the following conditions
|
|
|
838
750
|
|
|
839
751
|
**Description:** Selects a resource of the container.
|
|
840
752
|
|
|
841
|
-
| Property
|
|
842
|
-
|
|
|
843
|
-
| - [containerName](#
|
|
844
|
-
| - [resource](#
|
|
753
|
+
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|
|
754
|
+
| ------------------------------------------------------------------------------------- | ------- | ------ | ---------- | --------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
755
|
+
| - [containerName](#env_anyOf_i0_pattern1_pattern2_i1_resourceFieldRef_containerName ) | No | string | No | Same as [name](#global_imagePullSecret_name ) | Name of a Container. |
|
|
756
|
+
| - [resource](#env_anyOf_i0_pattern1_pattern2_i1_resourceFieldRef_resource ) | No | string | No | - | Only resources limits and requests (limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, requests.memory and requests.ephemeral-storage) are currently supported. |
|
|
845
757
|
|
|
846
|
-
##### <a name="
|
|
758
|
+
##### <a name="env_anyOf_i0_pattern1_pattern2_i1_resourceFieldRef_containerName"></a>16.1.1.2.3.1. Property `containerName<br />`
|
|
847
759
|
|
|
848
760
|
| | |
|
|
849
761
|
| ---------------------- | ------------------------------------ |
|
|
@@ -852,7 +764,7 @@ must respect the following conditions
|
|
|
852
764
|
|
|
853
765
|
**Description:** Name of a Container.
|
|
854
766
|
|
|
855
|
-
##### <a name="
|
|
767
|
+
##### <a name="env_anyOf_i0_pattern1_pattern2_i1_resourceFieldRef_resource"></a>16.1.1.2.3.2. Property `resource<br />`
|
|
856
768
|
|
|
857
769
|
| | |
|
|
858
770
|
| -------- | -------- |
|
|
@@ -860,7 +772,7 @@ must respect the following conditions
|
|
|
860
772
|
|
|
861
773
|
**Description:** Only resources limits and requests (limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, requests.memory and requests.ephemeral-storage) are currently supported.
|
|
862
774
|
|
|
863
|
-
##### <a name="
|
|
775
|
+
##### <a name="env_anyOf_i0_pattern1_pattern2_i1_fieldRef"></a>16.1.1.2.4. Property `fieldRef<br />`
|
|
864
776
|
|
|
865
777
|
| | |
|
|
866
778
|
| ------------------------- | -------------------------------------------------------------------------------------------------------- |
|
|
@@ -869,11 +781,11 @@ must respect the following conditions
|
|
|
869
781
|
|
|
870
782
|
**Description:** Selects a field of the pod.
|
|
871
783
|
|
|
872
|
-
| Property
|
|
873
|
-
|
|
|
874
|
-
| - [fieldPath](#
|
|
784
|
+
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|
|
785
|
+
| --------------------------------------------------------------------- | ------- | ------ | ---------- | ---------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
786
|
+
| - [fieldPath](#env_anyOf_i0_pattern1_pattern2_i1_fieldRef_fieldPath ) | No | string | No | - | Supports metadata.name, metadata.namespace, \`metadata.labels['<KEY>']\`, \`metadata.annotations['<KEY>']\`, spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs. |
|
|
875
787
|
|
|
876
|
-
##### <a name="
|
|
788
|
+
##### <a name="env_anyOf_i0_pattern1_pattern2_i1_fieldRef_fieldPath"></a>16.1.1.2.4.1. Property `fieldPath<br />`
|
|
877
789
|
|
|
878
790
|
| | |
|
|
879
791
|
| -------- | -------- |
|
|
@@ -881,7 +793,7 @@ must respect the following conditions
|
|
|
881
793
|
|
|
882
794
|
**Description:** Supports metadata.name, metadata.namespace, `metadata.labels['<KEY>']`, `metadata.annotations['<KEY>']`, spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs.
|
|
883
795
|
|
|
884
|
-
### <a name="env_anyOf_i1"></a>
|
|
796
|
+
### <a name="env_anyOf_i1"></a>16.2. Property `item 1<br />`
|
|
885
797
|
|
|
886
798
|
| | |
|
|
887
799
|
| -------- | ----------------- |
|
|
@@ -891,7 +803,7 @@ must respect the following conditions
|
|
|
891
803
|
| ----------------------------------- | ----------- |
|
|
892
804
|
| [item 1 items](#env_anyOf_i1_items) | - |
|
|
893
805
|
|
|
894
|
-
#### <a name="autogenerated_heading_3"></a>
|
|
806
|
+
#### <a name="autogenerated_heading_3"></a>16.2.1. item 1 items<br />
|
|
895
807
|
|
|
896
808
|
| | |
|
|
897
809
|
| ------------------------- | -------------------------------------------------------------------------------------------------------- |
|
|
@@ -907,7 +819,7 @@ must respect the following conditions
|
|
|
907
819
|
| - [resourceFieldRef](#env_anyOf_i1_items_resourceFieldRef ) | No | object | No | - | Selects a resource of the container. |
|
|
908
820
|
| - [fieldRef](#env_anyOf_i1_items_fieldRef ) | No | object | No | - | Selects a field of the pod. |
|
|
909
821
|
|
|
910
|
-
##### <a name="env_anyOf_i1_items_name"></a>
|
|
822
|
+
##### <a name="env_anyOf_i1_items_name"></a>16.2.1.1. Property `name<br />`
|
|
911
823
|
|
|
912
824
|
| | |
|
|
913
825
|
| -------- | -------- |
|
|
@@ -917,13 +829,13 @@ must respect the following conditions
|
|
|
917
829
|
| --------------------------------- | ----------------------------------------------------------------------------------------------------------------- |
|
|
918
830
|
| **Must match regular expression** | ```^[-._a-zA-Z][-._a-zA-Z0-9]*$``` [Test](https://regex101.com/?regex=%5E%5B-._a-zA-Z%5D%5B-._a-zA-Z0-9%5D%2A%24) |
|
|
919
831
|
|
|
920
|
-
##### <a name="env_anyOf_i1_items_value"></a>
|
|
832
|
+
##### <a name="env_anyOf_i1_items_value"></a>16.2.1.2. Property `value<br />`
|
|
921
833
|
|
|
922
834
|
| | |
|
|
923
835
|
| -------- | ------------------- |
|
|
924
836
|
| **Type** | `string or integer` |
|
|
925
837
|
|
|
926
|
-
##### <a name="env_anyOf_i1_items_configMapKeyRef"></a>
|
|
838
|
+
##### <a name="env_anyOf_i1_items_configMapKeyRef"></a>16.2.1.3. Property `configMapKeyRef<br />`
|
|
927
839
|
|
|
928
840
|
| | |
|
|
929
841
|
| ------------------------- | -------------------------------------------------------------------------------------------------------- |
|
|
@@ -937,7 +849,7 @@ must respect the following conditions
|
|
|
937
849
|
| - [name](#env_anyOf_i1_items_configMapKeyRef_name ) | No | string | No | - | Name of a ConfigMap. |
|
|
938
850
|
| - [key](#env_anyOf_i1_items_configMapKeyRef_key ) | No | string | No | - | Key in that ConfigMap, which value will be used. |
|
|
939
851
|
|
|
940
|
-
##### <a name="env_anyOf_i1_items_configMapKeyRef_name"></a>
|
|
852
|
+
##### <a name="env_anyOf_i1_items_configMapKeyRef_name"></a>16.2.1.3.1. Property `name<br />`
|
|
941
853
|
|
|
942
854
|
| | |
|
|
943
855
|
| -------- | -------- |
|
|
@@ -945,7 +857,7 @@ must respect the following conditions
|
|
|
945
857
|
|
|
946
858
|
**Description:** Name of a ConfigMap.
|
|
947
859
|
|
|
948
|
-
##### <a name="env_anyOf_i1_items_configMapKeyRef_key"></a>
|
|
860
|
+
##### <a name="env_anyOf_i1_items_configMapKeyRef_key"></a>16.2.1.3.2. Property `key<br />`
|
|
949
861
|
|
|
950
862
|
| | |
|
|
951
863
|
| -------- | -------- |
|
|
@@ -953,7 +865,7 @@ must respect the following conditions
|
|
|
953
865
|
|
|
954
866
|
**Description:** Key in that ConfigMap, which value will be used.
|
|
955
867
|
|
|
956
|
-
##### <a name="env_anyOf_i1_items_secretKeyRef"></a>
|
|
868
|
+
##### <a name="env_anyOf_i1_items_secretKeyRef"></a>16.2.1.4. Property `secretKeyRef<br />`
|
|
957
869
|
|
|
958
870
|
| | |
|
|
959
871
|
| ------------------------- | -------------------------------------------------------------------------------------------------------- |
|
|
@@ -967,7 +879,7 @@ must respect the following conditions
|
|
|
967
879
|
| - [name](#env_anyOf_i1_items_secretKeyRef_name ) | No | string | No | - | Name of a Secret. |
|
|
968
880
|
| - [key](#env_anyOf_i1_items_secretKeyRef_key ) | No | string | No | - | Key in that Secret, which value will be used. |
|
|
969
881
|
|
|
970
|
-
##### <a name="env_anyOf_i1_items_secretKeyRef_name"></a>
|
|
882
|
+
##### <a name="env_anyOf_i1_items_secretKeyRef_name"></a>16.2.1.4.1. Property `name<br />`
|
|
971
883
|
|
|
972
884
|
| | |
|
|
973
885
|
| -------- | -------- |
|
|
@@ -975,7 +887,7 @@ must respect the following conditions
|
|
|
975
887
|
|
|
976
888
|
**Description:** Name of a Secret.
|
|
977
889
|
|
|
978
|
-
##### <a name="env_anyOf_i1_items_secretKeyRef_key"></a>
|
|
890
|
+
##### <a name="env_anyOf_i1_items_secretKeyRef_key"></a>16.2.1.4.2. Property `key<br />`
|
|
979
891
|
|
|
980
892
|
| | |
|
|
981
893
|
| -------- | -------- |
|
|
@@ -983,7 +895,7 @@ must respect the following conditions
|
|
|
983
895
|
|
|
984
896
|
**Description:** Key in that Secret, which value will be used.
|
|
985
897
|
|
|
986
|
-
##### <a name="env_anyOf_i1_items_resourceFieldRef"></a>
|
|
898
|
+
##### <a name="env_anyOf_i1_items_resourceFieldRef"></a>16.2.1.5. Property `resourceFieldRef<br />`
|
|
987
899
|
|
|
988
900
|
| | |
|
|
989
901
|
| ------------------------- | -------------------------------------------------------------------------------------------------------- |
|
|
@@ -997,7 +909,7 @@ must respect the following conditions
|
|
|
997
909
|
| - [containerName](#env_anyOf_i1_items_resourceFieldRef_containerName ) | No | string | No | Same as [name](#global_imagePullSecret_name ) | Name of a Container. |
|
|
998
910
|
| - [resource](#env_anyOf_i1_items_resourceFieldRef_resource ) | No | string | No | - | Only resources limits and requests (limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, requests.memory and requests.ephemeral-storage) are currently supported. |
|
|
999
911
|
|
|
1000
|
-
##### <a name="env_anyOf_i1_items_resourceFieldRef_containerName"></a>
|
|
912
|
+
##### <a name="env_anyOf_i1_items_resourceFieldRef_containerName"></a>16.2.1.5.1. Property `containerName<br />`
|
|
1001
913
|
|
|
1002
914
|
| | |
|
|
1003
915
|
| ---------------------- | ------------------------------------ |
|
|
@@ -1006,7 +918,7 @@ must respect the following conditions
|
|
|
1006
918
|
|
|
1007
919
|
**Description:** Name of a Container.
|
|
1008
920
|
|
|
1009
|
-
##### <a name="env_anyOf_i1_items_resourceFieldRef_resource"></a>
|
|
921
|
+
##### <a name="env_anyOf_i1_items_resourceFieldRef_resource"></a>16.2.1.5.2. Property `resource<br />`
|
|
1010
922
|
|
|
1011
923
|
| | |
|
|
1012
924
|
| -------- | -------- |
|
|
@@ -1014,7 +926,7 @@ must respect the following conditions
|
|
|
1014
926
|
|
|
1015
927
|
**Description:** Only resources limits and requests (limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, requests.memory and requests.ephemeral-storage) are currently supported.
|
|
1016
928
|
|
|
1017
|
-
##### <a name="env_anyOf_i1_items_fieldRef"></a>
|
|
929
|
+
##### <a name="env_anyOf_i1_items_fieldRef"></a>16.2.1.6. Property `fieldRef<br />`
|
|
1018
930
|
|
|
1019
931
|
| | |
|
|
1020
932
|
| ------------------------- | -------------------------------------------------------------------------------------------------------- |
|
|
@@ -1027,7 +939,7 @@ must respect the following conditions
|
|
|
1027
939
|
| ------------------------------------------------------ | ------- | ------ | ---------- | ---------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
1028
940
|
| - [fieldPath](#env_anyOf_i1_items_fieldRef_fieldPath ) | No | string | No | - | Supports metadata.name, metadata.namespace, \`metadata.labels['<KEY>']\`, \`metadata.annotations['<KEY>']\`, spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs. |
|
|
1029
941
|
|
|
1030
|
-
##### <a name="env_anyOf_i1_items_fieldRef_fieldPath"></a>
|
|
942
|
+
##### <a name="env_anyOf_i1_items_fieldRef_fieldPath"></a>16.2.1.6.1. Property `fieldPath<br />`
|
|
1031
943
|
|
|
1032
944
|
| | |
|
|
1033
945
|
| -------- | -------- |
|
|
@@ -1035,27 +947,7 @@ must respect the following conditions
|
|
|
1035
947
|
|
|
1036
948
|
**Description:** Supports metadata.name, metadata.namespace, `metadata.labels['<KEY>']`, `metadata.annotations['<KEY>']`, spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs.
|
|
1037
949
|
|
|
1038
|
-
## <a name="
|
|
1039
|
-
|
|
1040
|
-
| | |
|
|
1041
|
-
| -------------- | ---------------------------------------------------------- |
|
|
1042
|
-
| **Type** | `array` |
|
|
1043
|
-
| **Deprecated** |  |
|
|
1044
|
-
|
|
1045
|
-
**Description:** [Deprecated] Use `envFrom` instead
|
|
1046
|
-
|
|
1047
|
-
| Each item of this array must be | Description |
|
|
1048
|
-
| --------------------------------------- | ----------- |
|
|
1049
|
-
| [KubernetesName](#envSecretNames_items) | - |
|
|
1050
|
-
|
|
1051
|
-
### <a name="autogenerated_heading_4"></a>19.1. items
|
|
1052
|
-
|
|
1053
|
-
| | |
|
|
1054
|
-
| ---------------------- | ------------------------------------ |
|
|
1055
|
-
| **Type** | `string` |
|
|
1056
|
-
| **Same definition as** | [name](#global_imagePullSecret_name) |
|
|
1057
|
-
|
|
1058
|
-
## <a name="envFrom"></a>20.  Property `envFrom`
|
|
950
|
+
## <a name="envFrom"></a>17.  Property `envFrom<br />`
|
|
1059
951
|
|
|
1060
952
|
| | |
|
|
1061
953
|
| ----------- | ----------------- |
|
|
@@ -1068,7 +960,7 @@ must respect the following conditions
|
|
|
1068
960
|
| ------------------------------- | ----------- |
|
|
1069
961
|
| [envFrom items](#envFrom_items) | - |
|
|
1070
962
|
|
|
1071
|
-
### <a name="
|
|
963
|
+
### <a name="autogenerated_heading_4"></a>17.1. envFrom items<br />
|
|
1072
964
|
|
|
1073
965
|
| | |
|
|
1074
966
|
| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- |
|
|
@@ -1080,7 +972,7 @@ must respect the following conditions
|
|
|
1080
972
|
| [item 0](#envFrom_items_oneOf_i0) |
|
|
1081
973
|
| [item 1](#envFrom_items_oneOf_i1) |
|
|
1082
974
|
|
|
1083
|
-
#### <a name="envFrom_items_oneOf_i0"></a>
|
|
975
|
+
#### <a name="envFrom_items_oneOf_i0"></a>17.1.1. Property `item 0<br />`
|
|
1084
976
|
|
|
1085
977
|
| | |
|
|
1086
978
|
| ------------------------- | -------------------------------------------------------------------------------------------------------- |
|
|
@@ -1091,7 +983,7 @@ must respect the following conditions
|
|
|
1091
983
|
| ------------------------------------------------------- | ------- | ------ | ---------- | ---------- | -------------------------------------------------------------------------------------------------------------- |
|
|
1092
984
|
| + [configMapRef](#envFrom_items_oneOf_i0_configMapRef ) | No | object | No | - | The contents of the target ConfigMap's Data field will represent the key-value pairs as environment variables. |
|
|
1093
985
|
|
|
1094
|
-
##### <a name="envFrom_items_oneOf_i0_configMapRef"></a>
|
|
986
|
+
##### <a name="envFrom_items_oneOf_i0_configMapRef"></a>17.1.1.1. Property `configMapRef<br />`
|
|
1095
987
|
|
|
1096
988
|
| | |
|
|
1097
989
|
| ------------------------- | -------------------------------------------------------------------------------------------------------- |
|
|
@@ -1104,7 +996,7 @@ must respect the following conditions
|
|
|
1104
996
|
| ---------------------------------------------------- | ------- | ------ | ---------- | ---------- | -------------------- |
|
|
1105
997
|
| + [name](#envFrom_items_oneOf_i0_configMapRef_name ) | No | string | No | - | Name of a ConfigMap. |
|
|
1106
998
|
|
|
1107
|
-
##### <a name="envFrom_items_oneOf_i0_configMapRef_name"></a>
|
|
999
|
+
##### <a name="envFrom_items_oneOf_i0_configMapRef_name"></a>17.1.1.1.1. Property `name<br />`
|
|
1108
1000
|
|
|
1109
1001
|
| | |
|
|
1110
1002
|
| -------- | -------- |
|
|
@@ -1112,7 +1004,7 @@ must respect the following conditions
|
|
|
1112
1004
|
|
|
1113
1005
|
**Description:** Name of a ConfigMap.
|
|
1114
1006
|
|
|
1115
|
-
#### <a name="envFrom_items_oneOf_i1"></a>
|
|
1007
|
+
#### <a name="envFrom_items_oneOf_i1"></a>17.1.2. Property `item 1<br />`
|
|
1116
1008
|
|
|
1117
1009
|
| | |
|
|
1118
1010
|
| ------------------------- | -------------------------------------------------------------------------------------------------------- |
|
|
@@ -1123,7 +1015,7 @@ must respect the following conditions
|
|
|
1123
1015
|
| ------------------------------------------------- | ------- | ------ | ---------- | ---------- | ----------------------------------------------------------------------------------------------------------- |
|
|
1124
1016
|
| + [secretRef](#envFrom_items_oneOf_i1_secretRef ) | No | object | No | - | The contents of the target Secret's Data field will represent the key-value pairs as environment variables. |
|
|
1125
1017
|
|
|
1126
|
-
##### <a name="envFrom_items_oneOf_i1_secretRef"></a>
|
|
1018
|
+
##### <a name="envFrom_items_oneOf_i1_secretRef"></a>17.1.2.1. Property `secretRef<br />`
|
|
1127
1019
|
|
|
1128
1020
|
| | |
|
|
1129
1021
|
| ------------------------- | -------------------------------------------------------------------------------------------------------- |
|
|
@@ -1136,7 +1028,7 @@ must respect the following conditions
|
|
|
1136
1028
|
| ------------------------------------------------- | ------- | ------ | ---------- | ---------- | ----------------- |
|
|
1137
1029
|
| + [name](#envFrom_items_oneOf_i1_secretRef_name ) | No | string | No | - | Name of a Secret. |
|
|
1138
1030
|
|
|
1139
|
-
##### <a name="envFrom_items_oneOf_i1_secretRef_name"></a>
|
|
1031
|
+
##### <a name="envFrom_items_oneOf_i1_secretRef_name"></a>17.1.2.1.1. Property `name<br />`
|
|
1140
1032
|
|
|
1141
1033
|
| | |
|
|
1142
1034
|
| -------- | -------- |
|
|
@@ -1144,20 +1036,21 @@ must respect the following conditions
|
|
|
1144
1036
|
|
|
1145
1037
|
**Description:** Name of a Secret.
|
|
1146
1038
|
|
|
1147
|
-
## <a name="expose"></a>
|
|
1039
|
+
## <a name="expose"></a>18.  Property `expose<br />`
|
|
1148
1040
|
|
|
1149
1041
|
| | |
|
|
1150
1042
|
| ------------------------- | -------------------------------------------------------------------------------------------------------- |
|
|
1151
1043
|
| **Type** | `object` |
|
|
1152
1044
|
| **Additional properties** | [](# "Additional Properties not allowed.") |
|
|
1153
1045
|
|
|
1154
|
-
| Property | Pattern | Type
|
|
1155
|
-
| ----------------------------- | ------- |
|
|
1156
|
-
| - [host](#expose_host ) | No | string
|
|
1157
|
-
| - [enabled](#expose_enabled ) | No | boolean
|
|
1158
|
-
| - [gateway](#expose_gateway ) | No | string
|
|
1046
|
+
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|
|
1047
|
+
| ----------------------------- | ------- | --------------- | ---------- | ---------- | ---------------------------------------------------------------------------------------------------------------------------------------- |
|
|
1048
|
+
| - [host](#expose_host ) | No | string | No | - | Specifies the service's dns name for inbound external traffic. If it doesn't contain a dot, the default cluster domain will be appended. |
|
|
1049
|
+
| - [enabled](#expose_enabled ) | No | boolean | No | - | Expose the application to the internet. |
|
|
1050
|
+
| - [gateway](#expose_gateway ) | No | string | No | - | Use this istio gateway for incoming traffic. |
|
|
1051
|
+
| - [rules](#expose_rules ) | No | array of object | No | - | Rules represents collection of Rule to apply. |
|
|
1159
1052
|
|
|
1160
|
-
### <a name="expose_host"></a>
|
|
1053
|
+
### <a name="expose_host"></a>18.1.  Property `host<br />`
|
|
1161
1054
|
|
|
1162
1055
|
| | |
|
|
1163
1056
|
| -------- | -------- |
|
|
@@ -1165,7 +1058,7 @@ must respect the following conditions
|
|
|
1165
1058
|
|
|
1166
1059
|
**Description:** Specifies the service's dns name for inbound external traffic. If it doesn't contain a dot, the default cluster domain will be appended.
|
|
1167
1060
|
|
|
1168
|
-
### <a name="expose_enabled"></a>
|
|
1061
|
+
### <a name="expose_enabled"></a>18.2.  Property `enabled<br />`
|
|
1169
1062
|
|
|
1170
1063
|
| | |
|
|
1171
1064
|
| ----------- | --------- |
|
|
@@ -1174,7 +1067,7 @@ must respect the following conditions
|
|
|
1174
1067
|
|
|
1175
1068
|
**Description:** Expose the application to the internet.
|
|
1176
1069
|
|
|
1177
|
-
### <a name="expose_gateway"></a>
|
|
1070
|
+
### <a name="expose_gateway"></a>18.3.  Property `gateway<br />`
|
|
1178
1071
|
|
|
1179
1072
|
| | |
|
|
1180
1073
|
| ----------- | ---------------------------------------------- |
|
|
@@ -1183,7 +1076,106 @@ must respect the following conditions
|
|
|
1183
1076
|
|
|
1184
1077
|
**Description:** Use this istio gateway for incoming traffic.
|
|
1185
1078
|
|
|
1186
|
-
|
|
1079
|
+
### <a name="expose_rules"></a>18.4.  Property `rules<br />`
|
|
1080
|
+
|
|
1081
|
+
| | |
|
|
1082
|
+
| ----------- | ----------------------------------------------------------------------------------------------------------------------------- |
|
|
1083
|
+
| **Type** | `array of object` |
|
|
1084
|
+
| **Default** | `[{"accessStrategies": [{"handler": "allow"}], "methods": ["GET", "POST", "PUT", "PATCH", "DELETE", "HEAD"], "path": "/.*"}]` |
|
|
1085
|
+
|
|
1086
|
+
**Description:** Rules represents collection of Rule to apply.
|
|
1087
|
+
|
|
1088
|
+
| Each item of this array must be | Description |
|
|
1089
|
+
| ---------------------------------- | ---------------- |
|
|
1090
|
+
| [rules items](#expose_rules_items) | A rule to apply. |
|
|
1091
|
+
|
|
1092
|
+
#### <a name="autogenerated_heading_5"></a>18.4.1. rules items<br />
|
|
1093
|
+
|
|
1094
|
+
| | |
|
|
1095
|
+
| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- |
|
|
1096
|
+
| **Type** | `object` |
|
|
1097
|
+
| **Additional properties** | [](# "Additional Properties of any type are allowed.") |
|
|
1098
|
+
|
|
1099
|
+
**Description:** A rule to apply.
|
|
1100
|
+
|
|
1101
|
+
## <a name="networkSecurity"></a>19.  Property `networkSecurity<br />`
|
|
1102
|
+
|
|
1103
|
+
**Title:** Network Security configuration
|
|
1104
|
+
|
|
1105
|
+
| | |
|
|
1106
|
+
| ------------------------- | -------------------------------------------------------------------------------------------------------- |
|
|
1107
|
+
| **Type** | `object` |
|
|
1108
|
+
| **Additional properties** | [](# "Additional Properties not allowed.") |
|
|
1109
|
+
|
|
1110
|
+
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|
|
1111
|
+
| -------------------------------------------------------------------- | ------- | --------------- | ---------- | ---------- | ----------------- |
|
|
1112
|
+
| - [enabled](#networkSecurity_enabled ) | No | boolean | No | - | - |
|
|
1113
|
+
| - [allowNamespaceInternal](#networkSecurity_allowNamespaceInternal ) | No | boolean | No | - | - |
|
|
1114
|
+
| - [ingress](#networkSecurity_ingress ) | No | array of object | No | - | - |
|
|
1115
|
+
|
|
1116
|
+
### <a name="networkSecurity_enabled"></a>19.1.  Property `enabled<br />`
|
|
1117
|
+
|
|
1118
|
+
| | |
|
|
1119
|
+
| ----------- | --------- |
|
|
1120
|
+
| **Type** | `boolean` |
|
|
1121
|
+
| **Default** | `true` |
|
|
1122
|
+
|
|
1123
|
+
### <a name="networkSecurity_allowNamespaceInternal"></a>19.2.  Property `allowNamespaceInternal<br />`
|
|
1124
|
+
|
|
1125
|
+
| | |
|
|
1126
|
+
| -------- | --------- |
|
|
1127
|
+
| **Type** | `boolean` |
|
|
1128
|
+
|
|
1129
|
+
### <a name="networkSecurity_ingress"></a>19.3.  Property `ingress<br />`
|
|
1130
|
+
|
|
1131
|
+
| | |
|
|
1132
|
+
| ----------- | ----------------- |
|
|
1133
|
+
| **Type** | `array of object` |
|
|
1134
|
+
| **Default** | `[]` |
|
|
1135
|
+
|
|
1136
|
+
| Each item of this array must be | Description |
|
|
1137
|
+
| ----------------------------------------------- | ----------- |
|
|
1138
|
+
| [ingress items](#networkSecurity_ingress_items) | - |
|
|
1139
|
+
|
|
1140
|
+
#### <a name="autogenerated_heading_6"></a>19.3.1. ingress items<br />
|
|
1141
|
+
|
|
1142
|
+
| | |
|
|
1143
|
+
| ------------------------- | -------------------------------------------------------------------------------------------------------- |
|
|
1144
|
+
| **Type** | `object` |
|
|
1145
|
+
| **Additional properties** | [](# "Additional Properties not allowed.") |
|
|
1146
|
+
|
|
1147
|
+
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|
|
1148
|
+
| ------------------------------------------------------------------------ | ------- | ------ | ---------- | ---------- | ----------------- |
|
|
1149
|
+
| - [namespace](#networkSecurity_ingress_items_namespace ) | No | string | No | - | - |
|
|
1150
|
+
| - [podLabelsSelector](#networkSecurity_ingress_items_podLabelsSelector ) | No | object | No | - | - |
|
|
1151
|
+
|
|
1152
|
+
##### <a name="networkSecurity_ingress_items_namespace"></a>19.3.1.1. Property `namespace<br />`
|
|
1153
|
+
|
|
1154
|
+
| | |
|
|
1155
|
+
| -------- | -------- |
|
|
1156
|
+
| **Type** | `string` |
|
|
1157
|
+
|
|
1158
|
+
##### <a name="networkSecurity_ingress_items_podLabelsSelector"></a>19.3.1.2. Property `podLabelsSelector<br />`
|
|
1159
|
+
|
|
1160
|
+
| | |
|
|
1161
|
+
| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- |
|
|
1162
|
+
| **Type** | `object` |
|
|
1163
|
+
| **Additional properties** | [](# "Additional Properties of any type are allowed.") |
|
|
1164
|
+
|
|
1165
|
+
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|
|
1166
|
+
| -------------------------------------------------------------------- | ------- | ------ | ---------- | ---------- | ----------------- |
|
|
1167
|
+
| - [^.*$](#networkSecurity_ingress_items_podLabelsSelector_pattern1 ) | Yes | string | No | - | - |
|
|
1168
|
+
|
|
1169
|
+
##### <a name="networkSecurity_ingress_items_podLabelsSelector_pattern1"></a>19.3.1.2.1. Pattern Property `^.*$<br />`
|
|
1170
|
+
> All properties whose name matches the regular expression
|
|
1171
|
+
```^.*$``` ([Test](https://regex101.com/?regex=%5E.%2A%24))
|
|
1172
|
+
must respect the following conditions
|
|
1173
|
+
|
|
1174
|
+
| | |
|
|
1175
|
+
| -------- | -------- |
|
|
1176
|
+
| **Type** | `string` |
|
|
1177
|
+
|
|
1178
|
+
## <a name="bindings"></a>20.  Property `bindings<br />`
|
|
1187
1179
|
|
|
1188
1180
|
**Title:** Service Binding configuration
|
|
1189
1181
|
|
|
@@ -1196,7 +1188,7 @@ must respect the following conditions
|
|
|
1196
1188
|
| ----------------------------------------------------- | ------- | ----------- | ---------- | ---------- | ----------------- |
|
|
1197
1189
|
| - [^[-._a-zA-Z][-._a-zA-Z0-9]*$](#bindings_pattern1 ) | Yes | Combination | No | - | - |
|
|
1198
1190
|
|
|
1199
|
-
### <a name="bindings_pattern1"></a>
|
|
1191
|
+
### <a name="bindings_pattern1"></a>20.1.  Pattern Property `^[-._a-zA-Z][-._a-zA-Z0-9]*$<br />`
|
|
1200
1192
|
> All properties whose name matches the regular expression
|
|
1201
1193
|
```^[-._a-zA-Z][-._a-zA-Z0-9]*$``` ([Test](https://regex101.com/?regex=%5E%5B-._a-zA-Z%5D%5B-._a-zA-Z0-9%5D%2A%24))
|
|
1202
1194
|
must respect the following conditions
|
|
@@ -1206,23 +1198,23 @@ must respect the following conditions
|
|
|
1206
1198
|
| **Type** | `combining` |
|
|
1207
1199
|
| **Additional properties** | [](# "Additional Properties of any type are allowed.") |
|
|
1208
1200
|
|
|
1209
|
-
| Any of(Option)
|
|
1210
|
-
|
|
|
1211
|
-
| [item 0](#
|
|
1212
|
-
| [item 1](#
|
|
1201
|
+
| Any of(Option) |
|
|
1202
|
+
| ---------------------------------------- |
|
|
1203
|
+
| [item 0](#bindings_pattern1_pattern1_i0) |
|
|
1204
|
+
| [item 1](#bindings_pattern1_pattern1_i1) |
|
|
1213
1205
|
|
|
1214
|
-
#### <a name="
|
|
1206
|
+
#### <a name="bindings_pattern1_pattern1_i0"></a>20.1.1. Property `item 0<br />`
|
|
1215
1207
|
|
|
1216
1208
|
| | |
|
|
1217
1209
|
| ------------------------- | -------------------------------------------------------------------------------------------------------- |
|
|
1218
1210
|
| **Type** | `object` |
|
|
1219
1211
|
| **Additional properties** | [](# "Additional Properties not allowed.") |
|
|
1220
1212
|
|
|
1221
|
-
| Property
|
|
1222
|
-
|
|
|
1223
|
-
| + [fromSecret](#
|
|
1213
|
+
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|
|
1214
|
+
| ---------------------------------------------------------- | ------- | ------ | ---------- | ---------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
1215
|
+
| + [fromSecret](#bindings_pattern1_pattern1_i0_fromSecret ) | No | string | No | - | Name of a Kubernetes Secret, with the binding content, compliant to the SAP Kubernetes Service Binding spec https://github.tools.sap/Kubernetes-Service-Bindings/doc/ |
|
|
1224
1216
|
|
|
1225
|
-
##### <a name="
|
|
1217
|
+
##### <a name="bindings_pattern1_pattern1_i0_fromSecret"></a>20.1.1.1. Property `fromSecret<br />`
|
|
1226
1218
|
|
|
1227
1219
|
| | |
|
|
1228
1220
|
| -------- | -------- |
|
|
@@ -1230,24 +1222,24 @@ must respect the following conditions
|
|
|
1230
1222
|
|
|
1231
1223
|
**Description:** Name of a Kubernetes Secret, with the binding content, compliant to the SAP Kubernetes Service Binding spec https://github.tools.sap/Kubernetes-Service-Bindings/doc/
|
|
1232
1224
|
|
|
1233
|
-
#### <a name="
|
|
1225
|
+
#### <a name="bindings_pattern1_pattern1_i1"></a>20.1.2. Property `item 1<br />`
|
|
1234
1226
|
|
|
1235
1227
|
| | |
|
|
1236
1228
|
| ------------------------- | -------------------------------------------------------------------------------------------------------- |
|
|
1237
1229
|
| **Type** | `object` |
|
|
1238
1230
|
| **Additional properties** | [](# "Additional Properties not allowed.") |
|
|
1239
1231
|
|
|
1240
|
-
| Property
|
|
1241
|
-
|
|
|
1242
|
-
| - [serviceInstanceName](#
|
|
1243
|
-
| - [serviceInstanceFullname](#
|
|
1244
|
-
| - [externalName](#
|
|
1245
|
-
| - [secretName](#
|
|
1246
|
-
| - [parameters](#
|
|
1247
|
-
| - [parametersFrom](#
|
|
1248
|
-
| - [credentialsRotationPolicy](#
|
|
1232
|
+
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|
|
1233
|
+
| ---------------------------------------------------------------------------------------- | ------- | --------------- | ---------- | ---------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
1234
|
+
| - [serviceInstanceName](#bindings_pattern1_pattern1_i1_serviceInstanceName ) | No | string | No | - | Name of a BTP Operator Service Instance, created by the \`service-instance\` Helm chart. Can't be used with the \`serviceInstanceFullname\` option. |
|
|
1235
|
+
| - [serviceInstanceFullname](#bindings_pattern1_pattern1_i1_serviceInstanceFullname ) | No | string | No | - | Full name of a BTP Operator Service Instance. Can't be used with the \`serviceInstanceName\` option. |
|
|
1236
|
+
| - [externalName](#bindings_pattern1_pattern1_i1_externalName ) | No | string | No | - | The name for the service binding in SAP BTP |
|
|
1237
|
+
| - [secretName](#bindings_pattern1_pattern1_i1_secretName ) | No | string | No | - | The name of the secret where the credentials are stored. |
|
|
1238
|
+
| - [parameters](#bindings_pattern1_pattern1_i1_parameters ) | No | object | No | - | Some services support the provisioning of additional configuration parameters during the bind request. For the list of supported parameters, check the documentation of the particular service offering. |
|
|
1239
|
+
| - [parametersFrom](#bindings_pattern1_pattern1_i1_parametersFrom ) | No | array of object | No | - | List of sources to populate parameters. |
|
|
1240
|
+
| - [credentialsRotationPolicy](#bindings_pattern1_pattern1_i1_credentialsRotationPolicy ) | No | object | No | - | Holds automatic credentials rotation configuration. For more details, see https://github.com/SAP/sap-btp-service-operator#spec-1 |
|
|
1249
1241
|
|
|
1250
|
-
##### <a name="
|
|
1242
|
+
##### <a name="bindings_pattern1_pattern1_i1_serviceInstanceName"></a>20.1.2.1. Property `serviceInstanceName<br />`
|
|
1251
1243
|
|
|
1252
1244
|
| | |
|
|
1253
1245
|
| -------- | -------- |
|
|
@@ -1255,7 +1247,7 @@ must respect the following conditions
|
|
|
1255
1247
|
|
|
1256
1248
|
**Description:** Name of a BTP Operator Service Instance, created by the `service-instance` Helm chart. Can't be used with the `serviceInstanceFullname` option.
|
|
1257
1249
|
|
|
1258
|
-
##### <a name="
|
|
1250
|
+
##### <a name="bindings_pattern1_pattern1_i1_serviceInstanceFullname"></a>20.1.2.2. Property `serviceInstanceFullname<br />`
|
|
1259
1251
|
|
|
1260
1252
|
| | |
|
|
1261
1253
|
| -------- | -------- |
|
|
@@ -1263,7 +1255,7 @@ must respect the following conditions
|
|
|
1263
1255
|
|
|
1264
1256
|
**Description:** Full name of a BTP Operator Service Instance. Can't be used with the `serviceInstanceName` option.
|
|
1265
1257
|
|
|
1266
|
-
##### <a name="
|
|
1258
|
+
##### <a name="bindings_pattern1_pattern1_i1_externalName"></a>20.1.2.3. Property `externalName<br />`
|
|
1267
1259
|
|
|
1268
1260
|
| | |
|
|
1269
1261
|
| -------- | -------- |
|
|
@@ -1271,7 +1263,7 @@ must respect the following conditions
|
|
|
1271
1263
|
|
|
1272
1264
|
**Description:** The name for the service binding in SAP BTP
|
|
1273
1265
|
|
|
1274
|
-
##### <a name="
|
|
1266
|
+
##### <a name="bindings_pattern1_pattern1_i1_secretName"></a>20.1.2.4. Property `secretName<br />`
|
|
1275
1267
|
|
|
1276
1268
|
| | |
|
|
1277
1269
|
| -------- | -------- |
|
|
@@ -1279,7 +1271,7 @@ must respect the following conditions
|
|
|
1279
1271
|
|
|
1280
1272
|
**Description:** The name of the secret where the credentials are stored.
|
|
1281
1273
|
|
|
1282
|
-
##### <a name="
|
|
1274
|
+
##### <a name="bindings_pattern1_pattern1_i1_parameters"></a>20.1.2.5. Property `parameters<br />`
|
|
1283
1275
|
|
|
1284
1276
|
| | |
|
|
1285
1277
|
| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- |
|
|
@@ -1288,31 +1280,19 @@ must respect the following conditions
|
|
|
1288
1280
|
|
|
1289
1281
|
**Description:** Some services support the provisioning of additional configuration parameters during the bind request. For the list of supported parameters, check the documentation of the particular service offering.
|
|
1290
1282
|
|
|
1291
|
-
##### <a name="
|
|
1283
|
+
##### <a name="bindings_pattern1_pattern1_i1_parametersFrom"></a>20.1.2.6. Property `parametersFrom<br />`
|
|
1292
1284
|
|
|
1293
|
-
| |
|
|
1294
|
-
| -------- |
|
|
1295
|
-
| **Type** | `array` |
|
|
1285
|
+
| | |
|
|
1286
|
+
| -------- | ----------------- |
|
|
1287
|
+
| **Type** | `array of object` |
|
|
1296
1288
|
|
|
1297
1289
|
**Description:** List of sources to populate parameters.
|
|
1298
1290
|
|
|
1299
|
-
| Each item of this array must be
|
|
1300
|
-
|
|
|
1301
|
-
| [parametersFrom items](#
|
|
1302
|
-
|
|
1303
|
-
##### <a name="autogenerated_heading_6"></a>22.1.2.6.1. items
|
|
1304
|
-
|
|
1305
|
-
| | |
|
|
1306
|
-
| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- |
|
|
1307
|
-
| **Type** | `combining` |
|
|
1308
|
-
| **Additional properties** | [](# "Additional Properties of any type are allowed.") |
|
|
1309
|
-
|
|
1310
|
-
| Any of(Option) |
|
|
1311
|
-
| ------------------------------------------------------------------- |
|
|
1312
|
-
| [item 0](#bindings_pattern1_anyOf_i1_parametersFrom_items_anyOf_i0) |
|
|
1313
|
-
| [item 1](#bindings_pattern1_anyOf_i1_parametersFrom_items_anyOf_i1) |
|
|
1291
|
+
| Each item of this array must be | Description |
|
|
1292
|
+
| --------------------------------------------------------------------------- | ----------------------------------------- |
|
|
1293
|
+
| [parametersFrom items](#bindings_pattern1_pattern1_i1_parametersFrom_items) | Kubernetes Secret as a parameters source. |
|
|
1314
1294
|
|
|
1315
|
-
##### <a name="
|
|
1295
|
+
##### <a name="autogenerated_heading_7"></a>20.1.2.6.1. parametersFrom items<br />
|
|
1316
1296
|
|
|
1317
1297
|
| | |
|
|
1318
1298
|
| ------------------------- | -------------------------------------------------------------------------------------------------------- |
|
|
@@ -1321,23 +1301,23 @@ must respect the following conditions
|
|
|
1321
1301
|
|
|
1322
1302
|
**Description:** Kubernetes Secret as a parameters source.
|
|
1323
1303
|
|
|
1324
|
-
| Property
|
|
1325
|
-
|
|
|
1326
|
-
| - [secretKeyRef](#
|
|
1304
|
+
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|
|
1305
|
+
| ----------------------------------------------------------------------------------- | ------- | ------ | ---------- | ---------- | ----------------- |
|
|
1306
|
+
| - [secretKeyRef](#bindings_pattern1_pattern1_i1_parametersFrom_items_secretKeyRef ) | No | object | No | - | - |
|
|
1327
1307
|
|
|
1328
|
-
##### <a name="
|
|
1308
|
+
##### <a name="bindings_pattern1_pattern1_i1_parametersFrom_items_secretKeyRef"></a>20.1.2.6.1.1. Property `secretKeyRef<br />`
|
|
1329
1309
|
|
|
1330
1310
|
| | |
|
|
1331
1311
|
| ------------------------- | -------------------------------------------------------------------------------------------------------- |
|
|
1332
1312
|
| **Type** | `object` |
|
|
1333
1313
|
| **Additional properties** | [](# "Additional Properties not allowed.") |
|
|
1334
1314
|
|
|
1335
|
-
| Property
|
|
1336
|
-
|
|
|
1337
|
-
| + [name](#
|
|
1338
|
-
| + [key](#
|
|
1315
|
+
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|
|
1316
|
+
| -------------------------------------------------------------------------------- | ------- | ------ | ---------- | ---------- | ---------------------------------------------------------------------------------------------------------------------------------- |
|
|
1317
|
+
| + [name](#bindings_pattern1_pattern1_i1_parametersFrom_items_secretKeyRef_name ) | No | string | No | - | Name of a Secret. |
|
|
1318
|
+
| + [key](#bindings_pattern1_pattern1_i1_parametersFrom_items_secretKeyRef_key ) | No | string | No | - | Key in that Secret, which contains a string that represents the json to include in the set of parameters to be sent to the broker. |
|
|
1339
1319
|
|
|
1340
|
-
##### <a name="
|
|
1320
|
+
##### <a name="bindings_pattern1_pattern1_i1_parametersFrom_items_secretKeyRef_name"></a>20.1.2.6.1.1.1. Property `name<br />`
|
|
1341
1321
|
|
|
1342
1322
|
| | |
|
|
1343
1323
|
| -------- | -------- |
|
|
@@ -1345,7 +1325,7 @@ must respect the following conditions
|
|
|
1345
1325
|
|
|
1346
1326
|
**Description:** Name of a Secret.
|
|
1347
1327
|
|
|
1348
|
-
##### <a name="
|
|
1328
|
+
##### <a name="bindings_pattern1_pattern1_i1_parametersFrom_items_secretKeyRef_key"></a>20.1.2.6.1.1.2. Property `key<br />`
|
|
1349
1329
|
|
|
1350
1330
|
| | |
|
|
1351
1331
|
| -------- | -------- |
|
|
@@ -1353,49 +1333,7 @@ must respect the following conditions
|
|
|
1353
1333
|
|
|
1354
1334
|
**Description:** Key in that Secret, which contains a string that represents the json to include in the set of parameters to be sent to the broker.
|
|
1355
1335
|
|
|
1356
|
-
##### <a name="
|
|
1357
|
-
|
|
1358
|
-
| | |
|
|
1359
|
-
| ------------------------- | -------------------------------------------------------------------------------------------------------- |
|
|
1360
|
-
| **Type** | `object` |
|
|
1361
|
-
| **Additional properties** | [](# "Additional Properties not allowed.") |
|
|
1362
|
-
|
|
1363
|
-
**Description:** Kubernetes Config Map as a parameters source.
|
|
1364
|
-
|
|
1365
|
-
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|
|
1366
|
-
| ----------------------------------------------------------------------------------------------- | ------- | ------ | ---------- | ---------- | ----------------- |
|
|
1367
|
-
| - [configMapKeyRef](#bindings_pattern1_anyOf_i1_parametersFrom_items_anyOf_i1_configMapKeyRef ) | No | object | No | - | - |
|
|
1368
|
-
|
|
1369
|
-
##### <a name="bindings_pattern1_anyOf_i1_parametersFrom_items_anyOf_i1_configMapKeyRef"></a>22.1.2.6.1.2.1. Property `configMapKeyRef`
|
|
1370
|
-
|
|
1371
|
-
| | |
|
|
1372
|
-
| ------------------------- | -------------------------------------------------------------------------------------------------------- |
|
|
1373
|
-
| **Type** | `object` |
|
|
1374
|
-
| **Additional properties** | [](# "Additional Properties not allowed.") |
|
|
1375
|
-
|
|
1376
|
-
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|
|
1377
|
-
| ----------------------------------------------------------------------------------------- | ------- | ------ | ---------- | --------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- |
|
|
1378
|
-
| + [name](#bindings_pattern1_anyOf_i1_parametersFrom_items_anyOf_i1_configMapKeyRef_name ) | No | string | No | Same as [name](#global_imagePullSecret_name ) | Name of a Config Map |
|
|
1379
|
-
| + [key](#bindings_pattern1_anyOf_i1_parametersFrom_items_anyOf_i1_configMapKeyRef_key ) | No | string | No | - | Key in that Config Map, which contains a string that represents the json to include in the set of parameters to be sent to the broker. |
|
|
1380
|
-
|
|
1381
|
-
##### <a name="bindings_pattern1_anyOf_i1_parametersFrom_items_anyOf_i1_configMapKeyRef_name"></a>22.1.2.6.1.2.1.1. Property `name`
|
|
1382
|
-
|
|
1383
|
-
| | |
|
|
1384
|
-
| ---------------------- | ------------------------------------ |
|
|
1385
|
-
| **Type** | `string` |
|
|
1386
|
-
| **Same definition as** | [name](#global_imagePullSecret_name) |
|
|
1387
|
-
|
|
1388
|
-
**Description:** Name of a Config Map
|
|
1389
|
-
|
|
1390
|
-
##### <a name="bindings_pattern1_anyOf_i1_parametersFrom_items_anyOf_i1_configMapKeyRef_key"></a>22.1.2.6.1.2.1.2. Property `key`
|
|
1391
|
-
|
|
1392
|
-
| | |
|
|
1393
|
-
| -------- | -------- |
|
|
1394
|
-
| **Type** | `string` |
|
|
1395
|
-
|
|
1396
|
-
**Description:** Key in that Config Map, which contains a string that represents the json to include in the set of parameters to be sent to the broker.
|
|
1397
|
-
|
|
1398
|
-
##### <a name="bindings_pattern1_anyOf_i1_credentialsRotationPolicy"></a>22.1.2.7. Property `credentialsRotationPolicy`
|
|
1336
|
+
##### <a name="bindings_pattern1_pattern1_i1_credentialsRotationPolicy"></a>20.1.2.7. Property `credentialsRotationPolicy<br />`
|
|
1399
1337
|
|
|
1400
1338
|
| | |
|
|
1401
1339
|
| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- |
|