@sap/cds-dk 6.4.1 → 6.5.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +30 -0
- package/bin/bind.js +30 -34
- package/bin/cds.js +14 -3
- package/bin/deploy/index.js +6 -5
- package/bin/deploy/to-sqlite.js +2 -1
- package/bin/env.js +4 -4
- package/bin/migrate.js +25 -4
- package/bin/push.js +4 -0
- package/bin/watch.js +3 -3
- package/lib/bind/KubernetesApiAccessor.js +79 -0
- package/lib/bind/{BindingManager.js → bindingManager.js} +16 -15
- package/lib/bind/bindingResolver.js +41 -68
- package/lib/bind/bindingUtil.js +93 -104
- package/lib/bind/cfKeyProvider.js +85 -74
- package/lib/bind/kubernetesCredentialsProvider.js +34 -132
- package/lib/bind/userCdsrcJsonStorageProvider.js +12 -18
- package/lib/client/params.js +2 -2
- package/lib/client/push.js +11 -6
- package/lib/client/settings_manager.js +2 -1
- package/lib/client/subscription.js +4 -1
- package/lib/import/odata/v2parser.js +32 -8
- package/lib/import/odata/v4parser.js +5 -2
- package/lib/init/constants.js +1 -1
- package/lib/init/index.js +3 -11
- package/lib/init/template/approuter/files/approuter-configmap.yaml +4 -1
- package/lib/init/template/approuter/files/approuter-mtxs-configmap.yaml +5 -1
- package/lib/init/template/approuter/files/package.json +1 -1
- package/lib/init/template/approuter/files/values.yaml.hbs +1 -1
- package/lib/init/template/approuter/files/xs-app.json.hbs +2 -2
- package/lib/init/template/approuter/index.js +4 -5
- package/lib/init/template/auditlog/index.js +1 -1
- package/lib/init/template/data/index.js +1 -1
- package/lib/init/template/destinations/index.js +1 -1
- package/lib/init/template/enterprise-messaging/index.js +1 -1
- package/lib/init/template/extensibility/index.js +6 -1
- package/lib/init/template/hana/files/chart.yaml +4 -0
- package/lib/init/template/hana/files/hana.yaml +1 -0
- package/lib/init/template/hana/files/java/db/package.json +1 -1
- package/lib/init/template/hana/files/values.yaml.hbs +6 -3
- package/lib/init/template/hana/index.js +73 -21
- package/lib/init/template/helm/chart/templates/_deployment_helpers.tpl +14 -6
- package/lib/init/template/helm/chart/values.root.schema.json +10 -0
- package/lib/init/template/helm/chart/values.schema.json +11 -110
- package/lib/init/template/helm/index.js +2 -2
- package/lib/init/template/helm/subcharts/content-deployment/Chart.yaml +5 -0
- package/lib/init/template/helm/subcharts/content-deployment/templates/_helpers.tpl +207 -0
- package/lib/init/template/helm/subcharts/content-deployment/templates/job.yaml +66 -0
- package/lib/init/template/helm/subcharts/content-deployment/templates/secret.yaml +10 -0
- package/lib/init/template/helm/subcharts/content-deployment/templates/service-account.yaml +4 -0
- package/lib/init/template/helm/subcharts/content-deployment/templates/service-binding.yaml +28 -0
- package/lib/init/template/helm/subcharts/content-deployment/values-lint.yaml +5 -0
- package/lib/init/template/helm/subcharts/content-deployment/values.md +1014 -0
- package/lib/init/template/helm/subcharts/content-deployment/values.schema.json +589 -0
- package/lib/init/template/helm/subcharts/content-deployment/values.yaml +54 -0
- package/lib/init/template/helm/{subchart → subcharts/web-application}/Chart.yaml +0 -0
- package/lib/init/template/helm/{subchart → subcharts/web-application}/templates/_helpers.tpl +56 -50
- package/lib/init/template/helm/{subchart → subcharts/web-application}/templates/api-rule.yaml +1 -1
- package/lib/init/template/helm/{subchart → subcharts/web-application}/templates/deployment.yaml +15 -9
- package/lib/init/template/helm/{subchart → subcharts/web-application}/templates/network-policy.yaml +0 -0
- package/lib/init/template/helm/{subchart → subcharts/web-application}/templates/pod-disruption-budget.yaml +2 -2
- package/lib/init/template/helm/{subchart → subcharts/web-application}/templates/secret.yaml +0 -0
- package/lib/init/template/helm/subcharts/web-application/templates/service-account.yaml +6 -0
- package/lib/init/template/helm/{subchart → subcharts/web-application}/templates/service-binding.yaml +4 -3
- package/lib/init/template/helm/{subchart → subcharts/web-application}/templates/service.yaml +0 -0
- package/lib/init/template/helm/subcharts/web-application/templating.md +44 -0
- package/lib/init/template/helm/{subchart → subcharts/web-application}/values-lint.yaml +0 -0
- package/lib/init/template/helm/{subchart → subcharts/web-application}/values.md +254 -200
- package/lib/init/template/helm/{subchart → subcharts/web-application}/values.schema.json +82 -28
- package/lib/init/template/helm/{subchart → subcharts/web-application}/values.yaml +15 -5
- package/lib/init/template/html5-repo/files/chart.yaml +4 -0
- package/lib/init/template/html5-repo/files/html5-apps-deployer-configmap.yaml +14 -0
- package/lib/init/template/html5-repo/index.js +39 -7
- package/lib/init/template/kibana-logging/index.js +1 -1
- package/lib/init/template/lint/index.js +1 -1
- package/lib/init/template/multitenancy/files/saas-registry.yaml +2 -2
- package/lib/init/template/multitenancy/files/service-manager.yaml +1 -0
- package/lib/init/template/multitenancy/files/values.yaml.hbs +10 -6
- package/lib/init/template/multitenancy/index.js +21 -3
- package/lib/init/util/commandUtil.js +5 -5
- package/lib/init/util/merge.js +27 -1
- package/lib/init/util/mvnArchetypeUtil.js +1 -1
- package/lib/init/util/projectReader.js +2 -2
- package/lib/util/exec.js +3 -3
- package/lib/util/term.js +7 -7
- package/lib/watch/livereload-connect.js +187 -0
- package/lib/watch/livereload-server.js +12 -12
- package/lib/watch/node-watch.js +1 -1
- package/npm-shrinkwrap.json +56 -308
- package/package.json +1 -4
- package/lib/init/template/hana/files/hana-deployer-job.yaml +0 -49
- package/lib/init/template/html5-repo/files/_html5_deployment_helpers.tpl +0 -16
- package/lib/init/template/html5-repo/files/html5-apps-deployer-job.yaml +0 -61
- package/lib/init/util/spinner.js +0 -80
|
@@ -0,0 +1,1014 @@
|
|
|
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
|
+
| + [image](#image ) | No | object | No | - | Image configuration |
|
|
14
|
+
| - [imagePullSecret](#imagePullSecret ) | No | object | No | - | Image Pull Secret configuration |
|
|
15
|
+
| - [resources](#resources ) | No | object | No | - | Pod resources configuration |
|
|
16
|
+
| - [env](#env ) | No | Combination | No | - | Key-value map of environment variables, which should be added to the Pod spec. |
|
|
17
|
+
| - [envSecretNames](#envSecretNames ) | No | array of string |  | - | [Deprecated] Use \`envFrom\` instead |
|
|
18
|
+
| - [envFrom](#envFrom ) | No | array of object | No | - | List of sources to populate environment variables in the pod. |
|
|
19
|
+
| - [ttlDaysAfterFinished](#ttlDaysAfterFinished ) | No | integer | No | - | Time to keep the Job after it has finished. |
|
|
20
|
+
| + [bindings](#bindings ) | No | object | No | - | Service Binding configuration |
|
|
21
|
+
|
|
22
|
+
## <a name="global"></a>1.  Property `global`
|
|
23
|
+
|
|
24
|
+
**Title:** Helm global values
|
|
25
|
+
|
|
26
|
+
| | |
|
|
27
|
+
| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- |
|
|
28
|
+
| **Type** | `object` |
|
|
29
|
+
| **Additional properties** | [](# "Additional Properties of any type are allowed.") |
|
|
30
|
+
|
|
31
|
+
**Description:** For more information, see https://helm.sh/docs/chart_template_guide/subcharts_and_globals/#global-chart-values
|
|
32
|
+
|
|
33
|
+
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|
|
34
|
+
| ------------------------------------------------------- | ------- | ------ | ---------- | ---------- | ------------------------------- |
|
|
35
|
+
| - [imagePullSecret](#global_imagePullSecret ) | No | object | No | - | Image Pull Secret configuration |
|
|
36
|
+
| - [image](#global_image ) | No | object | No | - | Image configuration |
|
|
37
|
+
| - [additionalProperties](#global_additionalProperties ) | No | object | No | - | - |
|
|
38
|
+
|
|
39
|
+
### <a name="global_imagePullSecret"></a>1.1.  Property `imagePullSecret`
|
|
40
|
+
|
|
41
|
+
**Title:** Image Pull Secret configuration
|
|
42
|
+
|
|
43
|
+
| | |
|
|
44
|
+
| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- |
|
|
45
|
+
| **Type** | `object` |
|
|
46
|
+
| **Additional properties** | [](# "Additional Properties of any type are allowed.") |
|
|
47
|
+
|
|
48
|
+
**Description:** For more information, see https://kubernetes.io/docs/tasks/configure-pod-container/pull-image-private-registry/
|
|
49
|
+
|
|
50
|
+
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|
|
51
|
+
| ----------------------------------------------------------------------- | ------- | ------ | ---------- | ------------------------------- | ----------------- |
|
|
52
|
+
| - [name](#global_imagePullSecret_name ) | No | string | No | In #/definitions/KubernetesName | Secret name |
|
|
53
|
+
| - [dockerconfigjson](#global_imagePullSecret_dockerconfigjson ) | No | string | No | - | Secret content |
|
|
54
|
+
| - [additionalProperties](#global_imagePullSecret_additionalProperties ) | No | object | No | - | - |
|
|
55
|
+
|
|
56
|
+
#### <a name="global_imagePullSecret_name"></a>1.1.1.  Property `name`
|
|
57
|
+
|
|
58
|
+
**Title:** Secret name
|
|
59
|
+
|
|
60
|
+
| | |
|
|
61
|
+
| -------------- | ---------------------------- |
|
|
62
|
+
| **Type** | `string` |
|
|
63
|
+
| **Defined in** | #/definitions/KubernetesName |
|
|
64
|
+
|
|
65
|
+
**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.
|
|
66
|
+
|
|
67
|
+
| Restrictions | |
|
|
68
|
+
| --------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
69
|
+
| **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) |
|
|
70
|
+
|
|
71
|
+
#### <a name="global_imagePullSecret_dockerconfigjson"></a>1.1.2.  Property `dockerconfigjson`
|
|
72
|
+
|
|
73
|
+
**Title:** Secret content
|
|
74
|
+
|
|
75
|
+
| | |
|
|
76
|
+
| -------- | -------- |
|
|
77
|
+
| **Type** | `string` |
|
|
78
|
+
|
|
79
|
+
**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.
|
|
80
|
+
|
|
81
|
+
### <a name="global_image"></a>1.2.  Property `image`
|
|
82
|
+
|
|
83
|
+
**Title:** Image configuration
|
|
84
|
+
|
|
85
|
+
| | |
|
|
86
|
+
| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- |
|
|
87
|
+
| **Type** | `object` |
|
|
88
|
+
| **Additional properties** | [](# "Additional Properties of any type are allowed.") |
|
|
89
|
+
|
|
90
|
+
**Description:** Either name or repository is required.
|
|
91
|
+
|
|
92
|
+
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|
|
93
|
+
| ------------------------------------------------------------- | ------- | ------ | ---------- | ------------------------------ | ----------------------------------------------------------------------------------------------------------------------- |
|
|
94
|
+
| - [tag](#global_image_tag ) | No | string | No | In #/definitions/ImageTag | Image tag without the name (everything after the \`:\` sign, potentially including the \`@sha256\` section at the end). |
|
|
95
|
+
| - [registry](#global_image_registry ) | No | string | No | In #/definitions/ImageRegistry | Image registry e.g. docker.io |
|
|
96
|
+
| - [additionalProperties](#global_image_additionalProperties ) | No | object | No | - | - |
|
|
97
|
+
|
|
98
|
+
#### <a name="global_image_tag"></a>1.2.1.  Property `tag`
|
|
99
|
+
|
|
100
|
+
| | |
|
|
101
|
+
| -------------- | ---------------------- |
|
|
102
|
+
| **Type** | `string` |
|
|
103
|
+
| **Defined in** | #/definitions/ImageTag |
|
|
104
|
+
|
|
105
|
+
**Description:** Image tag without the name (everything after the `:` sign, potentially including the `@sha256` section at the end).
|
|
106
|
+
|
|
107
|
+
| Restrictions | |
|
|
108
|
+
| --------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
109
|
+
| **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) |
|
|
110
|
+
|
|
111
|
+
#### <a name="global_image_registry"></a>1.2.2.  Property `registry`
|
|
112
|
+
|
|
113
|
+
| | |
|
|
114
|
+
| -------------- | --------------------------- |
|
|
115
|
+
| **Type** | `string` |
|
|
116
|
+
| **Defined in** | #/definitions/ImageRegistry |
|
|
117
|
+
|
|
118
|
+
**Description:** Image registry e.g. docker.io
|
|
119
|
+
|
|
120
|
+
| Restrictions | |
|
|
121
|
+
| --------------------------------- | ----------------------------------------------------------------------------- |
|
|
122
|
+
| **Must match regular expression** | ```^[\w-./]+$``` [Test](https://regex101.com/?regex=%5E%5B%5Cw-.%2F%5D%2B%24) |
|
|
123
|
+
|
|
124
|
+
## <a name="nameOverride"></a>2.  Property `nameOverride`
|
|
125
|
+
|
|
126
|
+
**Title:** Chart name override
|
|
127
|
+
|
|
128
|
+
| | |
|
|
129
|
+
| -------- | -------- |
|
|
130
|
+
| **Type** | `string` |
|
|
131
|
+
|
|
132
|
+
**Description:** Will be used instead of the `.Chart.Name`, e.g. when generating the Deployment name.
|
|
133
|
+
|
|
134
|
+
| Restrictions | |
|
|
135
|
+
| --------------------------------- | ------------------------------------------------------------------------------------------- |
|
|
136
|
+
| **Must match regular expression** | ```[0-9a-z][0-9a-z-.]*``` [Test](https://regex101.com/?regex=%5B0-9a-z%5D%5B0-9a-z-.%5D%2A) |
|
|
137
|
+
|
|
138
|
+
## <a name="fullnameOverride"></a>3.  Property `fullnameOverride`
|
|
139
|
+
|
|
140
|
+
**Title:** Override for the `.fullname` helper function.
|
|
141
|
+
|
|
142
|
+
| | |
|
|
143
|
+
| -------- | -------- |
|
|
144
|
+
| **Type** | `string` |
|
|
145
|
+
|
|
146
|
+
**Description:** Will be used as an override for the `.fullname` helper function (i.e. `.Release.Name-.Chart.Name`).
|
|
147
|
+
|
|
148
|
+
| Restrictions | |
|
|
149
|
+
| --------------------------------- | ------------------------------------------------------------------------------------------- |
|
|
150
|
+
| **Must match regular expression** | ```[0-9a-z][0-9a-z-.]*``` [Test](https://regex101.com/?regex=%5B0-9a-z%5D%5B0-9a-z-.%5D%2A) |
|
|
151
|
+
|
|
152
|
+
## <a name="image"></a>4.  Property `image`
|
|
153
|
+
|
|
154
|
+
**Title:** Image configuration
|
|
155
|
+
|
|
156
|
+
| | |
|
|
157
|
+
| ------------------------- | -------------------------------------------------------------------------------------------------------- |
|
|
158
|
+
| **Type** | `object` |
|
|
159
|
+
| **Additional properties** | [](# "Additional Properties not allowed.") |
|
|
160
|
+
|
|
161
|
+
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|
|
162
|
+
| ---------------------------------- | ------- | ------ | ---------- | ------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- |
|
|
163
|
+
| + [repository](#image_repository ) | No | string | No | - | Repository of the image |
|
|
164
|
+
| - [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). |
|
|
165
|
+
| - [registry](#image_registry ) | No | string | No | Same as [registry](#global_image_registry ) | Image registry e.g. docker.io |
|
|
166
|
+
|
|
167
|
+
### <a name="image_repository"></a>4.1.  Property `repository`
|
|
168
|
+
|
|
169
|
+
**Title:** Repository of the image
|
|
170
|
+
|
|
171
|
+
| | |
|
|
172
|
+
| -------- | -------- |
|
|
173
|
+
| **Type** | `string` |
|
|
174
|
+
|
|
175
|
+
**Description:** Should also include the image name (i.e. everything before the `:` sign).
|
|
176
|
+
|
|
177
|
+
| Restrictions | |
|
|
178
|
+
| --------------------------------- | ------------------------------------------------------------------------------------------------------------- |
|
|
179
|
+
| **Must match regular expression** | ```^[\w-./:]*[@sha256]*$``` [Test](https://regex101.com/?regex=%5E%5B%5Cw-.%2F%3A%5D%2A%5B%40sha256%5D%2A%24) |
|
|
180
|
+
|
|
181
|
+
### <a name="image_tag"></a>4.2.  Property `tag`
|
|
182
|
+
|
|
183
|
+
| | |
|
|
184
|
+
| ---------------------- | ------------------------ |
|
|
185
|
+
| **Type** | `string` |
|
|
186
|
+
| **Same definition as** | [tag](#global_image_tag) |
|
|
187
|
+
|
|
188
|
+
**Description:** Image tag without the name (everything after the `:` sign, potentially including the `@sha256` section at the end).
|
|
189
|
+
|
|
190
|
+
### <a name="image_registry"></a>4.3.  Property `registry`
|
|
191
|
+
|
|
192
|
+
| | |
|
|
193
|
+
| ---------------------- | ---------------------------------- |
|
|
194
|
+
| **Type** | `string` |
|
|
195
|
+
| **Same definition as** | [registry](#global_image_registry) |
|
|
196
|
+
|
|
197
|
+
**Description:** Image registry e.g. docker.io
|
|
198
|
+
|
|
199
|
+
## <a name="imagePullSecret"></a>5.  Property `imagePullSecret`
|
|
200
|
+
|
|
201
|
+
**Title:** Image Pull Secret configuration
|
|
202
|
+
|
|
203
|
+
| | |
|
|
204
|
+
| ------------------------- | -------------------------------------------------------------------------------------------------------- |
|
|
205
|
+
| **Type** | `object` |
|
|
206
|
+
| **Additional properties** | [](# "Additional Properties not allowed.") |
|
|
207
|
+
|
|
208
|
+
**Description:** For more information, see https://kubernetes.io/docs/tasks/configure-pod-container/pull-image-private-registry/
|
|
209
|
+
|
|
210
|
+
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|
|
211
|
+
| -------------------------------------------------------- | ------- | ------ | ---------- | --------------------------------------------- | ----------------- |
|
|
212
|
+
| - [name](#imagePullSecret_name ) | No | string | No | Same as [name](#global_imagePullSecret_name ) | Secret name |
|
|
213
|
+
| - [dockerconfigjson](#imagePullSecret_dockerconfigjson ) | No | string | No | - | Secret content |
|
|
214
|
+
|
|
215
|
+
### <a name="imagePullSecret_name"></a>5.1.  Property `name`
|
|
216
|
+
|
|
217
|
+
**Title:** Secret name
|
|
218
|
+
|
|
219
|
+
| | |
|
|
220
|
+
| ---------------------- | ------------------------------------ |
|
|
221
|
+
| **Type** | `string` |
|
|
222
|
+
| **Same definition as** | [name](#global_imagePullSecret_name) |
|
|
223
|
+
|
|
224
|
+
**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.
|
|
225
|
+
|
|
226
|
+
### <a name="imagePullSecret_dockerconfigjson"></a>5.2.  Property `dockerconfigjson`
|
|
227
|
+
|
|
228
|
+
**Title:** Secret content
|
|
229
|
+
|
|
230
|
+
| | |
|
|
231
|
+
| -------- | -------- |
|
|
232
|
+
| **Type** | `string` |
|
|
233
|
+
|
|
234
|
+
**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.
|
|
235
|
+
|
|
236
|
+
## <a name="resources"></a>6.  Property `resources`
|
|
237
|
+
|
|
238
|
+
**Title:** Pod resources configuration
|
|
239
|
+
|
|
240
|
+
| | |
|
|
241
|
+
| ------------------------- | -------------------------------------------------------------------------------------------------------- |
|
|
242
|
+
| **Type** | `object` |
|
|
243
|
+
| **Additional properties** | [](# "Additional Properties not allowed.") |
|
|
244
|
+
|
|
245
|
+
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|
|
246
|
+
| ---------------------------------- | ------- | ------ | ---------- | ---------- | -------------------------------------------------------------------------------------------------- |
|
|
247
|
+
| - [requests](#resources_requests ) | No | object | No | - | Minimal required resources for the application to operate, that will be reserved for each replica. |
|
|
248
|
+
| - [limits](#resources_limits ) | No | object | No | - | - |
|
|
249
|
+
|
|
250
|
+
### <a name="resources_requests"></a>6.1.  Property `requests`
|
|
251
|
+
|
|
252
|
+
| | |
|
|
253
|
+
| ------------------------- | -------------------------------------------------------------------------------------------------------- |
|
|
254
|
+
| **Type** | `object` |
|
|
255
|
+
| **Additional properties** | [](# "Additional Properties not allowed.") |
|
|
256
|
+
|
|
257
|
+
**Description:** Minimal required resources for the application to operate, that will be reserved for each replica.
|
|
258
|
+
|
|
259
|
+
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|
|
260
|
+
| ------------------------------------------------------------- | ------- | ---------------- | ---------- | ---------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
261
|
+
| - [cpu](#resources_requests_cpu ) | No | number or string | No | - | CPU resource units, as described here https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/#meaning-of-cpu |
|
|
262
|
+
| - [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 |
|
|
263
|
+
| - [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 |
|
|
264
|
+
|
|
265
|
+
#### <a name="resources_requests_cpu"></a>6.1.1.  Property `cpu`
|
|
266
|
+
|
|
267
|
+
| | |
|
|
268
|
+
| -------- | ------------------ |
|
|
269
|
+
| **Type** | `number or string` |
|
|
270
|
+
|
|
271
|
+
**Description:** CPU resource units, as described here https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/#meaning-of-cpu
|
|
272
|
+
|
|
273
|
+
#### <a name="resources_requests_ephemeral-storage"></a>6.1.2.  Property `ephemeral-storage`
|
|
274
|
+
|
|
275
|
+
| | |
|
|
276
|
+
| -------- | -------- |
|
|
277
|
+
| **Type** | `string` |
|
|
278
|
+
|
|
279
|
+
**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
|
|
280
|
+
|
|
281
|
+
#### <a name="resources_requests_memory"></a>6.1.3.  Property `memory`
|
|
282
|
+
|
|
283
|
+
| | |
|
|
284
|
+
| -------- | -------- |
|
|
285
|
+
| **Type** | `string` |
|
|
286
|
+
|
|
287
|
+
**Description:** Amount of memory, mesaured in bytes. For more info, see https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/#meaning-of-memory
|
|
288
|
+
|
|
289
|
+
### <a name="resources_limits"></a>6.2.  Property `limits`
|
|
290
|
+
|
|
291
|
+
| | |
|
|
292
|
+
| ------------------------- | -------------------------------------------------------------------------------------------------------- |
|
|
293
|
+
| **Type** | `object` |
|
|
294
|
+
| **Additional properties** | [](# "Additional Properties not allowed.") |
|
|
295
|
+
|
|
296
|
+
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|
|
297
|
+
| ----------------------------------------------------------- | ------- | ---------------- | ---------- | ---------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
298
|
+
| - [cpu](#resources_limits_cpu ) | No | number or string | No | - | CPU resource units, as described here https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/#meaning-of-cpu |
|
|
299
|
+
| - [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 |
|
|
300
|
+
| - [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 |
|
|
301
|
+
|
|
302
|
+
#### <a name="resources_limits_cpu"></a>6.2.1.  Property `cpu`
|
|
303
|
+
|
|
304
|
+
| | |
|
|
305
|
+
| -------- | ------------------ |
|
|
306
|
+
| **Type** | `number or string` |
|
|
307
|
+
|
|
308
|
+
**Description:** CPU resource units, as described here https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/#meaning-of-cpu
|
|
309
|
+
|
|
310
|
+
#### <a name="resources_limits_ephemeral-storage"></a>6.2.2.  Property `ephemeral-storage`
|
|
311
|
+
|
|
312
|
+
| | |
|
|
313
|
+
| -------- | -------- |
|
|
314
|
+
| **Type** | `string` |
|
|
315
|
+
|
|
316
|
+
**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
|
|
317
|
+
|
|
318
|
+
#### <a name="resources_limits_memory"></a>6.2.3.  Property `memory`
|
|
319
|
+
|
|
320
|
+
| | |
|
|
321
|
+
| -------- | -------- |
|
|
322
|
+
| **Type** | `string` |
|
|
323
|
+
|
|
324
|
+
**Description:** Amount of memory, mesaured in bytes. For more info, see https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/#meaning-of-memory
|
|
325
|
+
|
|
326
|
+
## <a name="env"></a>7.  Property `env`
|
|
327
|
+
|
|
328
|
+
| | |
|
|
329
|
+
| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- |
|
|
330
|
+
| **Type** | `combining` |
|
|
331
|
+
| **Additional properties** | [](# "Additional Properties of any type are allowed.") |
|
|
332
|
+
| **Default** | `{}` |
|
|
333
|
+
|
|
334
|
+
**Description:** Key-value map of environment variables, which should be added to the Pod spec.
|
|
335
|
+
|
|
336
|
+
| Any of(Option) |
|
|
337
|
+
| ----------------------- |
|
|
338
|
+
| [item 0](#env_anyOf_i0) |
|
|
339
|
+
| [item 1](#env_anyOf_i1) |
|
|
340
|
+
|
|
341
|
+
### <a name="env_anyOf_i0"></a>7.1. Property `None`
|
|
342
|
+
|
|
343
|
+
| | |
|
|
344
|
+
| ------------------------- | -------------------------------------------------------------------------------------------------------- |
|
|
345
|
+
| **Type** | `object` |
|
|
346
|
+
| **Additional properties** | [](# "Additional Properties not allowed.") |
|
|
347
|
+
| **Default** | `{}` |
|
|
348
|
+
|
|
349
|
+
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|
|
350
|
+
| --------------------------------------------------------- | ------- | ----------- | ---------- | ---------- | ----------------- |
|
|
351
|
+
| - [^[-._a-zA-Z][-._a-zA-Z0-9]*$](#env_anyOf_i0_pattern1 ) | Yes | Combination | No | - | - |
|
|
352
|
+
|
|
353
|
+
#### <a name="env_anyOf_i0_pattern1"></a>7.1.1. Pattern Property `^[-._a-zA-Z][-._a-zA-Z0-9]*$`
|
|
354
|
+
> All properties whose name matches the regular expression
|
|
355
|
+
```^[-._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))
|
|
356
|
+
must respect the following conditions
|
|
357
|
+
|
|
358
|
+
| | |
|
|
359
|
+
| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- |
|
|
360
|
+
| **Type** | `combining` |
|
|
361
|
+
| **Additional properties** | [](# "Additional Properties of any type are allowed.") |
|
|
362
|
+
|
|
363
|
+
| Any of(Option) |
|
|
364
|
+
| ----------------------------------------- |
|
|
365
|
+
| [item 0](#env_anyOf_i0_pattern1_anyOf_i0) |
|
|
366
|
+
| [item 1](#env_anyOf_i0_pattern1_anyOf_i1) |
|
|
367
|
+
|
|
368
|
+
##### <a name="env_anyOf_i0_pattern1_anyOf_i0"></a>7.1.1.1. Property `None`
|
|
369
|
+
|
|
370
|
+
| | |
|
|
371
|
+
| -------- | ------------------- |
|
|
372
|
+
| **Type** | `integer or string` |
|
|
373
|
+
|
|
374
|
+
**Description:** Plain value of an environment variable.
|
|
375
|
+
|
|
376
|
+
##### <a name="env_anyOf_i0_pattern1_anyOf_i1"></a>7.1.1.2. Property `None`
|
|
377
|
+
|
|
378
|
+
| | |
|
|
379
|
+
| ------------------------- | -------------------------------------------------------------------------------------------------------- |
|
|
380
|
+
| **Type** | `object` |
|
|
381
|
+
| **Additional properties** | [](# "Additional Properties not allowed.") |
|
|
382
|
+
|
|
383
|
+
**Description:** `valueFrom` configuration for the environment variable https://kubernetes.io/docs/tasks/inject-data-application/environment-variable-expose-pod-information/
|
|
384
|
+
|
|
385
|
+
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|
|
386
|
+
| ----------------------------------------------------------------------- | ------- | ------ | ---------- | ---------- | ------------------------------------ |
|
|
387
|
+
| - [configMapKeyRef](#env_anyOf_i0_pattern1_anyOf_i1_configMapKeyRef ) | No | object | No | - | Selects a key of a ConfigMap. |
|
|
388
|
+
| - [secretKeyRef](#env_anyOf_i0_pattern1_anyOf_i1_secretKeyRef ) | No | object | No | - | Selects a key of a Secret. |
|
|
389
|
+
| - [resourceFieldRef](#env_anyOf_i0_pattern1_anyOf_i1_resourceFieldRef ) | No | object | No | - | Selects a resource of the container. |
|
|
390
|
+
| - [fieldRef](#env_anyOf_i0_pattern1_anyOf_i1_fieldRef ) | No | object | No | - | Selects a field of the pod. |
|
|
391
|
+
|
|
392
|
+
##### <a name="env_anyOf_i0_pattern1_anyOf_i1_configMapKeyRef"></a>7.1.1.2.1. Property `configMapKeyRef`
|
|
393
|
+
|
|
394
|
+
| | |
|
|
395
|
+
| ------------------------- | -------------------------------------------------------------------------------------------------------- |
|
|
396
|
+
| **Type** | `object` |
|
|
397
|
+
| **Additional properties** | [](# "Additional Properties not allowed.") |
|
|
398
|
+
|
|
399
|
+
**Description:** Selects a key of a ConfigMap.
|
|
400
|
+
|
|
401
|
+
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|
|
402
|
+
| --------------------------------------------------------------- | ------- | ------ | ---------- | --------------------------------------------- | ------------------------------------------------ |
|
|
403
|
+
| - [name](#env_anyOf_i0_pattern1_anyOf_i1_configMapKeyRef_name ) | No | string | No | Same as [name](#global_imagePullSecret_name ) | Name of a ConfigMap. |
|
|
404
|
+
| - [key](#env_anyOf_i0_pattern1_anyOf_i1_configMapKeyRef_key ) | No | string | No | - | Key in that ConfigMap, which value will be used. |
|
|
405
|
+
|
|
406
|
+
##### <a name="env_anyOf_i0_pattern1_anyOf_i1_configMapKeyRef_name"></a>7.1.1.2.1.1. Property `name`
|
|
407
|
+
|
|
408
|
+
| | |
|
|
409
|
+
| ---------------------- | ------------------------------------ |
|
|
410
|
+
| **Type** | `string` |
|
|
411
|
+
| **Same definition as** | [name](#global_imagePullSecret_name) |
|
|
412
|
+
|
|
413
|
+
**Description:** Name of a ConfigMap.
|
|
414
|
+
|
|
415
|
+
##### <a name="env_anyOf_i0_pattern1_anyOf_i1_configMapKeyRef_key"></a>7.1.1.2.1.2. Property `key`
|
|
416
|
+
|
|
417
|
+
| | |
|
|
418
|
+
| -------- | -------- |
|
|
419
|
+
| **Type** | `string` |
|
|
420
|
+
|
|
421
|
+
**Description:** Key in that ConfigMap, which value will be used.
|
|
422
|
+
|
|
423
|
+
##### <a name="env_anyOf_i0_pattern1_anyOf_i1_secretKeyRef"></a>7.1.1.2.2. Property `secretKeyRef`
|
|
424
|
+
|
|
425
|
+
| | |
|
|
426
|
+
| ------------------------- | -------------------------------------------------------------------------------------------------------- |
|
|
427
|
+
| **Type** | `object` |
|
|
428
|
+
| **Additional properties** | [](# "Additional Properties not allowed.") |
|
|
429
|
+
|
|
430
|
+
**Description:** Selects a key of a Secret.
|
|
431
|
+
|
|
432
|
+
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|
|
433
|
+
| ------------------------------------------------------------ | ------- | ------ | ---------- | --------------------------------------------- | --------------------------------------------- |
|
|
434
|
+
| - [name](#env_anyOf_i0_pattern1_anyOf_i1_secretKeyRef_name ) | No | string | No | Same as [name](#global_imagePullSecret_name ) | Name of a Secret. |
|
|
435
|
+
| - [key](#env_anyOf_i0_pattern1_anyOf_i1_secretKeyRef_key ) | No | string | No | - | Key in that Secret, which value will be used. |
|
|
436
|
+
|
|
437
|
+
##### <a name="env_anyOf_i0_pattern1_anyOf_i1_secretKeyRef_name"></a>7.1.1.2.2.1. Property `name`
|
|
438
|
+
|
|
439
|
+
| | |
|
|
440
|
+
| ---------------------- | ------------------------------------ |
|
|
441
|
+
| **Type** | `string` |
|
|
442
|
+
| **Same definition as** | [name](#global_imagePullSecret_name) |
|
|
443
|
+
|
|
444
|
+
**Description:** Name of a Secret.
|
|
445
|
+
|
|
446
|
+
##### <a name="env_anyOf_i0_pattern1_anyOf_i1_secretKeyRef_key"></a>7.1.1.2.2.2. Property `key`
|
|
447
|
+
|
|
448
|
+
| | |
|
|
449
|
+
| -------- | -------- |
|
|
450
|
+
| **Type** | `string` |
|
|
451
|
+
|
|
452
|
+
**Description:** Key in that Secret, which value will be used.
|
|
453
|
+
|
|
454
|
+
##### <a name="env_anyOf_i0_pattern1_anyOf_i1_resourceFieldRef"></a>7.1.1.2.3. Property `resourceFieldRef`
|
|
455
|
+
|
|
456
|
+
| | |
|
|
457
|
+
| ------------------------- | -------------------------------------------------------------------------------------------------------- |
|
|
458
|
+
| **Type** | `object` |
|
|
459
|
+
| **Additional properties** | [](# "Additional Properties not allowed.") |
|
|
460
|
+
|
|
461
|
+
**Description:** Selects a resource of the container.
|
|
462
|
+
|
|
463
|
+
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|
|
464
|
+
| ---------------------------------------------------------------------------------- | ------- | ------ | ---------- | --------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
465
|
+
| - [containerName](#env_anyOf_i0_pattern1_anyOf_i1_resourceFieldRef_containerName ) | No | string | No | Same as [name](#global_imagePullSecret_name ) | Name of a Container. |
|
|
466
|
+
| - [resource](#env_anyOf_i0_pattern1_anyOf_i1_resourceFieldRef_resource ) | No | string | No | - | Only resources limits and requests (limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, requests.memory and requests.ephemeral-storage) are currently supported. |
|
|
467
|
+
|
|
468
|
+
##### <a name="env_anyOf_i0_pattern1_anyOf_i1_resourceFieldRef_containerName"></a>7.1.1.2.3.1. Property `containerName`
|
|
469
|
+
|
|
470
|
+
| | |
|
|
471
|
+
| ---------------------- | ------------------------------------ |
|
|
472
|
+
| **Type** | `string` |
|
|
473
|
+
| **Same definition as** | [name](#global_imagePullSecret_name) |
|
|
474
|
+
|
|
475
|
+
**Description:** Name of a Container.
|
|
476
|
+
|
|
477
|
+
##### <a name="env_anyOf_i0_pattern1_anyOf_i1_resourceFieldRef_resource"></a>7.1.1.2.3.2. Property `resource`
|
|
478
|
+
|
|
479
|
+
| | |
|
|
480
|
+
| -------- | -------- |
|
|
481
|
+
| **Type** | `string` |
|
|
482
|
+
|
|
483
|
+
**Description:** Only resources limits and requests (limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, requests.memory and requests.ephemeral-storage) are currently supported.
|
|
484
|
+
|
|
485
|
+
##### <a name="env_anyOf_i0_pattern1_anyOf_i1_fieldRef"></a>7.1.1.2.4. Property `fieldRef`
|
|
486
|
+
|
|
487
|
+
| | |
|
|
488
|
+
| ------------------------- | -------------------------------------------------------------------------------------------------------- |
|
|
489
|
+
| **Type** | `object` |
|
|
490
|
+
| **Additional properties** | [](# "Additional Properties not allowed.") |
|
|
491
|
+
|
|
492
|
+
**Description:** Selects a field of the pod.
|
|
493
|
+
|
|
494
|
+
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|
|
495
|
+
| ------------------------------------------------------------------ | ------- | ------ | ---------- | ---------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
496
|
+
| - [fieldPath](#env_anyOf_i0_pattern1_anyOf_i1_fieldRef_fieldPath ) | No | string | No | - | Supports metadata.name, metadata.namespace, \`metadata.labels['<KEY>']\`, \`metadata.annotations['<KEY>']\`, spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs. |
|
|
497
|
+
|
|
498
|
+
##### <a name="env_anyOf_i0_pattern1_anyOf_i1_fieldRef_fieldPath"></a>7.1.1.2.4.1. Property `fieldPath`
|
|
499
|
+
|
|
500
|
+
| | |
|
|
501
|
+
| -------- | -------- |
|
|
502
|
+
| **Type** | `string` |
|
|
503
|
+
|
|
504
|
+
**Description:** Supports metadata.name, metadata.namespace, `metadata.labels['<KEY>']`, `metadata.annotations['<KEY>']`, spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs.
|
|
505
|
+
|
|
506
|
+
### <a name="env_anyOf_i1"></a>7.2. Property `None`
|
|
507
|
+
|
|
508
|
+
| | |
|
|
509
|
+
| -------- | ----------------- |
|
|
510
|
+
| **Type** | `array of object` |
|
|
511
|
+
|
|
512
|
+
| Each item of this array must be | Description |
|
|
513
|
+
| ----------------------------------- | ----------- |
|
|
514
|
+
| [item 1 items](#env_anyOf_i1_items) | - |
|
|
515
|
+
|
|
516
|
+
#### <a name="autogenerated_heading_2"></a>7.2.1. items
|
|
517
|
+
|
|
518
|
+
| | |
|
|
519
|
+
| ------------------------- | -------------------------------------------------------------------------------------------------------- |
|
|
520
|
+
| **Type** | `object` |
|
|
521
|
+
| **Additional properties** | [](# "Additional Properties not allowed.") |
|
|
522
|
+
|
|
523
|
+
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|
|
524
|
+
| ----------------------------------------------------------- | ------- | ----------------- | ---------- | ---------- | ------------------------------------ |
|
|
525
|
+
| + [name](#env_anyOf_i1_items_name ) | No | string | No | - | - |
|
|
526
|
+
| - [value](#env_anyOf_i1_items_value ) | No | string or integer | No | - | - |
|
|
527
|
+
| - [configMapKeyRef](#env_anyOf_i1_items_configMapKeyRef ) | No | object | No | - | Selects a key of a ConfigMap. |
|
|
528
|
+
| - [secretKeyRef](#env_anyOf_i1_items_secretKeyRef ) | No | object | No | - | Selects a key of a Secret. |
|
|
529
|
+
| - [resourceFieldRef](#env_anyOf_i1_items_resourceFieldRef ) | No | object | No | - | Selects a resource of the container. |
|
|
530
|
+
| - [fieldRef](#env_anyOf_i1_items_fieldRef ) | No | object | No | - | Selects a field of the pod. |
|
|
531
|
+
|
|
532
|
+
##### <a name="env_anyOf_i1_items_name"></a>7.2.1.1. Property `name`
|
|
533
|
+
|
|
534
|
+
| | |
|
|
535
|
+
| -------- | -------- |
|
|
536
|
+
| **Type** | `string` |
|
|
537
|
+
|
|
538
|
+
| Restrictions | |
|
|
539
|
+
| --------------------------------- | ----------------------------------------------------------------------------------------------------------------- |
|
|
540
|
+
| **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) |
|
|
541
|
+
|
|
542
|
+
##### <a name="env_anyOf_i1_items_value"></a>7.2.1.2. Property `value`
|
|
543
|
+
|
|
544
|
+
| | |
|
|
545
|
+
| -------- | ------------------- |
|
|
546
|
+
| **Type** | `string or integer` |
|
|
547
|
+
|
|
548
|
+
##### <a name="env_anyOf_i1_items_configMapKeyRef"></a>7.2.1.3. Property `configMapKeyRef`
|
|
549
|
+
|
|
550
|
+
| | |
|
|
551
|
+
| ------------------------- | -------------------------------------------------------------------------------------------------------- |
|
|
552
|
+
| **Type** | `object` |
|
|
553
|
+
| **Additional properties** | [](# "Additional Properties not allowed.") |
|
|
554
|
+
|
|
555
|
+
**Description:** Selects a key of a ConfigMap.
|
|
556
|
+
|
|
557
|
+
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|
|
558
|
+
| --------------------------------------------------- | ------- | ------ | ---------- | --------------------------------------------- | ------------------------------------------------ |
|
|
559
|
+
| - [name](#env_anyOf_i1_items_configMapKeyRef_name ) | No | string | No | Same as [name](#global_imagePullSecret_name ) | Name of a ConfigMap. |
|
|
560
|
+
| - [key](#env_anyOf_i1_items_configMapKeyRef_key ) | No | string | No | - | Key in that ConfigMap, which value will be used. |
|
|
561
|
+
|
|
562
|
+
##### <a name="env_anyOf_i1_items_configMapKeyRef_name"></a>7.2.1.3.1. Property `name`
|
|
563
|
+
|
|
564
|
+
| | |
|
|
565
|
+
| ---------------------- | ------------------------------------ |
|
|
566
|
+
| **Type** | `string` |
|
|
567
|
+
| **Same definition as** | [name](#global_imagePullSecret_name) |
|
|
568
|
+
|
|
569
|
+
**Description:** Name of a ConfigMap.
|
|
570
|
+
|
|
571
|
+
##### <a name="env_anyOf_i1_items_configMapKeyRef_key"></a>7.2.1.3.2. Property `key`
|
|
572
|
+
|
|
573
|
+
| | |
|
|
574
|
+
| -------- | -------- |
|
|
575
|
+
| **Type** | `string` |
|
|
576
|
+
|
|
577
|
+
**Description:** Key in that ConfigMap, which value will be used.
|
|
578
|
+
|
|
579
|
+
##### <a name="env_anyOf_i1_items_secretKeyRef"></a>7.2.1.4. Property `secretKeyRef`
|
|
580
|
+
|
|
581
|
+
| | |
|
|
582
|
+
| ------------------------- | -------------------------------------------------------------------------------------------------------- |
|
|
583
|
+
| **Type** | `object` |
|
|
584
|
+
| **Additional properties** | [](# "Additional Properties not allowed.") |
|
|
585
|
+
|
|
586
|
+
**Description:** Selects a key of a Secret.
|
|
587
|
+
|
|
588
|
+
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|
|
589
|
+
| ------------------------------------------------ | ------- | ------ | ---------- | --------------------------------------------- | --------------------------------------------- |
|
|
590
|
+
| - [name](#env_anyOf_i1_items_secretKeyRef_name ) | No | string | No | Same as [name](#global_imagePullSecret_name ) | Name of a Secret. |
|
|
591
|
+
| - [key](#env_anyOf_i1_items_secretKeyRef_key ) | No | string | No | - | Key in that Secret, which value will be used. |
|
|
592
|
+
|
|
593
|
+
##### <a name="env_anyOf_i1_items_secretKeyRef_name"></a>7.2.1.4.1. Property `name`
|
|
594
|
+
|
|
595
|
+
| | |
|
|
596
|
+
| ---------------------- | ------------------------------------ |
|
|
597
|
+
| **Type** | `string` |
|
|
598
|
+
| **Same definition as** | [name](#global_imagePullSecret_name) |
|
|
599
|
+
|
|
600
|
+
**Description:** Name of a Secret.
|
|
601
|
+
|
|
602
|
+
##### <a name="env_anyOf_i1_items_secretKeyRef_key"></a>7.2.1.4.2. Property `key`
|
|
603
|
+
|
|
604
|
+
| | |
|
|
605
|
+
| -------- | -------- |
|
|
606
|
+
| **Type** | `string` |
|
|
607
|
+
|
|
608
|
+
**Description:** Key in that Secret, which value will be used.
|
|
609
|
+
|
|
610
|
+
##### <a name="env_anyOf_i1_items_resourceFieldRef"></a>7.2.1.5. Property `resourceFieldRef`
|
|
611
|
+
|
|
612
|
+
| | |
|
|
613
|
+
| ------------------------- | -------------------------------------------------------------------------------------------------------- |
|
|
614
|
+
| **Type** | `object` |
|
|
615
|
+
| **Additional properties** | [](# "Additional Properties not allowed.") |
|
|
616
|
+
|
|
617
|
+
**Description:** Selects a resource of the container.
|
|
618
|
+
|
|
619
|
+
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|
|
620
|
+
| ---------------------------------------------------------------------- | ------- | ------ | ---------- | --------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
621
|
+
| - [containerName](#env_anyOf_i1_items_resourceFieldRef_containerName ) | No | string | No | Same as [name](#global_imagePullSecret_name ) | Name of a Container. |
|
|
622
|
+
| - [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. |
|
|
623
|
+
|
|
624
|
+
##### <a name="env_anyOf_i1_items_resourceFieldRef_containerName"></a>7.2.1.5.1. Property `containerName`
|
|
625
|
+
|
|
626
|
+
| | |
|
|
627
|
+
| ---------------------- | ------------------------------------ |
|
|
628
|
+
| **Type** | `string` |
|
|
629
|
+
| **Same definition as** | [name](#global_imagePullSecret_name) |
|
|
630
|
+
|
|
631
|
+
**Description:** Name of a Container.
|
|
632
|
+
|
|
633
|
+
##### <a name="env_anyOf_i1_items_resourceFieldRef_resource"></a>7.2.1.5.2. Property `resource`
|
|
634
|
+
|
|
635
|
+
| | |
|
|
636
|
+
| -------- | -------- |
|
|
637
|
+
| **Type** | `string` |
|
|
638
|
+
|
|
639
|
+
**Description:** Only resources limits and requests (limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, requests.memory and requests.ephemeral-storage) are currently supported.
|
|
640
|
+
|
|
641
|
+
##### <a name="env_anyOf_i1_items_fieldRef"></a>7.2.1.6. Property `fieldRef`
|
|
642
|
+
|
|
643
|
+
| | |
|
|
644
|
+
| ------------------------- | -------------------------------------------------------------------------------------------------------- |
|
|
645
|
+
| **Type** | `object` |
|
|
646
|
+
| **Additional properties** | [](# "Additional Properties not allowed.") |
|
|
647
|
+
|
|
648
|
+
**Description:** Selects a field of the pod.
|
|
649
|
+
|
|
650
|
+
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|
|
651
|
+
| ------------------------------------------------------ | ------- | ------ | ---------- | ---------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
652
|
+
| - [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. |
|
|
653
|
+
|
|
654
|
+
##### <a name="env_anyOf_i1_items_fieldRef_fieldPath"></a>7.2.1.6.1. Property `fieldPath`
|
|
655
|
+
|
|
656
|
+
| | |
|
|
657
|
+
| -------- | -------- |
|
|
658
|
+
| **Type** | `string` |
|
|
659
|
+
|
|
660
|
+
**Description:** Supports metadata.name, metadata.namespace, `metadata.labels['<KEY>']`, `metadata.annotations['<KEY>']`, spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs.
|
|
661
|
+
|
|
662
|
+
## <a name="envSecretNames"></a>8. ~~ Property `envSecretNames`~~
|
|
663
|
+
|
|
664
|
+
| | |
|
|
665
|
+
| -------------- | ---------------------------------------------------------- |
|
|
666
|
+
| **Type** | `array of string` |
|
|
667
|
+
| **Deprecated** |  |
|
|
668
|
+
|
|
669
|
+
**Description:** [Deprecated] Use `envFrom` instead
|
|
670
|
+
|
|
671
|
+
| Each item of this array must be | Description |
|
|
672
|
+
| --------------------------------------- | ----------- |
|
|
673
|
+
| [KubernetesName](#envSecretNames_items) | - |
|
|
674
|
+
|
|
675
|
+
### <a name="autogenerated_heading_3"></a>8.1. items
|
|
676
|
+
|
|
677
|
+
| | |
|
|
678
|
+
| ---------------------- | ------------------------------------ |
|
|
679
|
+
| **Type** | `string` |
|
|
680
|
+
| **Same definition as** | [name](#global_imagePullSecret_name) |
|
|
681
|
+
|
|
682
|
+
## <a name="envFrom"></a>9.  Property `envFrom`
|
|
683
|
+
|
|
684
|
+
| | |
|
|
685
|
+
| ----------- | ----------------- |
|
|
686
|
+
| **Type** | `array of object` |
|
|
687
|
+
| **Default** | `[]` |
|
|
688
|
+
|
|
689
|
+
**Description:** List of sources to populate environment variables in the pod.
|
|
690
|
+
|
|
691
|
+
| Each item of this array must be | Description |
|
|
692
|
+
| ------------------------------- | ----------- |
|
|
693
|
+
| [envFrom items](#envFrom_items) | - |
|
|
694
|
+
|
|
695
|
+
### <a name="autogenerated_heading_4"></a>9.1. items
|
|
696
|
+
|
|
697
|
+
| | |
|
|
698
|
+
| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- |
|
|
699
|
+
| **Type** | `combining` |
|
|
700
|
+
| **Additional properties** | [](# "Additional Properties of any type are allowed.") |
|
|
701
|
+
|
|
702
|
+
| One of(Option) |
|
|
703
|
+
| --------------------------------- |
|
|
704
|
+
| [item 0](#envFrom_items_oneOf_i0) |
|
|
705
|
+
| [item 1](#envFrom_items_oneOf_i1) |
|
|
706
|
+
|
|
707
|
+
#### <a name="envFrom_items_oneOf_i0"></a>9.1.1. Property `None`
|
|
708
|
+
|
|
709
|
+
| | |
|
|
710
|
+
| ------------------------- | -------------------------------------------------------------------------------------------------------- |
|
|
711
|
+
| **Type** | `object` |
|
|
712
|
+
| **Additional properties** | [](# "Additional Properties not allowed.") |
|
|
713
|
+
|
|
714
|
+
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|
|
715
|
+
| ------------------------------------------------------- | ------- | ------ | ---------- | ---------- | -------------------------------------------------------------------------------------------------------------- |
|
|
716
|
+
| + [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. |
|
|
717
|
+
|
|
718
|
+
##### <a name="envFrom_items_oneOf_i0_configMapRef"></a>9.1.1.1. Property `configMapRef`
|
|
719
|
+
|
|
720
|
+
| | |
|
|
721
|
+
| ------------------------- | -------------------------------------------------------------------------------------------------------- |
|
|
722
|
+
| **Type** | `object` |
|
|
723
|
+
| **Additional properties** | [](# "Additional Properties not allowed.") |
|
|
724
|
+
|
|
725
|
+
**Description:** The contents of the target ConfigMap's Data field will represent the key-value pairs as environment variables.
|
|
726
|
+
|
|
727
|
+
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|
|
728
|
+
| ---------------------------------------------------- | ------- | ------ | ---------- | --------------------------------------------- | -------------------- |
|
|
729
|
+
| + [name](#envFrom_items_oneOf_i0_configMapRef_name ) | No | string | No | Same as [name](#global_imagePullSecret_name ) | Name of a ConfigMap. |
|
|
730
|
+
|
|
731
|
+
##### <a name="envFrom_items_oneOf_i0_configMapRef_name"></a>9.1.1.1.1. Property `name`
|
|
732
|
+
|
|
733
|
+
| | |
|
|
734
|
+
| ---------------------- | ------------------------------------ |
|
|
735
|
+
| **Type** | `string` |
|
|
736
|
+
| **Same definition as** | [name](#global_imagePullSecret_name) |
|
|
737
|
+
|
|
738
|
+
**Description:** Name of a ConfigMap.
|
|
739
|
+
|
|
740
|
+
#### <a name="envFrom_items_oneOf_i1"></a>9.1.2. Property `None`
|
|
741
|
+
|
|
742
|
+
| | |
|
|
743
|
+
| ------------------------- | -------------------------------------------------------------------------------------------------------- |
|
|
744
|
+
| **Type** | `object` |
|
|
745
|
+
| **Additional properties** | [](# "Additional Properties not allowed.") |
|
|
746
|
+
|
|
747
|
+
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|
|
748
|
+
| ------------------------------------------------- | ------- | ------ | ---------- | ---------- | ----------------------------------------------------------------------------------------------------------- |
|
|
749
|
+
| + [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. |
|
|
750
|
+
|
|
751
|
+
##### <a name="envFrom_items_oneOf_i1_secretRef"></a>9.1.2.1. Property `secretRef`
|
|
752
|
+
|
|
753
|
+
| | |
|
|
754
|
+
| ------------------------- | -------------------------------------------------------------------------------------------------------- |
|
|
755
|
+
| **Type** | `object` |
|
|
756
|
+
| **Additional properties** | [](# "Additional Properties not allowed.") |
|
|
757
|
+
|
|
758
|
+
**Description:** The contents of the target Secret's Data field will represent the key-value pairs as environment variables.
|
|
759
|
+
|
|
760
|
+
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|
|
761
|
+
| ------------------------------------------------- | ------- | ------ | ---------- | --------------------------------------------- | ----------------- |
|
|
762
|
+
| + [name](#envFrom_items_oneOf_i1_secretRef_name ) | No | string | No | Same as [name](#global_imagePullSecret_name ) | Name of a Secret. |
|
|
763
|
+
|
|
764
|
+
##### <a name="envFrom_items_oneOf_i1_secretRef_name"></a>9.1.2.1.1. Property `name`
|
|
765
|
+
|
|
766
|
+
| | |
|
|
767
|
+
| ---------------------- | ------------------------------------ |
|
|
768
|
+
| **Type** | `string` |
|
|
769
|
+
| **Same definition as** | [name](#global_imagePullSecret_name) |
|
|
770
|
+
|
|
771
|
+
**Description:** Name of a Secret.
|
|
772
|
+
|
|
773
|
+
## <a name="ttlDaysAfterFinished"></a>10.  Property `ttlDaysAfterFinished`
|
|
774
|
+
|
|
775
|
+
**Title:** Time to keep the Job after it has finished.
|
|
776
|
+
|
|
777
|
+
| | |
|
|
778
|
+
| ----------- | --------- |
|
|
779
|
+
| **Type** | `integer` |
|
|
780
|
+
| **Default** | `14` |
|
|
781
|
+
|
|
782
|
+
**Description:** Number of days to keep the Kubernetes Job once it is finished. 0 means it is removed as soon as it is finished.
|
|
783
|
+
|
|
784
|
+
| Restrictions | |
|
|
785
|
+
| ------------ | ------ |
|
|
786
|
+
| **Minimum** | ≥ 0 |
|
|
787
|
+
|
|
788
|
+
## <a name="bindings"></a>11.  Property `bindings`
|
|
789
|
+
|
|
790
|
+
**Title:** Service Binding configuration
|
|
791
|
+
|
|
792
|
+
| | |
|
|
793
|
+
| ------------------------- | -------------------------------------------------------------------------------------------------------- |
|
|
794
|
+
| **Type** | `object` |
|
|
795
|
+
| **Additional properties** | [](# "Additional Properties not allowed.") |
|
|
796
|
+
|
|
797
|
+
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|
|
798
|
+
| ----------------------------------------------------- | ------- | ----------- | ---------- | ---------- | ----------------- |
|
|
799
|
+
| - [^[-._a-zA-Z][-._a-zA-Z0-9]*$](#bindings_pattern1 ) | Yes | Combination | No | - | - |
|
|
800
|
+
|
|
801
|
+
### <a name="bindings_pattern1"></a>11.1.  Pattern Property `^[-._a-zA-Z][-._a-zA-Z0-9]*$`
|
|
802
|
+
> All properties whose name matches the regular expression
|
|
803
|
+
```^[-._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))
|
|
804
|
+
must respect the following conditions
|
|
805
|
+
|
|
806
|
+
| | |
|
|
807
|
+
| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- |
|
|
808
|
+
| **Type** | `combining` |
|
|
809
|
+
| **Additional properties** | [](# "Additional Properties of any type are allowed.") |
|
|
810
|
+
|
|
811
|
+
| One of(Option) |
|
|
812
|
+
| ------------------------------------- |
|
|
813
|
+
| [item 0](#bindings_pattern1_oneOf_i0) |
|
|
814
|
+
| [item 1](#bindings_pattern1_oneOf_i1) |
|
|
815
|
+
|
|
816
|
+
#### <a name="bindings_pattern1_oneOf_i0"></a>11.1.1. Property `None`
|
|
817
|
+
|
|
818
|
+
| | |
|
|
819
|
+
| ------------------------- | -------------------------------------------------------------------------------------------------------- |
|
|
820
|
+
| **Type** | `object` |
|
|
821
|
+
| **Additional properties** | [](# "Additional Properties not allowed.") |
|
|
822
|
+
|
|
823
|
+
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|
|
824
|
+
| ------------------------------------------------------- | ------- | ------ | ---------- | --------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
825
|
+
| + [fromSecret](#bindings_pattern1_oneOf_i0_fromSecret ) | No | string | No | Same as [name](#global_imagePullSecret_name ) | Name of a Kubernetes Secret, with the binding content, compliant to the SAP Kubernetes Service Binding spec https://github.tools.sap/Kubernetes-Service-Bindings/doc/ |
|
|
826
|
+
|
|
827
|
+
##### <a name="bindings_pattern1_oneOf_i0_fromSecret"></a>11.1.1.1. Property `fromSecret`
|
|
828
|
+
|
|
829
|
+
| | |
|
|
830
|
+
| ---------------------- | ------------------------------------ |
|
|
831
|
+
| **Type** | `string` |
|
|
832
|
+
| **Same definition as** | [name](#global_imagePullSecret_name) |
|
|
833
|
+
|
|
834
|
+
**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/
|
|
835
|
+
|
|
836
|
+
#### <a name="bindings_pattern1_oneOf_i1"></a>11.1.2. Property `None`
|
|
837
|
+
|
|
838
|
+
| | |
|
|
839
|
+
| ------------------------- | -------------------------------------------------------------------------------------------------------- |
|
|
840
|
+
| **Type** | `object` |
|
|
841
|
+
| **Additional properties** | [](# "Additional Properties not allowed.") |
|
|
842
|
+
|
|
843
|
+
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|
|
844
|
+
| ------------------------------------------------------------------------------------- | ------- | ------ | ---------- | --------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
845
|
+
| - [serviceInstanceName](#bindings_pattern1_oneOf_i1_serviceInstanceName ) | No | string | No | Same as [name](#global_imagePullSecret_name ) | Name of a BTP Operator Service Instance, created by the \`service-instance\` Helm chart. Can't be used with the \`serviceInstanceFullname\` option. |
|
|
846
|
+
| - [serviceInstanceFullname](#bindings_pattern1_oneOf_i1_serviceInstanceFullname ) | No | string | No | Same as [name](#global_imagePullSecret_name ) | Full name of a BTP Operator Service Instance. Can't be used with the \`serviceInstanceName\` option. |
|
|
847
|
+
| - [externalName](#bindings_pattern1_oneOf_i1_externalName ) | No | string | No | - | The name for the service binding in SAP BTP |
|
|
848
|
+
| - [secretName](#bindings_pattern1_oneOf_i1_secretName ) | No | string | No | Same as [name](#global_imagePullSecret_name ) | The name of the secret where the credentials are stored. |
|
|
849
|
+
| - [parameters](#bindings_pattern1_oneOf_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. |
|
|
850
|
+
| - [parametersFrom](#bindings_pattern1_oneOf_i1_parametersFrom ) | No | array | No | - | List of sources to populate parameters. |
|
|
851
|
+
| - [credentialsRotationPolicy](#bindings_pattern1_oneOf_i1_credentialsRotationPolicy ) | No | object | No | - | Holds automatic credentials rotation configuration. For more details, see https://github.com/SAP/sap-btp-service-operator#spec-1 |
|
|
852
|
+
|
|
853
|
+
##### <a name="bindings_pattern1_oneOf_i1_serviceInstanceName"></a>11.1.2.1. Property `serviceInstanceName`
|
|
854
|
+
|
|
855
|
+
| | |
|
|
856
|
+
| ---------------------- | ------------------------------------ |
|
|
857
|
+
| **Type** | `string` |
|
|
858
|
+
| **Same definition as** | [name](#global_imagePullSecret_name) |
|
|
859
|
+
|
|
860
|
+
**Description:** Name of a BTP Operator Service Instance, created by the `service-instance` Helm chart. Can't be used with the `serviceInstanceFullname` option.
|
|
861
|
+
|
|
862
|
+
##### <a name="bindings_pattern1_oneOf_i1_serviceInstanceFullname"></a>11.1.2.2. Property `serviceInstanceFullname`
|
|
863
|
+
|
|
864
|
+
| | |
|
|
865
|
+
| ---------------------- | ------------------------------------ |
|
|
866
|
+
| **Type** | `string` |
|
|
867
|
+
| **Same definition as** | [name](#global_imagePullSecret_name) |
|
|
868
|
+
|
|
869
|
+
**Description:** Full name of a BTP Operator Service Instance. Can't be used with the `serviceInstanceName` option.
|
|
870
|
+
|
|
871
|
+
##### <a name="bindings_pattern1_oneOf_i1_externalName"></a>11.1.2.3. Property `externalName`
|
|
872
|
+
|
|
873
|
+
| | |
|
|
874
|
+
| -------- | -------- |
|
|
875
|
+
| **Type** | `string` |
|
|
876
|
+
|
|
877
|
+
**Description:** The name for the service binding in SAP BTP
|
|
878
|
+
|
|
879
|
+
##### <a name="bindings_pattern1_oneOf_i1_secretName"></a>11.1.2.4. Property `secretName`
|
|
880
|
+
|
|
881
|
+
| | |
|
|
882
|
+
| ---------------------- | ------------------------------------ |
|
|
883
|
+
| **Type** | `string` |
|
|
884
|
+
| **Same definition as** | [name](#global_imagePullSecret_name) |
|
|
885
|
+
|
|
886
|
+
**Description:** The name of the secret where the credentials are stored.
|
|
887
|
+
|
|
888
|
+
##### <a name="bindings_pattern1_oneOf_i1_parameters"></a>11.1.2.5. Property `parameters`
|
|
889
|
+
|
|
890
|
+
| | |
|
|
891
|
+
| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- |
|
|
892
|
+
| **Type** | `object` |
|
|
893
|
+
| **Additional properties** | [](# "Additional Properties of any type are allowed.") |
|
|
894
|
+
|
|
895
|
+
**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.
|
|
896
|
+
|
|
897
|
+
##### <a name="bindings_pattern1_oneOf_i1_parametersFrom"></a>11.1.2.6. Property `parametersFrom`
|
|
898
|
+
|
|
899
|
+
| | |
|
|
900
|
+
| -------- | ------- |
|
|
901
|
+
| **Type** | `array` |
|
|
902
|
+
|
|
903
|
+
**Description:** List of sources to populate parameters.
|
|
904
|
+
|
|
905
|
+
| Each item of this array must be | Description |
|
|
906
|
+
| ------------------------------------------------------------------------ | ----------- |
|
|
907
|
+
| [parametersFrom items](#bindings_pattern1_oneOf_i1_parametersFrom_items) | - |
|
|
908
|
+
|
|
909
|
+
##### <a name="autogenerated_heading_5"></a>11.1.2.6.1. items
|
|
910
|
+
|
|
911
|
+
| | |
|
|
912
|
+
| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- |
|
|
913
|
+
| **Type** | `combining` |
|
|
914
|
+
| **Additional properties** | [](# "Additional Properties of any type are allowed.") |
|
|
915
|
+
|
|
916
|
+
| Any of(Option) |
|
|
917
|
+
| ------------------------------------------------------------------- |
|
|
918
|
+
| [item 0](#bindings_pattern1_oneOf_i1_parametersFrom_items_anyOf_i0) |
|
|
919
|
+
| [item 1](#bindings_pattern1_oneOf_i1_parametersFrom_items_anyOf_i1) |
|
|
920
|
+
|
|
921
|
+
##### <a name="bindings_pattern1_oneOf_i1_parametersFrom_items_anyOf_i0"></a>11.1.2.6.1.1. Property `None`
|
|
922
|
+
|
|
923
|
+
| | |
|
|
924
|
+
| ------------------------- | -------------------------------------------------------------------------------------------------------- |
|
|
925
|
+
| **Type** | `object` |
|
|
926
|
+
| **Additional properties** | [](# "Additional Properties not allowed.") |
|
|
927
|
+
|
|
928
|
+
**Description:** Kubernetes Secret as a parameters source.
|
|
929
|
+
|
|
930
|
+
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|
|
931
|
+
| ----------------------------------------------------------------------------------------- | ------- | ------ | ---------- | ---------- | ----------------- |
|
|
932
|
+
| - [secretKeyRef](#bindings_pattern1_oneOf_i1_parametersFrom_items_anyOf_i0_secretKeyRef ) | No | object | No | - | - |
|
|
933
|
+
|
|
934
|
+
##### <a name="bindings_pattern1_oneOf_i1_parametersFrom_items_anyOf_i0_secretKeyRef"></a>11.1.2.6.1.1.1. Property `secretKeyRef`
|
|
935
|
+
|
|
936
|
+
| | |
|
|
937
|
+
| ------------------------- | -------------------------------------------------------------------------------------------------------- |
|
|
938
|
+
| **Type** | `object` |
|
|
939
|
+
| **Additional properties** | [](# "Additional Properties not allowed.") |
|
|
940
|
+
|
|
941
|
+
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|
|
942
|
+
| -------------------------------------------------------------------------------------- | ------- | ------ | ---------- | --------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- |
|
|
943
|
+
| + [name](#bindings_pattern1_oneOf_i1_parametersFrom_items_anyOf_i0_secretKeyRef_name ) | No | string | No | Same as [name](#global_imagePullSecret_name ) | Name of a Secret. |
|
|
944
|
+
| + [key](#bindings_pattern1_oneOf_i1_parametersFrom_items_anyOf_i0_secretKeyRef_key ) | No | string | No | - | Key in that Secret, which contains a string that represents the json to include in the set of parameters to be sent to the broker. |
|
|
945
|
+
|
|
946
|
+
##### <a name="bindings_pattern1_oneOf_i1_parametersFrom_items_anyOf_i0_secretKeyRef_name"></a>11.1.2.6.1.1.1.1. Property `name`
|
|
947
|
+
|
|
948
|
+
| | |
|
|
949
|
+
| ---------------------- | ------------------------------------ |
|
|
950
|
+
| **Type** | `string` |
|
|
951
|
+
| **Same definition as** | [name](#global_imagePullSecret_name) |
|
|
952
|
+
|
|
953
|
+
**Description:** Name of a Secret.
|
|
954
|
+
|
|
955
|
+
##### <a name="bindings_pattern1_oneOf_i1_parametersFrom_items_anyOf_i0_secretKeyRef_key"></a>11.1.2.6.1.1.1.2. Property `key`
|
|
956
|
+
|
|
957
|
+
| | |
|
|
958
|
+
| -------- | -------- |
|
|
959
|
+
| **Type** | `string` |
|
|
960
|
+
|
|
961
|
+
**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.
|
|
962
|
+
|
|
963
|
+
##### <a name="bindings_pattern1_oneOf_i1_parametersFrom_items_anyOf_i1"></a>11.1.2.6.1.2. Property `None`
|
|
964
|
+
|
|
965
|
+
| | |
|
|
966
|
+
| ------------------------- | -------------------------------------------------------------------------------------------------------- |
|
|
967
|
+
| **Type** | `object` |
|
|
968
|
+
| **Additional properties** | [](# "Additional Properties not allowed.") |
|
|
969
|
+
|
|
970
|
+
**Description:** Kubernetes Config Map as a parameters source.
|
|
971
|
+
|
|
972
|
+
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|
|
973
|
+
| ----------------------------------------------------------------------------------------------- | ------- | ------ | ---------- | ---------- | ----------------- |
|
|
974
|
+
| - [configMapKeyRef](#bindings_pattern1_oneOf_i1_parametersFrom_items_anyOf_i1_configMapKeyRef ) | No | object | No | - | - |
|
|
975
|
+
|
|
976
|
+
##### <a name="bindings_pattern1_oneOf_i1_parametersFrom_items_anyOf_i1_configMapKeyRef"></a>11.1.2.6.1.2.1. Property `configMapKeyRef`
|
|
977
|
+
|
|
978
|
+
| | |
|
|
979
|
+
| ------------------------- | -------------------------------------------------------------------------------------------------------- |
|
|
980
|
+
| **Type** | `object` |
|
|
981
|
+
| **Additional properties** | [](# "Additional Properties not allowed.") |
|
|
982
|
+
|
|
983
|
+
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|
|
984
|
+
| ----------------------------------------------------------------------------------------- | ------- | ------ | ---------- | --------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- |
|
|
985
|
+
| + [name](#bindings_pattern1_oneOf_i1_parametersFrom_items_anyOf_i1_configMapKeyRef_name ) | No | string | No | Same as [name](#global_imagePullSecret_name ) | Name of a Config Map |
|
|
986
|
+
| + [key](#bindings_pattern1_oneOf_i1_parametersFrom_items_anyOf_i1_configMapKeyRef_key ) | No | string | No | - | Key in that Config Map, which contains a string that represents the json to include in the set of parameters to be sent to the broker. |
|
|
987
|
+
|
|
988
|
+
##### <a name="bindings_pattern1_oneOf_i1_parametersFrom_items_anyOf_i1_configMapKeyRef_name"></a>11.1.2.6.1.2.1.1. Property `name`
|
|
989
|
+
|
|
990
|
+
| | |
|
|
991
|
+
| ---------------------- | ------------------------------------ |
|
|
992
|
+
| **Type** | `string` |
|
|
993
|
+
| **Same definition as** | [name](#global_imagePullSecret_name) |
|
|
994
|
+
|
|
995
|
+
**Description:** Name of a Config Map
|
|
996
|
+
|
|
997
|
+
##### <a name="bindings_pattern1_oneOf_i1_parametersFrom_items_anyOf_i1_configMapKeyRef_key"></a>11.1.2.6.1.2.1.2. Property `key`
|
|
998
|
+
|
|
999
|
+
| | |
|
|
1000
|
+
| -------- | -------- |
|
|
1001
|
+
| **Type** | `string` |
|
|
1002
|
+
|
|
1003
|
+
**Description:** Key in that Config Map, which contains a string that represents the json to include in the set of parameters to be sent to the broker.
|
|
1004
|
+
|
|
1005
|
+
##### <a name="bindings_pattern1_oneOf_i1_credentialsRotationPolicy"></a>11.1.2.7. Property `credentialsRotationPolicy`
|
|
1006
|
+
|
|
1007
|
+
| | |
|
|
1008
|
+
| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- |
|
|
1009
|
+
| **Type** | `object` |
|
|
1010
|
+
| **Additional properties** | [](# "Additional Properties of any type are allowed.") |
|
|
1011
|
+
|
|
1012
|
+
**Description:** Holds automatic credentials rotation configuration. For more details, see https://github.com/SAP/sap-btp-service-operator#spec-1
|
|
1013
|
+
|
|
1014
|
+
----------------------------------------------------------------------------------------------------------------------------
|