@sap/cds-dk 6.0.3 → 6.1.2
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 +62 -0
- package/bin/add.js +29 -16
- package/bin/compile/index.js +7 -2
- package/bin/fix-redirects.js +4 -2
- package/bin/init.js +5 -0
- package/bin/login.js +20 -4
- package/bin/pull.js +58 -0
- package/bin/push.js +52 -0
- package/bin/subscribe.js +45 -0
- package/lib/bind/bindingUtil.js +1 -2
- package/lib/bind/cfKeyProvider.js +3 -3
- package/lib/cds.js +2 -3
- package/lib/client/activate.js +17 -16
- package/lib/client/auth_manager.js +10 -5
- package/lib/client/base_command.js +4 -6
- package/lib/client/extend.js +3 -2
- package/lib/client/helper/cf_helper.js +1 -0
- package/lib/client/helper/errors.js +11 -0
- package/lib/client/helper/logging.js +3 -10
- package/lib/client/helper/url_helper.js +7 -3
- package/lib/client/index.js +1 -1
- package/lib/client/params.js +9 -6
- package/lib/client/pull.js +48 -0
- package/lib/client/push.js +45 -0
- package/lib/client/settings_manager.js +81 -27
- package/lib/compile/openapi/csdl2openapi.js +135 -163
- package/lib/compile/openapi/index.js +0 -1
- package/lib/import/common.js +9 -1
- package/lib/import/odata/metadataconverter/MetadataConverter.js +17 -4
- package/lib/import/odata/v2parser.js +50 -26
- package/lib/import/odata/v4parser.js +110 -29
- package/lib/import/openapi/importOpenAPI.js +3 -3
- package/lib/init/constants.js +9 -3
- package/lib/init/template/_merging/registry-mta.js +284 -0
- package/lib/init/template/approuter/files/xs-app.json.hbs +7 -7
- package/lib/init/template/approuter/index.js +22 -32
- package/lib/init/template/auditlog/index.js +7 -9
- package/lib/init/template/data/index.js +2 -4
- package/lib/init/template/extensibility/files/cds.package.json +7 -0
- package/lib/init/template/extensibility/files/cds.package.json.hbs +9 -0
- package/lib/init/template/extensibility/files/xs-security.json.hbs +26 -0
- package/lib/init/template/extensibility/index.js +48 -0
- package/lib/init/template/hana/files/java/cdsrc.json.hbs +1 -1
- package/lib/init/template/hana/files/java/profile.cdsrc.json.hbs +2 -2
- package/lib/init/template/hana/files/mta.yaml.hbs +10 -0
- package/lib/init/template/hana/files/nodejs/cds.package.json.hbs +1 -1
- package/lib/init/template/hana/files/nodejs/cds.profile.package.json.hbs +2 -2
- package/lib/init/template/hana/index.js +76 -63
- package/lib/init/template/kibana-logging/index.js +31 -37
- package/lib/init/template/lint/files/.eslint/rules/no-entity-moo.js +14 -14
- package/lib/init/template/mta/files/mta.yaml.hbs +1 -1
- package/lib/init/template/mta/index.js +13 -7
- package/lib/init/template/mtx/index.js +2 -142
- package/lib/init/template/multitenancy/files/cds.package.json +7 -0
- package/lib/init/template/multitenancy/files/cds.package.json.hbs +9 -0
- package/lib/init/template/{mtx → multitenancy}/files/dependencies.package.json +1 -1
- package/lib/init/template/multitenancy/files/java/.cdsrc.json +19 -0
- package/lib/init/template/multitenancy/files/java/package.json +31 -0
- package/lib/init/template/{mtx → multitenancy}/files/mta.yaml.hbs +13 -6
- package/lib/init/template/multitenancy/files/xs-security.json.hbs +18 -0
- package/lib/init/template/multitenancy/index.js +109 -0
- package/lib/init/template/nodejs/files/package.json.hbs +3 -0
- package/lib/init/template/templateBase.js +2 -1
- package/lib/init/template/toggles/files/cds.package.json +7 -0
- package/lib/init/template/toggles/files/cds.package.json.hbs +9 -0
- package/lib/init/template/toggles/index.js +24 -0
- package/lib/init/template/xsuaa/files/mta.yaml.hbs +10 -0
- package/lib/init/template/xsuaa/index.js +44 -33
- package/lib/init/util/projectReader.js +12 -7
- package/lib/init/util/templateUtil.js +113 -111
- package/lib/k8s/ChartAdder.js +13 -3
- package/lib/k8s/ChartBuilder.js +6 -0
- package/lib/k8s/buildModel.js +1 -3
- package/lib/k8s/connectivity/index.js +5 -5
- package/lib/k8s/deployment/index.js +2 -4
- package/lib/k8s/deployment/subchart/Chart.yaml +1 -1
- package/lib/k8s/deployment/subchart/templates/_helpers.tpl +22 -11
- package/lib/k8s/deployment/subchart/templates/deployment.yaml +12 -5
- package/lib/k8s/deployment/subchart/templates/network-policy.yaml +3 -1
- package/lib/k8s/deployment/subchart/templates/pod-disruption-budget.yaml +1 -1
- package/lib/k8s/deployment/subchart/values.md +812 -0
- package/lib/k8s/deployment/subchart/values.schema.json +125 -30
- package/lib/k8s/deployment/subchart/values.yaml +7 -3
- package/lib/k8s/hana-deployer/index.js +10 -0
- package/lib/k8s/hana-deployer/templates/hana-deployer-job.yaml +8 -0
- package/lib/k8s/html5-apps-deployer/index.js +10 -0
- package/lib/k8s/html5-apps-deployer/templates/html5-apps-deployer-job.yaml +8 -0
- package/lib/k8s/index.js +2 -2
- package/lib/k8s/resources/helm/chart/schemas/values.root.schema.json +11 -0
- package/lib/k8s/resources/helm/chart/schemas/values.schema.json +479 -0
- package/lib/k8s/resources/helm/chart/templates/_deployment_helpers.tpl +1 -159
- package/lib/k8s/resources/helm/chart/templates/_helpers.tpl +0 -33
- package/lib/k8s/resources/helm/chart/templates/_sapcp_helpers.tpl +1 -1
- package/lib/lint/Linter.js +155 -158
- package/lib/lint/io.js +12 -5
- package/npm-shrinkwrap.json +1052 -135
- package/package.json +5 -4
- package/lib/init/template/_merging/existences.js +0 -297
- package/lib/init/template/mtx/files/cds.package.json +0 -12
- package/lib/init/template/mtx/files/cds.package.json.hbs +0 -14
- package/lib/init/template/mtx/files/java/.cdsrc.json +0 -17
- package/lib/init/template/mtx/files/java/package.json +0 -43
- package/lib/init/template/mtx/files/java/server.js +0 -30
- package/lib/init/template/mtx/files/xs-security.json.hbs +0 -48
- package/lib/lint/.eslintrc.js +0 -3
|
@@ -0,0 +1,812 @@
|
|
|
1
|
+
# Schema Docs
|
|
2
|
+
|
|
3
|
+
| Type | `object` |
|
|
4
|
+
| ------------------------- | -------------------------------------------------------------------------------------------------------- |
|
|
5
|
+
| **Additional properties** | [](# "Additional Properties not allowed.") |
|
|
6
|
+
|
|
7
|
+
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|
|
8
|
+
| -------------------------------------------- | ------- | --------------- | ---------- | ---------- | ------------------------------------------------------------------------------------ |
|
|
9
|
+
| - [global](#global ) | No | object | No | - | Helm global values |
|
|
10
|
+
| - [nameOverride](#nameOverride ) | No | string | No | - | Chart name override |
|
|
11
|
+
| - [fullnameOverride](#fullnameOverride ) | No | string | No | - | Override for the '.fullname' helper function. |
|
|
12
|
+
| - [replicaCount](#replicaCount ) | No | integer | No | - | Replica count |
|
|
13
|
+
| - [port](#port ) | No | integer | No | - | Port |
|
|
14
|
+
| - [serviceAccountName](#serviceAccountName ) | No | Combination | No | - | Service Account name |
|
|
15
|
+
| + [image](#image ) | No | object | No | - | Image configuration |
|
|
16
|
+
| - [imagePullSecret](#imagePullSecret ) | No | object | No | - | Image Pull Secret configuration |
|
|
17
|
+
| - [additionalVolumes](#additionalVolumes ) | No | array of object | No | - | Additional Pod volumes |
|
|
18
|
+
| - [ha](#ha ) | No | object | No | - | High Availability configuration |
|
|
19
|
+
| + [resources](#resources ) | No | object | No | - | Pod resources configuration |
|
|
20
|
+
| - [health_check](#health_check ) | No | object | No | - | Health-check configuration |
|
|
21
|
+
| - [startupTimeout](#startupTimeout ) | No | integer | No | - | Initial timeout in seconds, during which the app must start giving the response ... |
|
|
22
|
+
| - [env](#env ) | No | object | No | - | Key-value map of environment variables, which should be added to the Pod spec. |
|
|
23
|
+
| - [envSecretNames](#envSecretNames ) | No | array | No | - | List of Kubernetes Secret names, used as sources for the Pod's environment varia ... |
|
|
24
|
+
| - [expose](#expose ) | No | object | No | - | - |
|
|
25
|
+
| - [bindings](#bindings ) | No | object | No | - | Service Binding configuration |
|
|
26
|
+
|
|
27
|
+
## <a name="global"></a>1.  Property `global`
|
|
28
|
+
|
|
29
|
+
**Title:** Helm global values
|
|
30
|
+
|
|
31
|
+
| Type | `object` |
|
|
32
|
+
| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- |
|
|
33
|
+
| **Additional properties** | [](# "Additional Properties of any type are allowed.") |
|
|
34
|
+
|
|
35
|
+
**Description:** For more information, see https://helm.sh/docs/chart_template_guide/subcharts_and_globals/#global-chart-values
|
|
36
|
+
|
|
37
|
+
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|
|
38
|
+
| ------------------------------------------------------- | ------- | ------ | ---------- | ---------- | ------------------------------- |
|
|
39
|
+
| - [imagePullSecret](#global_imagePullSecret ) | No | object | No | - | Image Pull Secret configuration |
|
|
40
|
+
| - [image](#global_image ) | No | object | No | - | Image configuration |
|
|
41
|
+
| - [additionalProperties](#global_additionalProperties ) | No | object | No | - | - |
|
|
42
|
+
|
|
43
|
+
### <a name="global_imagePullSecret"></a>1.1.  Property `imagePullSecret`
|
|
44
|
+
|
|
45
|
+
**Title:** Image Pull Secret configuration
|
|
46
|
+
|
|
47
|
+
| Type | `object` |
|
|
48
|
+
| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- |
|
|
49
|
+
| **Additional properties** | [](# "Additional Properties of any type are allowed.") |
|
|
50
|
+
|
|
51
|
+
**Description:** For more information, see https://kubernetes.io/docs/tasks/configure-pod-container/pull-image-private-registry/
|
|
52
|
+
|
|
53
|
+
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|
|
54
|
+
| ----------------------------------------------------------------------- | ------- | ------ | ---------- | ------------------------------- | ----------------- |
|
|
55
|
+
| - [name](#global_imagePullSecret_name ) | No | string | No | In #/definitions/KubernetesName | Secret name |
|
|
56
|
+
| - [dockerconfigjson](#global_imagePullSecret_dockerconfigjson ) | No | string | No | - | Secret content |
|
|
57
|
+
| - [additionalProperties](#global_imagePullSecret_additionalProperties ) | No | object | No | - | - |
|
|
58
|
+
|
|
59
|
+
#### <a name="global_imagePullSecret_name"></a>1.1.1.  Property `name`
|
|
60
|
+
|
|
61
|
+
**Title:** Secret name
|
|
62
|
+
|
|
63
|
+
| Type | `string` |
|
|
64
|
+
| -------------- | ---------------------------- |
|
|
65
|
+
| **Defined in** | #/definitions/KubernetesName |
|
|
66
|
+
|
|
67
|
+
**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.
|
|
68
|
+
|
|
69
|
+
| Restrictions | |
|
|
70
|
+
| --------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
71
|
+
| **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) |
|
|
72
|
+
|
|
73
|
+
#### <a name="global_imagePullSecret_dockerconfigjson"></a>1.1.2.  Property `dockerconfigjson`
|
|
74
|
+
|
|
75
|
+
**Title:** Secret content
|
|
76
|
+
|
|
77
|
+
| Type | `string` |
|
|
78
|
+
| ---- | -------- |
|
|
79
|
+
|
|
80
|
+
**Description:** The content for the dynamically generated Kubernetes Secret, which will be used as an image pull secret. Can't be used with the `name` option.
|
|
81
|
+
|
|
82
|
+
### <a name="global_image"></a>1.2.  Property `image`
|
|
83
|
+
|
|
84
|
+
**Title:** Image configuration
|
|
85
|
+
|
|
86
|
+
| Type | `object` |
|
|
87
|
+
| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- |
|
|
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 ... |
|
|
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
|
+
| Type | `string` |
|
|
101
|
+
| -------------- | ---------------------- |
|
|
102
|
+
| **Defined in** | #/definitions/ImageTag |
|
|
103
|
+
|
|
104
|
+
**Description:** Image tag without the name (everything after the `:` sign, potentially including the `@sha256` section at the end).
|
|
105
|
+
|
|
106
|
+
| Restrictions | |
|
|
107
|
+
| --------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
108
|
+
| **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) |
|
|
109
|
+
|
|
110
|
+
#### <a name="global_image_registry"></a>1.2.2.  Property `registry`
|
|
111
|
+
|
|
112
|
+
| Type | `string` |
|
|
113
|
+
| -------------- | --------------------------- |
|
|
114
|
+
| **Defined in** | #/definitions/ImageRegistry |
|
|
115
|
+
|
|
116
|
+
**Description:** Image registry e.g. docker.io
|
|
117
|
+
|
|
118
|
+
| Restrictions | |
|
|
119
|
+
| --------------------------------- | ----------------------------------------------------------------------------- |
|
|
120
|
+
| **Must match regular expression** | ```^[\w-./]+$``` [Test](https://regex101.com/?regex=%5E%5B%5Cw-.%2F%5D%2B%24) |
|
|
121
|
+
|
|
122
|
+
## <a name="nameOverride"></a>2.  Property `nameOverride`
|
|
123
|
+
|
|
124
|
+
**Title:** Chart name override
|
|
125
|
+
|
|
126
|
+
| Type | `string` |
|
|
127
|
+
| ---- | -------- |
|
|
128
|
+
|
|
129
|
+
**Description:** Will be used instead of the `.Chart.Name`, e.g. when generating the Deployment name.
|
|
130
|
+
|
|
131
|
+
| Restrictions | |
|
|
132
|
+
| --------------------------------- | ------------------------------------------------------------------------------------------- |
|
|
133
|
+
| **Must match regular expression** | ```[0-9a-z][0-9a-z-.]*``` [Test](https://regex101.com/?regex=%5B0-9a-z%5D%5B0-9a-z-.%5D%2A) |
|
|
134
|
+
|
|
135
|
+
## <a name="fullnameOverride"></a>3.  Property `fullnameOverride`
|
|
136
|
+
|
|
137
|
+
**Title:** Override for the `.fullname` helper function.
|
|
138
|
+
|
|
139
|
+
| Type | `string` |
|
|
140
|
+
| ---- | -------- |
|
|
141
|
+
|
|
142
|
+
**Description:** Will be used as an override for the `.fullname` helper function (i.e. `.Release.Name-.Chart.Name`).
|
|
143
|
+
|
|
144
|
+
| Restrictions | |
|
|
145
|
+
| --------------------------------- | ------------------------------------------------------------------------------------------- |
|
|
146
|
+
| **Must match regular expression** | ```[0-9a-z][0-9a-z-.]*``` [Test](https://regex101.com/?regex=%5B0-9a-z%5D%5B0-9a-z-.%5D%2A) |
|
|
147
|
+
|
|
148
|
+
## <a name="replicaCount"></a>4.  Property `replicaCount`
|
|
149
|
+
|
|
150
|
+
**Title:** Replica count
|
|
151
|
+
|
|
152
|
+
| Type | `integer` |
|
|
153
|
+
| ----------- | --------- |
|
|
154
|
+
| **Default** | `1` |
|
|
155
|
+
|
|
156
|
+
**Description:** Number of desired pods within the Deployment.
|
|
157
|
+
|
|
158
|
+
| Restrictions | |
|
|
159
|
+
| ------------ | ------ |
|
|
160
|
+
| **Minimum** | ≥ 1 |
|
|
161
|
+
|
|
162
|
+
## <a name="port"></a>5.  Property `port`
|
|
163
|
+
|
|
164
|
+
**Title:** Port
|
|
165
|
+
|
|
166
|
+
| Type | `integer` |
|
|
167
|
+
| ----------- | --------- |
|
|
168
|
+
| **Default** | `8080` |
|
|
169
|
+
|
|
170
|
+
**Description:** Application's exposed port.
|
|
171
|
+
|
|
172
|
+
| Restrictions | |
|
|
173
|
+
| ------------ | ---------- |
|
|
174
|
+
| **Minimum** | ≥ 1 |
|
|
175
|
+
| **Maximum** | ≤ 65535 |
|
|
176
|
+
|
|
177
|
+
## <a name="serviceAccountName"></a>6.  Property `serviceAccountName`
|
|
178
|
+
|
|
179
|
+
**Title:** Service Account name
|
|
180
|
+
|
|
181
|
+
| Type | `combining` |
|
|
182
|
+
| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- |
|
|
183
|
+
| **Additional properties** | [](# "Additional Properties of any type are allowed.") |
|
|
184
|
+
| **Default** | `"default"` |
|
|
185
|
+
|
|
186
|
+
**Description:** Name of the Service Account assigned to pods.
|
|
187
|
+
|
|
188
|
+
| All of(Requirement) |
|
|
189
|
+
| ---------------------------------------------- |
|
|
190
|
+
| [KubernetesName](#serviceAccountName_allOf_i0) |
|
|
191
|
+
|
|
192
|
+
### <a name="serviceAccountName_allOf_i0"></a>6.1. Property `None`
|
|
193
|
+
|
|
194
|
+
| Type | `string` |
|
|
195
|
+
| ---------------------- | ------------------------------------ |
|
|
196
|
+
| **Same definition as** | [name](#global_imagePullSecret_name) |
|
|
197
|
+
|
|
198
|
+
## <a name="image"></a>7.  Property `image`
|
|
199
|
+
|
|
200
|
+
**Title:** Image configuration
|
|
201
|
+
|
|
202
|
+
| Type | `object` |
|
|
203
|
+
| ------------------------- | -------------------------------------------------------------------------------------------------------- |
|
|
204
|
+
| **Additional properties** | [](# "Additional Properties not allowed.") |
|
|
205
|
+
|
|
206
|
+
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|
|
207
|
+
| ---------------------------------- | ------- | ------ | ---------- | ------------------------------------------- | ------------------------------------------------------------------------------------ |
|
|
208
|
+
| + [repository](#image_repository ) | No | string | No | - | Repository of the image |
|
|
209
|
+
| - [tag](#image_tag ) | No | string | No | Same as [tag](#global_image_tag ) | Image tag without the name (everything after the ':' sign, potentially including ... |
|
|
210
|
+
| - [registry](#image_registry ) | No | string | No | Same as [registry](#global_image_registry ) | Image registry e.g. docker.io |
|
|
211
|
+
|
|
212
|
+
### <a name="image_repository"></a>7.1.  Property `repository`
|
|
213
|
+
|
|
214
|
+
**Title:** Repository of the image
|
|
215
|
+
|
|
216
|
+
| Type | `string` |
|
|
217
|
+
| ---- | -------- |
|
|
218
|
+
|
|
219
|
+
**Description:** Should also include the image name (i.e. everything before the `:` sign).
|
|
220
|
+
|
|
221
|
+
| Restrictions | |
|
|
222
|
+
| --------------------------------- | ------------------------------------------------------------------------------------------------------------- |
|
|
223
|
+
| **Must match regular expression** | ```^[\w-./:]*[@sha256]*$``` [Test](https://regex101.com/?regex=%5E%5B%5Cw-.%2F%3A%5D%2A%5B%40sha256%5D%2A%24) |
|
|
224
|
+
|
|
225
|
+
### <a name="image_tag"></a>7.2.  Property `tag`
|
|
226
|
+
|
|
227
|
+
| Type | `string` |
|
|
228
|
+
| ---------------------- | ------------------------ |
|
|
229
|
+
| **Same definition as** | [tag](#global_image_tag) |
|
|
230
|
+
|
|
231
|
+
**Description:** Image tag without the name (everything after the `:` sign, potentially including the `@sha256` section at the end).
|
|
232
|
+
|
|
233
|
+
### <a name="image_registry"></a>7.3.  Property `registry`
|
|
234
|
+
|
|
235
|
+
| Type | `string` |
|
|
236
|
+
| ---------------------- | ---------------------------------- |
|
|
237
|
+
| **Same definition as** | [registry](#global_image_registry) |
|
|
238
|
+
|
|
239
|
+
**Description:** Image registry e.g. docker.io
|
|
240
|
+
|
|
241
|
+
## <a name="imagePullSecret"></a>8.  Property `imagePullSecret`
|
|
242
|
+
|
|
243
|
+
**Title:** Image Pull Secret configuration
|
|
244
|
+
|
|
245
|
+
| Type | `object` |
|
|
246
|
+
| ------------------------- | -------------------------------------------------------------------------------------------------------- |
|
|
247
|
+
| **Additional properties** | [](# "Additional Properties not allowed.") |
|
|
248
|
+
|
|
249
|
+
**Description:** For more information, see https://kubernetes.io/docs/tasks/configure-pod-container/pull-image-private-registry/
|
|
250
|
+
|
|
251
|
+
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|
|
252
|
+
| -------------------------------------------------------- | ------- | ------ | ---------- | --------------------------------------------- | ----------------- |
|
|
253
|
+
| - [name](#imagePullSecret_name ) | No | string | No | Same as [name](#global_imagePullSecret_name ) | Secret name |
|
|
254
|
+
| - [dockerconfigjson](#imagePullSecret_dockerconfigjson ) | No | string | No | - | Secret content |
|
|
255
|
+
|
|
256
|
+
### <a name="imagePullSecret_name"></a>8.1.  Property `name`
|
|
257
|
+
|
|
258
|
+
**Title:** Secret name
|
|
259
|
+
|
|
260
|
+
| Type | `string` |
|
|
261
|
+
| ---------------------- | ------------------------------------ |
|
|
262
|
+
| **Same definition as** | [name](#global_imagePullSecret_name) |
|
|
263
|
+
|
|
264
|
+
**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.
|
|
265
|
+
|
|
266
|
+
### <a name="imagePullSecret_dockerconfigjson"></a>8.2.  Property `dockerconfigjson`
|
|
267
|
+
|
|
268
|
+
**Title:** Secret content
|
|
269
|
+
|
|
270
|
+
| Type | `string` |
|
|
271
|
+
| ---- | -------- |
|
|
272
|
+
|
|
273
|
+
**Description:** The content for the dynamically generated Kubernetes Secret, which will be used as an image pull secret. Can't be used with the `name` option.
|
|
274
|
+
|
|
275
|
+
## <a name="additionalVolumes"></a>9.  Property `additionalVolumes`
|
|
276
|
+
|
|
277
|
+
**Title:** Additional Pod volumes
|
|
278
|
+
|
|
279
|
+
| Type | `array of object` |
|
|
280
|
+
| ----------- | ----------------- |
|
|
281
|
+
| **Default** | `[]` |
|
|
282
|
+
|
|
283
|
+
**Description:** List of volumes, which should be mounted into Pods
|
|
284
|
+
|
|
285
|
+
| Each item of this array must be | Description |
|
|
286
|
+
| ----------------------------------------------------------- | ----------- |
|
|
287
|
+
| [Additional volume configuration](#additionalVolumes_items) | - |
|
|
288
|
+
|
|
289
|
+
### <a name="autogenerated_heading_2"></a>9.1. items
|
|
290
|
+
|
|
291
|
+
**Title:** Additional volume configuration
|
|
292
|
+
|
|
293
|
+
| Type | `object` |
|
|
294
|
+
| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- |
|
|
295
|
+
| **Additional properties** | [](# "Additional Properties of any type are allowed.") |
|
|
296
|
+
|
|
297
|
+
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|
|
298
|
+
| ------------------------------------------------------------------------ | ------- | ------ | ---------- | --------------------------------------------- | -------------------------- |
|
|
299
|
+
| + [name](#additionalVolumes_items_name ) | No | string | No | Same as [name](#global_imagePullSecret_name ) | Name of the volume |
|
|
300
|
+
| + [volumeMount](#additionalVolumes_items_volumeMount ) | No | object | No | - | Volume mount configuration |
|
|
301
|
+
| - [additionalProperties](#additionalVolumes_items_additionalProperties ) | No | object | No | - | - |
|
|
302
|
+
|
|
303
|
+
#### <a name="additionalVolumes_items_name"></a>9.1.1. Property `name`
|
|
304
|
+
|
|
305
|
+
**Title:** Name of the volume
|
|
306
|
+
|
|
307
|
+
| Type | `string` |
|
|
308
|
+
| ---------------------- | ------------------------------------ |
|
|
309
|
+
| **Same definition as** | [name](#global_imagePullSecret_name) |
|
|
310
|
+
|
|
311
|
+
#### <a name="additionalVolumes_items_volumeMount"></a>9.1.2. Property `volumeMount`
|
|
312
|
+
|
|
313
|
+
**Title:** Volume mount configuration
|
|
314
|
+
|
|
315
|
+
| Type | `object` |
|
|
316
|
+
| ------------------------- | -------------------------------------------------------------------------------------------------------- |
|
|
317
|
+
| **Additional properties** | [](# "Additional Properties not allowed.") |
|
|
318
|
+
|
|
319
|
+
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|
|
320
|
+
| ---------------------------------------------------------------------------- | ------- | ---------------- | ---------- | ---------- | ------------------------------------------------------------------------------------ |
|
|
321
|
+
| + [mountPath](#additionalVolumes_items_volumeMount_mountPath ) | No | string | No | - | Path within a Pod, where the volume should be mounted. |
|
|
322
|
+
| - [mountPropagation](#additionalVolumes_items_volumeMount_mountPropagation ) | No | enum (of string) | No | - | Mount propagation allows for sharing volumes mounted by a container to other con ... |
|
|
323
|
+
| - [readOnly](#additionalVolumes_items_volumeMount_readOnly ) | No | boolean | No | - | Whether mounted volume should be in read-only mode. |
|
|
324
|
+
| - [subPath](#additionalVolumes_items_volumeMount_subPath ) | No | string | No | - | Sub-path inside the referenced volume instead of its root. |
|
|
325
|
+
| - [subPathExpr](#additionalVolumes_items_volumeMount_subPathExpr ) | No | string | No | - | Similar to the 'subPath', but can be constructed using the downward API environm ... |
|
|
326
|
+
|
|
327
|
+
##### <a name="additionalVolumes_items_volumeMount_mountPath"></a>9.1.2.1. Property `mountPath`
|
|
328
|
+
|
|
329
|
+
| Type | `string` |
|
|
330
|
+
| ---- | -------- |
|
|
331
|
+
|
|
332
|
+
**Description:** Path within a Pod, where the volume should be mounted.
|
|
333
|
+
|
|
334
|
+
| Restrictions | |
|
|
335
|
+
| --------------------------------- | ----------------------------------------------------------------------- |
|
|
336
|
+
| **Must match regular expression** | ```^[^:]*$``` [Test](https://regex101.com/?regex=%5E%5B%5E%3A%5D%2A%24) |
|
|
337
|
+
|
|
338
|
+
##### <a name="additionalVolumes_items_volumeMount_mountPropagation"></a>9.1.2.2. Property `mountPropagation`
|
|
339
|
+
|
|
340
|
+
| Type | `enum (of string)` |
|
|
341
|
+
| ---- | ------------------ |
|
|
342
|
+
|
|
343
|
+
**Description:** Mount propagation allows for sharing volumes mounted by a container to other containers in the same pod, or even to other pods on the same node.
|
|
344
|
+
|
|
345
|
+
Must be one of:
|
|
346
|
+
* "None"
|
|
347
|
+
* "HostToContainer"
|
|
348
|
+
|
|
349
|
+
##### <a name="additionalVolumes_items_volumeMount_readOnly"></a>9.1.2.3. Property `readOnly`
|
|
350
|
+
|
|
351
|
+
| Type | `boolean` |
|
|
352
|
+
| ---- | --------- |
|
|
353
|
+
|
|
354
|
+
**Description:** Whether mounted volume should be in read-only mode.
|
|
355
|
+
|
|
356
|
+
##### <a name="additionalVolumes_items_volumeMount_subPath"></a>9.1.2.4. Property `subPath`
|
|
357
|
+
|
|
358
|
+
| Type | `string` |
|
|
359
|
+
| ---- | -------- |
|
|
360
|
+
|
|
361
|
+
**Description:** Sub-path inside the referenced volume instead of its root.
|
|
362
|
+
|
|
363
|
+
##### <a name="additionalVolumes_items_volumeMount_subPathExpr"></a>9.1.2.5. Property `subPathExpr`
|
|
364
|
+
|
|
365
|
+
| Type | `string` |
|
|
366
|
+
| ---- | -------- |
|
|
367
|
+
|
|
368
|
+
**Description:** Similar to the `subPath`, but can be constructed using the downward API environment variables. For more info, see https://kubernetes.io/docs/concepts/storage/volumes/#using-subpath-expanded-environment
|
|
369
|
+
|
|
370
|
+
## <a name="ha"></a>10.  Property `ha`
|
|
371
|
+
|
|
372
|
+
**Title:** High Availability configuration
|
|
373
|
+
|
|
374
|
+
| Type | `object` |
|
|
375
|
+
| ------------------------- | -------------------------------------------------------------------------------------------------------- |
|
|
376
|
+
| **Additional properties** | [](# "Additional Properties not allowed.") |
|
|
377
|
+
|
|
378
|
+
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|
|
379
|
+
| ------------------------- | ------- | ------- | ---------- | ---------- | ------------------------------------------------------------------------------------ |
|
|
380
|
+
| - [enabled](#ha_enabled ) | No | boolean | No | - | Enables additional high-availability related configuration, like Pod Disruption ... |
|
|
381
|
+
|
|
382
|
+
### <a name="ha_enabled"></a>10.1.  Property `enabled`
|
|
383
|
+
|
|
384
|
+
| Type | `boolean` |
|
|
385
|
+
| ----------- | --------- |
|
|
386
|
+
| **Default** | `true` |
|
|
387
|
+
|
|
388
|
+
**Description:** Enables additional high-availability related configuration, like Pod Disruption Budget and Topology Spread Constraints.
|
|
389
|
+
|
|
390
|
+
## <a name="resources"></a>11.  Property `resources`
|
|
391
|
+
|
|
392
|
+
**Title:** Pod resources configuration
|
|
393
|
+
|
|
394
|
+
| Type | `object` |
|
|
395
|
+
| ------------------------- | -------------------------------------------------------------------------------------------------------- |
|
|
396
|
+
| **Additional properties** | [](# "Additional Properties not allowed.") |
|
|
397
|
+
|
|
398
|
+
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|
|
399
|
+
| ---------------------------------- | ------- | ------ | ---------- | ---------- | ------------------------------------------------------------------------------------ |
|
|
400
|
+
| + [requests](#resources_requests ) | No | object | No | - | Minimal required resources for the application to operate, that will be reserved ... |
|
|
401
|
+
| + [limits](#resources_limits ) | No | object | No | - | - |
|
|
402
|
+
|
|
403
|
+
### <a name="resources_requests"></a>11.1.  Property `requests`
|
|
404
|
+
|
|
405
|
+
| Type | `object` |
|
|
406
|
+
| ------------------------- | -------------------------------------------------------------------------------------------------------- |
|
|
407
|
+
| **Additional properties** | [](# "Additional Properties not allowed.") |
|
|
408
|
+
|
|
409
|
+
**Description:** Minimal required resources for the application to operate, that will be reserved for each replica.
|
|
410
|
+
|
|
411
|
+
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|
|
412
|
+
| ------------------------------------------------------------- | ------- | ---------------- | ---------- | ---------- | ------------------------------------------------------------------------------------ |
|
|
413
|
+
| + [cpu](#resources_requests_cpu ) | No | string or number | No | - | CPU resource units, as described here https://kubernetes.io/docs/concepts/config ... |
|
|
414
|
+
| - [ephemeral-storage](#resources_requests_ephemeral-storage ) | No | string | No | - | Size of the local ephemeral storage, measured in bytes. For more info, see https ... |
|
|
415
|
+
| + [memory](#resources_requests_memory ) | No | string | No | - | Amount of memory, mesaured in bytes. For more info, see https://kubernetes.io/do ... |
|
|
416
|
+
|
|
417
|
+
#### <a name="resources_requests_cpu"></a>11.1.1.  Property `cpu`
|
|
418
|
+
|
|
419
|
+
| Type | `string or number` |
|
|
420
|
+
| ---- | ------------------ |
|
|
421
|
+
|
|
422
|
+
**Description:** CPU resource units, as described here https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/#meaning-of-cpu
|
|
423
|
+
|
|
424
|
+
#### <a name="resources_requests_ephemeral-storage"></a>11.1.2.  Property `ephemeral-storage`
|
|
425
|
+
|
|
426
|
+
| Type | `string` |
|
|
427
|
+
| ---- | -------- |
|
|
428
|
+
|
|
429
|
+
**Description:** Size of the local ephemeral storage, measured in bytes. For more info, see https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/#local-ephemeral-storage
|
|
430
|
+
|
|
431
|
+
#### <a name="resources_requests_memory"></a>11.1.3.  Property `memory`
|
|
432
|
+
|
|
433
|
+
| Type | `string` |
|
|
434
|
+
| ---- | -------- |
|
|
435
|
+
|
|
436
|
+
**Description:** Amount of memory, mesaured in bytes. For more info, see https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/#meaning-of-memory
|
|
437
|
+
|
|
438
|
+
### <a name="resources_limits"></a>11.2.  Property `limits`
|
|
439
|
+
|
|
440
|
+
| Type | `object` |
|
|
441
|
+
| ------------------------- | -------------------------------------------------------------------------------------------------------- |
|
|
442
|
+
| **Additional properties** | [](# "Additional Properties not allowed.") |
|
|
443
|
+
|
|
444
|
+
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|
|
445
|
+
| ----------------------------------------------------------- | ------- | ---------------- | ---------- | ---------- | ------------------------------------------------------------------------------------ |
|
|
446
|
+
| - [cpu](#resources_limits_cpu ) | No | string or number | No | - | CPU resource units, as described here https://kubernetes.io/docs/concepts/config ... |
|
|
447
|
+
| - [ephemeral-storage](#resources_limits_ephemeral-storage ) | No | string | No | - | Size of the local ephemeral storage, measured in bytes. For more info, see https ... |
|
|
448
|
+
| + [memory](#resources_limits_memory ) | No | string | No | - | Amount of memory, mesaured in bytes. For more info, see https://kubernetes.io/do ... |
|
|
449
|
+
|
|
450
|
+
#### <a name="resources_limits_cpu"></a>11.2.1.  Property `cpu`
|
|
451
|
+
|
|
452
|
+
| Type | `string or number` |
|
|
453
|
+
| ---- | ------------------ |
|
|
454
|
+
|
|
455
|
+
**Description:** CPU resource units, as described here https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/#meaning-of-cpu
|
|
456
|
+
|
|
457
|
+
#### <a name="resources_limits_ephemeral-storage"></a>11.2.2.  Property `ephemeral-storage`
|
|
458
|
+
|
|
459
|
+
| Type | `string` |
|
|
460
|
+
| ---- | -------- |
|
|
461
|
+
|
|
462
|
+
**Description:** Size of the local ephemeral storage, measured in bytes. For more info, see https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/#local-ephemeral-storage
|
|
463
|
+
|
|
464
|
+
#### <a name="resources_limits_memory"></a>11.2.3.  Property `memory`
|
|
465
|
+
|
|
466
|
+
| Type | `string` |
|
|
467
|
+
| ---- | -------- |
|
|
468
|
+
|
|
469
|
+
**Description:** Amount of memory, mesaured in bytes. For more info, see https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/#meaning-of-memory
|
|
470
|
+
|
|
471
|
+
## <a name="health_check"></a>12.  Property `health_check`
|
|
472
|
+
|
|
473
|
+
**Title:** Health-check configuration
|
|
474
|
+
|
|
475
|
+
| Type | `object` |
|
|
476
|
+
| ------------------------- | -------------------------------------------------------------------------------------------------------- |
|
|
477
|
+
| **Additional properties** | [](# "Additional Properties not allowed.") |
|
|
478
|
+
|
|
479
|
+
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|
|
480
|
+
| --------------------------------------- | ------- | ------ | ---------- | ---------- | ------------------------------ |
|
|
481
|
+
| - [liveness](#health_check_liveness ) | No | object | No | - | Liveness-probe configuration. |
|
|
482
|
+
| - [readiness](#health_check_readiness ) | No | object | No | - | Readiness-probe configuration. |
|
|
483
|
+
|
|
484
|
+
### <a name="health_check_liveness"></a>12.1.  Property `liveness`
|
|
485
|
+
|
|
486
|
+
| Type | `object` |
|
|
487
|
+
| ------------------------- | -------------------------------------------------------------------------------------------------------- |
|
|
488
|
+
| **Additional properties** | [](# "Additional Properties not allowed.") |
|
|
489
|
+
|
|
490
|
+
**Description:** Liveness-probe configuration.
|
|
491
|
+
|
|
492
|
+
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|
|
493
|
+
| -------------------------------------- | ------- | ------ | ---------- | ---------- | ------------------------------------------------------------ |
|
|
494
|
+
| - [path](#health_check_liveness_path ) | No | string | No | - | HTTP path used by Kubernetes, to perform health-check calls. |
|
|
495
|
+
|
|
496
|
+
#### <a name="health_check_liveness_path"></a>12.1.1.  Property `path`
|
|
497
|
+
|
|
498
|
+
| Type | `string` |
|
|
499
|
+
| ----------- | ------------ |
|
|
500
|
+
| **Default** | `"/healthz"` |
|
|
501
|
+
|
|
502
|
+
**Description:** HTTP path used by Kubernetes, to perform health-check calls.
|
|
503
|
+
|
|
504
|
+
### <a name="health_check_readiness"></a>12.2.  Property `readiness`
|
|
505
|
+
|
|
506
|
+
| Type | `object` |
|
|
507
|
+
| ------------------------- | -------------------------------------------------------------------------------------------------------- |
|
|
508
|
+
| **Additional properties** | [](# "Additional Properties not allowed.") |
|
|
509
|
+
|
|
510
|
+
**Description:** Readiness-probe configuration.
|
|
511
|
+
|
|
512
|
+
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|
|
513
|
+
| --------------------------------------- | ------- | ------ | ---------- | ---------- | ------------------------------------------------------------ |
|
|
514
|
+
| - [path](#health_check_readiness_path ) | No | string | No | - | HTTP path used by Kubernetes, to perform health-check calls. |
|
|
515
|
+
|
|
516
|
+
#### <a name="health_check_readiness_path"></a>12.2.1.  Property `path`
|
|
517
|
+
|
|
518
|
+
| Type | `string` |
|
|
519
|
+
| ----------- | ------------ |
|
|
520
|
+
| **Default** | `"/healthz"` |
|
|
521
|
+
|
|
522
|
+
**Description:** HTTP path used by Kubernetes, to perform health-check calls.
|
|
523
|
+
|
|
524
|
+
## <a name="startupTimeout"></a>13.  Property `startupTimeout`
|
|
525
|
+
|
|
526
|
+
| Type | `integer` |
|
|
527
|
+
| ----------- | --------- |
|
|
528
|
+
| **Default** | `30` |
|
|
529
|
+
|
|
530
|
+
**Description:** Initial timeout in seconds, during which the app must start giving the response to the liveness-probe.
|
|
531
|
+
|
|
532
|
+
| Restrictions | |
|
|
533
|
+
| ------------ | ------ |
|
|
534
|
+
| **Minimum** | ≥ 1 |
|
|
535
|
+
|
|
536
|
+
## <a name="env"></a>14.  Property `env`
|
|
537
|
+
|
|
538
|
+
| Type | `object` |
|
|
539
|
+
| ------------------------- | -------------------------------------------------------------------------------------------------------- |
|
|
540
|
+
| **Additional properties** | [](# "Additional Properties not allowed.") |
|
|
541
|
+
| **Default** | `{}` |
|
|
542
|
+
|
|
543
|
+
**Description:** Key-value map of environment variables, which should be added to the Pod spec.
|
|
544
|
+
|
|
545
|
+
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|
|
546
|
+
| ------------------------------------------------ | ------- | ----------- | ---------- | ---------- | ----------------- |
|
|
547
|
+
| - [^[-._a-zA-Z][-._a-zA-Z0-9]*$](#env_pattern1 ) | Yes | Combination | No | - | - |
|
|
548
|
+
|
|
549
|
+
### <a name="env_pattern1"></a>14.1.  Pattern Property `^[-._a-zA-Z][-._a-zA-Z0-9]*$`
|
|
550
|
+
> All properties whose name matches the regular expression
|
|
551
|
+
```^[-._a-zA-Z][-._a-zA-Z0-9]*$``` ([Test](https://regex101.com/?regex=%5E%5B-._a-zA-Z%5D%5B-._a-zA-Z0-9%5D%2A%24))
|
|
552
|
+
must respect the following conditions
|
|
553
|
+
|
|
554
|
+
| Type | `combining` |
|
|
555
|
+
| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- |
|
|
556
|
+
| **Additional properties** | [](# "Additional Properties of any type are allowed.") |
|
|
557
|
+
|
|
558
|
+
#### <a name="autogenerated_heading_3"></a>14.1.1. Must **not** be
|
|
559
|
+
|
|
560
|
+
| Type | `null, object or array` |
|
|
561
|
+
| ---- | ----------------------- |
|
|
562
|
+
|
|
563
|
+
## <a name="envSecretNames"></a>15.  Property `envSecretNames`
|
|
564
|
+
|
|
565
|
+
| Type | `array` |
|
|
566
|
+
| ----------- | ------- |
|
|
567
|
+
| **Default** | `[]` |
|
|
568
|
+
|
|
569
|
+
**Description:** List of Kubernetes Secret names, used as sources for the Pod's environment variables.
|
|
570
|
+
|
|
571
|
+
| Each item of this array must be | Description |
|
|
572
|
+
| --------------------------------------- | ----------- |
|
|
573
|
+
| [KubernetesName](#envSecretNames_items) | - |
|
|
574
|
+
|
|
575
|
+
### <a name="autogenerated_heading_4"></a>15.1. items
|
|
576
|
+
|
|
577
|
+
| Type | `string` |
|
|
578
|
+
| ---------------------- | ------------------------------------ |
|
|
579
|
+
| **Same definition as** | [name](#global_imagePullSecret_name) |
|
|
580
|
+
|
|
581
|
+
## <a name="expose"></a>16.  Property `expose`
|
|
582
|
+
|
|
583
|
+
| Type | `object` |
|
|
584
|
+
| ------------------------- | -------------------------------------------------------------------------------------------------------- |
|
|
585
|
+
| **Additional properties** | [](# "Additional Properties not allowed.") |
|
|
586
|
+
|
|
587
|
+
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|
|
588
|
+
| ----------------------------- | ------- | ------- | ---------- | ---------- | ------------------------------------------------------------------------------------ |
|
|
589
|
+
| - [host](#expose_host ) | No | string | No | - | Specifies the service's dns name for inbound external traffic. If it doesn't con ... |
|
|
590
|
+
| - [enabled](#expose_enabled ) | No | boolean | No | - | Expose the application to the internet. |
|
|
591
|
+
|
|
592
|
+
### <a name="expose_host"></a>16.1.  Property `host`
|
|
593
|
+
|
|
594
|
+
| Type | `string` |
|
|
595
|
+
| ---- | -------- |
|
|
596
|
+
|
|
597
|
+
**Description:** Specifies the service's dns name for inbound external traffic. If it doesn't contain a dot, the default cluster domain will be appended.
|
|
598
|
+
|
|
599
|
+
### <a name="expose_enabled"></a>16.2.  Property `enabled`
|
|
600
|
+
|
|
601
|
+
| Type | `boolean` |
|
|
602
|
+
| ----------- | --------- |
|
|
603
|
+
| **Default** | `true` |
|
|
604
|
+
|
|
605
|
+
**Description:** Expose the application to the internet.
|
|
606
|
+
|
|
607
|
+
## <a name="bindings"></a>17.  Property `bindings`
|
|
608
|
+
|
|
609
|
+
**Title:** Service Binding configuration
|
|
610
|
+
|
|
611
|
+
| Type | `object` |
|
|
612
|
+
| ------------------------- | -------------------------------------------------------------------------------------------------------- |
|
|
613
|
+
| **Additional properties** | [](# "Additional Properties not allowed.") |
|
|
614
|
+
|
|
615
|
+
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|
|
616
|
+
| ----------------------------------------------------- | ------- | ----------- | ---------- | ---------- | ----------------- |
|
|
617
|
+
| - [^[-._a-zA-Z][-._a-zA-Z0-9]*$](#bindings_pattern1 ) | Yes | Combination | No | - | - |
|
|
618
|
+
|
|
619
|
+
### <a name="bindings_pattern1"></a>17.1.  Pattern Property `^[-._a-zA-Z][-._a-zA-Z0-9]*$`
|
|
620
|
+
> All properties whose name matches the regular expression
|
|
621
|
+
```^[-._a-zA-Z][-._a-zA-Z0-9]*$``` ([Test](https://regex101.com/?regex=%5E%5B-._a-zA-Z%5D%5B-._a-zA-Z0-9%5D%2A%24))
|
|
622
|
+
must respect the following conditions
|
|
623
|
+
|
|
624
|
+
| Type | `combining` |
|
|
625
|
+
| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- |
|
|
626
|
+
| **Additional properties** | [](# "Additional Properties of any type are allowed.") |
|
|
627
|
+
|
|
628
|
+
| Any of(Option) |
|
|
629
|
+
| ------------------------------------- |
|
|
630
|
+
| [item 0](#bindings_pattern1_anyOf_i0) |
|
|
631
|
+
| [item 1](#bindings_pattern1_anyOf_i1) |
|
|
632
|
+
|
|
633
|
+
#### <a name="bindings_pattern1_anyOf_i0"></a>17.1.1. Property `None`
|
|
634
|
+
|
|
635
|
+
| Type | `object` |
|
|
636
|
+
| ------------------------- | -------------------------------------------------------------------------------------------------------- |
|
|
637
|
+
| **Additional properties** | [](# "Additional Properties not allowed.") |
|
|
638
|
+
|
|
639
|
+
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|
|
640
|
+
| ------------------------------------------------------- | ------- | ------ | ---------- | --------------------------------------------- | ------------------------------------------------------------------------------------ |
|
|
641
|
+
| + [fromSecret](#bindings_pattern1_anyOf_i0_fromSecret ) | No | string | No | Same as [name](#global_imagePullSecret_name ) | Name of a Kubernetes Secret, with the binding content, compliant to the SAP Kube ... |
|
|
642
|
+
|
|
643
|
+
##### <a name="bindings_pattern1_anyOf_i0_fromSecret"></a>17.1.1.1. Property `fromSecret`
|
|
644
|
+
|
|
645
|
+
| Type | `string` |
|
|
646
|
+
| ---------------------- | ------------------------------------ |
|
|
647
|
+
| **Same definition as** | [name](#global_imagePullSecret_name) |
|
|
648
|
+
|
|
649
|
+
**Description:** Name of a Kubernetes Secret, with the binding content, compliant to the SAP Kubernetes Service Binding spec https://github.tools.sap/Kubernetes-Service-Bindings/doc/
|
|
650
|
+
|
|
651
|
+
#### <a name="bindings_pattern1_anyOf_i1"></a>17.1.2. Property `None`
|
|
652
|
+
|
|
653
|
+
| Type | `object` |
|
|
654
|
+
| ------------------------- | -------------------------------------------------------------------------------------------------------- |
|
|
655
|
+
| **Additional properties** | [](# "Additional Properties not allowed.") |
|
|
656
|
+
|
|
657
|
+
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|
|
658
|
+
| ------------------------------------------------------------------------------------- | ------- | ------ | ---------- | --------------------------------------------- | ------------------------------------------------------------------------------------ |
|
|
659
|
+
| - [serviceInstanceName](#bindings_pattern1_anyOf_i1_serviceInstanceName ) | No | string | No | Same as [name](#global_imagePullSecret_name ) | Name of a BTP Operator Service Instance, created by the 'service-instance' Helm ... |
|
|
660
|
+
| - [serviceInstanceFullname](#bindings_pattern1_anyOf_i1_serviceInstanceFullname ) | No | string | No | Same as [name](#global_imagePullSecret_name ) | Full name of a BTP Operator Service Instance. Can't be used with the 'serviceIns ... |
|
|
661
|
+
| - [externalName](#bindings_pattern1_anyOf_i1_externalName ) | No | string | No | - | The name for the service binding in SAP BTP |
|
|
662
|
+
| - [secretName](#bindings_pattern1_anyOf_i1_secretName ) | No | string | No | Same as [name](#global_imagePullSecret_name ) | The name of the secret where the credentials are stored. |
|
|
663
|
+
| - [parameters](#bindings_pattern1_anyOf_i1_parameters ) | No | object | No | - | Some services support the provisioning of additional configuration parameters du ... |
|
|
664
|
+
| - [parametersFrom](#bindings_pattern1_anyOf_i1_parametersFrom ) | No | array | No | - | List of sources to populate parameters. |
|
|
665
|
+
| - [credentialsRotationPolicy](#bindings_pattern1_anyOf_i1_credentialsRotationPolicy ) | No | object | No | - | Holds automatic credentials rotation configuration. For more details, see https: ... |
|
|
666
|
+
|
|
667
|
+
##### <a name="bindings_pattern1_anyOf_i1_serviceInstanceName"></a>17.1.2.1. Property `serviceInstanceName`
|
|
668
|
+
|
|
669
|
+
| Type | `string` |
|
|
670
|
+
| ---------------------- | ------------------------------------ |
|
|
671
|
+
| **Same definition as** | [name](#global_imagePullSecret_name) |
|
|
672
|
+
|
|
673
|
+
**Description:** Name of a BTP Operator Service Instance, created by the `service-instance` Helm chart. Can't be used with the `serviceInstanceFullname` option.
|
|
674
|
+
|
|
675
|
+
##### <a name="bindings_pattern1_anyOf_i1_serviceInstanceFullname"></a>17.1.2.2. Property `serviceInstanceFullname`
|
|
676
|
+
|
|
677
|
+
| Type | `string` |
|
|
678
|
+
| ---------------------- | ------------------------------------ |
|
|
679
|
+
| **Same definition as** | [name](#global_imagePullSecret_name) |
|
|
680
|
+
|
|
681
|
+
**Description:** Full name of a BTP Operator Service Instance. Can't be used with the `serviceInstanceName` option.
|
|
682
|
+
|
|
683
|
+
##### <a name="bindings_pattern1_anyOf_i1_externalName"></a>17.1.2.3. Property `externalName`
|
|
684
|
+
|
|
685
|
+
| Type | `string` |
|
|
686
|
+
| ---- | -------- |
|
|
687
|
+
|
|
688
|
+
**Description:** The name for the service binding in SAP BTP
|
|
689
|
+
|
|
690
|
+
##### <a name="bindings_pattern1_anyOf_i1_secretName"></a>17.1.2.4. Property `secretName`
|
|
691
|
+
|
|
692
|
+
| Type | `string` |
|
|
693
|
+
| ---------------------- | ------------------------------------ |
|
|
694
|
+
| **Same definition as** | [name](#global_imagePullSecret_name) |
|
|
695
|
+
|
|
696
|
+
**Description:** The name of the secret where the credentials are stored.
|
|
697
|
+
|
|
698
|
+
##### <a name="bindings_pattern1_anyOf_i1_parameters"></a>17.1.2.5. Property `parameters`
|
|
699
|
+
|
|
700
|
+
| Type | `object` |
|
|
701
|
+
| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- |
|
|
702
|
+
| **Additional properties** | [](# "Additional Properties of any type are allowed.") |
|
|
703
|
+
|
|
704
|
+
**Description:** Some services support the provisioning of additional configuration parameters during the bind request. For the list of supported parameters, check the documentation of the particular service offering.
|
|
705
|
+
|
|
706
|
+
##### <a name="bindings_pattern1_anyOf_i1_parametersFrom"></a>17.1.2.6. Property `parametersFrom`
|
|
707
|
+
|
|
708
|
+
| Type | `array` |
|
|
709
|
+
| ---- | ------- |
|
|
710
|
+
|
|
711
|
+
**Description:** List of sources to populate parameters.
|
|
712
|
+
|
|
713
|
+
| Each item of this array must be | Description |
|
|
714
|
+
| ------------------------------------------------------------------------ | ----------- |
|
|
715
|
+
| [parametersFrom items](#bindings_pattern1_anyOf_i1_parametersFrom_items) | - |
|
|
716
|
+
|
|
717
|
+
##### <a name="autogenerated_heading_5"></a>17.1.2.6.1. items
|
|
718
|
+
|
|
719
|
+
| Type | `combining` |
|
|
720
|
+
| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- |
|
|
721
|
+
| **Additional properties** | [](# "Additional Properties of any type are allowed.") |
|
|
722
|
+
|
|
723
|
+
| Any of(Option) |
|
|
724
|
+
| ------------------------------------------------------------------- |
|
|
725
|
+
| [item 0](#bindings_pattern1_anyOf_i1_parametersFrom_items_anyOf_i0) |
|
|
726
|
+
| [item 1](#bindings_pattern1_anyOf_i1_parametersFrom_items_anyOf_i1) |
|
|
727
|
+
|
|
728
|
+
##### <a name="bindings_pattern1_anyOf_i1_parametersFrom_items_anyOf_i0"></a>17.1.2.6.1.1. Property `None`
|
|
729
|
+
|
|
730
|
+
| Type | `object` |
|
|
731
|
+
| ------------------------- | -------------------------------------------------------------------------------------------------------- |
|
|
732
|
+
| **Additional properties** | [](# "Additional Properties not allowed.") |
|
|
733
|
+
|
|
734
|
+
**Description:** Kubernetes Secret as a parameters source.
|
|
735
|
+
|
|
736
|
+
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|
|
737
|
+
| ----------------------------------------------------------------------------------------- | ------- | ------ | ---------- | ---------- | ----------------- |
|
|
738
|
+
| - [secretKeyRef](#bindings_pattern1_anyOf_i1_parametersFrom_items_anyOf_i0_secretKeyRef ) | No | object | No | - | - |
|
|
739
|
+
|
|
740
|
+
##### <a name="bindings_pattern1_anyOf_i1_parametersFrom_items_anyOf_i0_secretKeyRef"></a>17.1.2.6.1.1.1. Property `secretKeyRef`
|
|
741
|
+
|
|
742
|
+
| Type | `object` |
|
|
743
|
+
| ------------------------- | -------------------------------------------------------------------------------------------------------- |
|
|
744
|
+
| **Additional properties** | [](# "Additional Properties not allowed.") |
|
|
745
|
+
|
|
746
|
+
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|
|
747
|
+
| -------------------------------------------------------------------------------------- | ------- | ------ | ---------- | --------------------------------------------- | ------------------------------------------------------------------------------------ |
|
|
748
|
+
| + [name](#bindings_pattern1_anyOf_i1_parametersFrom_items_anyOf_i0_secretKeyRef_name ) | No | string | No | Same as [name](#global_imagePullSecret_name ) | Name of a Secret. |
|
|
749
|
+
| + [key](#bindings_pattern1_anyOf_i1_parametersFrom_items_anyOf_i0_secretKeyRef_key ) | No | string | No | - | Key in that Secret, which contains a string that represents the json to include ... |
|
|
750
|
+
|
|
751
|
+
##### <a name="bindings_pattern1_anyOf_i1_parametersFrom_items_anyOf_i0_secretKeyRef_name"></a>17.1.2.6.1.1.1.1. Property `name`
|
|
752
|
+
|
|
753
|
+
| Type | `string` |
|
|
754
|
+
| ---------------------- | ------------------------------------ |
|
|
755
|
+
| **Same definition as** | [name](#global_imagePullSecret_name) |
|
|
756
|
+
|
|
757
|
+
**Description:** Name of a Secret.
|
|
758
|
+
|
|
759
|
+
##### <a name="bindings_pattern1_anyOf_i1_parametersFrom_items_anyOf_i0_secretKeyRef_key"></a>17.1.2.6.1.1.1.2. Property `key`
|
|
760
|
+
|
|
761
|
+
| Type | `string` |
|
|
762
|
+
| ---- | -------- |
|
|
763
|
+
|
|
764
|
+
**Description:** Key in that Secret, which contains a string that represents the json to include in the set of parameters to be sent to the broker.
|
|
765
|
+
|
|
766
|
+
##### <a name="bindings_pattern1_anyOf_i1_parametersFrom_items_anyOf_i1"></a>17.1.2.6.1.2. Property `None`
|
|
767
|
+
|
|
768
|
+
| Type | `object` |
|
|
769
|
+
| ------------------------- | -------------------------------------------------------------------------------------------------------- |
|
|
770
|
+
| **Additional properties** | [](# "Additional Properties not allowed.") |
|
|
771
|
+
|
|
772
|
+
**Description:** Kubernetes Config Map as a parameters source.
|
|
773
|
+
|
|
774
|
+
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|
|
775
|
+
| ----------------------------------------------------------------------------------------------- | ------- | ------ | ---------- | ---------- | ----------------- |
|
|
776
|
+
| - [configMapKeyRef](#bindings_pattern1_anyOf_i1_parametersFrom_items_anyOf_i1_configMapKeyRef ) | No | object | No | - | - |
|
|
777
|
+
|
|
778
|
+
##### <a name="bindings_pattern1_anyOf_i1_parametersFrom_items_anyOf_i1_configMapKeyRef"></a>17.1.2.6.1.2.1. Property `configMapKeyRef`
|
|
779
|
+
|
|
780
|
+
| Type | `object` |
|
|
781
|
+
| ------------------------- | -------------------------------------------------------------------------------------------------------- |
|
|
782
|
+
| **Additional properties** | [](# "Additional Properties not allowed.") |
|
|
783
|
+
|
|
784
|
+
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|
|
785
|
+
| ----------------------------------------------------------------------------------------- | ------- | ------ | ---------- | --------------------------------------------- | ------------------------------------------------------------------------------------ |
|
|
786
|
+
| + [name](#bindings_pattern1_anyOf_i1_parametersFrom_items_anyOf_i1_configMapKeyRef_name ) | No | string | No | Same as [name](#global_imagePullSecret_name ) | Name of a Config Map |
|
|
787
|
+
| + [key](#bindings_pattern1_anyOf_i1_parametersFrom_items_anyOf_i1_configMapKeyRef_key ) | No | string | No | - | Key in that Config Map, which contains a string that represents the json to incl ... |
|
|
788
|
+
|
|
789
|
+
##### <a name="bindings_pattern1_anyOf_i1_parametersFrom_items_anyOf_i1_configMapKeyRef_name"></a>17.1.2.6.1.2.1.1. Property `name`
|
|
790
|
+
|
|
791
|
+
| Type | `string` |
|
|
792
|
+
| ---------------------- | ------------------------------------ |
|
|
793
|
+
| **Same definition as** | [name](#global_imagePullSecret_name) |
|
|
794
|
+
|
|
795
|
+
**Description:** Name of a Config Map
|
|
796
|
+
|
|
797
|
+
##### <a name="bindings_pattern1_anyOf_i1_parametersFrom_items_anyOf_i1_configMapKeyRef_key"></a>17.1.2.6.1.2.1.2. Property `key`
|
|
798
|
+
|
|
799
|
+
| Type | `string` |
|
|
800
|
+
| ---- | -------- |
|
|
801
|
+
|
|
802
|
+
**Description:** Key in that Config Map, which contains a string that represents the json to include in the set of parameters to be sent to the broker.
|
|
803
|
+
|
|
804
|
+
##### <a name="bindings_pattern1_anyOf_i1_credentialsRotationPolicy"></a>17.1.2.7. Property `credentialsRotationPolicy`
|
|
805
|
+
|
|
806
|
+
| Type | `object` |
|
|
807
|
+
| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- |
|
|
808
|
+
| **Additional properties** | [](# "Additional Properties of any type are allowed.") |
|
|
809
|
+
|
|
810
|
+
**Description:** Holds automatic credentials rotation configuration. For more details, see https://github.com/SAP/sap-btp-service-operator#spec-1
|
|
811
|
+
|
|
812
|
+
----------------------------------------------------------------------------------------------------------------------------
|