@sap/cds-dk 6.2.2 → 6.3.0
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 +38 -0
- package/bin/bind.js +4 -4
- package/bin/deploy/to-h2.js +4 -0
- package/bin/deploy/to-sqlite.js +6 -4
- package/bin/help.js +1 -1
- package/bin/login.js +1 -0
- package/bin/mock.js +2 -2
- package/bin/push.js +29 -7
- package/lib/bind/userCdsrcJsonStorageProvider.js +4 -4
- package/lib/cds.js +6 -3
- package/lib/client/activate.js +1 -1
- package/lib/client/base_command.js +10 -10
- package/lib/client/helper/dependency_helper.js +10 -1
- package/lib/client/helper/logging.js +6 -2
- package/lib/client/pull.js +6 -6
- package/lib/client/push.js +33 -14
- package/lib/client/settings_manager.js +52 -21
- package/lib/compile/openapi/csdl2openapi.js +1 -1
- package/lib/compile/to-xsuaa.js +1 -1
- package/lib/import/odata/v2parser.js +37 -1
- package/lib/import/odata/v4parser.js +101 -23
- package/lib/init/constants.js +1 -1
- package/lib/init/index.js +23 -45
- package/lib/init/template/approuter/index.js +44 -48
- package/lib/init/template/auditlog/index.js +14 -10
- package/lib/init/template/cf-manifest/index.js +9 -11
- package/lib/init/template/connectivity/index.js +10 -10
- package/lib/init/template/data/index.js +20 -19
- package/lib/init/template/destinations/index.js +14 -9
- package/lib/init/template/enterprise-messaging/index.js +14 -9
- package/lib/init/template/extensibility/index.js +14 -9
- package/lib/init/template/hana/index.js +51 -57
- package/lib/init/template/helm/index.js +27 -59
- package/lib/init/template/helm/subchart/templates/_helpers.tpl +38 -0
- package/lib/init/template/helm/subchart/templates/deployment.yaml +12 -12
- package/lib/init/template/helm/subchart/values.md +565 -194
- package/lib/init/template/helm/subchart/values.schema.json +163 -8
- package/lib/init/template/helm/subchart/values.yaml +17 -1
- package/lib/init/template/html5-repo/index.js +15 -11
- package/lib/init/template/java/index.js +15 -11
- package/lib/init/template/kibana-logging/index.js +30 -31
- package/lib/init/template/lint/index.js +17 -18
- package/lib/init/template/mta/index.js +18 -40
- package/lib/init/template/mtx/index.js +2 -3
- package/lib/init/template/multitenancy/index.js +27 -20
- package/lib/init/template/nodejs/index.js +18 -20
- package/lib/init/template/notebook/index.js +5 -434
- package/lib/init/template/pipeline/index.js +10 -10
- package/lib/init/template/samples/index.js +7 -16
- package/lib/init/template/templateBase.js +17 -18
- package/lib/init/template/toggles/files/cdsrc.json +5 -0
- package/lib/init/template/toggles/files/cdsrc.json.hbs +7 -0
- package/lib/init/template/toggles/index.js +12 -6
- package/lib/init/template/xsuaa/index.js +44 -41
- package/lib/init/types.d.ts +0 -59
- package/lib/init/util/commandUtil.js +6 -7
- package/lib/init/util/fsUtil.js +23 -109
- package/lib/init/util/merge.js +319 -0
- package/lib/init/util/mvnArchetypeUtil.js +6 -5
- package/lib/init/util/projectReader.js +125 -300
- package/lib/init/util/spinner.js +10 -8
- package/lib/init/util/templateUtil.js +25 -368
- package/lib/lint/Linter.js +2 -3
- package/lib/lint/checks.js +0 -1
- package/lib/lint/io.js +18 -34
- package/npm-shrinkwrap.json +115 -261
- package/package.json +3 -3
- package/lib/init/template/notebook/cap_magic.py +0 -118
- package/lib/init/template/notebook/files/{{{name}}}.ipynb.hbs +0 -90
- package/lib/init/template/notebook/files/{{{name}}}.json +0 -102
- package/lib/init/template/notebook/notebook.js +0 -394
- package/lib/init/util/logger.js +0 -42
|
@@ -1,35 +1,37 @@
|
|
|
1
1
|
# Schema Docs
|
|
2
2
|
|
|
3
|
-
|
|
|
3
|
+
| | |
|
|
4
4
|
| ------------------------- | -------------------------------------------------------------------------------------------------------- |
|
|
5
|
+
| **Type** | `object` |
|
|
5
6
|
| **Additional properties** | [](# "Additional Properties not allowed.") |
|
|
6
7
|
|
|
7
|
-
| Property | Pattern | Type | Deprecated | Definition
|
|
8
|
-
| -------------------------------------------- | ------- | --------------- | ---------- |
|
|
9
|
-
| - [global](#global ) | No | object | No | -
|
|
10
|
-
| - [nameOverride](#nameOverride ) | No | string | No | -
|
|
11
|
-
| - [fullnameOverride](#fullnameOverride ) | No | string | No | -
|
|
12
|
-
| - [replicaCount](#replicaCount ) | No | integer | No | -
|
|
13
|
-
| - [port](#port ) | No | integer | No | -
|
|
14
|
-
| - [serviceAccountName](#serviceAccountName ) | No |
|
|
15
|
-
| + [image](#image ) | No | object | No | -
|
|
16
|
-
| - [imagePullSecret](#imagePullSecret ) | No | object | No | -
|
|
17
|
-
| - [additionalVolumes](#additionalVolumes ) | No | array of object | No | -
|
|
18
|
-
| - [ha](#ha ) | No | object | No | -
|
|
19
|
-
| + [resources](#resources ) | No | object | No | -
|
|
20
|
-
| - [health_check](#health_check ) | No | object | No | -
|
|
21
|
-
| - [startupTimeout](#startupTimeout ) | No | integer | No | -
|
|
22
|
-
| - [env](#env ) | No |
|
|
23
|
-
| - [envSecretNames](#envSecretNames ) | No | array | No | -
|
|
24
|
-
| - [expose](#expose ) | No | object | No | -
|
|
25
|
-
| - [bindings](#bindings ) | No | object | No | -
|
|
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 | Same as [name](#global_imagePullSecret_name ) | 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
|
+
| - [ha](#ha ) | No | object | No | - | High Availability configuration |
|
|
20
|
+
| + [resources](#resources ) | No | object | No | - | Pod resources configuration |
|
|
21
|
+
| - [health_check](#health_check ) | No | object | No | - | Health-check configuration |
|
|
22
|
+
| - [startupTimeout](#startupTimeout ) | No | integer | No | - | Initial timeout in seconds, during which the app must start giving the response to the liveness-probe. |
|
|
23
|
+
| - [env](#env ) | No | Combination | No | - | Key-value map of environment variables, which should be added to the Pod spec. |
|
|
24
|
+
| - [envSecretNames](#envSecretNames ) | No | array | No | - | List of Kubernetes Secret names, used as sources for the Pod's environment variables. |
|
|
25
|
+
| - [expose](#expose ) | No | object | No | - | - |
|
|
26
|
+
| - [bindings](#bindings ) | No | object | No | - | Service Binding configuration |
|
|
26
27
|
|
|
27
28
|
## <a name="global"></a>1.  Property `global`
|
|
28
29
|
|
|
29
30
|
**Title:** Helm global values
|
|
30
31
|
|
|
31
|
-
|
|
|
32
|
+
| | |
|
|
32
33
|
| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- |
|
|
34
|
+
| **Type** | `object` |
|
|
33
35
|
| **Additional properties** | [](# "Additional Properties of any type are allowed.") |
|
|
34
36
|
|
|
35
37
|
**Description:** For more information, see https://helm.sh/docs/chart_template_guide/subcharts_and_globals/#global-chart-values
|
|
@@ -44,8 +46,9 @@
|
|
|
44
46
|
|
|
45
47
|
**Title:** Image Pull Secret configuration
|
|
46
48
|
|
|
47
|
-
|
|
|
49
|
+
| | |
|
|
48
50
|
| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- |
|
|
51
|
+
| **Type** | `object` |
|
|
49
52
|
| **Additional properties** | [](# "Additional Properties of any type are allowed.") |
|
|
50
53
|
|
|
51
54
|
**Description:** For more information, see https://kubernetes.io/docs/tasks/configure-pod-container/pull-image-private-registry/
|
|
@@ -60,8 +63,9 @@
|
|
|
60
63
|
|
|
61
64
|
**Title:** Secret name
|
|
62
65
|
|
|
63
|
-
|
|
|
66
|
+
| | |
|
|
64
67
|
| -------------- | ---------------------------- |
|
|
68
|
+
| **Type** | `string` |
|
|
65
69
|
| **Defined in** | #/definitions/KubernetesName |
|
|
66
70
|
|
|
67
71
|
**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.
|
|
@@ -74,8 +78,9 @@
|
|
|
74
78
|
|
|
75
79
|
**Title:** Secret content
|
|
76
80
|
|
|
77
|
-
|
|
|
78
|
-
|
|
|
81
|
+
| | |
|
|
82
|
+
| -------- | -------- |
|
|
83
|
+
| **Type** | `string` |
|
|
79
84
|
|
|
80
85
|
**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.
|
|
81
86
|
|
|
@@ -83,22 +88,24 @@
|
|
|
83
88
|
|
|
84
89
|
**Title:** Image configuration
|
|
85
90
|
|
|
86
|
-
|
|
|
91
|
+
| | |
|
|
87
92
|
| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- |
|
|
93
|
+
| **Type** | `object` |
|
|
88
94
|
| **Additional properties** | [](# "Additional Properties of any type are allowed.") |
|
|
89
95
|
|
|
90
96
|
**Description:** Either name or repository is required.
|
|
91
97
|
|
|
92
|
-
| Property | Pattern | Type | Deprecated | Definition | Title/Description
|
|
93
|
-
| ------------------------------------------------------------- | ------- | ------ | ---------- | ------------------------------ |
|
|
94
|
-
| - [tag](#global_image_tag ) | No | string | No | In #/definitions/ImageTag | Image tag without the name (everything after the
|
|
95
|
-
| - [registry](#global_image_registry ) | No | string | No | In #/definitions/ImageRegistry | Image registry e.g. docker.io
|
|
96
|
-
| - [additionalProperties](#global_image_additionalProperties ) | No | object | No | - | -
|
|
98
|
+
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|
|
99
|
+
| ------------------------------------------------------------- | ------- | ------ | ---------- | ------------------------------ | ----------------------------------------------------------------------------------------------------------------------- |
|
|
100
|
+
| - [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). |
|
|
101
|
+
| - [registry](#global_image_registry ) | No | string | No | In #/definitions/ImageRegistry | Image registry e.g. docker.io |
|
|
102
|
+
| - [additionalProperties](#global_image_additionalProperties ) | No | object | No | - | - |
|
|
97
103
|
|
|
98
104
|
#### <a name="global_image_tag"></a>1.2.1.  Property `tag`
|
|
99
105
|
|
|
100
|
-
|
|
|
106
|
+
| | |
|
|
101
107
|
| -------------- | ---------------------- |
|
|
108
|
+
| **Type** | `string` |
|
|
102
109
|
| **Defined in** | #/definitions/ImageTag |
|
|
103
110
|
|
|
104
111
|
**Description:** Image tag without the name (everything after the `:` sign, potentially including the `@sha256` section at the end).
|
|
@@ -109,8 +116,9 @@
|
|
|
109
116
|
|
|
110
117
|
#### <a name="global_image_registry"></a>1.2.2.  Property `registry`
|
|
111
118
|
|
|
112
|
-
|
|
|
119
|
+
| | |
|
|
113
120
|
| -------------- | --------------------------- |
|
|
121
|
+
| **Type** | `string` |
|
|
114
122
|
| **Defined in** | #/definitions/ImageRegistry |
|
|
115
123
|
|
|
116
124
|
**Description:** Image registry e.g. docker.io
|
|
@@ -123,8 +131,9 @@
|
|
|
123
131
|
|
|
124
132
|
**Title:** Chart name override
|
|
125
133
|
|
|
126
|
-
|
|
|
127
|
-
|
|
|
134
|
+
| | |
|
|
135
|
+
| -------- | -------- |
|
|
136
|
+
| **Type** | `string` |
|
|
128
137
|
|
|
129
138
|
**Description:** Will be used instead of the `.Chart.Name`, e.g. when generating the Deployment name.
|
|
130
139
|
|
|
@@ -136,8 +145,9 @@
|
|
|
136
145
|
|
|
137
146
|
**Title:** Override for the `.fullname` helper function.
|
|
138
147
|
|
|
139
|
-
|
|
|
140
|
-
|
|
|
148
|
+
| | |
|
|
149
|
+
| -------- | -------- |
|
|
150
|
+
| **Type** | `string` |
|
|
141
151
|
|
|
142
152
|
**Description:** Will be used as an override for the `.fullname` helper function (i.e. `.Release.Name-.Chart.Name`).
|
|
143
153
|
|
|
@@ -149,8 +159,9 @@
|
|
|
149
159
|
|
|
150
160
|
**Title:** Replica count
|
|
151
161
|
|
|
152
|
-
|
|
|
162
|
+
| | |
|
|
153
163
|
| ----------- | --------- |
|
|
164
|
+
| **Type** | `integer` |
|
|
154
165
|
| **Default** | `1` |
|
|
155
166
|
|
|
156
167
|
**Description:** Number of desired pods within the Deployment.
|
|
@@ -163,8 +174,9 @@
|
|
|
163
174
|
|
|
164
175
|
**Title:** Port
|
|
165
176
|
|
|
166
|
-
|
|
|
177
|
+
| | |
|
|
167
178
|
| ----------- | --------- |
|
|
179
|
+
| **Type** | `integer` |
|
|
168
180
|
| **Default** | `8080` |
|
|
169
181
|
|
|
170
182
|
**Description:** Application's exposed port.
|
|
@@ -178,43 +190,36 @@
|
|
|
178
190
|
|
|
179
191
|
**Title:** Service Account name
|
|
180
192
|
|
|
181
|
-
|
|
|
182
|
-
| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- |
|
|
183
|
-
| **Additional properties** | [](# "Additional Properties of any type are allowed.") |
|
|
184
|
-
| **Default** | `"default"` |
|
|
185
|
-
|
|
186
|
-
**Description:** Name of the Service Account assigned to pods.
|
|
187
|
-
|
|
188
|
-
| All of(Requirement) |
|
|
189
|
-
| ---------------------------------------------- |
|
|
190
|
-
| [KubernetesName](#serviceAccountName_allOf_i0) |
|
|
191
|
-
|
|
192
|
-
### <a name="serviceAccountName_allOf_i0"></a>6.1. Property `None`
|
|
193
|
-
|
|
194
|
-
| Type | `string` |
|
|
193
|
+
| | |
|
|
195
194
|
| ---------------------- | ------------------------------------ |
|
|
195
|
+
| **Type** | `string` |
|
|
196
|
+
| **Default** | `"default"` |
|
|
196
197
|
| **Same definition as** | [name](#global_imagePullSecret_name) |
|
|
197
198
|
|
|
199
|
+
**Description:** Name of the Service Account assigned to pods.
|
|
200
|
+
|
|
198
201
|
## <a name="image"></a>7.  Property `image`
|
|
199
202
|
|
|
200
203
|
**Title:** Image configuration
|
|
201
204
|
|
|
202
|
-
|
|
|
205
|
+
| | |
|
|
203
206
|
| ------------------------- | -------------------------------------------------------------------------------------------------------- |
|
|
207
|
+
| **Type** | `object` |
|
|
204
208
|
| **Additional properties** | [](# "Additional Properties not allowed.") |
|
|
205
209
|
|
|
206
|
-
| Property | Pattern | Type | Deprecated | Definition | Title/Description
|
|
207
|
-
| ---------------------------------- | ------- | ------ | ---------- | ------------------------------------------- |
|
|
208
|
-
| + [repository](#image_repository ) | No | string | No | - | Repository of the image
|
|
209
|
-
| - [tag](#image_tag ) | No | string | No | Same as [tag](#global_image_tag ) | Image tag without the name (everything after the
|
|
210
|
-
| - [registry](#image_registry ) | No | string | No | Same as [registry](#global_image_registry ) | Image registry e.g. docker.io
|
|
210
|
+
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|
|
211
|
+
| ---------------------------------- | ------- | ------ | ---------- | ------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- |
|
|
212
|
+
| + [repository](#image_repository ) | No | string | No | - | Repository of the image |
|
|
213
|
+
| - [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). |
|
|
214
|
+
| - [registry](#image_registry ) | No | string | No | Same as [registry](#global_image_registry ) | Image registry e.g. docker.io |
|
|
211
215
|
|
|
212
216
|
### <a name="image_repository"></a>7.1.  Property `repository`
|
|
213
217
|
|
|
214
218
|
**Title:** Repository of the image
|
|
215
219
|
|
|
216
|
-
|
|
|
217
|
-
|
|
|
220
|
+
| | |
|
|
221
|
+
| -------- | -------- |
|
|
222
|
+
| **Type** | `string` |
|
|
218
223
|
|
|
219
224
|
**Description:** Should also include the image name (i.e. everything before the `:` sign).
|
|
220
225
|
|
|
@@ -224,16 +229,18 @@
|
|
|
224
229
|
|
|
225
230
|
### <a name="image_tag"></a>7.2.  Property `tag`
|
|
226
231
|
|
|
227
|
-
|
|
|
232
|
+
| | |
|
|
228
233
|
| ---------------------- | ------------------------ |
|
|
234
|
+
| **Type** | `string` |
|
|
229
235
|
| **Same definition as** | [tag](#global_image_tag) |
|
|
230
236
|
|
|
231
237
|
**Description:** Image tag without the name (everything after the `:` sign, potentially including the `@sha256` section at the end).
|
|
232
238
|
|
|
233
239
|
### <a name="image_registry"></a>7.3.  Property `registry`
|
|
234
240
|
|
|
235
|
-
|
|
|
241
|
+
| | |
|
|
236
242
|
| ---------------------- | ---------------------------------- |
|
|
243
|
+
| **Type** | `string` |
|
|
237
244
|
| **Same definition as** | [registry](#global_image_registry) |
|
|
238
245
|
|
|
239
246
|
**Description:** Image registry e.g. docker.io
|
|
@@ -242,8 +249,9 @@
|
|
|
242
249
|
|
|
243
250
|
**Title:** Image Pull Secret configuration
|
|
244
251
|
|
|
245
|
-
|
|
|
252
|
+
| | |
|
|
246
253
|
| ------------------------- | -------------------------------------------------------------------------------------------------------- |
|
|
254
|
+
| **Type** | `object` |
|
|
247
255
|
| **Additional properties** | [](# "Additional Properties not allowed.") |
|
|
248
256
|
|
|
249
257
|
**Description:** For more information, see https://kubernetes.io/docs/tasks/configure-pod-container/pull-image-private-registry/
|
|
@@ -257,8 +265,9 @@
|
|
|
257
265
|
|
|
258
266
|
**Title:** Secret name
|
|
259
267
|
|
|
260
|
-
|
|
|
268
|
+
| | |
|
|
261
269
|
| ---------------------- | ------------------------------------ |
|
|
270
|
+
| **Type** | `string` |
|
|
262
271
|
| **Same definition as** | [name](#global_imagePullSecret_name) |
|
|
263
272
|
|
|
264
273
|
**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.
|
|
@@ -267,8 +276,9 @@
|
|
|
267
276
|
|
|
268
277
|
**Title:** Secret content
|
|
269
278
|
|
|
270
|
-
|
|
|
271
|
-
|
|
|
279
|
+
| | |
|
|
280
|
+
| -------- | -------- |
|
|
281
|
+
| **Type** | `string` |
|
|
272
282
|
|
|
273
283
|
**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.
|
|
274
284
|
|
|
@@ -276,8 +286,9 @@
|
|
|
276
286
|
|
|
277
287
|
**Title:** Additional Pod volumes
|
|
278
288
|
|
|
279
|
-
|
|
|
289
|
+
| | |
|
|
280
290
|
| ----------- | ----------------- |
|
|
291
|
+
| **Type** | `array of object` |
|
|
281
292
|
| **Default** | `[]` |
|
|
282
293
|
|
|
283
294
|
**Description:** List of volumes, which should be mounted into Pods
|
|
@@ -290,8 +301,9 @@
|
|
|
290
301
|
|
|
291
302
|
**Title:** Additional volume configuration
|
|
292
303
|
|
|
293
|
-
|
|
|
304
|
+
| | |
|
|
294
305
|
| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- |
|
|
306
|
+
| **Type** | `object` |
|
|
295
307
|
| **Additional properties** | [](# "Additional Properties of any type are allowed.") |
|
|
296
308
|
|
|
297
309
|
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|
|
@@ -304,30 +316,33 @@
|
|
|
304
316
|
|
|
305
317
|
**Title:** Name of the volume
|
|
306
318
|
|
|
307
|
-
|
|
|
319
|
+
| | |
|
|
308
320
|
| ---------------------- | ------------------------------------ |
|
|
321
|
+
| **Type** | `string` |
|
|
309
322
|
| **Same definition as** | [name](#global_imagePullSecret_name) |
|
|
310
323
|
|
|
311
324
|
#### <a name="additionalVolumes_items_volumeMount"></a>9.1.2. Property `volumeMount`
|
|
312
325
|
|
|
313
326
|
**Title:** Volume mount configuration
|
|
314
327
|
|
|
315
|
-
|
|
|
328
|
+
| | |
|
|
316
329
|
| ------------------------- | -------------------------------------------------------------------------------------------------------- |
|
|
330
|
+
| **Type** | `object` |
|
|
317
331
|
| **Additional properties** | [](# "Additional Properties not allowed.") |
|
|
318
332
|
|
|
319
|
-
| Property | Pattern | Type | Deprecated | Definition | Title/Description
|
|
320
|
-
| ---------------------------------------------------------------------------- | ------- | ---------------- | ---------- | ---------- |
|
|
321
|
-
| + [mountPath](#additionalVolumes_items_volumeMount_mountPath ) | No | string | No | - | Path within a Pod, where the volume should be mounted.
|
|
322
|
-
| - [mountPropagation](#additionalVolumes_items_volumeMount_mountPropagation ) | No | enum (of string) | No | - | Mount propagation allows for sharing volumes mounted by a container to other
|
|
323
|
-
| - [readOnly](#additionalVolumes_items_volumeMount_readOnly ) | No | boolean | No | - | Whether mounted volume should be in read-only mode.
|
|
324
|
-
| - [subPath](#additionalVolumes_items_volumeMount_subPath ) | No | string | No | - | Sub-path inside the referenced volume instead of its root.
|
|
325
|
-
| - [subPathExpr](#additionalVolumes_items_volumeMount_subPathExpr ) | No | string | No | - | Similar to the
|
|
333
|
+
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|
|
334
|
+
| ---------------------------------------------------------------------------- | ------- | ---------------- | ---------- | ---------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
335
|
+
| + [mountPath](#additionalVolumes_items_volumeMount_mountPath ) | No | string | No | - | Path within a Pod, where the volume should be mounted. |
|
|
336
|
+
| - [mountPropagation](#additionalVolumes_items_volumeMount_mountPropagation ) | No | enum (of string) | No | - | Mount propagation allows for sharing volumes mounted by a container to other containers in the same pod, or even to other pods on the same node. |
|
|
337
|
+
| - [readOnly](#additionalVolumes_items_volumeMount_readOnly ) | No | boolean | No | - | Whether mounted volume should be in read-only mode. |
|
|
338
|
+
| - [subPath](#additionalVolumes_items_volumeMount_subPath ) | No | string | No | - | Sub-path inside the referenced volume instead of its root. |
|
|
339
|
+
| - [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 |
|
|
326
340
|
|
|
327
341
|
##### <a name="additionalVolumes_items_volumeMount_mountPath"></a>9.1.2.1. Property `mountPath`
|
|
328
342
|
|
|
329
|
-
|
|
|
330
|
-
|
|
|
343
|
+
| | |
|
|
344
|
+
| -------- | -------- |
|
|
345
|
+
| **Type** | `string` |
|
|
331
346
|
|
|
332
347
|
**Description:** Path within a Pod, where the volume should be mounted.
|
|
333
348
|
|
|
@@ -337,8 +352,9 @@
|
|
|
337
352
|
|
|
338
353
|
##### <a name="additionalVolumes_items_volumeMount_mountPropagation"></a>9.1.2.2. Property `mountPropagation`
|
|
339
354
|
|
|
340
|
-
|
|
|
341
|
-
|
|
|
355
|
+
| | |
|
|
356
|
+
| -------- | ------------------ |
|
|
357
|
+
| **Type** | `enum (of string)` |
|
|
342
358
|
|
|
343
359
|
**Description:** Mount propagation allows for sharing volumes mounted by a container to other containers in the same pod, or even to other pods on the same node.
|
|
344
360
|
|
|
@@ -348,22 +364,25 @@ Must be one of:
|
|
|
348
364
|
|
|
349
365
|
##### <a name="additionalVolumes_items_volumeMount_readOnly"></a>9.1.2.3. Property `readOnly`
|
|
350
366
|
|
|
351
|
-
|
|
|
352
|
-
|
|
|
367
|
+
| | |
|
|
368
|
+
| -------- | --------- |
|
|
369
|
+
| **Type** | `boolean` |
|
|
353
370
|
|
|
354
371
|
**Description:** Whether mounted volume should be in read-only mode.
|
|
355
372
|
|
|
356
373
|
##### <a name="additionalVolumes_items_volumeMount_subPath"></a>9.1.2.4. Property `subPath`
|
|
357
374
|
|
|
358
|
-
|
|
|
359
|
-
|
|
|
375
|
+
| | |
|
|
376
|
+
| -------- | -------- |
|
|
377
|
+
| **Type** | `string` |
|
|
360
378
|
|
|
361
379
|
**Description:** Sub-path inside the referenced volume instead of its root.
|
|
362
380
|
|
|
363
381
|
##### <a name="additionalVolumes_items_volumeMount_subPathExpr"></a>9.1.2.5. Property `subPathExpr`
|
|
364
382
|
|
|
365
|
-
|
|
|
366
|
-
|
|
|
383
|
+
| | |
|
|
384
|
+
| -------- | -------- |
|
|
385
|
+
| **Type** | `string` |
|
|
367
386
|
|
|
368
387
|
**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
|
|
369
388
|
|
|
@@ -371,18 +390,20 @@ Must be one of:
|
|
|
371
390
|
|
|
372
391
|
**Title:** High Availability configuration
|
|
373
392
|
|
|
374
|
-
|
|
|
393
|
+
| | |
|
|
375
394
|
| ------------------------- | -------------------------------------------------------------------------------------------------------- |
|
|
395
|
+
| **Type** | `object` |
|
|
376
396
|
| **Additional properties** | [](# "Additional Properties not allowed.") |
|
|
377
397
|
|
|
378
|
-
| Property | Pattern | Type | Deprecated | Definition | Title/Description
|
|
379
|
-
| ------------------------- | ------- | ------- | ---------- | ---------- |
|
|
380
|
-
| - [enabled](#ha_enabled ) | No | boolean | No | - | Enables additional high-availability related configuration, like Pod Disruption
|
|
398
|
+
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|
|
399
|
+
| ------------------------- | ------- | ------- | ---------- | ---------- | ----------------------------------------------------------------------------------------------------------------------- |
|
|
400
|
+
| - [enabled](#ha_enabled ) | No | boolean | No | - | Enables additional high-availability related configuration, like Pod Disruption Budget and Topology Spread Constraints. |
|
|
381
401
|
|
|
382
402
|
### <a name="ha_enabled"></a>10.1.  Property `enabled`
|
|
383
403
|
|
|
384
|
-
|
|
|
404
|
+
| | |
|
|
385
405
|
| ----------- | --------- |
|
|
406
|
+
| **Type** | `boolean` |
|
|
386
407
|
| **Default** | `true` |
|
|
387
408
|
|
|
388
409
|
**Description:** Enables additional high-availability related configuration, like Pod Disruption Budget and Topology Spread Constraints.
|
|
@@ -391,80 +412,89 @@ Must be one of:
|
|
|
391
412
|
|
|
392
413
|
**Title:** Pod resources configuration
|
|
393
414
|
|
|
394
|
-
|
|
|
415
|
+
| | |
|
|
395
416
|
| ------------------------- | -------------------------------------------------------------------------------------------------------- |
|
|
417
|
+
| **Type** | `object` |
|
|
396
418
|
| **Additional properties** | [](# "Additional Properties not allowed.") |
|
|
397
419
|
|
|
398
|
-
| Property | Pattern | Type | Deprecated | Definition | Title/Description
|
|
399
|
-
| ---------------------------------- | ------- | ------ | ---------- | ---------- |
|
|
400
|
-
| + [requests](#resources_requests ) | No | object | No | - | Minimal required resources for the application to operate, that will be reserved
|
|
401
|
-
| + [limits](#resources_limits ) | No | object | No | - | -
|
|
420
|
+
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|
|
421
|
+
| ---------------------------------- | ------- | ------ | ---------- | ---------- | -------------------------------------------------------------------------------------------------- |
|
|
422
|
+
| + [requests](#resources_requests ) | No | object | No | - | Minimal required resources for the application to operate, that will be reserved for each replica. |
|
|
423
|
+
| + [limits](#resources_limits ) | No | object | No | - | - |
|
|
402
424
|
|
|
403
425
|
### <a name="resources_requests"></a>11.1.  Property `requests`
|
|
404
426
|
|
|
405
|
-
|
|
|
427
|
+
| | |
|
|
406
428
|
| ------------------------- | -------------------------------------------------------------------------------------------------------- |
|
|
429
|
+
| **Type** | `object` |
|
|
407
430
|
| **Additional properties** | [](# "Additional Properties not allowed.") |
|
|
408
431
|
|
|
409
432
|
**Description:** Minimal required resources for the application to operate, that will be reserved for each replica.
|
|
410
433
|
|
|
411
|
-
| Property | Pattern | Type | Deprecated | Definition | Title/Description
|
|
412
|
-
| ------------------------------------------------------------- | ------- | ---------------- | ---------- | ---------- |
|
|
413
|
-
| + [cpu](#resources_requests_cpu ) | No | string or number | No | - | CPU resource units, as described here https://kubernetes.io/docs/concepts/
|
|
414
|
-
| - [ephemeral-storage](#resources_requests_ephemeral-storage ) | No | string | No | - | Size of the local ephemeral storage, measured in bytes. For more info, see https
|
|
415
|
-
| + [memory](#resources_requests_memory ) | No | string | No | - | Amount of memory, mesaured in bytes. For more info, see https://kubernetes.io/
|
|
434
|
+
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|
|
435
|
+
| ------------------------------------------------------------- | ------- | ---------------- | ---------- | ---------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
436
|
+
| + [cpu](#resources_requests_cpu ) | No | string or number | No | - | CPU resource units, as described here https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/#meaning-of-cpu |
|
|
437
|
+
| - [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 |
|
|
438
|
+
| + [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 |
|
|
416
439
|
|
|
417
440
|
#### <a name="resources_requests_cpu"></a>11.1.1.  Property `cpu`
|
|
418
441
|
|
|
419
|
-
|
|
|
420
|
-
|
|
|
442
|
+
| | |
|
|
443
|
+
| -------- | ------------------ |
|
|
444
|
+
| **Type** | `string or number` |
|
|
421
445
|
|
|
422
446
|
**Description:** CPU resource units, as described here https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/#meaning-of-cpu
|
|
423
447
|
|
|
424
448
|
#### <a name="resources_requests_ephemeral-storage"></a>11.1.2.  Property `ephemeral-storage`
|
|
425
449
|
|
|
426
|
-
|
|
|
427
|
-
|
|
|
450
|
+
| | |
|
|
451
|
+
| -------- | -------- |
|
|
452
|
+
| **Type** | `string` |
|
|
428
453
|
|
|
429
454
|
**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
|
|
430
455
|
|
|
431
456
|
#### <a name="resources_requests_memory"></a>11.1.3.  Property `memory`
|
|
432
457
|
|
|
433
|
-
|
|
|
434
|
-
|
|
|
458
|
+
| | |
|
|
459
|
+
| -------- | -------- |
|
|
460
|
+
| **Type** | `string` |
|
|
435
461
|
|
|
436
462
|
**Description:** Amount of memory, mesaured in bytes. For more info, see https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/#meaning-of-memory
|
|
437
463
|
|
|
438
464
|
### <a name="resources_limits"></a>11.2.  Property `limits`
|
|
439
465
|
|
|
440
|
-
|
|
|
466
|
+
| | |
|
|
441
467
|
| ------------------------- | -------------------------------------------------------------------------------------------------------- |
|
|
468
|
+
| **Type** | `object` |
|
|
442
469
|
| **Additional properties** | [](# "Additional Properties not allowed.") |
|
|
443
470
|
|
|
444
|
-
| Property | Pattern | Type | Deprecated | Definition | Title/Description
|
|
445
|
-
| ----------------------------------------------------------- | ------- | ---------------- | ---------- | ---------- |
|
|
446
|
-
| - [cpu](#resources_limits_cpu ) | No | string or number | No | - | CPU resource units, as described here https://kubernetes.io/docs/concepts/
|
|
447
|
-
| - [ephemeral-storage](#resources_limits_ephemeral-storage ) | No | string | No | - | Size of the local ephemeral storage, measured in bytes. For more info, see https
|
|
448
|
-
| + [memory](#resources_limits_memory ) | No | string | No | - | Amount of memory, mesaured in bytes. For more info, see https://kubernetes.io/
|
|
471
|
+
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|
|
472
|
+
| ----------------------------------------------------------- | ------- | ---------------- | ---------- | ---------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
473
|
+
| - [cpu](#resources_limits_cpu ) | No | string or number | No | - | CPU resource units, as described here https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/#meaning-of-cpu |
|
|
474
|
+
| - [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 |
|
|
475
|
+
| + [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 |
|
|
449
476
|
|
|
450
477
|
#### <a name="resources_limits_cpu"></a>11.2.1.  Property `cpu`
|
|
451
478
|
|
|
452
|
-
|
|
|
453
|
-
|
|
|
479
|
+
| | |
|
|
480
|
+
| -------- | ------------------ |
|
|
481
|
+
| **Type** | `string or number` |
|
|
454
482
|
|
|
455
483
|
**Description:** CPU resource units, as described here https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/#meaning-of-cpu
|
|
456
484
|
|
|
457
485
|
#### <a name="resources_limits_ephemeral-storage"></a>11.2.2.  Property `ephemeral-storage`
|
|
458
486
|
|
|
459
|
-
|
|
|
460
|
-
|
|
|
487
|
+
| | |
|
|
488
|
+
| -------- | -------- |
|
|
489
|
+
| **Type** | `string` |
|
|
461
490
|
|
|
462
491
|
**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
|
|
463
492
|
|
|
464
493
|
#### <a name="resources_limits_memory"></a>11.2.3.  Property `memory`
|
|
465
494
|
|
|
466
|
-
|
|
|
467
|
-
|
|
|
495
|
+
| | |
|
|
496
|
+
| -------- | -------- |
|
|
497
|
+
| **Type** | `string` |
|
|
468
498
|
|
|
469
499
|
**Description:** Amount of memory, mesaured in bytes. For more info, see https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/#meaning-of-memory
|
|
470
500
|
|
|
@@ -472,8 +502,9 @@ Must be one of:
|
|
|
472
502
|
|
|
473
503
|
**Title:** Health-check configuration
|
|
474
504
|
|
|
475
|
-
|
|
|
505
|
+
| | |
|
|
476
506
|
| ------------------------- | -------------------------------------------------------------------------------------------------------- |
|
|
507
|
+
| **Type** | `object` |
|
|
477
508
|
| **Additional properties** | [](# "Additional Properties not allowed.") |
|
|
478
509
|
|
|
479
510
|
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|
|
@@ -483,8 +514,9 @@ Must be one of:
|
|
|
483
514
|
|
|
484
515
|
### <a name="health_check_liveness"></a>12.1.  Property `liveness`
|
|
485
516
|
|
|
486
|
-
|
|
|
517
|
+
| | |
|
|
487
518
|
| ------------------------- | -------------------------------------------------------------------------------------------------------- |
|
|
519
|
+
| **Type** | `object` |
|
|
488
520
|
| **Additional properties** | [](# "Additional Properties not allowed.") |
|
|
489
521
|
|
|
490
522
|
**Description:** Liveness-probe configuration.
|
|
@@ -495,16 +527,18 @@ Must be one of:
|
|
|
495
527
|
|
|
496
528
|
#### <a name="health_check_liveness_path"></a>12.1.1.  Property `path`
|
|
497
529
|
|
|
498
|
-
|
|
|
530
|
+
| | |
|
|
499
531
|
| ----------- | ------------ |
|
|
532
|
+
| **Type** | `string` |
|
|
500
533
|
| **Default** | `"/healthz"` |
|
|
501
534
|
|
|
502
535
|
**Description:** HTTP path used by Kubernetes, to perform health-check calls.
|
|
503
536
|
|
|
504
537
|
### <a name="health_check_readiness"></a>12.2.  Property `readiness`
|
|
505
538
|
|
|
506
|
-
|
|
|
539
|
+
| | |
|
|
507
540
|
| ------------------------- | -------------------------------------------------------------------------------------------------------- |
|
|
541
|
+
| **Type** | `object` |
|
|
508
542
|
| **Additional properties** | [](# "Additional Properties not allowed.") |
|
|
509
543
|
|
|
510
544
|
**Description:** Readiness-probe configuration.
|
|
@@ -515,16 +549,18 @@ Must be one of:
|
|
|
515
549
|
|
|
516
550
|
#### <a name="health_check_readiness_path"></a>12.2.1.  Property `path`
|
|
517
551
|
|
|
518
|
-
|
|
|
552
|
+
| | |
|
|
519
553
|
| ----------- | ------------ |
|
|
554
|
+
| **Type** | `string` |
|
|
520
555
|
| **Default** | `"/healthz"` |
|
|
521
556
|
|
|
522
557
|
**Description:** HTTP path used by Kubernetes, to perform health-check calls.
|
|
523
558
|
|
|
524
559
|
## <a name="startupTimeout"></a>13.  Property `startupTimeout`
|
|
525
560
|
|
|
526
|
-
|
|
|
561
|
+
| | |
|
|
527
562
|
| ----------- | --------- |
|
|
563
|
+
| **Type** | `integer` |
|
|
528
564
|
| **Default** | `30` |
|
|
529
565
|
|
|
530
566
|
**Description:** Initial timeout in seconds, during which the app must start giving the response to the liveness-probe.
|
|
@@ -535,35 +571,345 @@ Must be one of:
|
|
|
535
571
|
|
|
536
572
|
## <a name="env"></a>14.  Property `env`
|
|
537
573
|
|
|
538
|
-
|
|
|
574
|
+
| | |
|
|
575
|
+
| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- |
|
|
576
|
+
| **Type** | `combining` |
|
|
577
|
+
| **Additional properties** | [](# "Additional Properties of any type are allowed.") |
|
|
578
|
+
| **Default** | `{}` |
|
|
579
|
+
|
|
580
|
+
**Description:** Key-value map of environment variables, which should be added to the Pod spec.
|
|
581
|
+
|
|
582
|
+
| Any of(Option) |
|
|
583
|
+
| ----------------------- |
|
|
584
|
+
| [item 0](#env_anyOf_i0) |
|
|
585
|
+
| [item 1](#env_anyOf_i1) |
|
|
586
|
+
|
|
587
|
+
### <a name="env_anyOf_i0"></a>14.1. Property `None`
|
|
588
|
+
|
|
589
|
+
| | |
|
|
539
590
|
| ------------------------- | -------------------------------------------------------------------------------------------------------- |
|
|
591
|
+
| **Type** | `object` |
|
|
540
592
|
| **Additional properties** | [](# "Additional Properties not allowed.") |
|
|
541
593
|
| **Default** | `{}` |
|
|
542
594
|
|
|
543
|
-
|
|
544
|
-
|
|
545
|
-
|
|
|
546
|
-
| ------------------------------------------------ | ------- | ----------- | ---------- | ---------- | ----------------- |
|
|
547
|
-
| - [^[-._a-zA-Z][-._a-zA-Z0-9]*$](#env_pattern1 ) | Yes | Combination | No | - | - |
|
|
595
|
+
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|
|
596
|
+
| --------------------------------------------------------- | ------- | ----------- | ---------- | ---------- | ----------------- |
|
|
597
|
+
| - [^[-._a-zA-Z][-._a-zA-Z0-9]*$](#env_anyOf_i0_pattern1 ) | Yes | Combination | No | - | - |
|
|
548
598
|
|
|
549
|
-
|
|
599
|
+
#### <a name="env_anyOf_i0_pattern1"></a>14.1.1. Pattern Property `^[-._a-zA-Z][-._a-zA-Z0-9]*$`
|
|
550
600
|
> All properties whose name matches the regular expression
|
|
551
601
|
```^[-._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))
|
|
552
602
|
must respect the following conditions
|
|
553
603
|
|
|
554
|
-
|
|
|
604
|
+
| | |
|
|
555
605
|
| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- |
|
|
606
|
+
| **Type** | `combining` |
|
|
556
607
|
| **Additional properties** | [](# "Additional Properties of any type are allowed.") |
|
|
557
608
|
|
|
558
|
-
|
|
609
|
+
| Any of(Option) |
|
|
610
|
+
| ----------------------------------------- |
|
|
611
|
+
| [item 0](#env_anyOf_i0_pattern1_anyOf_i0) |
|
|
612
|
+
| [item 1](#env_anyOf_i0_pattern1_anyOf_i1) |
|
|
613
|
+
|
|
614
|
+
##### <a name="env_anyOf_i0_pattern1_anyOf_i0"></a>14.1.1.1. Property `None`
|
|
615
|
+
|
|
616
|
+
| | |
|
|
617
|
+
| -------- | ------------------- |
|
|
618
|
+
| **Type** | `integer or string` |
|
|
619
|
+
|
|
620
|
+
**Description:** Plain value of an environment variable.
|
|
621
|
+
|
|
622
|
+
##### <a name="env_anyOf_i0_pattern1_anyOf_i1"></a>14.1.1.2. Property `None`
|
|
623
|
+
|
|
624
|
+
| | |
|
|
625
|
+
| ------------------------- | -------------------------------------------------------------------------------------------------------- |
|
|
626
|
+
| **Type** | `object` |
|
|
627
|
+
| **Additional properties** | [](# "Additional Properties not allowed.") |
|
|
628
|
+
|
|
629
|
+
**Description:** `valueFrom` configuration for the environment variable https://kubernetes.io/docs/tasks/inject-data-application/environment-variable-expose-pod-information/
|
|
630
|
+
|
|
631
|
+
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|
|
632
|
+
| ----------------------------------------------------------------------- | ------- | ------ | ---------- | ---------- | ------------------------------------ |
|
|
633
|
+
| - [configMapKeyRef](#env_anyOf_i0_pattern1_anyOf_i1_configMapKeyRef ) | No | object | No | - | Selects a key of a ConfigMap. |
|
|
634
|
+
| - [secretKeyRef](#env_anyOf_i0_pattern1_anyOf_i1_secretKeyRef ) | No | object | No | - | Selects a key of a Secret. |
|
|
635
|
+
| - [resourceFieldRef](#env_anyOf_i0_pattern1_anyOf_i1_resourceFieldRef ) | No | object | No | - | Selects a resource of the container. |
|
|
636
|
+
| - [fieldRef](#env_anyOf_i0_pattern1_anyOf_i1_fieldRef ) | No | object | No | - | Selects a field of the pod. |
|
|
637
|
+
|
|
638
|
+
##### <a name="env_anyOf_i0_pattern1_anyOf_i1_configMapKeyRef"></a>14.1.1.2.1. Property `configMapKeyRef`
|
|
639
|
+
|
|
640
|
+
| | |
|
|
641
|
+
| ------------------------- | -------------------------------------------------------------------------------------------------------- |
|
|
642
|
+
| **Type** | `object` |
|
|
643
|
+
| **Additional properties** | [](# "Additional Properties not allowed.") |
|
|
644
|
+
|
|
645
|
+
**Description:** Selects a key of a ConfigMap.
|
|
646
|
+
|
|
647
|
+
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|
|
648
|
+
| --------------------------------------------------------------- | ------- | ------ | ---------- | --------------------------------------------- | ------------------------------------------------ |
|
|
649
|
+
| - [name](#env_anyOf_i0_pattern1_anyOf_i1_configMapKeyRef_name ) | No | string | No | Same as [name](#global_imagePullSecret_name ) | Name of a ConfigMap. |
|
|
650
|
+
| - [key](#env_anyOf_i0_pattern1_anyOf_i1_configMapKeyRef_key ) | No | string | No | - | Key in that ConfigMap, which value will be used. |
|
|
651
|
+
|
|
652
|
+
##### <a name="env_anyOf_i0_pattern1_anyOf_i1_configMapKeyRef_name"></a>14.1.1.2.1.1. Property `name`
|
|
653
|
+
|
|
654
|
+
| | |
|
|
655
|
+
| ---------------------- | ------------------------------------ |
|
|
656
|
+
| **Type** | `string` |
|
|
657
|
+
| **Same definition as** | [name](#global_imagePullSecret_name) |
|
|
658
|
+
|
|
659
|
+
**Description:** Name of a ConfigMap.
|
|
660
|
+
|
|
661
|
+
##### <a name="env_anyOf_i0_pattern1_anyOf_i1_configMapKeyRef_key"></a>14.1.1.2.1.2. Property `key`
|
|
662
|
+
|
|
663
|
+
| | |
|
|
664
|
+
| -------- | -------- |
|
|
665
|
+
| **Type** | `string` |
|
|
666
|
+
|
|
667
|
+
**Description:** Key in that ConfigMap, which value will be used.
|
|
668
|
+
|
|
669
|
+
##### <a name="env_anyOf_i0_pattern1_anyOf_i1_secretKeyRef"></a>14.1.1.2.2. Property `secretKeyRef`
|
|
670
|
+
|
|
671
|
+
| | |
|
|
672
|
+
| ------------------------- | -------------------------------------------------------------------------------------------------------- |
|
|
673
|
+
| **Type** | `object` |
|
|
674
|
+
| **Additional properties** | [](# "Additional Properties not allowed.") |
|
|
675
|
+
|
|
676
|
+
**Description:** Selects a key of a Secret.
|
|
677
|
+
|
|
678
|
+
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|
|
679
|
+
| ------------------------------------------------------------ | ------- | ------ | ---------- | --------------------------------------------- | --------------------------------------------- |
|
|
680
|
+
| - [name](#env_anyOf_i0_pattern1_anyOf_i1_secretKeyRef_name ) | No | string | No | Same as [name](#global_imagePullSecret_name ) | Name of a Secret. |
|
|
681
|
+
| - [key](#env_anyOf_i0_pattern1_anyOf_i1_secretKeyRef_key ) | No | string | No | - | Key in that Secret, which value will be used. |
|
|
682
|
+
|
|
683
|
+
##### <a name="env_anyOf_i0_pattern1_anyOf_i1_secretKeyRef_name"></a>14.1.1.2.2.1. Property `name`
|
|
684
|
+
|
|
685
|
+
| | |
|
|
686
|
+
| ---------------------- | ------------------------------------ |
|
|
687
|
+
| **Type** | `string` |
|
|
688
|
+
| **Same definition as** | [name](#global_imagePullSecret_name) |
|
|
689
|
+
|
|
690
|
+
**Description:** Name of a Secret.
|
|
691
|
+
|
|
692
|
+
##### <a name="env_anyOf_i0_pattern1_anyOf_i1_secretKeyRef_key"></a>14.1.1.2.2.2. Property `key`
|
|
693
|
+
|
|
694
|
+
| | |
|
|
695
|
+
| -------- | -------- |
|
|
696
|
+
| **Type** | `string` |
|
|
697
|
+
|
|
698
|
+
**Description:** Key in that Secret, which value will be used.
|
|
699
|
+
|
|
700
|
+
##### <a name="env_anyOf_i0_pattern1_anyOf_i1_resourceFieldRef"></a>14.1.1.2.3. Property `resourceFieldRef`
|
|
701
|
+
|
|
702
|
+
| | |
|
|
703
|
+
| ------------------------- | -------------------------------------------------------------------------------------------------------- |
|
|
704
|
+
| **Type** | `object` |
|
|
705
|
+
| **Additional properties** | [](# "Additional Properties not allowed.") |
|
|
706
|
+
|
|
707
|
+
**Description:** Selects a resource of the container.
|
|
708
|
+
|
|
709
|
+
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|
|
710
|
+
| ---------------------------------------------------------------------------------- | ------- | ------ | ---------- | --------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
711
|
+
| - [containerName](#env_anyOf_i0_pattern1_anyOf_i1_resourceFieldRef_containerName ) | No | string | No | Same as [name](#global_imagePullSecret_name ) | Name of a Container. |
|
|
712
|
+
| - [resource](#env_anyOf_i0_pattern1_anyOf_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. |
|
|
713
|
+
|
|
714
|
+
##### <a name="env_anyOf_i0_pattern1_anyOf_i1_resourceFieldRef_containerName"></a>14.1.1.2.3.1. Property `containerName`
|
|
715
|
+
|
|
716
|
+
| | |
|
|
717
|
+
| ---------------------- | ------------------------------------ |
|
|
718
|
+
| **Type** | `string` |
|
|
719
|
+
| **Same definition as** | [name](#global_imagePullSecret_name) |
|
|
720
|
+
|
|
721
|
+
**Description:** Name of a Container.
|
|
722
|
+
|
|
723
|
+
##### <a name="env_anyOf_i0_pattern1_anyOf_i1_resourceFieldRef_resource"></a>14.1.1.2.3.2. Property `resource`
|
|
724
|
+
|
|
725
|
+
| | |
|
|
726
|
+
| -------- | -------- |
|
|
727
|
+
| **Type** | `string` |
|
|
728
|
+
|
|
729
|
+
**Description:** Only resources limits and requests (limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, requests.memory and requests.ephemeral-storage) are currently supported.
|
|
730
|
+
|
|
731
|
+
##### <a name="env_anyOf_i0_pattern1_anyOf_i1_fieldRef"></a>14.1.1.2.4. Property `fieldRef`
|
|
732
|
+
|
|
733
|
+
| | |
|
|
734
|
+
| ------------------------- | -------------------------------------------------------------------------------------------------------- |
|
|
735
|
+
| **Type** | `object` |
|
|
736
|
+
| **Additional properties** | [](# "Additional Properties not allowed.") |
|
|
737
|
+
|
|
738
|
+
**Description:** Selects a field of the pod.
|
|
739
|
+
|
|
740
|
+
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|
|
741
|
+
| ------------------------------------------------------------------ | ------- | ------ | ---------- | ---------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
742
|
+
| - [fieldPath](#env_anyOf_i0_pattern1_anyOf_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. |
|
|
743
|
+
|
|
744
|
+
##### <a name="env_anyOf_i0_pattern1_anyOf_i1_fieldRef_fieldPath"></a>14.1.1.2.4.1. Property `fieldPath`
|
|
745
|
+
|
|
746
|
+
| | |
|
|
747
|
+
| -------- | -------- |
|
|
748
|
+
| **Type** | `string` |
|
|
749
|
+
|
|
750
|
+
**Description:** Supports metadata.name, metadata.namespace, `metadata.labels['<KEY>']`, `metadata.annotations['<KEY>']`, spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs.
|
|
751
|
+
|
|
752
|
+
### <a name="env_anyOf_i1"></a>14.2. Property `None`
|
|
753
|
+
|
|
754
|
+
| | |
|
|
755
|
+
| -------- | ----------------- |
|
|
756
|
+
| **Type** | `array of object` |
|
|
757
|
+
|
|
758
|
+
| Each item of this array must be | Description |
|
|
759
|
+
| ----------------------------------- | ----------- |
|
|
760
|
+
| [item 1 items](#env_anyOf_i1_items) | - |
|
|
761
|
+
|
|
762
|
+
#### <a name="autogenerated_heading_3"></a>14.2.1. items
|
|
763
|
+
|
|
764
|
+
| | |
|
|
765
|
+
| ------------------------- | -------------------------------------------------------------------------------------------------------- |
|
|
766
|
+
| **Type** | `object` |
|
|
767
|
+
| **Additional properties** | [](# "Additional Properties not allowed.") |
|
|
768
|
+
|
|
769
|
+
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|
|
770
|
+
| ----------------------------------------------------------- | ------- | ----------------- | ---------- | ---------- | ------------------------------------ |
|
|
771
|
+
| + [name](#env_anyOf_i1_items_name ) | No | string | No | - | - |
|
|
772
|
+
| - [value](#env_anyOf_i1_items_value ) | No | string or integer | No | - | - |
|
|
773
|
+
| - [configMapKeyRef](#env_anyOf_i1_items_configMapKeyRef ) | No | object | No | - | Selects a key of a ConfigMap. |
|
|
774
|
+
| - [secretKeyRef](#env_anyOf_i1_items_secretKeyRef ) | No | object | No | - | Selects a key of a Secret. |
|
|
775
|
+
| - [resourceFieldRef](#env_anyOf_i1_items_resourceFieldRef ) | No | object | No | - | Selects a resource of the container. |
|
|
776
|
+
| - [fieldRef](#env_anyOf_i1_items_fieldRef ) | No | object | No | - | Selects a field of the pod. |
|
|
777
|
+
|
|
778
|
+
##### <a name="env_anyOf_i1_items_name"></a>14.2.1.1. Property `name`
|
|
779
|
+
|
|
780
|
+
| | |
|
|
781
|
+
| -------- | -------- |
|
|
782
|
+
| **Type** | `string` |
|
|
783
|
+
|
|
784
|
+
| Restrictions | |
|
|
785
|
+
| --------------------------------- | ----------------------------------------------------------------------------------------------------------------- |
|
|
786
|
+
| **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) |
|
|
787
|
+
|
|
788
|
+
##### <a name="env_anyOf_i1_items_value"></a>14.2.1.2. Property `value`
|
|
789
|
+
|
|
790
|
+
| | |
|
|
791
|
+
| -------- | ------------------- |
|
|
792
|
+
| **Type** | `string or integer` |
|
|
793
|
+
|
|
794
|
+
##### <a name="env_anyOf_i1_items_configMapKeyRef"></a>14.2.1.3. Property `configMapKeyRef`
|
|
795
|
+
|
|
796
|
+
| | |
|
|
797
|
+
| ------------------------- | -------------------------------------------------------------------------------------------------------- |
|
|
798
|
+
| **Type** | `object` |
|
|
799
|
+
| **Additional properties** | [](# "Additional Properties not allowed.") |
|
|
800
|
+
|
|
801
|
+
**Description:** Selects a key of a ConfigMap.
|
|
802
|
+
|
|
803
|
+
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|
|
804
|
+
| --------------------------------------------------- | ------- | ------ | ---------- | --------------------------------------------- | ------------------------------------------------ |
|
|
805
|
+
| - [name](#env_anyOf_i1_items_configMapKeyRef_name ) | No | string | No | Same as [name](#global_imagePullSecret_name ) | Name of a ConfigMap. |
|
|
806
|
+
| - [key](#env_anyOf_i1_items_configMapKeyRef_key ) | No | string | No | - | Key in that ConfigMap, which value will be used. |
|
|
807
|
+
|
|
808
|
+
##### <a name="env_anyOf_i1_items_configMapKeyRef_name"></a>14.2.1.3.1. Property `name`
|
|
809
|
+
|
|
810
|
+
| | |
|
|
811
|
+
| ---------------------- | ------------------------------------ |
|
|
812
|
+
| **Type** | `string` |
|
|
813
|
+
| **Same definition as** | [name](#global_imagePullSecret_name) |
|
|
814
|
+
|
|
815
|
+
**Description:** Name of a ConfigMap.
|
|
816
|
+
|
|
817
|
+
##### <a name="env_anyOf_i1_items_configMapKeyRef_key"></a>14.2.1.3.2. Property `key`
|
|
818
|
+
|
|
819
|
+
| | |
|
|
820
|
+
| -------- | -------- |
|
|
821
|
+
| **Type** | `string` |
|
|
822
|
+
|
|
823
|
+
**Description:** Key in that ConfigMap, which value will be used.
|
|
824
|
+
|
|
825
|
+
##### <a name="env_anyOf_i1_items_secretKeyRef"></a>14.2.1.4. Property `secretKeyRef`
|
|
826
|
+
|
|
827
|
+
| | |
|
|
828
|
+
| ------------------------- | -------------------------------------------------------------------------------------------------------- |
|
|
829
|
+
| **Type** | `object` |
|
|
830
|
+
| **Additional properties** | [](# "Additional Properties not allowed.") |
|
|
831
|
+
|
|
832
|
+
**Description:** Selects a key of a Secret.
|
|
833
|
+
|
|
834
|
+
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|
|
835
|
+
| ------------------------------------------------ | ------- | ------ | ---------- | --------------------------------------------- | --------------------------------------------- |
|
|
836
|
+
| - [name](#env_anyOf_i1_items_secretKeyRef_name ) | No | string | No | Same as [name](#global_imagePullSecret_name ) | Name of a Secret. |
|
|
837
|
+
| - [key](#env_anyOf_i1_items_secretKeyRef_key ) | No | string | No | - | Key in that Secret, which value will be used. |
|
|
838
|
+
|
|
839
|
+
##### <a name="env_anyOf_i1_items_secretKeyRef_name"></a>14.2.1.4.1. Property `name`
|
|
840
|
+
|
|
841
|
+
| | |
|
|
842
|
+
| ---------------------- | ------------------------------------ |
|
|
843
|
+
| **Type** | `string` |
|
|
844
|
+
| **Same definition as** | [name](#global_imagePullSecret_name) |
|
|
845
|
+
|
|
846
|
+
**Description:** Name of a Secret.
|
|
847
|
+
|
|
848
|
+
##### <a name="env_anyOf_i1_items_secretKeyRef_key"></a>14.2.1.4.2. Property `key`
|
|
849
|
+
|
|
850
|
+
| | |
|
|
851
|
+
| -------- | -------- |
|
|
852
|
+
| **Type** | `string` |
|
|
853
|
+
|
|
854
|
+
**Description:** Key in that Secret, which value will be used.
|
|
855
|
+
|
|
856
|
+
##### <a name="env_anyOf_i1_items_resourceFieldRef"></a>14.2.1.5. Property `resourceFieldRef`
|
|
857
|
+
|
|
858
|
+
| | |
|
|
859
|
+
| ------------------------- | -------------------------------------------------------------------------------------------------------- |
|
|
860
|
+
| **Type** | `object` |
|
|
861
|
+
| **Additional properties** | [](# "Additional Properties not allowed.") |
|
|
862
|
+
|
|
863
|
+
**Description:** Selects a resource of the container.
|
|
864
|
+
|
|
865
|
+
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|
|
866
|
+
| ---------------------------------------------------------------------- | ------- | ------ | ---------- | --------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
867
|
+
| - [containerName](#env_anyOf_i1_items_resourceFieldRef_containerName ) | No | string | No | Same as [name](#global_imagePullSecret_name ) | Name of a Container. |
|
|
868
|
+
| - [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. |
|
|
869
|
+
|
|
870
|
+
##### <a name="env_anyOf_i1_items_resourceFieldRef_containerName"></a>14.2.1.5.1. Property `containerName`
|
|
871
|
+
|
|
872
|
+
| | |
|
|
873
|
+
| ---------------------- | ------------------------------------ |
|
|
874
|
+
| **Type** | `string` |
|
|
875
|
+
| **Same definition as** | [name](#global_imagePullSecret_name) |
|
|
876
|
+
|
|
877
|
+
**Description:** Name of a Container.
|
|
878
|
+
|
|
879
|
+
##### <a name="env_anyOf_i1_items_resourceFieldRef_resource"></a>14.2.1.5.2. Property `resource`
|
|
880
|
+
|
|
881
|
+
| | |
|
|
882
|
+
| -------- | -------- |
|
|
883
|
+
| **Type** | `string` |
|
|
884
|
+
|
|
885
|
+
**Description:** Only resources limits and requests (limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, requests.memory and requests.ephemeral-storage) are currently supported.
|
|
886
|
+
|
|
887
|
+
##### <a name="env_anyOf_i1_items_fieldRef"></a>14.2.1.6. Property `fieldRef`
|
|
888
|
+
|
|
889
|
+
| | |
|
|
890
|
+
| ------------------------- | -------------------------------------------------------------------------------------------------------- |
|
|
891
|
+
| **Type** | `object` |
|
|
892
|
+
| **Additional properties** | [](# "Additional Properties not allowed.") |
|
|
893
|
+
|
|
894
|
+
**Description:** Selects a field of the pod.
|
|
895
|
+
|
|
896
|
+
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|
|
897
|
+
| ------------------------------------------------------ | ------- | ------ | ---------- | ---------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
898
|
+
| - [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. |
|
|
899
|
+
|
|
900
|
+
##### <a name="env_anyOf_i1_items_fieldRef_fieldPath"></a>14.2.1.6.1. Property `fieldPath`
|
|
901
|
+
|
|
902
|
+
| | |
|
|
903
|
+
| -------- | -------- |
|
|
904
|
+
| **Type** | `string` |
|
|
559
905
|
|
|
560
|
-
|
|
561
|
-
| ---- | ----------------------- |
|
|
906
|
+
**Description:** Supports metadata.name, metadata.namespace, `metadata.labels['<KEY>']`, `metadata.annotations['<KEY>']`, spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs.
|
|
562
907
|
|
|
563
908
|
## <a name="envSecretNames"></a>15.  Property `envSecretNames`
|
|
564
909
|
|
|
565
|
-
|
|
|
910
|
+
| | |
|
|
566
911
|
| ----------- | ------- |
|
|
912
|
+
| **Type** | `array` |
|
|
567
913
|
| **Default** | `[]` |
|
|
568
914
|
|
|
569
915
|
**Description:** List of Kubernetes Secret names, used as sources for the Pod's environment variables.
|
|
@@ -574,32 +920,36 @@ must respect the following conditions
|
|
|
574
920
|
|
|
575
921
|
### <a name="autogenerated_heading_4"></a>15.1. items
|
|
576
922
|
|
|
577
|
-
|
|
|
923
|
+
| | |
|
|
578
924
|
| ---------------------- | ------------------------------------ |
|
|
925
|
+
| **Type** | `string` |
|
|
579
926
|
| **Same definition as** | [name](#global_imagePullSecret_name) |
|
|
580
927
|
|
|
581
928
|
## <a name="expose"></a>16.  Property `expose`
|
|
582
929
|
|
|
583
|
-
|
|
|
930
|
+
| | |
|
|
584
931
|
| ------------------------- | -------------------------------------------------------------------------------------------------------- |
|
|
932
|
+
| **Type** | `object` |
|
|
585
933
|
| **Additional properties** | [](# "Additional Properties not allowed.") |
|
|
586
934
|
|
|
587
|
-
| Property | Pattern | Type | Deprecated | Definition | Title/Description
|
|
588
|
-
| ----------------------------- | ------- | ------- | ---------- | ---------- |
|
|
589
|
-
| - [host](#expose_host ) | No | string | No | - | Specifies the service's dns name for inbound external traffic. If it doesn't
|
|
590
|
-
| - [enabled](#expose_enabled ) | No | boolean | No | - | Expose the application to the internet.
|
|
935
|
+
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|
|
936
|
+
| ----------------------------- | ------- | ------- | ---------- | ---------- | ---------------------------------------------------------------------------------------------------------------------------------------- |
|
|
937
|
+
| - [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. |
|
|
938
|
+
| - [enabled](#expose_enabled ) | No | boolean | No | - | Expose the application to the internet. |
|
|
591
939
|
|
|
592
940
|
### <a name="expose_host"></a>16.1.  Property `host`
|
|
593
941
|
|
|
594
|
-
|
|
|
595
|
-
|
|
|
942
|
+
| | |
|
|
943
|
+
| -------- | -------- |
|
|
944
|
+
| **Type** | `string` |
|
|
596
945
|
|
|
597
946
|
**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.
|
|
598
947
|
|
|
599
948
|
### <a name="expose_enabled"></a>16.2.  Property `enabled`
|
|
600
949
|
|
|
601
|
-
|
|
|
950
|
+
| | |
|
|
602
951
|
| ----------- | --------- |
|
|
952
|
+
| **Type** | `boolean` |
|
|
603
953
|
| **Default** | `true` |
|
|
604
954
|
|
|
605
955
|
**Description:** Expose the application to the internet.
|
|
@@ -608,8 +958,9 @@ must respect the following conditions
|
|
|
608
958
|
|
|
609
959
|
**Title:** Service Binding configuration
|
|
610
960
|
|
|
611
|
-
|
|
|
961
|
+
| | |
|
|
612
962
|
| ------------------------- | -------------------------------------------------------------------------------------------------------- |
|
|
963
|
+
| **Type** | `object` |
|
|
613
964
|
| **Additional properties** | [](# "Additional Properties not allowed.") |
|
|
614
965
|
|
|
615
966
|
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|
|
@@ -621,8 +972,9 @@ must respect the following conditions
|
|
|
621
972
|
```^[-._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))
|
|
622
973
|
must respect the following conditions
|
|
623
974
|
|
|
624
|
-
|
|
|
975
|
+
| | |
|
|
625
976
|
| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- |
|
|
977
|
+
| **Type** | `combining` |
|
|
626
978
|
| **Additional properties** | [](# "Additional Properties of any type are allowed.") |
|
|
627
979
|
|
|
628
980
|
| Any of(Option) |
|
|
@@ -632,81 +984,90 @@ must respect the following conditions
|
|
|
632
984
|
|
|
633
985
|
#### <a name="bindings_pattern1_anyOf_i0"></a>17.1.1. Property `None`
|
|
634
986
|
|
|
635
|
-
|
|
|
987
|
+
| | |
|
|
636
988
|
| ------------------------- | -------------------------------------------------------------------------------------------------------- |
|
|
989
|
+
| **Type** | `object` |
|
|
637
990
|
| **Additional properties** | [](# "Additional Properties not allowed.") |
|
|
638
991
|
|
|
639
|
-
| Property | Pattern | Type | Deprecated | Definition | Title/Description
|
|
640
|
-
| ------------------------------------------------------- | ------- | ------ | ---------- | --------------------------------------------- |
|
|
641
|
-
| + [fromSecret](#bindings_pattern1_anyOf_i0_fromSecret ) | No | string | No | Same as [name](#global_imagePullSecret_name ) | Name of a Kubernetes Secret, with the binding content, compliant to the SAP
|
|
992
|
+
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|
|
993
|
+
| ------------------------------------------------------- | ------- | ------ | ---------- | --------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
994
|
+
| + [fromSecret](#bindings_pattern1_anyOf_i0_fromSecret ) | No | string | No | Same as [name](#global_imagePullSecret_name ) | 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/ |
|
|
642
995
|
|
|
643
996
|
##### <a name="bindings_pattern1_anyOf_i0_fromSecret"></a>17.1.1.1. Property `fromSecret`
|
|
644
997
|
|
|
645
|
-
|
|
|
998
|
+
| | |
|
|
646
999
|
| ---------------------- | ------------------------------------ |
|
|
1000
|
+
| **Type** | `string` |
|
|
647
1001
|
| **Same definition as** | [name](#global_imagePullSecret_name) |
|
|
648
1002
|
|
|
649
1003
|
**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/
|
|
650
1004
|
|
|
651
1005
|
#### <a name="bindings_pattern1_anyOf_i1"></a>17.1.2. Property `None`
|
|
652
1006
|
|
|
653
|
-
|
|
|
1007
|
+
| | |
|
|
654
1008
|
| ------------------------- | -------------------------------------------------------------------------------------------------------- |
|
|
1009
|
+
| **Type** | `object` |
|
|
655
1010
|
| **Additional properties** | [](# "Additional Properties not allowed.") |
|
|
656
1011
|
|
|
657
|
-
| Property | Pattern | Type | Deprecated | Definition | Title/Description
|
|
658
|
-
| ------------------------------------------------------------------------------------- | ------- | ------ | ---------- | --------------------------------------------- |
|
|
659
|
-
| - [serviceInstanceName](#bindings_pattern1_anyOf_i1_serviceInstanceName ) | No | string | No | Same as [name](#global_imagePullSecret_name ) | Name of a BTP Operator Service Instance, created by the
|
|
660
|
-
| - [serviceInstanceFullname](#bindings_pattern1_anyOf_i1_serviceInstanceFullname ) | No | string | No | Same as [name](#global_imagePullSecret_name ) | Full name of a BTP Operator Service Instance. Can't be used with the
|
|
661
|
-
| - [externalName](#bindings_pattern1_anyOf_i1_externalName ) | No | string | No | - | The name for the service binding in SAP BTP
|
|
662
|
-
| - [secretName](#bindings_pattern1_anyOf_i1_secretName ) | No | string | No | Same as [name](#global_imagePullSecret_name ) | The name of the secret where the credentials are stored.
|
|
663
|
-
| - [parameters](#bindings_pattern1_anyOf_i1_parameters ) | No | object | No | - | Some services support the provisioning of additional configuration parameters
|
|
664
|
-
| - [parametersFrom](#bindings_pattern1_anyOf_i1_parametersFrom ) | No | array | No | - | List of sources to populate parameters.
|
|
665
|
-
| - [credentialsRotationPolicy](#bindings_pattern1_anyOf_i1_credentialsRotationPolicy ) | No | object | No | - | Holds automatic credentials rotation configuration. For more details, see https
|
|
1012
|
+
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|
|
1013
|
+
| ------------------------------------------------------------------------------------- | ------- | ------ | ---------- | --------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
1014
|
+
| - [serviceInstanceName](#bindings_pattern1_anyOf_i1_serviceInstanceName ) | No | string | No | Same as [name](#global_imagePullSecret_name ) | Name of a BTP Operator Service Instance, created by the \`service-instance\` Helm chart. Can't be used with the \`serviceInstanceFullname\` option. |
|
|
1015
|
+
| - [serviceInstanceFullname](#bindings_pattern1_anyOf_i1_serviceInstanceFullname ) | No | string | No | Same as [name](#global_imagePullSecret_name ) | Full name of a BTP Operator Service Instance. Can't be used with the \`serviceInstanceName\` option. |
|
|
1016
|
+
| - [externalName](#bindings_pattern1_anyOf_i1_externalName ) | No | string | No | - | The name for the service binding in SAP BTP |
|
|
1017
|
+
| - [secretName](#bindings_pattern1_anyOf_i1_secretName ) | No | string | No | Same as [name](#global_imagePullSecret_name ) | The name of the secret where the credentials are stored. |
|
|
1018
|
+
| - [parameters](#bindings_pattern1_anyOf_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. |
|
|
1019
|
+
| - [parametersFrom](#bindings_pattern1_anyOf_i1_parametersFrom ) | No | array | No | - | List of sources to populate parameters. |
|
|
1020
|
+
| - [credentialsRotationPolicy](#bindings_pattern1_anyOf_i1_credentialsRotationPolicy ) | No | object | No | - | Holds automatic credentials rotation configuration. For more details, see https://github.com/SAP/sap-btp-service-operator#spec-1 |
|
|
666
1021
|
|
|
667
1022
|
##### <a name="bindings_pattern1_anyOf_i1_serviceInstanceName"></a>17.1.2.1. Property `serviceInstanceName`
|
|
668
1023
|
|
|
669
|
-
|
|
|
1024
|
+
| | |
|
|
670
1025
|
| ---------------------- | ------------------------------------ |
|
|
1026
|
+
| **Type** | `string` |
|
|
671
1027
|
| **Same definition as** | [name](#global_imagePullSecret_name) |
|
|
672
1028
|
|
|
673
1029
|
**Description:** Name of a BTP Operator Service Instance, created by the `service-instance` Helm chart. Can't be used with the `serviceInstanceFullname` option.
|
|
674
1030
|
|
|
675
1031
|
##### <a name="bindings_pattern1_anyOf_i1_serviceInstanceFullname"></a>17.1.2.2. Property `serviceInstanceFullname`
|
|
676
1032
|
|
|
677
|
-
|
|
|
1033
|
+
| | |
|
|
678
1034
|
| ---------------------- | ------------------------------------ |
|
|
1035
|
+
| **Type** | `string` |
|
|
679
1036
|
| **Same definition as** | [name](#global_imagePullSecret_name) |
|
|
680
1037
|
|
|
681
1038
|
**Description:** Full name of a BTP Operator Service Instance. Can't be used with the `serviceInstanceName` option.
|
|
682
1039
|
|
|
683
1040
|
##### <a name="bindings_pattern1_anyOf_i1_externalName"></a>17.1.2.3. Property `externalName`
|
|
684
1041
|
|
|
685
|
-
|
|
|
686
|
-
|
|
|
1042
|
+
| | |
|
|
1043
|
+
| -------- | -------- |
|
|
1044
|
+
| **Type** | `string` |
|
|
687
1045
|
|
|
688
1046
|
**Description:** The name for the service binding in SAP BTP
|
|
689
1047
|
|
|
690
1048
|
##### <a name="bindings_pattern1_anyOf_i1_secretName"></a>17.1.2.4. Property `secretName`
|
|
691
1049
|
|
|
692
|
-
|
|
|
1050
|
+
| | |
|
|
693
1051
|
| ---------------------- | ------------------------------------ |
|
|
1052
|
+
| **Type** | `string` |
|
|
694
1053
|
| **Same definition as** | [name](#global_imagePullSecret_name) |
|
|
695
1054
|
|
|
696
1055
|
**Description:** The name of the secret where the credentials are stored.
|
|
697
1056
|
|
|
698
1057
|
##### <a name="bindings_pattern1_anyOf_i1_parameters"></a>17.1.2.5. Property `parameters`
|
|
699
1058
|
|
|
700
|
-
|
|
|
1059
|
+
| | |
|
|
701
1060
|
| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- |
|
|
1061
|
+
| **Type** | `object` |
|
|
702
1062
|
| **Additional properties** | [](# "Additional Properties of any type are allowed.") |
|
|
703
1063
|
|
|
704
1064
|
**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.
|
|
705
1065
|
|
|
706
1066
|
##### <a name="bindings_pattern1_anyOf_i1_parametersFrom"></a>17.1.2.6. Property `parametersFrom`
|
|
707
1067
|
|
|
708
|
-
|
|
|
709
|
-
|
|
|
1068
|
+
| | |
|
|
1069
|
+
| -------- | ------- |
|
|
1070
|
+
| **Type** | `array` |
|
|
710
1071
|
|
|
711
1072
|
**Description:** List of sources to populate parameters.
|
|
712
1073
|
|
|
@@ -716,8 +1077,9 @@ must respect the following conditions
|
|
|
716
1077
|
|
|
717
1078
|
##### <a name="autogenerated_heading_5"></a>17.1.2.6.1. items
|
|
718
1079
|
|
|
719
|
-
|
|
|
1080
|
+
| | |
|
|
720
1081
|
| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- |
|
|
1082
|
+
| **Type** | `combining` |
|
|
721
1083
|
| **Additional properties** | [](# "Additional Properties of any type are allowed.") |
|
|
722
1084
|
|
|
723
1085
|
| Any of(Option) |
|
|
@@ -727,8 +1089,9 @@ must respect the following conditions
|
|
|
727
1089
|
|
|
728
1090
|
##### <a name="bindings_pattern1_anyOf_i1_parametersFrom_items_anyOf_i0"></a>17.1.2.6.1.1. Property `None`
|
|
729
1091
|
|
|
730
|
-
|
|
|
1092
|
+
| | |
|
|
731
1093
|
| ------------------------- | -------------------------------------------------------------------------------------------------------- |
|
|
1094
|
+
| **Type** | `object` |
|
|
732
1095
|
| **Additional properties** | [](# "Additional Properties not allowed.") |
|
|
733
1096
|
|
|
734
1097
|
**Description:** Kubernetes Secret as a parameters source.
|
|
@@ -739,34 +1102,38 @@ must respect the following conditions
|
|
|
739
1102
|
|
|
740
1103
|
##### <a name="bindings_pattern1_anyOf_i1_parametersFrom_items_anyOf_i0_secretKeyRef"></a>17.1.2.6.1.1.1. Property `secretKeyRef`
|
|
741
1104
|
|
|
742
|
-
|
|
|
1105
|
+
| | |
|
|
743
1106
|
| ------------------------- | -------------------------------------------------------------------------------------------------------- |
|
|
1107
|
+
| **Type** | `object` |
|
|
744
1108
|
| **Additional properties** | [](# "Additional Properties not allowed.") |
|
|
745
1109
|
|
|
746
|
-
| Property | Pattern | Type | Deprecated | Definition | Title/Description
|
|
747
|
-
| -------------------------------------------------------------------------------------- | ------- | ------ | ---------- | --------------------------------------------- |
|
|
748
|
-
| + [name](#bindings_pattern1_anyOf_i1_parametersFrom_items_anyOf_i0_secretKeyRef_name ) | No | string | No | Same as [name](#global_imagePullSecret_name ) | Name of a Secret.
|
|
749
|
-
| + [key](#bindings_pattern1_anyOf_i1_parametersFrom_items_anyOf_i0_secretKeyRef_key ) | No | string | No | - | Key in that Secret, which contains a string that represents the json to include
|
|
1110
|
+
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|
|
1111
|
+
| -------------------------------------------------------------------------------------- | ------- | ------ | ---------- | --------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- |
|
|
1112
|
+
| + [name](#bindings_pattern1_anyOf_i1_parametersFrom_items_anyOf_i0_secretKeyRef_name ) | No | string | No | Same as [name](#global_imagePullSecret_name ) | Name of a Secret. |
|
|
1113
|
+
| + [key](#bindings_pattern1_anyOf_i1_parametersFrom_items_anyOf_i0_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. |
|
|
750
1114
|
|
|
751
1115
|
##### <a name="bindings_pattern1_anyOf_i1_parametersFrom_items_anyOf_i0_secretKeyRef_name"></a>17.1.2.6.1.1.1.1. Property `name`
|
|
752
1116
|
|
|
753
|
-
|
|
|
1117
|
+
| | |
|
|
754
1118
|
| ---------------------- | ------------------------------------ |
|
|
1119
|
+
| **Type** | `string` |
|
|
755
1120
|
| **Same definition as** | [name](#global_imagePullSecret_name) |
|
|
756
1121
|
|
|
757
1122
|
**Description:** Name of a Secret.
|
|
758
1123
|
|
|
759
1124
|
##### <a name="bindings_pattern1_anyOf_i1_parametersFrom_items_anyOf_i0_secretKeyRef_key"></a>17.1.2.6.1.1.1.2. Property `key`
|
|
760
1125
|
|
|
761
|
-
|
|
|
762
|
-
|
|
|
1126
|
+
| | |
|
|
1127
|
+
| -------- | -------- |
|
|
1128
|
+
| **Type** | `string` |
|
|
763
1129
|
|
|
764
1130
|
**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.
|
|
765
1131
|
|
|
766
1132
|
##### <a name="bindings_pattern1_anyOf_i1_parametersFrom_items_anyOf_i1"></a>17.1.2.6.1.2. Property `None`
|
|
767
1133
|
|
|
768
|
-
|
|
|
1134
|
+
| | |
|
|
769
1135
|
| ------------------------- | -------------------------------------------------------------------------------------------------------- |
|
|
1136
|
+
| **Type** | `object` |
|
|
770
1137
|
| **Additional properties** | [](# "Additional Properties not allowed.") |
|
|
771
1138
|
|
|
772
1139
|
**Description:** Kubernetes Config Map as a parameters source.
|
|
@@ -777,34 +1144,38 @@ must respect the following conditions
|
|
|
777
1144
|
|
|
778
1145
|
##### <a name="bindings_pattern1_anyOf_i1_parametersFrom_items_anyOf_i1_configMapKeyRef"></a>17.1.2.6.1.2.1. Property `configMapKeyRef`
|
|
779
1146
|
|
|
780
|
-
|
|
|
1147
|
+
| | |
|
|
781
1148
|
| ------------------------- | -------------------------------------------------------------------------------------------------------- |
|
|
1149
|
+
| **Type** | `object` |
|
|
782
1150
|
| **Additional properties** | [](# "Additional Properties not allowed.") |
|
|
783
1151
|
|
|
784
|
-
| Property | Pattern | Type | Deprecated | Definition | Title/Description
|
|
785
|
-
| ----------------------------------------------------------------------------------------- | ------- | ------ | ---------- | --------------------------------------------- |
|
|
786
|
-
| + [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
|
|
787
|
-
| + [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
|
|
1152
|
+
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|
|
1153
|
+
| ----------------------------------------------------------------------------------------- | ------- | ------ | ---------- | --------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- |
|
|
1154
|
+
| + [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 |
|
|
1155
|
+
| + [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. |
|
|
788
1156
|
|
|
789
1157
|
##### <a name="bindings_pattern1_anyOf_i1_parametersFrom_items_anyOf_i1_configMapKeyRef_name"></a>17.1.2.6.1.2.1.1. Property `name`
|
|
790
1158
|
|
|
791
|
-
|
|
|
1159
|
+
| | |
|
|
792
1160
|
| ---------------------- | ------------------------------------ |
|
|
1161
|
+
| **Type** | `string` |
|
|
793
1162
|
| **Same definition as** | [name](#global_imagePullSecret_name) |
|
|
794
1163
|
|
|
795
1164
|
**Description:** Name of a Config Map
|
|
796
1165
|
|
|
797
1166
|
##### <a name="bindings_pattern1_anyOf_i1_parametersFrom_items_anyOf_i1_configMapKeyRef_key"></a>17.1.2.6.1.2.1.2. Property `key`
|
|
798
1167
|
|
|
799
|
-
|
|
|
800
|
-
|
|
|
1168
|
+
| | |
|
|
1169
|
+
| -------- | -------- |
|
|
1170
|
+
| **Type** | `string` |
|
|
801
1171
|
|
|
802
1172
|
**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.
|
|
803
1173
|
|
|
804
1174
|
##### <a name="bindings_pattern1_anyOf_i1_credentialsRotationPolicy"></a>17.1.2.7. Property `credentialsRotationPolicy`
|
|
805
1175
|
|
|
806
|
-
|
|
|
1176
|
+
| | |
|
|
807
1177
|
| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- |
|
|
1178
|
+
| **Type** | `object` |
|
|
808
1179
|
| **Additional properties** | [](# "Additional Properties of any type are allowed.") |
|
|
809
1180
|
|
|
810
1181
|
**Description:** Holds automatic credentials rotation configuration. For more details, see https://github.com/SAP/sap-btp-service-operator#spec-1
|