@sap/cds-dk 7.2.0 → 7.3.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/bin/activate.js +2 -2
- package/bin/add.js +1 -1
- package/bin/build.js +6 -3
- package/bin/compile/index.js +9 -5
- package/bin/env.js +0 -3
- package/bin/extend.js +29 -3
- package/bin/import.js +7 -3
- package/bin/init.js +31 -37
- package/bin/push.js +10 -6
- package/bin/repl.js +23 -43
- package/bin/watch.js +5 -9
- package/lib/bind/bindingResolver.js +2 -1
- package/lib/bind/index.js +1 -1
- package/lib/build/{buildTaskHandler.js → buildPlugin.js} +40 -27
- package/lib/build/buildTaskEngine.js +75 -74
- package/lib/build/buildTaskFactory.js +39 -32
- package/lib/build/buildTaskProvider.js +24 -19
- package/lib/build/buildTaskProviderFactory.js +125 -58
- package/lib/build/constants.js +6 -4
- package/lib/build/index.js +7 -3
- package/lib/build/plugins.js +35 -0
- package/lib/build/provider/{buildTaskHandlerEdmx.js → edmxBuildPlugin.js} +11 -7
- package/lib/build/provider/{buildTaskHandlerFeatureToggles.js → featureToggleBuildPlugin.js} +5 -5
- package/lib/build/provider/fiori/index.js +5 -6
- package/lib/build/provider/hana/index.js +54 -30
- package/lib/build/provider/{buildTaskHandlerInternal.js → internalBuildPlugin.js} +14 -10
- package/lib/build/provider/{buildTaskProviderInternal.js → internalBuildTaskProvider.js} +27 -28
- package/lib/build/provider/java/index.js +30 -24
- package/lib/build/provider/mtx/index.js +4 -4
- package/lib/build/provider/mtx/resourcesTarBuilder.js +8 -8
- package/lib/build/provider/mtx-extension/index.js +17 -9
- package/lib/build/provider/mtx-sidecar/index.js +17 -11
- package/lib/build/provider/nodejs/index.js +14 -13
- package/lib/build/util.js +5 -0
- package/lib/client/auth_manager.js +6 -12
- package/lib/client/base_command.js +1 -1
- package/lib/client/download_legacy.js +43 -0
- package/lib/client/params.js +6 -0
- package/lib/client/push.js +41 -1
- package/lib/client/settings_manager.js +28 -17
- package/lib/compile/openapi/csdl2openapi.js +1 -1
- package/lib/env/schema.js +36 -0
- package/lib/env/schemas/cds-rc.json +101 -0
- package/lib/import/common.js +23 -10
- package/lib/import/importapi.js +2 -2
- package/lib/import/message.js +3 -1
- package/lib/import/odata/v4parser.js +23 -7
- package/lib/index.js +11 -0
- package/lib/init/constants.js +5 -2
- package/lib/init/index.js +2 -3
- package/lib/init/template/_merging/registry-mta.js +33 -0
- package/lib/init/template/approuter/files/mta.yaml.hbs +1 -1
- package/lib/init/template/approuter/index.js +9 -9
- package/lib/init/template/connectivity/index.js +5 -4
- package/lib/init/template/destination/index.js +2 -5
- package/lib/init/template/helm/subcharts/content-deployment/Chart.yaml +4 -4
- package/lib/init/template/helm/subcharts/content-deployment/templates/_helpers.tpl +4 -2
- package/lib/init/template/helm/subcharts/content-deployment/templates/job.yaml +4 -3
- package/lib/init/template/helm/subcharts/content-deployment/values.schema.json +9 -83
- package/lib/init/template/helm/subcharts/content-deployment/values.yaml +54 -15
- package/lib/init/template/helm/subcharts/service-instance/Chart.yaml +4 -4
- package/lib/init/template/helm/subcharts/service-instance/templates/serviceinstance.yaml +1 -1
- package/lib/init/template/helm/subcharts/service-instance/values.schema.json +0 -17
- package/lib/init/template/helm/subcharts/service-instance/values.yaml +28 -0
- package/lib/init/template/helm/subcharts/web-application/Chart.yaml +5 -5
- package/lib/init/template/helm/subcharts/web-application/templates/_api.tpl +60 -0
- package/lib/init/template/helm/subcharts/web-application/templates/_helpers.tpl +34 -73
- package/lib/init/template/helm/subcharts/web-application/templates/api-rule.yaml +4 -4
- package/lib/init/template/helm/subcharts/web-application/templates/deployment.yaml +96 -17
- package/lib/init/template/helm/subcharts/web-application/templates/network-policy.yaml +19 -3
- package/lib/init/template/helm/subcharts/web-application/templates/pod-disruption-budget.yaml +3 -3
- package/lib/init/template/helm/subcharts/web-application/templates/rbac.yaml +26 -0
- package/lib/init/template/helm/subcharts/web-application/templates/secret.yaml +1 -1
- package/lib/init/template/helm/subcharts/web-application/templates/service-account.yaml +1 -1
- package/lib/init/template/helm/subcharts/web-application/templates/service-binding.yaml +1 -1
- package/lib/init/template/helm/subcharts/web-application/templates/service.yaml +21 -3
- package/lib/init/template/helm/subcharts/web-application/templates/virtual-service.yaml +36 -0
- package/lib/init/template/helm/subcharts/web-application/values.schema.json +535 -142
- package/lib/init/template/helm/subcharts/web-application/values.yaml +168 -44
- package/lib/init/template/html5-repo/index.js +27 -3
- package/lib/init/template/mta/index.js +9 -3
- package/lib/init/template/nodejs/files/.vscode/launch.json +0 -3
- package/lib/init/template/notifications/files/mta.yaml.hbs +17 -0
- package/lib/init/template/notifications/files/notificationtypes.json.hbs +16 -0
- package/lib/init/template/notifications/files/package.json.hbs +14 -0
- package/lib/init/template/notifications/index.js +52 -0
- package/lib/init/template/postgres/files/mta.yaml.hbs +27 -0
- package/lib/init/template/postgres/files/package.json.hbs +5 -0
- package/lib/init/template/postgres/index.js +52 -0
- package/lib/init/util/projectReader.js +0 -1
- package/lib/util/pruneAxiosErrors.js +25 -8
- package/lib/util/term.js +1 -2
- package/lib/watch/livereload-server.js +38 -2
- package/lib/watch/node-watch.js +3 -2
- package/npm-shrinkwrap.json +334 -335
- package/package.json +2 -2
- package/lib/init/template/helm/subcharts/content-deployment/templating.md +0 -37
- package/lib/init/template/helm/subcharts/content-deployment/values-lint.yaml +0 -5
- package/lib/init/template/helm/subcharts/content-deployment/values.md +0 -1011
- package/lib/init/template/helm/subcharts/service-instance/templating.md +0 -18
- package/lib/init/template/helm/subcharts/service-instance/values-lint.yaml +0 -2
- package/lib/init/template/helm/subcharts/service-instance/values.md +0 -186
- package/lib/init/template/helm/subcharts/web-application/templating.md +0 -51
- package/lib/init/template/helm/subcharts/web-application/values-lint.yaml +0 -8
- package/lib/init/template/helm/subcharts/web-application/values.md +0 -1363
|
@@ -1,1363 +0,0 @@
|
|
|
1
|
-
# Schema Docs
|
|
2
|
-
|
|
3
|
-
| | |
|
|
4
|
-
| ------------------------- | -------------------------------------------------------------------------------------------------------- |
|
|
5
|
-
| **Type** | `object` |
|
|
6
|
-
| **Additional properties** | [](# "Additional Properties not allowed.") |
|
|
7
|
-
|
|
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`
|
|
32
|
-
|
|
33
|
-
**Title:** Helm global values
|
|
34
|
-
|
|
35
|
-
| | |
|
|
36
|
-
| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- |
|
|
37
|
-
| **Type** | `object` |
|
|
38
|
-
| **Additional properties** | [](# "Additional Properties of any type are allowed.") |
|
|
39
|
-
|
|
40
|
-
**Description:** For more information, see https://helm.sh/docs/chart_template_guide/subcharts_and_globals/#global-chart-values
|
|
41
|
-
|
|
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 | - | - |
|
|
47
|
-
|
|
48
|
-
### <a name="global_imagePullSecret"></a>1.1.  Property `imagePullSecret`
|
|
49
|
-
|
|
50
|
-
**Title:** Image Pull Secret configuration
|
|
51
|
-
|
|
52
|
-
| | |
|
|
53
|
-
| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- |
|
|
54
|
-
| **Type** | `object` |
|
|
55
|
-
| **Additional properties** | [](# "Additional Properties of any type are allowed.") |
|
|
56
|
-
|
|
57
|
-
**Description:** For more information, see https://kubernetes.io/docs/tasks/configure-pod-container/pull-image-private-registry/
|
|
58
|
-
|
|
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 | - | - |
|
|
64
|
-
|
|
65
|
-
#### <a name="global_imagePullSecret_name"></a>1.1.1.  Property `name`
|
|
66
|
-
|
|
67
|
-
**Title:** Secret name
|
|
68
|
-
|
|
69
|
-
| | |
|
|
70
|
-
| -------------- | ---------------------------- |
|
|
71
|
-
| **Type** | `string` |
|
|
72
|
-
| **Defined in** | #/definitions/KubernetesName |
|
|
73
|
-
|
|
74
|
-
**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.
|
|
75
|
-
|
|
76
|
-
| Restrictions | |
|
|
77
|
-
| --------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
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) |
|
|
79
|
-
|
|
80
|
-
#### <a name="global_imagePullSecret_dockerconfigjson"></a>1.1.2.  Property `dockerconfigjson`
|
|
81
|
-
|
|
82
|
-
**Title:** Secret content
|
|
83
|
-
|
|
84
|
-
| | |
|
|
85
|
-
| -------- | -------- |
|
|
86
|
-
| **Type** | `string` |
|
|
87
|
-
|
|
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.
|
|
89
|
-
|
|
90
|
-
### <a name="global_image"></a>1.2.  Property `image`
|
|
91
|
-
|
|
92
|
-
**Title:** Image configuration
|
|
93
|
-
|
|
94
|
-
| | |
|
|
95
|
-
| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- |
|
|
96
|
-
| **Type** | `object` |
|
|
97
|
-
| **Additional properties** | [](# "Additional Properties of any type are allowed.") |
|
|
98
|
-
|
|
99
|
-
**Description:** Either name or repository is required.
|
|
100
|
-
|
|
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 | - | - |
|
|
106
|
-
|
|
107
|
-
#### <a name="global_image_tag"></a>1.2.1.  Property `tag`
|
|
108
|
-
|
|
109
|
-
| | |
|
|
110
|
-
| -------------- | ---------------------- |
|
|
111
|
-
| **Type** | `string` |
|
|
112
|
-
| **Defined in** | #/definitions/ImageTag |
|
|
113
|
-
|
|
114
|
-
**Description:** Image tag without the name (everything after the `:` sign, potentially including the `@sha256` section at the end).
|
|
115
|
-
|
|
116
|
-
| Restrictions | |
|
|
117
|
-
| --------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
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) |
|
|
119
|
-
|
|
120
|
-
#### <a name="global_image_registry"></a>1.2.2.  Property `registry`
|
|
121
|
-
|
|
122
|
-
| | |
|
|
123
|
-
| -------------- | --------------------------- |
|
|
124
|
-
| **Type** | `string` |
|
|
125
|
-
| **Defined in** | #/definitions/ImageRegistry |
|
|
126
|
-
|
|
127
|
-
**Description:** Image registry e.g. docker.io
|
|
128
|
-
|
|
129
|
-
| Restrictions | |
|
|
130
|
-
| --------------------------------- | ----------------------------------------------------------------------------- |
|
|
131
|
-
| **Must match regular expression** | ```^[\w-./]+$``` [Test](https://regex101.com/?regex=%5E%5B%5Cw-.%2F%5D%2B%24) |
|
|
132
|
-
|
|
133
|
-
## <a name="nameOverride"></a>2.  Property `nameOverride`
|
|
134
|
-
|
|
135
|
-
**Title:** Chart name override
|
|
136
|
-
|
|
137
|
-
| | |
|
|
138
|
-
| -------- | -------- |
|
|
139
|
-
| **Type** | `string` |
|
|
140
|
-
|
|
141
|
-
**Description:** Will be used instead of the `.Chart.Name`, e.g. when generating the Deployment name.
|
|
142
|
-
|
|
143
|
-
| Restrictions | |
|
|
144
|
-
| --------------------------------- | ------------------------------------------------------------------------------------------- |
|
|
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) |
|
|
146
|
-
|
|
147
|
-
## <a name="fullnameOverride"></a>3.  Property `fullnameOverride`
|
|
148
|
-
|
|
149
|
-
**Title:** Override for the `.fullname` helper function.
|
|
150
|
-
|
|
151
|
-
| | |
|
|
152
|
-
| -------- | -------- |
|
|
153
|
-
| **Type** | `string` |
|
|
154
|
-
|
|
155
|
-
**Description:** Will be used as an override for the `.fullname` helper function (i.e. `.Release.Name-.Chart.Name`).
|
|
156
|
-
|
|
157
|
-
| Restrictions | |
|
|
158
|
-
| --------------------------------- | ------------------------------------------------------------------------------------------- |
|
|
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) |
|
|
160
|
-
|
|
161
|
-
## <a name="replicaCount"></a>4.  Property `replicaCount`
|
|
162
|
-
|
|
163
|
-
**Title:** Replica count
|
|
164
|
-
|
|
165
|
-
| | |
|
|
166
|
-
| ----------- | --------- |
|
|
167
|
-
| **Type** | `integer` |
|
|
168
|
-
| **Default** | `1` |
|
|
169
|
-
|
|
170
|
-
**Description:** Number of desired pods within the Deployment.
|
|
171
|
-
|
|
172
|
-
| Restrictions | |
|
|
173
|
-
| ------------ | ------ |
|
|
174
|
-
| **Minimum** | ≥ 1 |
|
|
175
|
-
|
|
176
|
-
## <a name="port"></a>5.  Property `port`
|
|
177
|
-
|
|
178
|
-
**Title:** Port
|
|
179
|
-
|
|
180
|
-
| | |
|
|
181
|
-
| ----------- | --------- |
|
|
182
|
-
| **Type** | `integer` |
|
|
183
|
-
| **Default** | `8080` |
|
|
184
|
-
|
|
185
|
-
**Description:** Application's exposed port.
|
|
186
|
-
|
|
187
|
-
| Restrictions | |
|
|
188
|
-
| ------------ | ---------- |
|
|
189
|
-
| **Minimum** | ≥ 1 |
|
|
190
|
-
| **Maximum** | ≤ 65535 |
|
|
191
|
-
|
|
192
|
-
## <a name="serviceAccountName"></a>6.  Property `serviceAccountName`
|
|
193
|
-
|
|
194
|
-
**Title:** Service Account name
|
|
195
|
-
|
|
196
|
-
| | |
|
|
197
|
-
| -------- | -------- |
|
|
198
|
-
| **Type** | `string` |
|
|
199
|
-
|
|
200
|
-
**Description:** Name of the Service Account assigned to pods.
|
|
201
|
-
|
|
202
|
-
## <a name="image"></a>7.  Property `image`
|
|
203
|
-
|
|
204
|
-
**Title:** Image configuration
|
|
205
|
-
|
|
206
|
-
| | |
|
|
207
|
-
| ------------------------- | -------------------------------------------------------------------------------------------------------- |
|
|
208
|
-
| **Type** | `object` |
|
|
209
|
-
| **Additional properties** | [](# "Additional Properties not allowed.") |
|
|
210
|
-
|
|
211
|
-
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|
|
212
|
-
| ---------------------------------- | ------- | ------ | ---------- | ------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- |
|
|
213
|
-
| + [repository](#image_repository ) | No | string | No | - | Repository of the image |
|
|
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). |
|
|
215
|
-
| - [registry](#image_registry ) | No | string | No | Same as [registry](#global_image_registry ) | Image registry e.g. docker.io |
|
|
216
|
-
|
|
217
|
-
### <a name="image_repository"></a>7.1.  Property `repository`
|
|
218
|
-
|
|
219
|
-
**Title:** Repository of the image
|
|
220
|
-
|
|
221
|
-
| | |
|
|
222
|
-
| -------- | -------- |
|
|
223
|
-
| **Type** | `string` |
|
|
224
|
-
|
|
225
|
-
**Description:** Should also include the image name (i.e. everything before the `:` sign).
|
|
226
|
-
|
|
227
|
-
| Restrictions | |
|
|
228
|
-
| --------------------------------- | ------------------------------------------------------------------------------------------------------------- |
|
|
229
|
-
| **Must match regular expression** | ```^[\w-./:]*[@sha256]*$``` [Test](https://regex101.com/?regex=%5E%5B%5Cw-.%2F%3A%5D%2A%5B%40sha256%5D%2A%24) |
|
|
230
|
-
|
|
231
|
-
### <a name="image_tag"></a>7.2.  Property `tag`
|
|
232
|
-
|
|
233
|
-
| | |
|
|
234
|
-
| ---------------------- | ------------------------ |
|
|
235
|
-
| **Type** | `string` |
|
|
236
|
-
| **Same definition as** | [tag](#global_image_tag) |
|
|
237
|
-
|
|
238
|
-
**Description:** Image tag without the name (everything after the `:` sign, potentially including the `@sha256` section at the end).
|
|
239
|
-
|
|
240
|
-
### <a name="image_registry"></a>7.3.  Property `registry`
|
|
241
|
-
|
|
242
|
-
| | |
|
|
243
|
-
| ---------------------- | ---------------------------------- |
|
|
244
|
-
| **Type** | `string` |
|
|
245
|
-
| **Same definition as** | [registry](#global_image_registry) |
|
|
246
|
-
|
|
247
|
-
**Description:** Image registry e.g. docker.io
|
|
248
|
-
|
|
249
|
-
## <a name="imagePullSecret"></a>8.  Property `imagePullSecret`
|
|
250
|
-
|
|
251
|
-
**Title:** Image Pull Secret configuration
|
|
252
|
-
|
|
253
|
-
| | |
|
|
254
|
-
| ------------------------- | -------------------------------------------------------------------------------------------------------- |
|
|
255
|
-
| **Type** | `object` |
|
|
256
|
-
| **Additional properties** | [](# "Additional Properties not allowed.") |
|
|
257
|
-
|
|
258
|
-
**Description:** For more information, see https://kubernetes.io/docs/tasks/configure-pod-container/pull-image-private-registry/
|
|
259
|
-
|
|
260
|
-
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|
|
261
|
-
| -------------------------------------------------------- | ------- | ------ | ---------- | --------------------------------------------- | ----------------- |
|
|
262
|
-
| - [name](#imagePullSecret_name ) | No | string | No | Same as [name](#global_imagePullSecret_name ) | Secret name |
|
|
263
|
-
| - [dockerconfigjson](#imagePullSecret_dockerconfigjson ) | No | string | No | - | Secret content |
|
|
264
|
-
|
|
265
|
-
### <a name="imagePullSecret_name"></a>8.1.  Property `name`
|
|
266
|
-
|
|
267
|
-
**Title:** Secret name
|
|
268
|
-
|
|
269
|
-
| | |
|
|
270
|
-
| ---------------------- | ------------------------------------ |
|
|
271
|
-
| **Type** | `string` |
|
|
272
|
-
| **Same definition as** | [name](#global_imagePullSecret_name) |
|
|
273
|
-
|
|
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.
|
|
275
|
-
|
|
276
|
-
### <a name="imagePullSecret_dockerconfigjson"></a>8.2.  Property `dockerconfigjson`
|
|
277
|
-
|
|
278
|
-
**Title:** Secret content
|
|
279
|
-
|
|
280
|
-
| | |
|
|
281
|
-
| -------- | -------- |
|
|
282
|
-
| **Type** | `string` |
|
|
283
|
-
|
|
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.
|
|
285
|
-
|
|
286
|
-
## <a name="additionalVolumes"></a>9.  Property `additionalVolumes`
|
|
287
|
-
|
|
288
|
-
**Title:** Additional Pod volumes
|
|
289
|
-
|
|
290
|
-
| | |
|
|
291
|
-
| ----------- | ----------------- |
|
|
292
|
-
| **Type** | `array of object` |
|
|
293
|
-
| **Default** | `[]` |
|
|
294
|
-
|
|
295
|
-
**Description:** List of volumes, which should be mounted into Pods
|
|
296
|
-
|
|
297
|
-
| Each item of this array must be | Description |
|
|
298
|
-
| ----------------------------------------------------------- | ----------- |
|
|
299
|
-
| [Additional volume configuration](#additionalVolumes_items) | - |
|
|
300
|
-
|
|
301
|
-
### <a name="autogenerated_heading_2"></a>9.1. Additional volume configuration
|
|
302
|
-
|
|
303
|
-
**Title:** Additional volume configuration
|
|
304
|
-
|
|
305
|
-
| | |
|
|
306
|
-
| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- |
|
|
307
|
-
| **Type** | `object` |
|
|
308
|
-
| **Additional properties** | [](# "Additional Properties of any type are allowed.") |
|
|
309
|
-
|
|
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 | - | - |
|
|
315
|
-
|
|
316
|
-
#### <a name="additionalVolumes_items_name"></a>9.1.1. Property `name`
|
|
317
|
-
|
|
318
|
-
**Title:** Name of the volume
|
|
319
|
-
|
|
320
|
-
| | |
|
|
321
|
-
| ---------------------- | ------------------------------------ |
|
|
322
|
-
| **Type** | `string` |
|
|
323
|
-
| **Same definition as** | [name](#global_imagePullSecret_name) |
|
|
324
|
-
|
|
325
|
-
#### <a name="additionalVolumes_items_volumeMount"></a>9.1.2. Property `volumeMount`
|
|
326
|
-
|
|
327
|
-
**Title:** Volume mount configuration
|
|
328
|
-
|
|
329
|
-
| | |
|
|
330
|
-
| ------------------------- | -------------------------------------------------------------------------------------------------------- |
|
|
331
|
-
| **Type** | `object` |
|
|
332
|
-
| **Additional properties** | [](# "Additional Properties not allowed.") |
|
|
333
|
-
|
|
334
|
-
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|
|
335
|
-
| ---------------------------------------------------------------------------- | ------- | ---------------- | ---------- | ---------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
336
|
-
| + [mountPath](#additionalVolumes_items_volumeMount_mountPath ) | No | string | No | - | Path within a Pod, where the volume should be mounted. |
|
|
337
|
-
| - [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. |
|
|
338
|
-
| - [readOnly](#additionalVolumes_items_volumeMount_readOnly ) | No | boolean | No | - | Whether mounted volume should be in read-only mode. |
|
|
339
|
-
| - [subPath](#additionalVolumes_items_volumeMount_subPath ) | No | string | No | - | Sub-path inside the referenced volume instead of its root. |
|
|
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 |
|
|
341
|
-
|
|
342
|
-
##### <a name="additionalVolumes_items_volumeMount_mountPath"></a>9.1.2.1. Property `mountPath`
|
|
343
|
-
|
|
344
|
-
| | |
|
|
345
|
-
| -------- | -------- |
|
|
346
|
-
| **Type** | `string` |
|
|
347
|
-
|
|
348
|
-
**Description:** Path within a Pod, where the volume should be mounted.
|
|
349
|
-
|
|
350
|
-
| Restrictions | |
|
|
351
|
-
| --------------------------------- | ----------------------------------------------------------------------- |
|
|
352
|
-
| **Must match regular expression** | ```^[^:]*$``` [Test](https://regex101.com/?regex=%5E%5B%5E%3A%5D%2A%24) |
|
|
353
|
-
|
|
354
|
-
##### <a name="additionalVolumes_items_volumeMount_mountPropagation"></a>9.1.2.2. Property `mountPropagation`
|
|
355
|
-
|
|
356
|
-
| | |
|
|
357
|
-
| -------- | ------------------ |
|
|
358
|
-
| **Type** | `enum (of string)` |
|
|
359
|
-
|
|
360
|
-
**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.
|
|
361
|
-
|
|
362
|
-
Must be one of:
|
|
363
|
-
* "None"
|
|
364
|
-
* "HostToContainer"
|
|
365
|
-
|
|
366
|
-
##### <a name="additionalVolumes_items_volumeMount_readOnly"></a>9.1.2.3. Property `readOnly`
|
|
367
|
-
|
|
368
|
-
| | |
|
|
369
|
-
| -------- | --------- |
|
|
370
|
-
| **Type** | `boolean` |
|
|
371
|
-
|
|
372
|
-
**Description:** Whether mounted volume should be in read-only mode.
|
|
373
|
-
|
|
374
|
-
##### <a name="additionalVolumes_items_volumeMount_subPath"></a>9.1.2.4. Property `subPath`
|
|
375
|
-
|
|
376
|
-
| | |
|
|
377
|
-
| -------- | -------- |
|
|
378
|
-
| **Type** | `string` |
|
|
379
|
-
|
|
380
|
-
**Description:** Sub-path inside the referenced volume instead of its root.
|
|
381
|
-
|
|
382
|
-
##### <a name="additionalVolumes_items_volumeMount_subPathExpr"></a>9.1.2.5. Property `subPathExpr`
|
|
383
|
-
|
|
384
|
-
| | |
|
|
385
|
-
| -------- | -------- |
|
|
386
|
-
| **Type** | `string` |
|
|
387
|
-
|
|
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
|
|
389
|
-
|
|
390
|
-
## <a name="resources"></a>10.  Property `resources`
|
|
391
|
-
|
|
392
|
-
**Title:** Pod resources configuration
|
|
393
|
-
|
|
394
|
-
| | |
|
|
395
|
-
| ------------------------- | -------------------------------------------------------------------------------------------------------- |
|
|
396
|
-
| **Type** | `object` |
|
|
397
|
-
| **Additional properties** | [](# "Additional Properties not allowed.") |
|
|
398
|
-
|
|
399
|
-
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|
|
400
|
-
| ---------------------------------- | ------- | ------ | ---------- | ---------- | -------------------------------------------------------------------------------------------------- |
|
|
401
|
-
| + [requests](#resources_requests ) | No | object | No | - | Minimal required resources for the application to operate, that will be reserved for each replica. |
|
|
402
|
-
| + [limits](#resources_limits ) | No | object | No | - | - |
|
|
403
|
-
|
|
404
|
-
### <a name="resources_requests"></a>10.1.  Property `requests`
|
|
405
|
-
|
|
406
|
-
| | |
|
|
407
|
-
| ------------------------- | -------------------------------------------------------------------------------------------------------- |
|
|
408
|
-
| **Type** | `object` |
|
|
409
|
-
| **Additional properties** | [](# "Additional Properties not allowed.") |
|
|
410
|
-
|
|
411
|
-
**Description:** Minimal required resources for the application to operate, that will be reserved for each replica.
|
|
412
|
-
|
|
413
|
-
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|
|
414
|
-
| ------------------------------------------------------------- | ------- | ---------------- | ---------- | ---------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
415
|
-
| + [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 |
|
|
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 |
|
|
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 |
|
|
418
|
-
|
|
419
|
-
#### <a name="resources_requests_cpu"></a>10.1.1.  Property `cpu`
|
|
420
|
-
|
|
421
|
-
| | |
|
|
422
|
-
| -------- | ------------------ |
|
|
423
|
-
| **Type** | `string or number` |
|
|
424
|
-
|
|
425
|
-
**Description:** CPU resource units, as described here https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/#meaning-of-cpu
|
|
426
|
-
|
|
427
|
-
#### <a name="resources_requests_ephemeral-storage"></a>10.1.2.  Property `ephemeral-storage`
|
|
428
|
-
|
|
429
|
-
| | |
|
|
430
|
-
| -------- | -------- |
|
|
431
|
-
| **Type** | `string` |
|
|
432
|
-
|
|
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
|
|
434
|
-
|
|
435
|
-
#### <a name="resources_requests_memory"></a>10.1.3.  Property `memory`
|
|
436
|
-
|
|
437
|
-
| | |
|
|
438
|
-
| -------- | -------- |
|
|
439
|
-
| **Type** | `string` |
|
|
440
|
-
|
|
441
|
-
**Description:** Amount of memory, mesaured in bytes. For more info, see https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/#meaning-of-memory
|
|
442
|
-
|
|
443
|
-
### <a name="resources_limits"></a>10.2.  Property `limits`
|
|
444
|
-
|
|
445
|
-
| | |
|
|
446
|
-
| ------------------------- | -------------------------------------------------------------------------------------------------------- |
|
|
447
|
-
| **Type** | `object` |
|
|
448
|
-
| **Additional properties** | [](# "Additional Properties not allowed.") |
|
|
449
|
-
|
|
450
|
-
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|
|
451
|
-
| ----------------------------------------------------------- | ------- | ---------------- | ---------- | ---------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
452
|
-
| - [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 |
|
|
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 |
|
|
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 |
|
|
455
|
-
|
|
456
|
-
#### <a name="resources_limits_cpu"></a>10.2.1.  Property `cpu`
|
|
457
|
-
|
|
458
|
-
| | |
|
|
459
|
-
| -------- | ------------------ |
|
|
460
|
-
| **Type** | `string or number` |
|
|
461
|
-
|
|
462
|
-
**Description:** CPU resource units, as described here https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/#meaning-of-cpu
|
|
463
|
-
|
|
464
|
-
#### <a name="resources_limits_ephemeral-storage"></a>10.2.2.  Property `ephemeral-storage`
|
|
465
|
-
|
|
466
|
-
| | |
|
|
467
|
-
| -------- | -------- |
|
|
468
|
-
| **Type** | `string` |
|
|
469
|
-
|
|
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
|
|
471
|
-
|
|
472
|
-
#### <a name="resources_limits_memory"></a>10.2.3.  Property `memory`
|
|
473
|
-
|
|
474
|
-
| | |
|
|
475
|
-
| -------- | -------- |
|
|
476
|
-
| **Type** | `string` |
|
|
477
|
-
|
|
478
|
-
**Description:** Amount of memory, mesaured in bytes. For more info, see https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/#meaning-of-memory
|
|
479
|
-
|
|
480
|
-
## <a name="availability"></a>11.  Property `availability`
|
|
481
|
-
|
|
482
|
-
**Title:** Availability related configuration
|
|
483
|
-
|
|
484
|
-
| | |
|
|
485
|
-
| ------------------------- | -------------------------------------------------------------------------------------------------------- |
|
|
486
|
-
| **Type** | `object` |
|
|
487
|
-
| **Additional properties** | [](# "Additional Properties not allowed.") |
|
|
488
|
-
|
|
489
|
-
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|
|
490
|
-
| ----------------------------------------------------------------------- | ------- | ------ | ---------- | ---------- | ------------------------------------------------- |
|
|
491
|
-
| - [podDisruptionBudget](#availability_podDisruptionBudget ) | No | object | No | - | The max disruption to the pods. |
|
|
492
|
-
| - [topologySpreadConstraints](#availability_topologySpreadConstraints ) | No | object | No | - | How pods ought to spread across topology domains. |
|
|
493
|
-
|
|
494
|
-
### <a name="availability_podDisruptionBudget"></a>11.1.  Property `podDisruptionBudget`
|
|
495
|
-
|
|
496
|
-
| | |
|
|
497
|
-
| ------------------------- | -------------------------------------------------------------------------------------------------------- |
|
|
498
|
-
| **Type** | `object` |
|
|
499
|
-
| **Additional properties** | [](# "Additional Properties not allowed.") |
|
|
500
|
-
|
|
501
|
-
**Description:** The max disruption to the pods.
|
|
502
|
-
|
|
503
|
-
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|
|
504
|
-
| --------------------------------------------------------------------- | ------- | ------ | ---------- | ---------- | --------------------------------------------------------------- |
|
|
505
|
-
| - [maxUnavailable](#availability_podDisruptionBudget_maxUnavailable ) | No | string | No | - | An eviction is allowed if this maximum of pods are unavailable. |
|
|
506
|
-
|
|
507
|
-
#### <a name="availability_podDisruptionBudget_maxUnavailable"></a>11.1.1.  Property `maxUnavailable`
|
|
508
|
-
|
|
509
|
-
| | |
|
|
510
|
-
| ----------- | -------- |
|
|
511
|
-
| **Type** | `string` |
|
|
512
|
-
| **Default** | `"10%"` |
|
|
513
|
-
|
|
514
|
-
**Description:** An eviction is allowed if this maximum of pods are unavailable.
|
|
515
|
-
|
|
516
|
-
### <a name="availability_topologySpreadConstraints"></a>11.2.  Property `topologySpreadConstraints`
|
|
517
|
-
|
|
518
|
-
| | |
|
|
519
|
-
| ------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
520
|
-
| **Type** | `object` |
|
|
521
|
-
| **Additional properties** | [](# "Additional Properties of any type are allowed.") |
|
|
522
|
-
| **Default** | `[{"maxSkew": 1, "topologyKey": "topology.kubernetes.io/zone", "whenUnsatisfiable": "ScheduleAnyway"}, {"maxSkew": 1, "topologyKey": "kubernetes.io/hostname", "whenUnsatisfiable": "ScheduleAnyway"}]` |
|
|
523
|
-
|
|
524
|
-
**Description:** How pods ought to spread across topology domains.
|
|
525
|
-
|
|
526
|
-
## <a name="health"></a>12.  Property `health`
|
|
527
|
-
|
|
528
|
-
**Title:** Health-check configuration
|
|
529
|
-
|
|
530
|
-
| | |
|
|
531
|
-
| ------------------------- | -------------------------------------------------------------------------------------------------------- |
|
|
532
|
-
| **Type** | `object` |
|
|
533
|
-
| **Additional properties** | [](# "Additional Properties not allowed.") |
|
|
534
|
-
|
|
535
|
-
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|
|
536
|
-
| --------------------------------- | ------- | ------ | ---------- | ---------- | ------------------------------ |
|
|
537
|
-
| - [liveness](#health_liveness ) | No | object | No | - | Liveness-probe configuration. |
|
|
538
|
-
| - [readiness](#health_readiness ) | No | object | No | - | Readiness-probe configuration. |
|
|
539
|
-
|
|
540
|
-
### <a name="health_liveness"></a>12.1.  Property `liveness`
|
|
541
|
-
|
|
542
|
-
| | |
|
|
543
|
-
| ------------------------- | -------------------------------------------------------------------------------------------------------- |
|
|
544
|
-
| **Type** | `object` |
|
|
545
|
-
| **Additional properties** | [](# "Additional Properties not allowed.") |
|
|
546
|
-
|
|
547
|
-
**Description:** Liveness-probe configuration.
|
|
548
|
-
|
|
549
|
-
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|
|
550
|
-
| -------------------------------- | ------- | ------ | ---------- | ---------- | -------------------------------------------------------------- |
|
|
551
|
-
| - [path](#health_liveness_path ) | No | string | No | - | HTTP path used by Kubernetes, to perform liveness-probe calls. |
|
|
552
|
-
|
|
553
|
-
#### <a name="health_liveness_path"></a>12.1.1.  Property `path`
|
|
554
|
-
|
|
555
|
-
| | |
|
|
556
|
-
| ----------- | ------------ |
|
|
557
|
-
| **Type** | `string` |
|
|
558
|
-
| **Default** | `"/healthz"` |
|
|
559
|
-
|
|
560
|
-
**Description:** HTTP path used by Kubernetes, to perform liveness-probe calls.
|
|
561
|
-
|
|
562
|
-
### <a name="health_readiness"></a>12.2.  Property `readiness`
|
|
563
|
-
|
|
564
|
-
| | |
|
|
565
|
-
| ------------------------- | -------------------------------------------------------------------------------------------------------- |
|
|
566
|
-
| **Type** | `object` |
|
|
567
|
-
| **Additional properties** | [](# "Additional Properties not allowed.") |
|
|
568
|
-
|
|
569
|
-
**Description:** Readiness-probe configuration.
|
|
570
|
-
|
|
571
|
-
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|
|
572
|
-
| --------------------------------- | ------- | ------ | ---------- | ---------- | --------------------------------------------------------------- |
|
|
573
|
-
| - [path](#health_readiness_path ) | No | string | No | - | HTTP path used by Kubernetes, to perform readiness-probe calls. |
|
|
574
|
-
|
|
575
|
-
#### <a name="health_readiness_path"></a>12.2.1.  Property `path`
|
|
576
|
-
|
|
577
|
-
| | |
|
|
578
|
-
| ----------- | ------------ |
|
|
579
|
-
| **Type** | `string` |
|
|
580
|
-
| **Default** | `"/healthz"` |
|
|
581
|
-
|
|
582
|
-
**Description:** HTTP path used by Kubernetes, to perform readiness-probe calls.
|
|
583
|
-
|
|
584
|
-
## <a name="startupTimeoutSeconds"></a>13.  Property `startupTimeoutSeconds`
|
|
585
|
-
|
|
586
|
-
| | |
|
|
587
|
-
| ----------- | --------- |
|
|
588
|
-
| **Type** | `integer` |
|
|
589
|
-
| **Default** | `30` |
|
|
590
|
-
|
|
591
|
-
**Description:** Initial timeout in seconds, during which the app must start giving the response to the liveness-probe.
|
|
592
|
-
|
|
593
|
-
| Restrictions | |
|
|
594
|
-
| ------------ | ------ |
|
|
595
|
-
| **Minimum** | ≥ 1 |
|
|
596
|
-
|
|
597
|
-
## <a name="readOnlyRootFilesystem"></a>14.  Property `readOnlyRootFilesystem`
|
|
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`
|
|
606
|
-
|
|
607
|
-
| | |
|
|
608
|
-
| ----------- | --------- |
|
|
609
|
-
| **Type** | `integer` |
|
|
610
|
-
| **Default** | `30` |
|
|
611
|
-
|
|
612
|
-
**Description:** Time in seconds after which the pod will be forcefully stopped after receiving SIGTERM.
|
|
613
|
-
|
|
614
|
-
| Restrictions | |
|
|
615
|
-
| ------------ | ------ |
|
|
616
|
-
| **Minimum** | ≥ 0 |
|
|
617
|
-
|
|
618
|
-
## <a name="env"></a>16.  Property `env`
|
|
619
|
-
|
|
620
|
-
| | |
|
|
621
|
-
| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- |
|
|
622
|
-
| **Type** | `combining` |
|
|
623
|
-
| **Additional properties** | [](# "Additional Properties of any type are allowed.") |
|
|
624
|
-
| **Default** | `{}` |
|
|
625
|
-
|
|
626
|
-
**Description:** Key-value map of environment variables, which should be added to the Pod spec.
|
|
627
|
-
|
|
628
|
-
| Any of(Option) |
|
|
629
|
-
| ----------------------- |
|
|
630
|
-
| [item 0](#env_anyOf_i0) |
|
|
631
|
-
| [item 1](#env_anyOf_i1) |
|
|
632
|
-
|
|
633
|
-
### <a name="env_anyOf_i0"></a>16.1. Property `item 0`
|
|
634
|
-
|
|
635
|
-
| | |
|
|
636
|
-
| ------------------------- | -------------------------------------------------------------------------------------------------------- |
|
|
637
|
-
| **Type** | `object` |
|
|
638
|
-
| **Additional properties** | [](# "Additional Properties not allowed.") |
|
|
639
|
-
| **Default** | `{}` |
|
|
640
|
-
|
|
641
|
-
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|
|
642
|
-
| --------------------------------------------------------- | ------- | ----------- | ---------- | ---------- | ----------------- |
|
|
643
|
-
| - [^[-._a-zA-Z][-._a-zA-Z0-9]*$](#env_anyOf_i0_pattern1 ) | Yes | Combination | No | - | - |
|
|
644
|
-
|
|
645
|
-
#### <a name="env_anyOf_i0_pattern1"></a>16.1.1. Pattern Property `^[-._a-zA-Z][-._a-zA-Z0-9]*$`
|
|
646
|
-
> All properties whose name matches the regular expression
|
|
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))
|
|
648
|
-
must respect the following conditions
|
|
649
|
-
|
|
650
|
-
| | |
|
|
651
|
-
| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- |
|
|
652
|
-
| **Type** | `combining` |
|
|
653
|
-
| **Additional properties** | [](# "Additional Properties of any type are allowed.") |
|
|
654
|
-
|
|
655
|
-
| Any of(Option) |
|
|
656
|
-
| -------------------------------------------- |
|
|
657
|
-
| [item 0](#env_anyOf_i0_pattern1_pattern2_i0) |
|
|
658
|
-
| [item 1](#env_anyOf_i0_pattern1_pattern2_i1) |
|
|
659
|
-
|
|
660
|
-
##### <a name="env_anyOf_i0_pattern1_pattern2_i0"></a>16.1.1.1. Property `item 0`
|
|
661
|
-
|
|
662
|
-
| | |
|
|
663
|
-
| -------- | ------------------- |
|
|
664
|
-
| **Type** | `integer or string` |
|
|
665
|
-
|
|
666
|
-
**Description:** Plain value of an environment variable.
|
|
667
|
-
|
|
668
|
-
##### <a name="env_anyOf_i0_pattern1_pattern2_i1"></a>16.1.1.2. Property `item 1`
|
|
669
|
-
|
|
670
|
-
| | |
|
|
671
|
-
| ------------------------- | -------------------------------------------------------------------------------------------------------- |
|
|
672
|
-
| **Type** | `object` |
|
|
673
|
-
| **Additional properties** | [](# "Additional Properties not allowed.") |
|
|
674
|
-
|
|
675
|
-
**Description:** `valueFrom` configuration for the environment variable https://kubernetes.io/docs/tasks/inject-data-application/environment-variable-expose-pod-information/
|
|
676
|
-
|
|
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. |
|
|
683
|
-
|
|
684
|
-
##### <a name="env_anyOf_i0_pattern1_pattern2_i1_configMapKeyRef"></a>16.1.1.2.1. Property `configMapKeyRef`
|
|
685
|
-
|
|
686
|
-
| | |
|
|
687
|
-
| ------------------------- | -------------------------------------------------------------------------------------------------------- |
|
|
688
|
-
| **Type** | `object` |
|
|
689
|
-
| **Additional properties** | [](# "Additional Properties not allowed.") |
|
|
690
|
-
|
|
691
|
-
**Description:** Selects a key of a ConfigMap.
|
|
692
|
-
|
|
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. |
|
|
697
|
-
|
|
698
|
-
##### <a name="env_anyOf_i0_pattern1_pattern2_i1_configMapKeyRef_name"></a>16.1.1.2.1.1. Property `name`
|
|
699
|
-
|
|
700
|
-
| | |
|
|
701
|
-
| -------- | -------- |
|
|
702
|
-
| **Type** | `string` |
|
|
703
|
-
|
|
704
|
-
**Description:** Name of a ConfigMap.
|
|
705
|
-
|
|
706
|
-
##### <a name="env_anyOf_i0_pattern1_pattern2_i1_configMapKeyRef_key"></a>16.1.1.2.1.2. Property `key`
|
|
707
|
-
|
|
708
|
-
| | |
|
|
709
|
-
| -------- | -------- |
|
|
710
|
-
| **Type** | `string` |
|
|
711
|
-
|
|
712
|
-
**Description:** Key in that ConfigMap, which value will be used.
|
|
713
|
-
|
|
714
|
-
##### <a name="env_anyOf_i0_pattern1_pattern2_i1_secretKeyRef"></a>16.1.1.2.2. Property `secretKeyRef`
|
|
715
|
-
|
|
716
|
-
| | |
|
|
717
|
-
| ------------------------- | -------------------------------------------------------------------------------------------------------- |
|
|
718
|
-
| **Type** | `object` |
|
|
719
|
-
| **Additional properties** | [](# "Additional Properties not allowed.") |
|
|
720
|
-
|
|
721
|
-
**Description:** Selects a key of a Secret.
|
|
722
|
-
|
|
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. |
|
|
727
|
-
|
|
728
|
-
##### <a name="env_anyOf_i0_pattern1_pattern2_i1_secretKeyRef_name"></a>16.1.1.2.2.1. Property `name`
|
|
729
|
-
|
|
730
|
-
| | |
|
|
731
|
-
| -------- | -------- |
|
|
732
|
-
| **Type** | `string` |
|
|
733
|
-
|
|
734
|
-
**Description:** Name of a Secret.
|
|
735
|
-
|
|
736
|
-
##### <a name="env_anyOf_i0_pattern1_pattern2_i1_secretKeyRef_key"></a>16.1.1.2.2.2. Property `key`
|
|
737
|
-
|
|
738
|
-
| | |
|
|
739
|
-
| -------- | -------- |
|
|
740
|
-
| **Type** | `string` |
|
|
741
|
-
|
|
742
|
-
**Description:** Key in that Secret, which value will be used.
|
|
743
|
-
|
|
744
|
-
##### <a name="env_anyOf_i0_pattern1_pattern2_i1_resourceFieldRef"></a>16.1.1.2.3. Property `resourceFieldRef`
|
|
745
|
-
|
|
746
|
-
| | |
|
|
747
|
-
| ------------------------- | -------------------------------------------------------------------------------------------------------- |
|
|
748
|
-
| **Type** | `object` |
|
|
749
|
-
| **Additional properties** | [](# "Additional Properties not allowed.") |
|
|
750
|
-
|
|
751
|
-
**Description:** Selects a resource of the container.
|
|
752
|
-
|
|
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. |
|
|
757
|
-
|
|
758
|
-
##### <a name="env_anyOf_i0_pattern1_pattern2_i1_resourceFieldRef_containerName"></a>16.1.1.2.3.1. Property `containerName`
|
|
759
|
-
|
|
760
|
-
| | |
|
|
761
|
-
| ---------------------- | ------------------------------------ |
|
|
762
|
-
| **Type** | `string` |
|
|
763
|
-
| **Same definition as** | [name](#global_imagePullSecret_name) |
|
|
764
|
-
|
|
765
|
-
**Description:** Name of a Container.
|
|
766
|
-
|
|
767
|
-
##### <a name="env_anyOf_i0_pattern1_pattern2_i1_resourceFieldRef_resource"></a>16.1.1.2.3.2. Property `resource`
|
|
768
|
-
|
|
769
|
-
| | |
|
|
770
|
-
| -------- | -------- |
|
|
771
|
-
| **Type** | `string` |
|
|
772
|
-
|
|
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.
|
|
774
|
-
|
|
775
|
-
##### <a name="env_anyOf_i0_pattern1_pattern2_i1_fieldRef"></a>16.1.1.2.4. Property `fieldRef`
|
|
776
|
-
|
|
777
|
-
| | |
|
|
778
|
-
| ------------------------- | -------------------------------------------------------------------------------------------------------- |
|
|
779
|
-
| **Type** | `object` |
|
|
780
|
-
| **Additional properties** | [](# "Additional Properties not allowed.") |
|
|
781
|
-
|
|
782
|
-
**Description:** Selects a field of the pod.
|
|
783
|
-
|
|
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. |
|
|
787
|
-
|
|
788
|
-
##### <a name="env_anyOf_i0_pattern1_pattern2_i1_fieldRef_fieldPath"></a>16.1.1.2.4.1. Property `fieldPath`
|
|
789
|
-
|
|
790
|
-
| | |
|
|
791
|
-
| -------- | -------- |
|
|
792
|
-
| **Type** | `string` |
|
|
793
|
-
|
|
794
|
-
**Description:** Supports metadata.name, metadata.namespace, `metadata.labels['<KEY>']`, `metadata.annotations['<KEY>']`, spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs.
|
|
795
|
-
|
|
796
|
-
### <a name="env_anyOf_i1"></a>16.2. Property `item 1`
|
|
797
|
-
|
|
798
|
-
| | |
|
|
799
|
-
| -------- | ----------------- |
|
|
800
|
-
| **Type** | `array of object` |
|
|
801
|
-
|
|
802
|
-
| Each item of this array must be | Description |
|
|
803
|
-
| ----------------------------------- | ----------- |
|
|
804
|
-
| [item 1 items](#env_anyOf_i1_items) | - |
|
|
805
|
-
|
|
806
|
-
#### <a name="autogenerated_heading_3"></a>16.2.1. item 1 items
|
|
807
|
-
|
|
808
|
-
| | |
|
|
809
|
-
| ------------------------- | -------------------------------------------------------------------------------------------------------- |
|
|
810
|
-
| **Type** | `object` |
|
|
811
|
-
| **Additional properties** | [](# "Additional Properties not allowed.") |
|
|
812
|
-
|
|
813
|
-
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|
|
814
|
-
| ----------------------------------------------------------- | ------- | ----------------- | ---------- | ---------- | ------------------------------------ |
|
|
815
|
-
| + [name](#env_anyOf_i1_items_name ) | No | string | No | - | - |
|
|
816
|
-
| - [value](#env_anyOf_i1_items_value ) | No | string or integer | No | - | - |
|
|
817
|
-
| - [configMapKeyRef](#env_anyOf_i1_items_configMapKeyRef ) | No | object | No | - | Selects a key of a ConfigMap. |
|
|
818
|
-
| - [secretKeyRef](#env_anyOf_i1_items_secretKeyRef ) | No | object | No | - | Selects a key of a Secret. |
|
|
819
|
-
| - [resourceFieldRef](#env_anyOf_i1_items_resourceFieldRef ) | No | object | No | - | Selects a resource of the container. |
|
|
820
|
-
| - [fieldRef](#env_anyOf_i1_items_fieldRef ) | No | object | No | - | Selects a field of the pod. |
|
|
821
|
-
|
|
822
|
-
##### <a name="env_anyOf_i1_items_name"></a>16.2.1.1. Property `name`
|
|
823
|
-
|
|
824
|
-
| | |
|
|
825
|
-
| -------- | -------- |
|
|
826
|
-
| **Type** | `string` |
|
|
827
|
-
|
|
828
|
-
| Restrictions | |
|
|
829
|
-
| --------------------------------- | ----------------------------------------------------------------------------------------------------------------- |
|
|
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) |
|
|
831
|
-
|
|
832
|
-
##### <a name="env_anyOf_i1_items_value"></a>16.2.1.2. Property `value`
|
|
833
|
-
|
|
834
|
-
| | |
|
|
835
|
-
| -------- | ------------------- |
|
|
836
|
-
| **Type** | `string or integer` |
|
|
837
|
-
|
|
838
|
-
##### <a name="env_anyOf_i1_items_configMapKeyRef"></a>16.2.1.3. Property `configMapKeyRef`
|
|
839
|
-
|
|
840
|
-
| | |
|
|
841
|
-
| ------------------------- | -------------------------------------------------------------------------------------------------------- |
|
|
842
|
-
| **Type** | `object` |
|
|
843
|
-
| **Additional properties** | [](# "Additional Properties not allowed.") |
|
|
844
|
-
|
|
845
|
-
**Description:** Selects a key of a ConfigMap.
|
|
846
|
-
|
|
847
|
-
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|
|
848
|
-
| --------------------------------------------------- | ------- | ------ | ---------- | ---------- | ------------------------------------------------ |
|
|
849
|
-
| - [name](#env_anyOf_i1_items_configMapKeyRef_name ) | No | string | No | - | Name of a ConfigMap. |
|
|
850
|
-
| - [key](#env_anyOf_i1_items_configMapKeyRef_key ) | No | string | No | - | Key in that ConfigMap, which value will be used. |
|
|
851
|
-
|
|
852
|
-
##### <a name="env_anyOf_i1_items_configMapKeyRef_name"></a>16.2.1.3.1. Property `name`
|
|
853
|
-
|
|
854
|
-
| | |
|
|
855
|
-
| -------- | -------- |
|
|
856
|
-
| **Type** | `string` |
|
|
857
|
-
|
|
858
|
-
**Description:** Name of a ConfigMap.
|
|
859
|
-
|
|
860
|
-
##### <a name="env_anyOf_i1_items_configMapKeyRef_key"></a>16.2.1.3.2. Property `key`
|
|
861
|
-
|
|
862
|
-
| | |
|
|
863
|
-
| -------- | -------- |
|
|
864
|
-
| **Type** | `string` |
|
|
865
|
-
|
|
866
|
-
**Description:** Key in that ConfigMap, which value will be used.
|
|
867
|
-
|
|
868
|
-
##### <a name="env_anyOf_i1_items_secretKeyRef"></a>16.2.1.4. Property `secretKeyRef`
|
|
869
|
-
|
|
870
|
-
| | |
|
|
871
|
-
| ------------------------- | -------------------------------------------------------------------------------------------------------- |
|
|
872
|
-
| **Type** | `object` |
|
|
873
|
-
| **Additional properties** | [](# "Additional Properties not allowed.") |
|
|
874
|
-
|
|
875
|
-
**Description:** Selects a key of a Secret.
|
|
876
|
-
|
|
877
|
-
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|
|
878
|
-
| ------------------------------------------------ | ------- | ------ | ---------- | ---------- | --------------------------------------------- |
|
|
879
|
-
| - [name](#env_anyOf_i1_items_secretKeyRef_name ) | No | string | No | - | Name of a Secret. |
|
|
880
|
-
| - [key](#env_anyOf_i1_items_secretKeyRef_key ) | No | string | No | - | Key in that Secret, which value will be used. |
|
|
881
|
-
|
|
882
|
-
##### <a name="env_anyOf_i1_items_secretKeyRef_name"></a>16.2.1.4.1. Property `name`
|
|
883
|
-
|
|
884
|
-
| | |
|
|
885
|
-
| -------- | -------- |
|
|
886
|
-
| **Type** | `string` |
|
|
887
|
-
|
|
888
|
-
**Description:** Name of a Secret.
|
|
889
|
-
|
|
890
|
-
##### <a name="env_anyOf_i1_items_secretKeyRef_key"></a>16.2.1.4.2. Property `key`
|
|
891
|
-
|
|
892
|
-
| | |
|
|
893
|
-
| -------- | -------- |
|
|
894
|
-
| **Type** | `string` |
|
|
895
|
-
|
|
896
|
-
**Description:** Key in that Secret, which value will be used.
|
|
897
|
-
|
|
898
|
-
##### <a name="env_anyOf_i1_items_resourceFieldRef"></a>16.2.1.5. Property `resourceFieldRef`
|
|
899
|
-
|
|
900
|
-
| | |
|
|
901
|
-
| ------------------------- | -------------------------------------------------------------------------------------------------------- |
|
|
902
|
-
| **Type** | `object` |
|
|
903
|
-
| **Additional properties** | [](# "Additional Properties not allowed.") |
|
|
904
|
-
|
|
905
|
-
**Description:** Selects a resource of the container.
|
|
906
|
-
|
|
907
|
-
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|
|
908
|
-
| ---------------------------------------------------------------------- | ------- | ------ | ---------- | --------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
909
|
-
| - [containerName](#env_anyOf_i1_items_resourceFieldRef_containerName ) | No | string | No | Same as [name](#global_imagePullSecret_name ) | Name of a Container. |
|
|
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. |
|
|
911
|
-
|
|
912
|
-
##### <a name="env_anyOf_i1_items_resourceFieldRef_containerName"></a>16.2.1.5.1. Property `containerName`
|
|
913
|
-
|
|
914
|
-
| | |
|
|
915
|
-
| ---------------------- | ------------------------------------ |
|
|
916
|
-
| **Type** | `string` |
|
|
917
|
-
| **Same definition as** | [name](#global_imagePullSecret_name) |
|
|
918
|
-
|
|
919
|
-
**Description:** Name of a Container.
|
|
920
|
-
|
|
921
|
-
##### <a name="env_anyOf_i1_items_resourceFieldRef_resource"></a>16.2.1.5.2. Property `resource`
|
|
922
|
-
|
|
923
|
-
| | |
|
|
924
|
-
| -------- | -------- |
|
|
925
|
-
| **Type** | `string` |
|
|
926
|
-
|
|
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.
|
|
928
|
-
|
|
929
|
-
##### <a name="env_anyOf_i1_items_fieldRef"></a>16.2.1.6. Property `fieldRef`
|
|
930
|
-
|
|
931
|
-
| | |
|
|
932
|
-
| ------------------------- | -------------------------------------------------------------------------------------------------------- |
|
|
933
|
-
| **Type** | `object` |
|
|
934
|
-
| **Additional properties** | [](# "Additional Properties not allowed.") |
|
|
935
|
-
|
|
936
|
-
**Description:** Selects a field of the pod.
|
|
937
|
-
|
|
938
|
-
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|
|
939
|
-
| ------------------------------------------------------ | ------- | ------ | ---------- | ---------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
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. |
|
|
941
|
-
|
|
942
|
-
##### <a name="env_anyOf_i1_items_fieldRef_fieldPath"></a>16.2.1.6.1. Property `fieldPath`
|
|
943
|
-
|
|
944
|
-
| | |
|
|
945
|
-
| -------- | -------- |
|
|
946
|
-
| **Type** | `string` |
|
|
947
|
-
|
|
948
|
-
**Description:** Supports metadata.name, metadata.namespace, `metadata.labels['<KEY>']`, `metadata.annotations['<KEY>']`, spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs.
|
|
949
|
-
|
|
950
|
-
## <a name="envFrom"></a>17.  Property `envFrom`
|
|
951
|
-
|
|
952
|
-
| | |
|
|
953
|
-
| ----------- | ----------------- |
|
|
954
|
-
| **Type** | `array of object` |
|
|
955
|
-
| **Default** | `[]` |
|
|
956
|
-
|
|
957
|
-
**Description:** List of sources to populate environment variables in the pod.
|
|
958
|
-
|
|
959
|
-
| Each item of this array must be | Description |
|
|
960
|
-
| ------------------------------- | ----------- |
|
|
961
|
-
| [envFrom items](#envFrom_items) | - |
|
|
962
|
-
|
|
963
|
-
### <a name="autogenerated_heading_4"></a>17.1. envFrom items
|
|
964
|
-
|
|
965
|
-
| | |
|
|
966
|
-
| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- |
|
|
967
|
-
| **Type** | `combining` |
|
|
968
|
-
| **Additional properties** | [](# "Additional Properties of any type are allowed.") |
|
|
969
|
-
|
|
970
|
-
| One of(Option) |
|
|
971
|
-
| --------------------------------- |
|
|
972
|
-
| [item 0](#envFrom_items_oneOf_i0) |
|
|
973
|
-
| [item 1](#envFrom_items_oneOf_i1) |
|
|
974
|
-
|
|
975
|
-
#### <a name="envFrom_items_oneOf_i0"></a>17.1.1. Property `item 0`
|
|
976
|
-
|
|
977
|
-
| | |
|
|
978
|
-
| ------------------------- | -------------------------------------------------------------------------------------------------------- |
|
|
979
|
-
| **Type** | `object` |
|
|
980
|
-
| **Additional properties** | [](# "Additional Properties not allowed.") |
|
|
981
|
-
|
|
982
|
-
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|
|
983
|
-
| ------------------------------------------------------- | ------- | ------ | ---------- | ---------- | -------------------------------------------------------------------------------------------------------------- |
|
|
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. |
|
|
985
|
-
|
|
986
|
-
##### <a name="envFrom_items_oneOf_i0_configMapRef"></a>17.1.1.1. Property `configMapRef`
|
|
987
|
-
|
|
988
|
-
| | |
|
|
989
|
-
| ------------------------- | -------------------------------------------------------------------------------------------------------- |
|
|
990
|
-
| **Type** | `object` |
|
|
991
|
-
| **Additional properties** | [](# "Additional Properties not allowed.") |
|
|
992
|
-
|
|
993
|
-
**Description:** The contents of the target ConfigMap's Data field will represent the key-value pairs as environment variables.
|
|
994
|
-
|
|
995
|
-
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|
|
996
|
-
| ---------------------------------------------------- | ------- | ------ | ---------- | ---------- | -------------------- |
|
|
997
|
-
| + [name](#envFrom_items_oneOf_i0_configMapRef_name ) | No | string | No | - | Name of a ConfigMap. |
|
|
998
|
-
|
|
999
|
-
##### <a name="envFrom_items_oneOf_i0_configMapRef_name"></a>17.1.1.1.1. Property `name`
|
|
1000
|
-
|
|
1001
|
-
| | |
|
|
1002
|
-
| -------- | -------- |
|
|
1003
|
-
| **Type** | `string` |
|
|
1004
|
-
|
|
1005
|
-
**Description:** Name of a ConfigMap.
|
|
1006
|
-
|
|
1007
|
-
#### <a name="envFrom_items_oneOf_i1"></a>17.1.2. Property `item 1`
|
|
1008
|
-
|
|
1009
|
-
| | |
|
|
1010
|
-
| ------------------------- | -------------------------------------------------------------------------------------------------------- |
|
|
1011
|
-
| **Type** | `object` |
|
|
1012
|
-
| **Additional properties** | [](# "Additional Properties not allowed.") |
|
|
1013
|
-
|
|
1014
|
-
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|
|
1015
|
-
| ------------------------------------------------- | ------- | ------ | ---------- | ---------- | ----------------------------------------------------------------------------------------------------------- |
|
|
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. |
|
|
1017
|
-
|
|
1018
|
-
##### <a name="envFrom_items_oneOf_i1_secretRef"></a>17.1.2.1. Property `secretRef`
|
|
1019
|
-
|
|
1020
|
-
| | |
|
|
1021
|
-
| ------------------------- | -------------------------------------------------------------------------------------------------------- |
|
|
1022
|
-
| **Type** | `object` |
|
|
1023
|
-
| **Additional properties** | [](# "Additional Properties not allowed.") |
|
|
1024
|
-
|
|
1025
|
-
**Description:** The contents of the target Secret's Data field will represent the key-value pairs as environment variables.
|
|
1026
|
-
|
|
1027
|
-
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|
|
1028
|
-
| ------------------------------------------------- | ------- | ------ | ---------- | ---------- | ----------------- |
|
|
1029
|
-
| + [name](#envFrom_items_oneOf_i1_secretRef_name ) | No | string | No | - | Name of a Secret. |
|
|
1030
|
-
|
|
1031
|
-
##### <a name="envFrom_items_oneOf_i1_secretRef_name"></a>17.1.2.1.1. Property `name`
|
|
1032
|
-
|
|
1033
|
-
| | |
|
|
1034
|
-
| -------- | -------- |
|
|
1035
|
-
| **Type** | `string` |
|
|
1036
|
-
|
|
1037
|
-
**Description:** Name of a Secret.
|
|
1038
|
-
|
|
1039
|
-
## <a name="expose"></a>18.  Property `expose`
|
|
1040
|
-
|
|
1041
|
-
| | |
|
|
1042
|
-
| ------------------------- | -------------------------------------------------------------------------------------------------------- |
|
|
1043
|
-
| **Type** | `object` |
|
|
1044
|
-
| **Additional properties** | [](# "Additional Properties not allowed.") |
|
|
1045
|
-
|
|
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. |
|
|
1052
|
-
|
|
1053
|
-
### <a name="expose_host"></a>18.1.  Property `host`
|
|
1054
|
-
|
|
1055
|
-
| | |
|
|
1056
|
-
| -------- | -------- |
|
|
1057
|
-
| **Type** | `string` |
|
|
1058
|
-
|
|
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.
|
|
1060
|
-
|
|
1061
|
-
### <a name="expose_enabled"></a>18.2.  Property `enabled`
|
|
1062
|
-
|
|
1063
|
-
| | |
|
|
1064
|
-
| ----------- | --------- |
|
|
1065
|
-
| **Type** | `boolean` |
|
|
1066
|
-
| **Default** | `true` |
|
|
1067
|
-
|
|
1068
|
-
**Description:** Expose the application to the internet.
|
|
1069
|
-
|
|
1070
|
-
### <a name="expose_gateway"></a>18.3.  Property `gateway`
|
|
1071
|
-
|
|
1072
|
-
| | |
|
|
1073
|
-
| ----------- | ---------------------------------------------- |
|
|
1074
|
-
| **Type** | `string` |
|
|
1075
|
-
| **Default** | `"kyma-gateway.kyma-system.svc.cluster.local"` |
|
|
1076
|
-
|
|
1077
|
-
**Description:** Use this istio gateway for incoming traffic.
|
|
1078
|
-
|
|
1079
|
-
### <a name="expose_rules"></a>18.4.  Property `rules`
|
|
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
|
|
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`
|
|
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
|
-
| - [additionalPorts](#networkSecurity_additionalPorts ) | No | array of integer | No | - | - |
|
|
1115
|
-
| - [ingress](#networkSecurity_ingress ) | No | array of object | No | - | - |
|
|
1116
|
-
|
|
1117
|
-
### <a name="networkSecurity_enabled"></a>19.1.  Property `enabled`
|
|
1118
|
-
|
|
1119
|
-
| | |
|
|
1120
|
-
| ----------- | --------- |
|
|
1121
|
-
| **Type** | `boolean` |
|
|
1122
|
-
| **Default** | `true` |
|
|
1123
|
-
|
|
1124
|
-
### <a name="networkSecurity_allowNamespaceInternal"></a>19.2.  Property `allowNamespaceInternal`
|
|
1125
|
-
|
|
1126
|
-
| | |
|
|
1127
|
-
| -------- | --------- |
|
|
1128
|
-
| **Type** | `boolean` |
|
|
1129
|
-
|
|
1130
|
-
### <a name="networkSecurity_additionalPorts"></a>19.3.  Property `additionalPorts`
|
|
1131
|
-
|
|
1132
|
-
| | |
|
|
1133
|
-
| ----------- | ------------------ |
|
|
1134
|
-
| **Type** | `array of integer` |
|
|
1135
|
-
| **Default** | `[]` |
|
|
1136
|
-
|
|
1137
|
-
| Each item of this array must be | Description |
|
|
1138
|
-
| --------------------------------------------------------------- | ----------- |
|
|
1139
|
-
| [additionalPorts items](#networkSecurity_additionalPorts_items) | - |
|
|
1140
|
-
|
|
1141
|
-
#### <a name="autogenerated_heading_6"></a>19.3.1. additionalPorts items
|
|
1142
|
-
|
|
1143
|
-
| | |
|
|
1144
|
-
| -------- | --------- |
|
|
1145
|
-
| **Type** | `integer` |
|
|
1146
|
-
|
|
1147
|
-
### <a name="networkSecurity_ingress"></a>19.4.  Property `ingress`
|
|
1148
|
-
|
|
1149
|
-
| | |
|
|
1150
|
-
| ----------- | ----------------- |
|
|
1151
|
-
| **Type** | `array of object` |
|
|
1152
|
-
| **Default** | `[]` |
|
|
1153
|
-
|
|
1154
|
-
| Each item of this array must be | Description |
|
|
1155
|
-
| ----------------------------------------------- | ----------- |
|
|
1156
|
-
| [ingress items](#networkSecurity_ingress_items) | - |
|
|
1157
|
-
|
|
1158
|
-
#### <a name="autogenerated_heading_7"></a>19.4.1. ingress items
|
|
1159
|
-
|
|
1160
|
-
| | |
|
|
1161
|
-
| ------------------------- | -------------------------------------------------------------------------------------------------------- |
|
|
1162
|
-
| **Type** | `object` |
|
|
1163
|
-
| **Additional properties** | [](# "Additional Properties not allowed.") |
|
|
1164
|
-
|
|
1165
|
-
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|
|
1166
|
-
| ------------------------------------------------------------------------ | ------- | ------ | ---------- | ---------- | ----------------- |
|
|
1167
|
-
| - [namespace](#networkSecurity_ingress_items_namespace ) | No | string | No | - | - |
|
|
1168
|
-
| - [podLabelsSelector](#networkSecurity_ingress_items_podLabelsSelector ) | No | object | No | - | - |
|
|
1169
|
-
|
|
1170
|
-
##### <a name="networkSecurity_ingress_items_namespace"></a>19.4.1.1. Property `namespace`
|
|
1171
|
-
|
|
1172
|
-
| | |
|
|
1173
|
-
| -------- | -------- |
|
|
1174
|
-
| **Type** | `string` |
|
|
1175
|
-
|
|
1176
|
-
##### <a name="networkSecurity_ingress_items_podLabelsSelector"></a>19.4.1.2. Property `podLabelsSelector`
|
|
1177
|
-
|
|
1178
|
-
| | |
|
|
1179
|
-
| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- |
|
|
1180
|
-
| **Type** | `object` |
|
|
1181
|
-
| **Additional properties** | [](# "Additional Properties of any type are allowed.") |
|
|
1182
|
-
|
|
1183
|
-
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|
|
1184
|
-
| -------------------------------------------------------------------- | ------- | ------ | ---------- | ---------- | ----------------- |
|
|
1185
|
-
| - [^.*$](#networkSecurity_ingress_items_podLabelsSelector_pattern1 ) | Yes | string | No | - | - |
|
|
1186
|
-
|
|
1187
|
-
##### <a name="networkSecurity_ingress_items_podLabelsSelector_pattern1"></a>19.4.1.2.1. Pattern Property `^.*$`
|
|
1188
|
-
> All properties whose name matches the regular expression
|
|
1189
|
-
```^.*$``` ([Test](https://regex101.com/?regex=%5E.%2A%24))
|
|
1190
|
-
must respect the following conditions
|
|
1191
|
-
|
|
1192
|
-
| | |
|
|
1193
|
-
| -------- | -------- |
|
|
1194
|
-
| **Type** | `string` |
|
|
1195
|
-
|
|
1196
|
-
## <a name="bindings"></a>20.  Property `bindings`
|
|
1197
|
-
|
|
1198
|
-
**Title:** Service Binding configuration
|
|
1199
|
-
|
|
1200
|
-
| | |
|
|
1201
|
-
| ------------------------- | -------------------------------------------------------------------------------------------------------- |
|
|
1202
|
-
| **Type** | `object` |
|
|
1203
|
-
| **Additional properties** | [](# "Additional Properties not allowed.") |
|
|
1204
|
-
|
|
1205
|
-
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|
|
1206
|
-
| ----------------------------------------------------- | ------- | ----------- | ---------- | ---------- | ----------------- |
|
|
1207
|
-
| - [^[-._a-zA-Z][-._a-zA-Z0-9]*$](#bindings_pattern1 ) | Yes | Combination | No | - | - |
|
|
1208
|
-
|
|
1209
|
-
### <a name="bindings_pattern1"></a>20.1.  Pattern Property `^[-._a-zA-Z][-._a-zA-Z0-9]*$`
|
|
1210
|
-
> All properties whose name matches the regular expression
|
|
1211
|
-
```^[-._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))
|
|
1212
|
-
must respect the following conditions
|
|
1213
|
-
|
|
1214
|
-
| | |
|
|
1215
|
-
| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- |
|
|
1216
|
-
| **Type** | `combining` |
|
|
1217
|
-
| **Additional properties** | [](# "Additional Properties of any type are allowed.") |
|
|
1218
|
-
|
|
1219
|
-
| Any of(Option) |
|
|
1220
|
-
| ---------------------------------------- |
|
|
1221
|
-
| [item 0](#bindings_pattern1_pattern1_i0) |
|
|
1222
|
-
| [item 1](#bindings_pattern1_pattern1_i1) |
|
|
1223
|
-
|
|
1224
|
-
#### <a name="bindings_pattern1_pattern1_i0"></a>20.1.1. Property `item 0`
|
|
1225
|
-
|
|
1226
|
-
| | |
|
|
1227
|
-
| ------------------------- | -------------------------------------------------------------------------------------------------------- |
|
|
1228
|
-
| **Type** | `object` |
|
|
1229
|
-
| **Additional properties** | [](# "Additional Properties not allowed.") |
|
|
1230
|
-
|
|
1231
|
-
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|
|
1232
|
-
| ---------------------------------------------------------- | ------- | ------ | ---------- | ---------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
1233
|
-
| + [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/ |
|
|
1234
|
-
|
|
1235
|
-
##### <a name="bindings_pattern1_pattern1_i0_fromSecret"></a>20.1.1.1. Property `fromSecret`
|
|
1236
|
-
|
|
1237
|
-
| | |
|
|
1238
|
-
| -------- | -------- |
|
|
1239
|
-
| **Type** | `string` |
|
|
1240
|
-
|
|
1241
|
-
**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/
|
|
1242
|
-
|
|
1243
|
-
#### <a name="bindings_pattern1_pattern1_i1"></a>20.1.2. Property `item 1`
|
|
1244
|
-
|
|
1245
|
-
| | |
|
|
1246
|
-
| ------------------------- | -------------------------------------------------------------------------------------------------------- |
|
|
1247
|
-
| **Type** | `object` |
|
|
1248
|
-
| **Additional properties** | [](# "Additional Properties not allowed.") |
|
|
1249
|
-
|
|
1250
|
-
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|
|
1251
|
-
| ---------------------------------------------------------------------------------------- | ------- | --------------- | ---------- | ---------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
1252
|
-
| - [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. |
|
|
1253
|
-
| - [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. |
|
|
1254
|
-
| - [externalName](#bindings_pattern1_pattern1_i1_externalName ) | No | string | No | - | The name for the service binding in SAP BTP |
|
|
1255
|
-
| - [secretName](#bindings_pattern1_pattern1_i1_secretName ) | No | string | No | - | The name of the secret where the credentials are stored. |
|
|
1256
|
-
| - [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. |
|
|
1257
|
-
| - [parametersFrom](#bindings_pattern1_pattern1_i1_parametersFrom ) | No | array of object | No | - | List of sources to populate parameters. |
|
|
1258
|
-
| - [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 |
|
|
1259
|
-
|
|
1260
|
-
##### <a name="bindings_pattern1_pattern1_i1_serviceInstanceName"></a>20.1.2.1. Property `serviceInstanceName`
|
|
1261
|
-
|
|
1262
|
-
| | |
|
|
1263
|
-
| -------- | -------- |
|
|
1264
|
-
| **Type** | `string` |
|
|
1265
|
-
|
|
1266
|
-
**Description:** Name of a BTP Operator Service Instance, created by the `service-instance` Helm chart. Can't be used with the `serviceInstanceFullname` option.
|
|
1267
|
-
|
|
1268
|
-
##### <a name="bindings_pattern1_pattern1_i1_serviceInstanceFullname"></a>20.1.2.2. Property `serviceInstanceFullname`
|
|
1269
|
-
|
|
1270
|
-
| | |
|
|
1271
|
-
| -------- | -------- |
|
|
1272
|
-
| **Type** | `string` |
|
|
1273
|
-
|
|
1274
|
-
**Description:** Full name of a BTP Operator Service Instance. Can't be used with the `serviceInstanceName` option.
|
|
1275
|
-
|
|
1276
|
-
##### <a name="bindings_pattern1_pattern1_i1_externalName"></a>20.1.2.3. Property `externalName`
|
|
1277
|
-
|
|
1278
|
-
| | |
|
|
1279
|
-
| -------- | -------- |
|
|
1280
|
-
| **Type** | `string` |
|
|
1281
|
-
|
|
1282
|
-
**Description:** The name for the service binding in SAP BTP
|
|
1283
|
-
|
|
1284
|
-
##### <a name="bindings_pattern1_pattern1_i1_secretName"></a>20.1.2.4. Property `secretName`
|
|
1285
|
-
|
|
1286
|
-
| | |
|
|
1287
|
-
| -------- | -------- |
|
|
1288
|
-
| **Type** | `string` |
|
|
1289
|
-
|
|
1290
|
-
**Description:** The name of the secret where the credentials are stored.
|
|
1291
|
-
|
|
1292
|
-
##### <a name="bindings_pattern1_pattern1_i1_parameters"></a>20.1.2.5. Property `parameters`
|
|
1293
|
-
|
|
1294
|
-
| | |
|
|
1295
|
-
| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- |
|
|
1296
|
-
| **Type** | `object` |
|
|
1297
|
-
| **Additional properties** | [](# "Additional Properties of any type are allowed.") |
|
|
1298
|
-
|
|
1299
|
-
**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.
|
|
1300
|
-
|
|
1301
|
-
##### <a name="bindings_pattern1_pattern1_i1_parametersFrom"></a>20.1.2.6. Property `parametersFrom`
|
|
1302
|
-
|
|
1303
|
-
| | |
|
|
1304
|
-
| -------- | ----------------- |
|
|
1305
|
-
| **Type** | `array of object` |
|
|
1306
|
-
|
|
1307
|
-
**Description:** List of sources to populate parameters.
|
|
1308
|
-
|
|
1309
|
-
| Each item of this array must be | Description |
|
|
1310
|
-
| --------------------------------------------------------------------------- | ----------------------------------------- |
|
|
1311
|
-
| [parametersFrom items](#bindings_pattern1_pattern1_i1_parametersFrom_items) | Kubernetes Secret as a parameters source. |
|
|
1312
|
-
|
|
1313
|
-
##### <a name="autogenerated_heading_8"></a>20.1.2.6.1. parametersFrom items
|
|
1314
|
-
|
|
1315
|
-
| | |
|
|
1316
|
-
| ------------------------- | -------------------------------------------------------------------------------------------------------- |
|
|
1317
|
-
| **Type** | `object` |
|
|
1318
|
-
| **Additional properties** | [](# "Additional Properties not allowed.") |
|
|
1319
|
-
|
|
1320
|
-
**Description:** Kubernetes Secret as a parameters source.
|
|
1321
|
-
|
|
1322
|
-
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|
|
1323
|
-
| ----------------------------------------------------------------------------------- | ------- | ------ | ---------- | ---------- | ----------------- |
|
|
1324
|
-
| - [secretKeyRef](#bindings_pattern1_pattern1_i1_parametersFrom_items_secretKeyRef ) | No | object | No | - | - |
|
|
1325
|
-
|
|
1326
|
-
##### <a name="bindings_pattern1_pattern1_i1_parametersFrom_items_secretKeyRef"></a>20.1.2.6.1.1. Property `secretKeyRef`
|
|
1327
|
-
|
|
1328
|
-
| | |
|
|
1329
|
-
| ------------------------- | -------------------------------------------------------------------------------------------------------- |
|
|
1330
|
-
| **Type** | `object` |
|
|
1331
|
-
| **Additional properties** | [](# "Additional Properties not allowed.") |
|
|
1332
|
-
|
|
1333
|
-
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|
|
1334
|
-
| -------------------------------------------------------------------------------- | ------- | ------ | ---------- | ---------- | ---------------------------------------------------------------------------------------------------------------------------------- |
|
|
1335
|
-
| + [name](#bindings_pattern1_pattern1_i1_parametersFrom_items_secretKeyRef_name ) | No | string | No | - | Name of a Secret. |
|
|
1336
|
-
| + [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. |
|
|
1337
|
-
|
|
1338
|
-
##### <a name="bindings_pattern1_pattern1_i1_parametersFrom_items_secretKeyRef_name"></a>20.1.2.6.1.1.1. Property `name`
|
|
1339
|
-
|
|
1340
|
-
| | |
|
|
1341
|
-
| -------- | -------- |
|
|
1342
|
-
| **Type** | `string` |
|
|
1343
|
-
|
|
1344
|
-
**Description:** Name of a Secret.
|
|
1345
|
-
|
|
1346
|
-
##### <a name="bindings_pattern1_pattern1_i1_parametersFrom_items_secretKeyRef_key"></a>20.1.2.6.1.1.2. Property `key`
|
|
1347
|
-
|
|
1348
|
-
| | |
|
|
1349
|
-
| -------- | -------- |
|
|
1350
|
-
| **Type** | `string` |
|
|
1351
|
-
|
|
1352
|
-
**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.
|
|
1353
|
-
|
|
1354
|
-
##### <a name="bindings_pattern1_pattern1_i1_credentialsRotationPolicy"></a>20.1.2.7. Property `credentialsRotationPolicy`
|
|
1355
|
-
|
|
1356
|
-
| | |
|
|
1357
|
-
| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- |
|
|
1358
|
-
| **Type** | `object` |
|
|
1359
|
-
| **Additional properties** | [](# "Additional Properties of any type are allowed.") |
|
|
1360
|
-
|
|
1361
|
-
**Description:** Holds automatic credentials rotation configuration. For more details, see https://github.com/SAP/sap-btp-service-operator#spec-1
|
|
1362
|
-
|
|
1363
|
-
----------------------------------------------------------------------------------------------------------------------------
|