@robinmordasiewicz/f5xc-terraform-mcp 3.10.3 → 3.10.4
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/dist/docs/data-sources/bgp.md +2 -2
- package/dist/docs/data-sources/fast_acl.md +2 -2
- package/dist/docs/data-sources/irule.md +2 -2
- package/dist/docs/data-sources/log_receiver.md +2 -2
- package/dist/docs/data-sources/network_policy.md +2 -2
- package/dist/docs/data-sources/policer.md +2 -2
- package/dist/docs/data-sources/site.md +2 -2
- package/dist/docs/data-sources/workload.md +2 -2
- package/dist/docs/resources/bgp.md +205 -37
- package/dist/docs/resources/cloud_connect.md +2 -2
- package/dist/docs/resources/fast_acl.md +166 -60
- package/dist/docs/resources/irule.md +5 -7
- package/dist/docs/resources/log_receiver.md +44 -825
- package/dist/docs/resources/network_policy.md +125 -119
- package/dist/docs/resources/policer.md +10 -50
- package/dist/docs/resources/securemesh_site.md +253 -1614
- package/dist/docs/resources/site.md +527 -233
- package/dist/docs/resources/workload.md +2951 -9
- package/dist/metadata/resource-metadata.json +301 -621
- package/package.json +1 -1
|
@@ -2,12 +2,12 @@
|
|
|
2
2
|
page_title: "f5xc_workload Resource - terraform-provider-f5xc"
|
|
3
3
|
subcategory: "Kubernetes"
|
|
4
4
|
description: |-
|
|
5
|
-
Manages
|
|
5
|
+
Manages a Workload resource in F5 Distributed Cloud for workload. configuration.
|
|
6
6
|
---
|
|
7
7
|
|
|
8
8
|
# f5xc_workload (Resource)
|
|
9
9
|
|
|
10
|
-
Manages
|
|
10
|
+
Manages a Workload resource in F5 Distributed Cloud for workload. configuration.
|
|
11
11
|
|
|
12
12
|
~> **Note** For more information about this resource, please refer to the [F5 XC API Documentation](https://docs.cloud.f5.com/docs/api/).
|
|
13
13
|
|
|
@@ -15,7 +15,7 @@ Manages workload_flavor. in F5 Distributed Cloud.
|
|
|
15
15
|
|
|
16
16
|
```terraform
|
|
17
17
|
# Workload Resource Example
|
|
18
|
-
# Manages
|
|
18
|
+
# Manages a Workload resource in F5 Distributed Cloud for workload. configuration.
|
|
19
19
|
|
|
20
20
|
# Basic Workload configuration
|
|
21
21
|
resource "f5xc_workload" "example" {
|
|
@@ -71,13 +71,13 @@ resource "f5xc_workload" "example" {
|
|
|
71
71
|
|
|
72
72
|
### Spec Argument Reference
|
|
73
73
|
|
|
74
|
-
|
|
74
|
+
-> **One of the following:**
|
|
75
|
+
• <a id="job"></a>[`job`](#job) - Optional Block<br>Jobs are used for running batch processing tasks and run to completion. Jobs are generally used for tasks like report generation, billing, parallel data processing, ETL processing, etc<br>See [Job](#job) below for details.
|
|
76
|
+
<br><br>• <a id="service"></a>[`service`](#service) - Optional Block<br>Service does not maintain per replica state, however it can be configured to use persistent storage that is shared amongst all the replicas. Replicas of a service are fungible and do not have a stable network identity or storage. Common examples of services are web servers, application servers<br>See [Service](#service) below for details.
|
|
77
|
+
<br><br>• <a id="simple-service"></a>[`simple_service`](#simple-service) - Optional Block<br>SimpleService is a service having one container and one replica that is deployed on all Regional Edges and advertised on Internet via HTTP loadbalancer on default VIP
|
|
78
|
+
<br><br>• <a id="stateful-service"></a>[`stateful_service`](#stateful-service) - Optional Block<br>StatefulService maintains per replica state and each replica has its own persistent storage. Each replica has a unique network identity and stable storage. Stateful service are used for distributed stateful applications like cassandra, mongodb, redis, etc
|
|
75
79
|
|
|
76
|
-
<a id="
|
|
77
|
-
|
|
78
|
-
<a id="timeouts"></a>• [`timeouts`](#timeouts) - Optional Block<br>See [Timeouts](#timeouts) below for details.
|
|
79
|
-
|
|
80
|
-
<a id="vcpus"></a>• [`vcpus`](#vcpus) - Optional Number<br>Number of vCPUs allocated for the workload_flavor. Each vCPU is a thread on a CPU core
|
|
80
|
+
<a id="timeouts"></a>• [`timeouts`](#timeouts) - Optional Block
|
|
81
81
|
|
|
82
82
|
### Attributes Reference
|
|
83
83
|
|
|
@@ -87,6 +87,2948 @@ In addition to all arguments above, the following attributes are exported:
|
|
|
87
87
|
|
|
88
88
|
---
|
|
89
89
|
|
|
90
|
+
#### Job
|
|
91
|
+
|
|
92
|
+
A [`job`](#job) block supports the following:
|
|
93
|
+
|
|
94
|
+
<a id="job-configuration"></a>• [`configuration`](#job-configuration) - Optional Block<br>Configuration parameters of the workload<br>See [Configuration](#job-configuration) below.
|
|
95
|
+
|
|
96
|
+
<a id="job-containers"></a>• [`containers`](#job-containers) - Optional Block<br>Containers to use for the job<br>See [Containers](#job-containers) below.
|
|
97
|
+
|
|
98
|
+
<a id="job-deploy-options"></a>• [`deploy_options`](#job-deploy-options) - Optional Block<br>Deploy OPTIONS are used to configure the workload deployment OPTIONS<br>See [Deploy Options](#job-deploy-options) below.
|
|
99
|
+
|
|
100
|
+
<a id="job-num-replicas"></a>• [`num_replicas`](#job-num-replicas) - Optional Number<br>Number of replicas of the batch job to spawn per site
|
|
101
|
+
|
|
102
|
+
<a id="job-volumes"></a>• [`volumes`](#job-volumes) - Optional Block<br>Volumes. Volumes for the job<br>See [Volumes](#job-volumes) below.
|
|
103
|
+
|
|
104
|
+
#### Job Configuration
|
|
105
|
+
|
|
106
|
+
A [`configuration`](#job-configuration) block (within [`job`](#job)) supports the following:
|
|
107
|
+
|
|
108
|
+
<a id="job-configuration-parameters"></a>• [`parameters`](#job-configuration-parameters) - Optional Block<br>Parameters. Parameters for the workload<br>See [Parameters](#job-configuration-parameters) below.
|
|
109
|
+
|
|
110
|
+
#### Job Configuration Parameters
|
|
111
|
+
|
|
112
|
+
A [`parameters`](#job-configuration-parameters) block (within [`job.configuration`](#job-configuration)) supports the following:
|
|
113
|
+
|
|
114
|
+
<a id="job-configuration-parameters-env-var"></a>• [`env_var`](#job-configuration-parameters-env-var) - Optional Block<br>Environment Variable. Environment Variable<br>See [Env Var](#job-configuration-parameters-env-var) below.
|
|
115
|
+
|
|
116
|
+
<a id="job-configuration-parameters-file"></a>• [`file`](#job-configuration-parameters-file) - Optional Block<br>Configuration File. Configuration File for the workload<br>See [File](#job-configuration-parameters-file) below.
|
|
117
|
+
|
|
118
|
+
#### Job Configuration Parameters Env Var
|
|
119
|
+
|
|
120
|
+
An [`env_var`](#job-configuration-parameters-env-var) block (within [`job.configuration.parameters`](#job-configuration-parameters)) supports the following:
|
|
121
|
+
|
|
122
|
+
<a id="name-8db56d"></a>• [`name`](#name-8db56d) - Optional String<br>Name. Name of Environment Variable
|
|
123
|
+
|
|
124
|
+
<a id="value-a8625d"></a>• [`value`](#value-a8625d) - Optional String<br>Value. Value of Environment Variable
|
|
125
|
+
|
|
126
|
+
#### Job Configuration Parameters File
|
|
127
|
+
|
|
128
|
+
A [`file`](#job-configuration-parameters-file) block (within [`job.configuration.parameters`](#job-configuration-parameters)) supports the following:
|
|
129
|
+
|
|
130
|
+
<a id="job-configuration-parameters-file-data"></a>• [`data`](#job-configuration-parameters-file-data) - Optional String<br>Data. File data
|
|
131
|
+
|
|
132
|
+
<a id="job-configuration-parameters-file-mount"></a>• [`mount`](#job-configuration-parameters-file-mount) - Optional Block<br>Volume mount describes how volume is mounted inside a workload<br>See [Mount](#job-configuration-parameters-file-mount) below.
|
|
133
|
+
|
|
134
|
+
<a id="job-configuration-parameters-file-name"></a>• [`name`](#job-configuration-parameters-file-name) - Optional String<br>Name. Name of the file
|
|
135
|
+
|
|
136
|
+
<a id="name-03691e"></a>• [`volume_name`](#name-03691e) - Optional String<br>Volume Name. Name of the Volume
|
|
137
|
+
|
|
138
|
+
#### Job Configuration Parameters File Mount
|
|
139
|
+
|
|
140
|
+
A [`mount`](#job-configuration-parameters-file-mount) block (within [`job.configuration.parameters.file`](#job-configuration-parameters-file)) supports the following:
|
|
141
|
+
|
|
142
|
+
<a id="mode-8141d6"></a>• [`mode`](#mode-8141d6) - Optional String Defaults to `VOLUME_MOUNT_READ_ONLY`<br>Possible values are `VOLUME_MOUNT_READ_ONLY`, `VOLUME_MOUNT_READ_WRITE`<br>[Enum: VOLUME_MOUNT_READ_ONLY|VOLUME_MOUNT_READ_WRITE] Mode in which the volume should be mounted to the workload - VOLUME_MOUNT_READ_ONLY: ReadOnly Mount the volume in read-only mode - VOLUME_MOUNT_READ_WRITE: Read Write Mount the volume in read-write mode
|
|
143
|
+
|
|
144
|
+
<a id="path-4baddf"></a>• [`mount_path`](#path-4baddf) - Optional String<br>Path within the workload container at which the volume should be mounted. Must not contain ':'
|
|
145
|
+
|
|
146
|
+
<a id="path-5fe649"></a>• [`sub_path`](#path-5fe649) - Optional String Defaults to `'' (volume's root)`<br>Path within the volume from which the workload's volume should be mounted
|
|
147
|
+
|
|
148
|
+
#### Job Containers
|
|
149
|
+
|
|
150
|
+
A [`containers`](#job-containers) block (within [`job`](#job)) supports the following:
|
|
151
|
+
|
|
152
|
+
<a id="job-containers-args"></a>• [`args`](#job-containers-args) - Optional List<br>Arguments to the entrypoint. Overrides the docker image's CMD
|
|
153
|
+
|
|
154
|
+
<a id="job-containers-command"></a>• [`command`](#job-containers-command) - Optional List<br>Command to execute. Overrides the docker image's ENTRYPOINT
|
|
155
|
+
|
|
156
|
+
<a id="job-containers-custom-flavor"></a>• [`custom_flavor`](#job-containers-custom-flavor) - Optional Block<br>Type establishes a direct reference from one object(the referrer) to another(the referred). Such a reference is in form of tenant/namespace/name<br>See [Custom Flavor](#job-containers-custom-flavor) below.
|
|
157
|
+
|
|
158
|
+
<a id="job-containers-default-flavor"></a>• [`default_flavor`](#job-containers-default-flavor) - Optional Block<br>Enable this option
|
|
159
|
+
|
|
160
|
+
<a id="job-containers-flavor"></a>• [`flavor`](#job-containers-flavor) - Optional String Defaults to `CONTAINER_FLAVOR_TYPE_TINY`<br>Possible values are `CONTAINER_FLAVOR_TYPE_TINY`, `CONTAINER_FLAVOR_TYPE_MEDIUM`, `CONTAINER_FLAVOR_TYPE_LARGE`<br>[Enum: CONTAINER_FLAVOR_TYPE_TINY|CONTAINER_FLAVOR_TYPE_MEDIUM|CONTAINER_FLAVOR_TYPE_LARGE] Container Flavor type - CONTAINER_FLAVOR_TYPE_TINY: Tiny Tiny containers have limit of 0.1 vCPU and 256 MiB (mebibyte) memory - CONTAINER_FLAVOR_TYPE_MEDIUM: Medium Medium containers have limit of 0.25 vCPU and 512 MiB (mebibyte) memory - CONTAINER_FLAVOR_TYPE_LARGE: Large Large containers have
|
|
161
|
+
|
|
162
|
+
<a id="job-containers-image"></a>• [`image`](#job-containers-image) - Optional Block<br>ImageType configures the image to use, how to pull the image, and the associated secrets to use if any<br>See [Image](#job-containers-image) below.
|
|
163
|
+
|
|
164
|
+
<a id="job-containers-init-container"></a>• [`init_container`](#job-containers-init-container) - Optional Bool<br>Specialized container that runs before application container and runs to completion
|
|
165
|
+
|
|
166
|
+
<a id="job-containers-liveness-check"></a>• [`liveness_check`](#job-containers-liveness-check) - Optional Block<br>HealthCheckType describes a health check to be performed against a container to determine whether it has started up or is alive or ready to receive traffic<br>See [Liveness Check](#job-containers-liveness-check) below.
|
|
167
|
+
|
|
168
|
+
<a id="job-containers-name"></a>• [`name`](#job-containers-name) - Optional String<br>Name. Name of the container
|
|
169
|
+
|
|
170
|
+
<a id="job-containers-readiness-check"></a>• [`readiness_check`](#job-containers-readiness-check) - Optional Block<br>HealthCheckType describes a health check to be performed against a container to determine whether it has started up or is alive or ready to receive traffic<br>See [Readiness Check](#job-containers-readiness-check) below.
|
|
171
|
+
|
|
172
|
+
#### Job Containers Custom Flavor
|
|
173
|
+
|
|
174
|
+
A [`custom_flavor`](#job-containers-custom-flavor) block (within [`job.containers`](#job-containers)) supports the following:
|
|
175
|
+
|
|
176
|
+
<a id="job-containers-custom-flavor-name"></a>• [`name`](#job-containers-custom-flavor-name) - Optional String<br>When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object's(e.g. Route's) name
|
|
177
|
+
|
|
178
|
+
<a id="job-containers-custom-flavor-namespace"></a>• [`namespace`](#job-containers-custom-flavor-namespace) - Optional String<br>When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object's(e.g. Route's) namespace
|
|
179
|
+
|
|
180
|
+
<a id="job-containers-custom-flavor-tenant"></a>• [`tenant`](#job-containers-custom-flavor-tenant) - Optional String<br>When a configuration object(e.g. Virtual_host) refers to another(e.g route) then tenant will hold the referred object's(e.g. Route's) tenant
|
|
181
|
+
|
|
182
|
+
#### Job Containers Image
|
|
183
|
+
|
|
184
|
+
An [`image`](#job-containers-image) block (within [`job.containers`](#job-containers)) supports the following:
|
|
185
|
+
|
|
186
|
+
<a id="job-containers-image-container-registry"></a>• [`container_registry`](#job-containers-image-container-registry) - Optional Block<br>Type establishes a direct reference from one object(the referrer) to another(the referred). Such a reference is in form of tenant/namespace/name<br>See [Container Registry](#job-containers-image-container-registry) below.
|
|
187
|
+
|
|
188
|
+
<a id="job-containers-image-name"></a>• [`name`](#job-containers-image-name) - Optional String<br>Name is a container image which are usually given a name such as alpine, ubuntu, or quay.I/O/etcd:0.13. The format is registry/image:tag or registry/image@image-digest. If registry is not specified, the Docker public registry is assumed
|
|
189
|
+
|
|
190
|
+
<a id="job-containers-image-public"></a>• [`public`](#job-containers-image-public) - Optional Block<br>Enable this option
|
|
191
|
+
|
|
192
|
+
<a id="job-containers-image-pull-policy"></a>• [`pull_policy`](#job-containers-image-pull-policy) - Optional String Defaults to `IMAGE_PULL_POLICY_DEFAULT`<br>Possible values are `IMAGE_PULL_POLICY_DEFAULT`, `IMAGE_PULL_POLICY_IF_NOT_PRESENT`, `IMAGE_PULL_POLICY_ALWAYS`, `IMAGE_PULL_POLICY_NEVER`<br>[Enum: IMAGE_PULL_POLICY_DEFAULT|IMAGE_PULL_POLICY_IF_NOT_PRESENT|IMAGE_PULL_POLICY_ALWAYS|IMAGE_PULL_POLICY_NEVER] Image pull policy type enumerates the policy choices to use for pulling the image prior to starting the workload - IMAGE_PULL_POLICY_DEFAULT: Default Default will always pull image if :latest tag is specified in image name. If :latest tag is not specified in image name, it will pull image only
|
|
193
|
+
|
|
194
|
+
#### Job Containers Image Container Registry
|
|
195
|
+
|
|
196
|
+
A [`container_registry`](#job-containers-image-container-registry) block (within [`job.containers.image`](#job-containers-image)) supports the following:
|
|
197
|
+
|
|
198
|
+
<a id="name-d8aa8e"></a>• [`name`](#name-d8aa8e) - Optional String<br>When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object's(e.g. Route's) name
|
|
199
|
+
|
|
200
|
+
<a id="namespace-0744ae"></a>• [`namespace`](#namespace-0744ae) - Optional String<br>When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object's(e.g. Route's) namespace
|
|
201
|
+
|
|
202
|
+
<a id="tenant-a2bf58"></a>• [`tenant`](#tenant-a2bf58) - Optional String<br>When a configuration object(e.g. Virtual_host) refers to another(e.g route) then tenant will hold the referred object's(e.g. Route's) tenant
|
|
203
|
+
|
|
204
|
+
#### Job Containers Liveness Check
|
|
205
|
+
|
|
206
|
+
A [`liveness_check`](#job-containers-liveness-check) block (within [`job.containers`](#job-containers)) supports the following:
|
|
207
|
+
|
|
208
|
+
<a id="check-738ef8"></a>• [`exec_health_check`](#check-738ef8) - Optional Block<br>ExecHealthCheckType describes a health check based on 'run in container' action. Exit status of 0 is treated as live/healthy and non-zero is unhealthy<br>See [Exec Health Check](#check-738ef8) below.
|
|
209
|
+
|
|
210
|
+
<a id="threshold-1e3058"></a>• [`healthy_threshold`](#threshold-1e3058) - Optional Number<br>Number of consecutive successful responses after having failed before declaring healthy. In other words, this is the number of healthy health checks required before marking healthy. Note that during startup and liveliness, only a single successful health check is required to mark a container
|
|
211
|
+
|
|
212
|
+
<a id="check-052b16"></a>• [`http_health_check`](#check-052b16) - Optional Block<br>HTTPHealthCheckType describes a health check based on HTTP GET requests<br>See [HTTP Health Check](#check-052b16) below.
|
|
213
|
+
|
|
214
|
+
<a id="delay-3382ba"></a>• [`initial_delay`](#delay-3382ba) - Optional Number<br>Number of seconds after the container has started before health checks are initiated
|
|
215
|
+
|
|
216
|
+
<a id="job-containers-liveness-check-interval"></a>• [`interval`](#job-containers-liveness-check-interval) - Optional Number<br>Time interval in seconds between two health check requests
|
|
217
|
+
|
|
218
|
+
<a id="check-71da8e"></a>• [`tcp_health_check`](#check-71da8e) - Optional Block<br>TCPHealthCheckType describes a health check based on opening a TCP connection<br>See [TCP Health Check](#check-71da8e) below.
|
|
219
|
+
|
|
220
|
+
<a id="job-containers-liveness-check-timeout"></a>• [`timeout`](#job-containers-liveness-check-timeout) - Optional Number<br>Timeout in seconds to wait for successful response. In other words, it is the time to wait for a health check response. If the timeout is reached the health check attempt will be considered a failure
|
|
221
|
+
|
|
222
|
+
<a id="threshold-3d7b0c"></a>• [`unhealthy_threshold`](#threshold-3d7b0c) - Optional Number<br>Number of consecutive failed responses before declaring unhealthy. In other words, this is the number of unhealthy health checks required before a container is marked unhealthy
|
|
223
|
+
|
|
224
|
+
#### Job Containers Liveness Check Exec Health Check
|
|
225
|
+
|
|
226
|
+
An [`exec_health_check`](#check-738ef8) block (within [`job.containers.liveness_check`](#job-containers-liveness-check)) supports the following:
|
|
227
|
+
|
|
228
|
+
<a id="command-e9b078"></a>• [`command`](#command-e9b078) - Optional List<br>Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to
|
|
229
|
+
|
|
230
|
+
#### Job Containers Liveness Check HTTP Health Check
|
|
231
|
+
|
|
232
|
+
A [`http_health_check`](#check-052b16) block (within [`job.containers.liveness_check`](#job-containers-liveness-check)) supports the following:
|
|
233
|
+
|
|
234
|
+
<a id="headers-202d31"></a>• [`headers`](#headers-202d31) - Optional Block<br>Specifies a list of HTTP headers that should be added to each request that is sent to the health checked container. This is a list of key-value pairs
|
|
235
|
+
|
|
236
|
+
<a id="header-2aa0a5"></a>• [`host_header`](#header-2aa0a5) - Optional String<br>The value of the host header in the HTTP health check request
|
|
237
|
+
|
|
238
|
+
<a id="path-c81de3"></a>• [`path`](#path-c81de3) - Optional String<br>Path to access on the HTTP server
|
|
239
|
+
|
|
240
|
+
<a id="port-3d627c"></a>• [`port`](#port-3d627c) - Optional Block<br>Port. Port<br>See [Port](#port-3d627c) below.
|
|
241
|
+
|
|
242
|
+
#### Job Containers Liveness Check HTTP Health Check Port
|
|
243
|
+
|
|
244
|
+
<a id="deep-e84b03"></a>Deeply nested **Port** block collapsed for readability.
|
|
245
|
+
|
|
246
|
+
#### Job Containers Liveness Check TCP Health Check
|
|
247
|
+
|
|
248
|
+
A [`tcp_health_check`](#check-71da8e) block (within [`job.containers.liveness_check`](#job-containers-liveness-check)) supports the following:
|
|
249
|
+
|
|
250
|
+
<a id="port-7cc237"></a>• [`port`](#port-7cc237) - Optional Block<br>Port. Port<br>See [Port](#port-7cc237) below.
|
|
251
|
+
|
|
252
|
+
#### Job Containers Liveness Check TCP Health Check Port
|
|
253
|
+
|
|
254
|
+
<a id="deep-eaa186"></a>Deeply nested **Port** block collapsed for readability.
|
|
255
|
+
|
|
256
|
+
#### Job Containers Readiness Check
|
|
257
|
+
|
|
258
|
+
A [`readiness_check`](#job-containers-readiness-check) block (within [`job.containers`](#job-containers)) supports the following:
|
|
259
|
+
|
|
260
|
+
<a id="check-ce28eb"></a>• [`exec_health_check`](#check-ce28eb) - Optional Block<br>ExecHealthCheckType describes a health check based on 'run in container' action. Exit status of 0 is treated as live/healthy and non-zero is unhealthy<br>See [Exec Health Check](#check-ce28eb) below.
|
|
261
|
+
|
|
262
|
+
<a id="threshold-c93f46"></a>• [`healthy_threshold`](#threshold-c93f46) - Optional Number<br>Number of consecutive successful responses after having failed before declaring healthy. In other words, this is the number of healthy health checks required before marking healthy. Note that during startup and liveliness, only a single successful health check is required to mark a container
|
|
263
|
+
|
|
264
|
+
<a id="check-c5bafc"></a>• [`http_health_check`](#check-c5bafc) - Optional Block<br>HTTPHealthCheckType describes a health check based on HTTP GET requests<br>See [HTTP Health Check](#check-c5bafc) below.
|
|
265
|
+
|
|
266
|
+
<a id="delay-cbd49d"></a>• [`initial_delay`](#delay-cbd49d) - Optional Number<br>Number of seconds after the container has started before health checks are initiated
|
|
267
|
+
|
|
268
|
+
<a id="job-containers-readiness-check-interval"></a>• [`interval`](#job-containers-readiness-check-interval) - Optional Number<br>Time interval in seconds between two health check requests
|
|
269
|
+
|
|
270
|
+
<a id="check-df7310"></a>• [`tcp_health_check`](#check-df7310) - Optional Block<br>TCPHealthCheckType describes a health check based on opening a TCP connection<br>See [TCP Health Check](#check-df7310) below.
|
|
271
|
+
|
|
272
|
+
<a id="job-containers-readiness-check-timeout"></a>• [`timeout`](#job-containers-readiness-check-timeout) - Optional Number<br>Timeout in seconds to wait for successful response. In other words, it is the time to wait for a health check response. If the timeout is reached the health check attempt will be considered a failure
|
|
273
|
+
|
|
274
|
+
<a id="threshold-9e6547"></a>• [`unhealthy_threshold`](#threshold-9e6547) - Optional Number<br>Number of consecutive failed responses before declaring unhealthy. In other words, this is the number of unhealthy health checks required before a container is marked unhealthy
|
|
275
|
+
|
|
276
|
+
#### Job Containers Readiness Check Exec Health Check
|
|
277
|
+
|
|
278
|
+
An [`exec_health_check`](#check-ce28eb) block (within [`job.containers.readiness_check`](#job-containers-readiness-check)) supports the following:
|
|
279
|
+
|
|
280
|
+
<a id="command-c7bef1"></a>• [`command`](#command-c7bef1) - Optional List<br>Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to
|
|
281
|
+
|
|
282
|
+
#### Job Containers Readiness Check HTTP Health Check
|
|
283
|
+
|
|
284
|
+
A [`http_health_check`](#check-c5bafc) block (within [`job.containers.readiness_check`](#job-containers-readiness-check)) supports the following:
|
|
285
|
+
|
|
286
|
+
<a id="headers-16116f"></a>• [`headers`](#headers-16116f) - Optional Block<br>Specifies a list of HTTP headers that should be added to each request that is sent to the health checked container. This is a list of key-value pairs
|
|
287
|
+
|
|
288
|
+
<a id="header-389f08"></a>• [`host_header`](#header-389f08) - Optional String<br>The value of the host header in the HTTP health check request
|
|
289
|
+
|
|
290
|
+
<a id="path-c89875"></a>• [`path`](#path-c89875) - Optional String<br>Path to access on the HTTP server
|
|
291
|
+
|
|
292
|
+
<a id="port-3b8b2e"></a>• [`port`](#port-3b8b2e) - Optional Block<br>Port. Port<br>See [Port](#port-3b8b2e) below.
|
|
293
|
+
|
|
294
|
+
#### Job Containers Readiness Check HTTP Health Check Port
|
|
295
|
+
|
|
296
|
+
<a id="deep-2f9b5d"></a>Deeply nested **Port** block collapsed for readability.
|
|
297
|
+
|
|
298
|
+
#### Job Containers Readiness Check TCP Health Check
|
|
299
|
+
|
|
300
|
+
A [`tcp_health_check`](#check-df7310) block (within [`job.containers.readiness_check`](#job-containers-readiness-check)) supports the following:
|
|
301
|
+
|
|
302
|
+
<a id="port-c9d337"></a>• [`port`](#port-c9d337) - Optional Block<br>Port. Port<br>See [Port](#port-c9d337) below.
|
|
303
|
+
|
|
304
|
+
#### Job Containers Readiness Check TCP Health Check Port
|
|
305
|
+
|
|
306
|
+
<a id="deep-042872"></a>Deeply nested **Port** block collapsed for readability.
|
|
307
|
+
|
|
308
|
+
#### Job Deploy Options
|
|
309
|
+
|
|
310
|
+
A [`deploy_options`](#job-deploy-options) block (within [`job`](#job)) supports the following:
|
|
311
|
+
|
|
312
|
+
<a id="job-deploy-options-all-res"></a>• [`all_res`](#job-deploy-options-all-res) - Optional Block<br>Enable this option
|
|
313
|
+
|
|
314
|
+
<a id="sites-7d16a9"></a>• [`default_virtual_sites`](#sites-7d16a9) - Optional Block<br>Enable this option
|
|
315
|
+
|
|
316
|
+
<a id="job-deploy-options-deploy-ce-sites"></a>• [`deploy_ce_sites`](#job-deploy-options-deploy-ce-sites) - Optional Block<br>Defines a way to deploy a workload on specific Customer sites<br>See [Deploy CE Sites](#job-deploy-options-deploy-ce-sites) below.
|
|
317
|
+
|
|
318
|
+
<a id="sites-f9f96a"></a>• [`deploy_ce_virtual_sites`](#sites-f9f96a) - Optional Block<br>Defines a way to deploy a workload on specific Customer virtual sites<br>See [Deploy CE Virtual Sites](#sites-f9f96a) below.
|
|
319
|
+
|
|
320
|
+
<a id="job-deploy-options-deploy-re-sites"></a>• [`deploy_re_sites`](#job-deploy-options-deploy-re-sites) - Optional Block<br>Defines a way to deploy a workload on specific Regional Edge sites<br>See [Deploy RE Sites](#job-deploy-options-deploy-re-sites) below.
|
|
321
|
+
|
|
322
|
+
<a id="sites-178ece"></a>• [`deploy_re_virtual_sites`](#sites-178ece) - Optional Block<br>Defines a way to deploy a workload on specific Regional Edge virtual sites<br>See [Deploy RE Virtual Sites](#sites-178ece) below.
|
|
323
|
+
|
|
324
|
+
#### Job Deploy Options Deploy CE Sites
|
|
325
|
+
|
|
326
|
+
A [`deploy_ce_sites`](#job-deploy-options-deploy-ce-sites) block (within [`job.deploy_options`](#job-deploy-options)) supports the following:
|
|
327
|
+
|
|
328
|
+
<a id="job-deploy-options-deploy-ce-sites-site"></a>• [`site`](#job-deploy-options-deploy-ce-sites-site) - Optional Block<br>Which customer sites should this workload be deployed<br>See [Site](#job-deploy-options-deploy-ce-sites-site) below.
|
|
329
|
+
|
|
330
|
+
#### Job Deploy Options Deploy CE Sites Site
|
|
331
|
+
|
|
332
|
+
A [`site`](#job-deploy-options-deploy-ce-sites-site) block (within [`job.deploy_options.deploy_ce_sites`](#job-deploy-options-deploy-ce-sites)) supports the following:
|
|
333
|
+
|
|
334
|
+
<a id="name-e258db"></a>• [`name`](#name-e258db) - Optional String<br>When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object's(e.g. Route's) name
|
|
335
|
+
|
|
336
|
+
<a id="namespace-064f53"></a>• [`namespace`](#namespace-064f53) - Optional String<br>When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object's(e.g. Route's) namespace
|
|
337
|
+
|
|
338
|
+
<a id="tenant-d6cc86"></a>• [`tenant`](#tenant-d6cc86) - Optional String<br>When a configuration object(e.g. Virtual_host) refers to another(e.g route) then tenant will hold the referred object's(e.g. Route's) tenant
|
|
339
|
+
|
|
340
|
+
#### Job Deploy Options Deploy CE Virtual Sites
|
|
341
|
+
|
|
342
|
+
A [`deploy_ce_virtual_sites`](#sites-f9f96a) block (within [`job.deploy_options`](#job-deploy-options)) supports the following:
|
|
343
|
+
|
|
344
|
+
<a id="site-0c4045"></a>• [`virtual_site`](#site-0c4045) - Optional Block<br>Which customer virtual sites should this workload be deployed<br>See [Virtual Site](#site-0c4045) below.
|
|
345
|
+
|
|
346
|
+
#### Job Deploy Options Deploy CE Virtual Sites Virtual Site
|
|
347
|
+
|
|
348
|
+
<a id="deep-eef48f"></a>Deeply nested **Site** block collapsed for readability.
|
|
349
|
+
|
|
350
|
+
#### Job Deploy Options Deploy RE Sites
|
|
351
|
+
|
|
352
|
+
A [`deploy_re_sites`](#job-deploy-options-deploy-re-sites) block (within [`job.deploy_options`](#job-deploy-options)) supports the following:
|
|
353
|
+
|
|
354
|
+
<a id="job-deploy-options-deploy-re-sites-site"></a>• [`site`](#job-deploy-options-deploy-re-sites-site) - Optional Block<br>Which regional edge sites should this workload be deployed<br>See [Site](#job-deploy-options-deploy-re-sites-site) below.
|
|
355
|
+
|
|
356
|
+
#### Job Deploy Options Deploy RE Sites Site
|
|
357
|
+
|
|
358
|
+
A [`site`](#job-deploy-options-deploy-re-sites-site) block (within [`job.deploy_options.deploy_re_sites`](#job-deploy-options-deploy-re-sites)) supports the following:
|
|
359
|
+
|
|
360
|
+
<a id="name-03e074"></a>• [`name`](#name-03e074) - Optional String<br>When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object's(e.g. Route's) name
|
|
361
|
+
|
|
362
|
+
<a id="namespace-f7dfa3"></a>• [`namespace`](#namespace-f7dfa3) - Optional String<br>When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object's(e.g. Route's) namespace
|
|
363
|
+
|
|
364
|
+
<a id="tenant-2ce318"></a>• [`tenant`](#tenant-2ce318) - Optional String<br>When a configuration object(e.g. Virtual_host) refers to another(e.g route) then tenant will hold the referred object's(e.g. Route's) tenant
|
|
365
|
+
|
|
366
|
+
#### Job Deploy Options Deploy RE Virtual Sites
|
|
367
|
+
|
|
368
|
+
A [`deploy_re_virtual_sites`](#sites-178ece) block (within [`job.deploy_options`](#job-deploy-options)) supports the following:
|
|
369
|
+
|
|
370
|
+
<a id="site-3ec46d"></a>• [`virtual_site`](#site-3ec46d) - Optional Block<br>Which regional edge virtual sites should this workload be deployed<br>See [Virtual Site](#site-3ec46d) below.
|
|
371
|
+
|
|
372
|
+
#### Job Deploy Options Deploy RE Virtual Sites Virtual Site
|
|
373
|
+
|
|
374
|
+
<a id="deep-4625a0"></a>Deeply nested **Site** block collapsed for readability.
|
|
375
|
+
|
|
376
|
+
#### Job Volumes
|
|
377
|
+
|
|
378
|
+
A [`volumes`](#job-volumes) block (within [`job`](#job)) supports the following:
|
|
379
|
+
|
|
380
|
+
<a id="job-volumes-empty-dir"></a>• [`empty_dir`](#job-volumes-empty-dir) - Optional Block<br>Volume containing a temporary directory whose lifetime is the same as a replica of a workload<br>See [Empty Dir](#job-volumes-empty-dir) below.
|
|
381
|
+
|
|
382
|
+
<a id="job-volumes-host-path"></a>• [`host_path`](#job-volumes-host-path) - Optional Block<br>Volume containing a host mapped path into the workload<br>See [Host Path](#job-volumes-host-path) below.
|
|
383
|
+
|
|
384
|
+
<a id="job-volumes-name"></a>• [`name`](#job-volumes-name) - Optional String<br>Name. Name of the volume
|
|
385
|
+
|
|
386
|
+
<a id="job-volumes-persistent-volume"></a>• [`persistent_volume`](#job-volumes-persistent-volume) - Optional Block<br>Volume containing the Persistent Storage for the workload<br>See [Persistent Volume](#job-volumes-persistent-volume) below.
|
|
387
|
+
|
|
388
|
+
#### Job Volumes Empty Dir
|
|
389
|
+
|
|
390
|
+
An [`empty_dir`](#job-volumes-empty-dir) block (within [`job.volumes`](#job-volumes)) supports the following:
|
|
391
|
+
|
|
392
|
+
<a id="job-volumes-empty-dir-mount"></a>• [`mount`](#job-volumes-empty-dir-mount) - Optional Block<br>Volume mount describes how volume is mounted inside a workload<br>See [Mount](#job-volumes-empty-dir-mount) below.
|
|
393
|
+
|
|
394
|
+
<a id="job-volumes-empty-dir-size-limit"></a>• [`size_limit`](#job-volumes-empty-dir-size-limit) - Optional Number<br>Size Limit (in GiB)
|
|
395
|
+
|
|
396
|
+
#### Job Volumes Empty Dir Mount
|
|
397
|
+
|
|
398
|
+
A [`mount`](#job-volumes-empty-dir-mount) block (within [`job.volumes.empty_dir`](#job-volumes-empty-dir)) supports the following:
|
|
399
|
+
|
|
400
|
+
<a id="job-volumes-empty-dir-mount-mode"></a>• [`mode`](#job-volumes-empty-dir-mount-mode) - Optional String Defaults to `VOLUME_MOUNT_READ_ONLY`<br>Possible values are `VOLUME_MOUNT_READ_ONLY`, `VOLUME_MOUNT_READ_WRITE`<br>[Enum: VOLUME_MOUNT_READ_ONLY|VOLUME_MOUNT_READ_WRITE] Mode in which the volume should be mounted to the workload - VOLUME_MOUNT_READ_ONLY: ReadOnly Mount the volume in read-only mode - VOLUME_MOUNT_READ_WRITE: Read Write Mount the volume in read-write mode
|
|
401
|
+
|
|
402
|
+
<a id="job-volumes-empty-dir-mount-mount-path"></a>• [`mount_path`](#job-volumes-empty-dir-mount-mount-path) - Optional String<br>Path within the workload container at which the volume should be mounted. Must not contain ':'
|
|
403
|
+
|
|
404
|
+
<a id="job-volumes-empty-dir-mount-sub-path"></a>• [`sub_path`](#job-volumes-empty-dir-mount-sub-path) - Optional String Defaults to `'' (volume's root)`<br>Path within the volume from which the workload's volume should be mounted
|
|
405
|
+
|
|
406
|
+
#### Job Volumes Host Path
|
|
407
|
+
|
|
408
|
+
A [`host_path`](#job-volumes-host-path) block (within [`job.volumes`](#job-volumes)) supports the following:
|
|
409
|
+
|
|
410
|
+
<a id="job-volumes-host-path-mount"></a>• [`mount`](#job-volumes-host-path-mount) - Optional Block<br>Volume mount describes how volume is mounted inside a workload<br>See [Mount](#job-volumes-host-path-mount) below.
|
|
411
|
+
|
|
412
|
+
<a id="job-volumes-host-path-path"></a>• [`path`](#job-volumes-host-path-path) - Optional String<br>Path of the directory on the host
|
|
413
|
+
|
|
414
|
+
#### Job Volumes Host Path Mount
|
|
415
|
+
|
|
416
|
+
A [`mount`](#job-volumes-host-path-mount) block (within [`job.volumes.host_path`](#job-volumes-host-path)) supports the following:
|
|
417
|
+
|
|
418
|
+
<a id="job-volumes-host-path-mount-mode"></a>• [`mode`](#job-volumes-host-path-mount-mode) - Optional String Defaults to `VOLUME_MOUNT_READ_ONLY`<br>Possible values are `VOLUME_MOUNT_READ_ONLY`, `VOLUME_MOUNT_READ_WRITE`<br>[Enum: VOLUME_MOUNT_READ_ONLY|VOLUME_MOUNT_READ_WRITE] Mode in which the volume should be mounted to the workload - VOLUME_MOUNT_READ_ONLY: ReadOnly Mount the volume in read-only mode - VOLUME_MOUNT_READ_WRITE: Read Write Mount the volume in read-write mode
|
|
419
|
+
|
|
420
|
+
<a id="job-volumes-host-path-mount-mount-path"></a>• [`mount_path`](#job-volumes-host-path-mount-mount-path) - Optional String<br>Path within the workload container at which the volume should be mounted. Must not contain ':'
|
|
421
|
+
|
|
422
|
+
<a id="job-volumes-host-path-mount-sub-path"></a>• [`sub_path`](#job-volumes-host-path-mount-sub-path) - Optional String Defaults to `'' (volume's root)`<br>Path within the volume from which the workload's volume should be mounted
|
|
423
|
+
|
|
424
|
+
#### Job Volumes Persistent Volume
|
|
425
|
+
|
|
426
|
+
A [`persistent_volume`](#job-volumes-persistent-volume) block (within [`job.volumes`](#job-volumes)) supports the following:
|
|
427
|
+
|
|
428
|
+
<a id="job-volumes-persistent-volume-mount"></a>• [`mount`](#job-volumes-persistent-volume-mount) - Optional Block<br>Volume mount describes how volume is mounted inside a workload<br>See [Mount](#job-volumes-persistent-volume-mount) below.
|
|
429
|
+
|
|
430
|
+
<a id="job-volumes-persistent-volume-storage"></a>• [`storage`](#job-volumes-persistent-volume-storage) - Optional Block<br>Persistent storage configuration is used to configure Persistent Volume Claim (PVC)<br>See [Storage](#job-volumes-persistent-volume-storage) below.
|
|
431
|
+
|
|
432
|
+
#### Job Volumes Persistent Volume Mount
|
|
433
|
+
|
|
434
|
+
A [`mount`](#job-volumes-persistent-volume-mount) block (within [`job.volumes.persistent_volume`](#job-volumes-persistent-volume)) supports the following:
|
|
435
|
+
|
|
436
|
+
<a id="mode-f3adb7"></a>• [`mode`](#mode-f3adb7) - Optional String Defaults to `VOLUME_MOUNT_READ_ONLY`<br>Possible values are `VOLUME_MOUNT_READ_ONLY`, `VOLUME_MOUNT_READ_WRITE`<br>[Enum: VOLUME_MOUNT_READ_ONLY|VOLUME_MOUNT_READ_WRITE] Mode in which the volume should be mounted to the workload - VOLUME_MOUNT_READ_ONLY: ReadOnly Mount the volume in read-only mode - VOLUME_MOUNT_READ_WRITE: Read Write Mount the volume in read-write mode
|
|
437
|
+
|
|
438
|
+
<a id="path-fda002"></a>• [`mount_path`](#path-fda002) - Optional String<br>Path within the workload container at which the volume should be mounted. Must not contain ':'
|
|
439
|
+
|
|
440
|
+
<a id="path-a2ee82"></a>• [`sub_path`](#path-a2ee82) - Optional String Defaults to `'' (volume's root)`<br>Path within the volume from which the workload's volume should be mounted
|
|
441
|
+
|
|
442
|
+
#### Job Volumes Persistent Volume Storage
|
|
443
|
+
|
|
444
|
+
A [`storage`](#job-volumes-persistent-volume-storage) block (within [`job.volumes.persistent_volume`](#job-volumes-persistent-volume)) supports the following:
|
|
445
|
+
|
|
446
|
+
<a id="mode-a09ded"></a>• [`access_mode`](#mode-a09ded) - Optional String Defaults to `ACCESS_MODE_READ_WRITE_ONCE`<br>Possible values are `ACCESS_MODE_READ_WRITE_ONCE`, `ACCESS_MODE_READ_WRITE_MANY`, `ACCESS_MODE_READ_ONLY_MANY`<br>[Enum: ACCESS_MODE_READ_WRITE_ONCE|ACCESS_MODE_READ_WRITE_MANY|ACCESS_MODE_READ_ONLY_MANY] Persistence storage access mode is used to configure access mode for persistent storage - ACCESS_MODE_READ_WRITE_ONCE: Read Write Once Read Write Once is used to mount persistent storage in read/write mode to exactly 1 host - ACCESS_MODE_READ_WRITE_MANY: Read Write Many Read Write Many is used
|
|
447
|
+
|
|
448
|
+
<a id="name-a51d52"></a>• [`class_name`](#name-a51d52) - Optional String<br>Use the specified class name
|
|
449
|
+
|
|
450
|
+
<a id="default-3128b0"></a>• [`default`](#default-3128b0) - Optional Block<br>Enable this option
|
|
451
|
+
|
|
452
|
+
<a id="size-81eddf"></a>• [`storage_size`](#size-81eddf) - Optional Number<br>Size in GiB of the persistent storage
|
|
453
|
+
|
|
454
|
+
#### Service
|
|
455
|
+
|
|
456
|
+
A [`service`](#service) block supports the following:
|
|
457
|
+
|
|
458
|
+
<a id="service-advertise-options"></a>• [`advertise_options`](#service-advertise-options) - Optional Block<br>Advertise OPTIONS are used to configure how and where to advertise the workload using load balancers<br>See [Advertise Options](#service-advertise-options) below.
|
|
459
|
+
|
|
460
|
+
<a id="service-configuration"></a>• [`configuration`](#service-configuration) - Optional Block<br>Configuration parameters of the workload<br>See [Configuration](#service-configuration) below.
|
|
461
|
+
|
|
462
|
+
<a id="service-containers"></a>• [`containers`](#service-containers) - Optional Block<br>Containers to use for service<br>See [Containers](#service-containers) below.
|
|
463
|
+
|
|
464
|
+
<a id="service-deploy-options"></a>• [`deploy_options`](#service-deploy-options) - Optional Block<br>Deploy OPTIONS are used to configure the workload deployment OPTIONS<br>See [Deploy Options](#service-deploy-options) below.
|
|
465
|
+
|
|
466
|
+
<a id="service-num-replicas"></a>• [`num_replicas`](#service-num-replicas) - Optional Number<br>Number of replicas of service to spawn per site
|
|
467
|
+
|
|
468
|
+
<a id="service-scale-to-zero"></a>• [`scale_to_zero`](#service-scale-to-zero) - Optional Block<br>Enable this option
|
|
469
|
+
|
|
470
|
+
<a id="service-volumes"></a>• [`volumes`](#service-volumes) - Optional Block<br>Volumes. Volumes for the service<br>See [Volumes](#service-volumes) below.
|
|
471
|
+
|
|
472
|
+
#### Service Advertise Options
|
|
473
|
+
|
|
474
|
+
An [`advertise_options`](#service-advertise-options) block (within [`service`](#service)) supports the following:
|
|
475
|
+
|
|
476
|
+
<a id="custom-206cd2"></a>• [`advertise_custom`](#custom-206cd2) - Optional Block<br>Advertise this workload via loadbalancer on specific sites<br>See [Advertise Custom](#custom-206cd2) below.
|
|
477
|
+
|
|
478
|
+
<a id="cluster-9d3c24"></a>• [`advertise_in_cluster`](#cluster-9d3c24) - Optional Block<br>Advertise the workload locally in-cluster<br>See [Advertise In Cluster](#cluster-9d3c24) below.
|
|
479
|
+
|
|
480
|
+
<a id="public-fac1e6"></a>• [`advertise_on_public`](#public-fac1e6) - Optional Block<br>Advertise this workload via loadbalancer on Internet with default VIP<br>See [Advertise On Public](#public-fac1e6) below.
|
|
481
|
+
|
|
482
|
+
<a id="advertise-e33e18"></a>• [`do_not_advertise`](#advertise-e33e18) - Optional Block<br>Enable this option
|
|
483
|
+
|
|
484
|
+
#### Service Advertise Options Advertise Custom
|
|
485
|
+
|
|
486
|
+
An [`advertise_custom`](#custom-206cd2) block (within [`service.advertise_options`](#service-advertise-options)) supports the following:
|
|
487
|
+
|
|
488
|
+
<a id="where-07a5a8"></a>• [`advertise_where`](#where-07a5a8) - Optional Block<br>Where should this load balancer be available<br>See [Advertise Where](#where-07a5a8) below.
|
|
489
|
+
|
|
490
|
+
<a id="ports-b755b5"></a>• [`ports`](#ports-b755b5) - Optional Block<br>Ports. Ports to advertise<br>See [Ports](#ports-b755b5) below.
|
|
491
|
+
|
|
492
|
+
#### Service Advertise Options Advertise Custom Advertise Where
|
|
493
|
+
|
|
494
|
+
An [`advertise_where`](#where-07a5a8) block (within [`service.advertise_options.advertise_custom`](#custom-206cd2)) supports the following:
|
|
495
|
+
|
|
496
|
+
<a id="site-511518"></a>• [`site`](#site-511518) - Optional Block<br>Defines a reference to a CE site along with network type and an optional IP address where a load balancer could be advertised<br>See [Site](#site-511518) below.
|
|
497
|
+
|
|
498
|
+
<a id="site-754a5a"></a>• [`virtual_site`](#site-754a5a) - Optional Block<br>Defines a reference to a customer site virtual site along with network type where a load balancer could be advertised<br>See [Virtual Site](#site-754a5a) below.
|
|
499
|
+
|
|
500
|
+
<a id="service-1a83c0"></a>• [`vk8s_service`](#service-1a83c0) - Optional Block<br>Defines a reference to a RE site or virtual site where a load balancer could be advertised in the vK8s service network<br>See [Vk8s Service](#service-1a83c0) below.
|
|
501
|
+
|
|
502
|
+
#### Service Advertise Options Advertise Custom Advertise Where Site
|
|
503
|
+
|
|
504
|
+
<a id="deep-63c006"></a>Deeply nested **Site** block collapsed for readability.
|
|
505
|
+
|
|
506
|
+
#### Service Advertise Options Advertise Custom Advertise Where Site Site
|
|
507
|
+
|
|
508
|
+
<a id="deep-55fbc2"></a>Deeply nested **Site** block collapsed for readability.
|
|
509
|
+
|
|
510
|
+
#### Service Advertise Options Advertise Custom Advertise Where Virtual Site
|
|
511
|
+
|
|
512
|
+
<a id="deep-f8931d"></a>Deeply nested **Site** block collapsed for readability.
|
|
513
|
+
|
|
514
|
+
#### Service Advertise Options Advertise Custom Advertise Where Virtual Site Virtual Site
|
|
515
|
+
|
|
516
|
+
<a id="deep-b4597b"></a>Deeply nested **Site** block collapsed for readability.
|
|
517
|
+
|
|
518
|
+
#### Service Advertise Options Advertise Custom Advertise Where Vk8s Service
|
|
519
|
+
|
|
520
|
+
<a id="deep-9d76cc"></a>Deeply nested **Service** block collapsed for readability.
|
|
521
|
+
|
|
522
|
+
#### Service Advertise Options Advertise Custom Advertise Where Vk8s Service Site
|
|
523
|
+
|
|
524
|
+
<a id="deep-12f52b"></a>Deeply nested **Site** block collapsed for readability.
|
|
525
|
+
|
|
526
|
+
#### Service Advertise Options Advertise Custom Advertise Where Vk8s Service Virtual Site
|
|
527
|
+
|
|
528
|
+
<a id="deep-631521"></a>Deeply nested **Site** block collapsed for readability.
|
|
529
|
+
|
|
530
|
+
#### Service Advertise Options Advertise Custom Ports
|
|
531
|
+
|
|
532
|
+
A [`ports`](#ports-b755b5) block (within [`service.advertise_options.advertise_custom`](#custom-206cd2)) supports the following:
|
|
533
|
+
|
|
534
|
+
<a id="loadbalancer-40a524"></a>• [`http_loadbalancer`](#loadbalancer-40a524) - Optional Block<br>HTTP/HTTPS Load Balancer. HTTP/HTTPS Load balancer<br>See [HTTP Loadbalancer](#loadbalancer-40a524) below.
|
|
535
|
+
|
|
536
|
+
<a id="port-49f116"></a>• [`port`](#port-49f116) - Optional Block<br>Port. Port of the workload<br>See [Port](#port-49f116) below.
|
|
537
|
+
|
|
538
|
+
<a id="loadbalancer-0fd9c3"></a>• [`tcp_loadbalancer`](#loadbalancer-0fd9c3) - Optional Block<br>TCP Load Balancer. TCP loadbalancer<br>See [TCP Loadbalancer](#loadbalancer-0fd9c3) below.
|
|
539
|
+
|
|
540
|
+
#### Service Advertise Options Advertise Custom Ports HTTP Loadbalancer
|
|
541
|
+
|
|
542
|
+
<a id="deep-df89c1"></a>Deeply nested **Loadbalancer** block collapsed for readability.
|
|
543
|
+
|
|
544
|
+
#### Service Advertise Options Advertise Custom Ports HTTP Loadbalancer Default Route
|
|
545
|
+
|
|
546
|
+
<a id="deep-a3eb40"></a>Deeply nested **Route** block collapsed for readability.
|
|
547
|
+
|
|
548
|
+
#### Service Advertise Options Advertise Custom Ports HTTP Loadbalancer HTTP
|
|
549
|
+
|
|
550
|
+
<a id="deep-84a2b1"></a>Deeply nested **HTTP** block collapsed for readability.
|
|
551
|
+
|
|
552
|
+
#### Service Advertise Options Advertise Custom Ports HTTP Loadbalancer HTTPS
|
|
553
|
+
|
|
554
|
+
<a id="deep-c3aaa7"></a>Deeply nested **HTTPS** block collapsed for readability.
|
|
555
|
+
|
|
556
|
+
#### Service Advertise Options Advertise Custom Ports HTTP Loadbalancer HTTPS Coalescing Options
|
|
557
|
+
|
|
558
|
+
<a id="deep-964101"></a>Deeply nested **Options** block collapsed for readability.
|
|
559
|
+
|
|
560
|
+
#### Service Advertise Options Advertise Custom Ports HTTP Loadbalancer HTTPS HTTP Protocol Options
|
|
561
|
+
|
|
562
|
+
<a id="deep-18a985"></a>Deeply nested **Options** block collapsed for readability.
|
|
563
|
+
|
|
564
|
+
#### Service Advertise Options Advertise Custom Ports HTTP Loadbalancer HTTPS HTTP Protocol Options HTTP Protocol Enable V1 Only
|
|
565
|
+
|
|
566
|
+
<a id="deep-2c8ac3"></a>Deeply nested **Only** block collapsed for readability.
|
|
567
|
+
|
|
568
|
+
#### Service Advertise Options Advertise Custom Ports HTTP Loadbalancer HTTPS HTTP Protocol Options HTTP Protocol Enable V1 Only Header Transformation
|
|
569
|
+
|
|
570
|
+
<a id="deep-686593"></a>Deeply nested **Transformation** block collapsed for readability.
|
|
571
|
+
|
|
572
|
+
#### Service Advertise Options Advertise Custom Ports HTTP Loadbalancer HTTPS TLS Cert Params
|
|
573
|
+
|
|
574
|
+
<a id="deep-794912"></a>Deeply nested **Params** block collapsed for readability.
|
|
575
|
+
|
|
576
|
+
#### Service Advertise Options Advertise Custom Ports HTTP Loadbalancer HTTPS TLS Cert Params Certificates
|
|
577
|
+
|
|
578
|
+
<a id="deep-8f5ce4"></a>Deeply nested **Certificates** block collapsed for readability.
|
|
579
|
+
|
|
580
|
+
#### Service Advertise Options Advertise Custom Ports HTTP Loadbalancer HTTPS TLS Cert Params TLS Config
|
|
581
|
+
|
|
582
|
+
<a id="deep-586d55"></a>Deeply nested **Config** block collapsed for readability.
|
|
583
|
+
|
|
584
|
+
#### Service Advertise Options Advertise Custom Ports HTTP Loadbalancer HTTPS TLS Cert Params TLS Config Custom Security
|
|
585
|
+
|
|
586
|
+
<a id="deep-2197c6"></a>Deeply nested **Security** block collapsed for readability.
|
|
587
|
+
|
|
588
|
+
#### Service Advertise Options Advertise Custom Ports HTTP Loadbalancer HTTPS TLS Cert Params Use mTLS
|
|
589
|
+
|
|
590
|
+
<a id="deep-d19b82"></a>Deeply nested **mTLS** block collapsed for readability.
|
|
591
|
+
|
|
592
|
+
#### Service Advertise Options Advertise Custom Ports HTTP Loadbalancer HTTPS TLS Cert Params Use mTLS CRL
|
|
593
|
+
|
|
594
|
+
<a id="deep-94e1a0"></a>Deeply nested **CRL** block collapsed for readability.
|
|
595
|
+
|
|
596
|
+
#### Service Advertise Options Advertise Custom Ports HTTP Loadbalancer HTTPS TLS Cert Params Use mTLS Trusted CA
|
|
597
|
+
|
|
598
|
+
<a id="deep-274fc9"></a>Deeply nested **CA** block collapsed for readability.
|
|
599
|
+
|
|
600
|
+
#### Service Advertise Options Advertise Custom Ports HTTP Loadbalancer HTTPS TLS Cert Params Use mTLS Xfcc Options
|
|
601
|
+
|
|
602
|
+
<a id="deep-726fe8"></a>Deeply nested **Options** block collapsed for readability.
|
|
603
|
+
|
|
604
|
+
#### Service Advertise Options Advertise Custom Ports HTTP Loadbalancer HTTPS TLS Parameters
|
|
605
|
+
|
|
606
|
+
<a id="deep-ff871e"></a>Deeply nested **Parameters** block collapsed for readability.
|
|
607
|
+
|
|
608
|
+
#### Service Advertise Options Advertise Custom Ports HTTP Loadbalancer HTTPS TLS Parameters TLS Certificates
|
|
609
|
+
|
|
610
|
+
<a id="deep-bcaea7"></a>Deeply nested **Certificates** block collapsed for readability.
|
|
611
|
+
|
|
612
|
+
#### Service Advertise Options Advertise Custom Ports HTTP Loadbalancer HTTPS TLS Parameters TLS Certificates Custom Hash Algorithms
|
|
613
|
+
|
|
614
|
+
<a id="deep-78ee27"></a>Deeply nested **Algorithms** block collapsed for readability.
|
|
615
|
+
|
|
616
|
+
#### Service Advertise Options Advertise Custom Ports HTTP Loadbalancer HTTPS TLS Parameters TLS Certificates Private Key
|
|
617
|
+
|
|
618
|
+
<a id="deep-6b2af0"></a>Deeply nested **Key** block collapsed for readability.
|
|
619
|
+
|
|
620
|
+
#### Service Advertise Options Advertise Custom Ports HTTP Loadbalancer HTTPS TLS Parameters TLS Certificates Private Key Blindfold Secret Info
|
|
621
|
+
|
|
622
|
+
<a id="deep-c31663"></a>Deeply nested **Info** block collapsed for readability.
|
|
623
|
+
|
|
624
|
+
#### Service Advertise Options Advertise Custom Ports HTTP Loadbalancer HTTPS TLS Parameters TLS Certificates Private Key Clear Secret Info
|
|
625
|
+
|
|
626
|
+
<a id="deep-7179e0"></a>Deeply nested **Info** block collapsed for readability.
|
|
627
|
+
|
|
628
|
+
#### Service Advertise Options Advertise Custom Ports HTTP Loadbalancer HTTPS TLS Parameters TLS Config
|
|
629
|
+
|
|
630
|
+
<a id="deep-5a85c5"></a>Deeply nested **Config** block collapsed for readability.
|
|
631
|
+
|
|
632
|
+
#### Service Advertise Options Advertise Custom Ports HTTP Loadbalancer HTTPS TLS Parameters TLS Config Custom Security
|
|
633
|
+
|
|
634
|
+
<a id="deep-8c729c"></a>Deeply nested **Security** block collapsed for readability.
|
|
635
|
+
|
|
636
|
+
#### Service Advertise Options Advertise Custom Ports HTTP Loadbalancer HTTPS TLS Parameters Use mTLS
|
|
637
|
+
|
|
638
|
+
<a id="deep-0a2766"></a>Deeply nested **mTLS** block collapsed for readability.
|
|
639
|
+
|
|
640
|
+
#### Service Advertise Options Advertise Custom Ports HTTP Loadbalancer HTTPS TLS Parameters Use mTLS CRL
|
|
641
|
+
|
|
642
|
+
<a id="deep-d94c97"></a>Deeply nested **CRL** block collapsed for readability.
|
|
643
|
+
|
|
644
|
+
#### Service Advertise Options Advertise Custom Ports HTTP Loadbalancer HTTPS TLS Parameters Use mTLS Trusted CA
|
|
645
|
+
|
|
646
|
+
<a id="deep-ffb136"></a>Deeply nested **CA** block collapsed for readability.
|
|
647
|
+
|
|
648
|
+
#### Service Advertise Options Advertise Custom Ports HTTP Loadbalancer HTTPS TLS Parameters Use mTLS Xfcc Options
|
|
649
|
+
|
|
650
|
+
<a id="deep-77dd02"></a>Deeply nested **Options** block collapsed for readability.
|
|
651
|
+
|
|
652
|
+
#### Service Advertise Options Advertise Custom Ports HTTP Loadbalancer HTTPS Auto Cert
|
|
653
|
+
|
|
654
|
+
<a id="deep-8be33c"></a>Deeply nested **Cert** block collapsed for readability.
|
|
655
|
+
|
|
656
|
+
#### Service Advertise Options Advertise Custom Ports HTTP Loadbalancer HTTPS Auto Cert Coalescing Options
|
|
657
|
+
|
|
658
|
+
<a id="deep-316e42"></a>Deeply nested **Options** block collapsed for readability.
|
|
659
|
+
|
|
660
|
+
#### Service Advertise Options Advertise Custom Ports HTTP Loadbalancer HTTPS Auto Cert HTTP Protocol Options
|
|
661
|
+
|
|
662
|
+
<a id="deep-6e41fa"></a>Deeply nested **Options** block collapsed for readability.
|
|
663
|
+
|
|
664
|
+
#### Service Advertise Options Advertise Custom Ports HTTP Loadbalancer HTTPS Auto Cert HTTP Protocol Options HTTP Protocol Enable V1 Only
|
|
665
|
+
|
|
666
|
+
<a id="deep-2c9770"></a>Deeply nested **Only** block collapsed for readability.
|
|
667
|
+
|
|
668
|
+
#### Service Advertise Options Advertise Custom Ports HTTP Loadbalancer HTTPS Auto Cert HTTP Protocol Options HTTP Protocol Enable V1 Only Header Transformation
|
|
669
|
+
|
|
670
|
+
<a id="deep-3da430"></a>Deeply nested **Transformation** block collapsed for readability.
|
|
671
|
+
|
|
672
|
+
#### Service Advertise Options Advertise Custom Ports HTTP Loadbalancer HTTPS Auto Cert TLS Config
|
|
673
|
+
|
|
674
|
+
<a id="deep-cfd083"></a>Deeply nested **Config** block collapsed for readability.
|
|
675
|
+
|
|
676
|
+
#### Service Advertise Options Advertise Custom Ports HTTP Loadbalancer HTTPS Auto Cert TLS Config Custom Security
|
|
677
|
+
|
|
678
|
+
<a id="deep-fd8bbe"></a>Deeply nested **Security** block collapsed for readability.
|
|
679
|
+
|
|
680
|
+
#### Service Advertise Options Advertise Custom Ports HTTP Loadbalancer HTTPS Auto Cert Use mTLS
|
|
681
|
+
|
|
682
|
+
<a id="deep-033783"></a>Deeply nested **mTLS** block collapsed for readability.
|
|
683
|
+
|
|
684
|
+
#### Service Advertise Options Advertise Custom Ports HTTP Loadbalancer HTTPS Auto Cert Use mTLS CRL
|
|
685
|
+
|
|
686
|
+
<a id="deep-ecd09a"></a>Deeply nested **CRL** block collapsed for readability.
|
|
687
|
+
|
|
688
|
+
#### Service Advertise Options Advertise Custom Ports HTTP Loadbalancer HTTPS Auto Cert Use mTLS Trusted CA
|
|
689
|
+
|
|
690
|
+
<a id="deep-841dde"></a>Deeply nested **CA** block collapsed for readability.
|
|
691
|
+
|
|
692
|
+
#### Service Advertise Options Advertise Custom Ports HTTP Loadbalancer HTTPS Auto Cert Use mTLS Xfcc Options
|
|
693
|
+
|
|
694
|
+
<a id="deep-6c38ec"></a>Deeply nested **Options** block collapsed for readability.
|
|
695
|
+
|
|
696
|
+
#### Service Advertise Options Advertise Custom Ports HTTP Loadbalancer Specific Routes
|
|
697
|
+
|
|
698
|
+
<a id="deep-1f4409"></a>Deeply nested **Routes** block collapsed for readability.
|
|
699
|
+
|
|
700
|
+
#### Service Advertise Options Advertise Custom Ports HTTP Loadbalancer Specific Routes Routes
|
|
701
|
+
|
|
702
|
+
<a id="deep-14b5ee"></a>Deeply nested **Routes** block collapsed for readability.
|
|
703
|
+
|
|
704
|
+
#### Service Advertise Options Advertise Custom Ports HTTP Loadbalancer Specific Routes Routes Custom Route Object
|
|
705
|
+
|
|
706
|
+
<a id="deep-f308f8"></a>Deeply nested **Object** block collapsed for readability.
|
|
707
|
+
|
|
708
|
+
#### Service Advertise Options Advertise Custom Ports HTTP Loadbalancer Specific Routes Routes Custom Route Object Route Ref
|
|
709
|
+
|
|
710
|
+
<a id="deep-a05f4e"></a>Deeply nested **Ref** block collapsed for readability.
|
|
711
|
+
|
|
712
|
+
#### Service Advertise Options Advertise Custom Ports HTTP Loadbalancer Specific Routes Routes Direct Response Route
|
|
713
|
+
|
|
714
|
+
<a id="deep-17efaa"></a>Deeply nested **Route** block collapsed for readability.
|
|
715
|
+
|
|
716
|
+
#### Service Advertise Options Advertise Custom Ports HTTP Loadbalancer Specific Routes Routes Direct Response Route Headers
|
|
717
|
+
|
|
718
|
+
<a id="deep-d77a6f"></a>Deeply nested **Headers** block collapsed for readability.
|
|
719
|
+
|
|
720
|
+
#### Service Advertise Options Advertise Custom Ports HTTP Loadbalancer Specific Routes Routes Direct Response Route Incoming Port
|
|
721
|
+
|
|
722
|
+
<a id="deep-972608"></a>Deeply nested **Port** block collapsed for readability.
|
|
723
|
+
|
|
724
|
+
#### Service Advertise Options Advertise Custom Ports HTTP Loadbalancer Specific Routes Routes Direct Response Route Path
|
|
725
|
+
|
|
726
|
+
<a id="deep-547291"></a>Deeply nested **Path** block collapsed for readability.
|
|
727
|
+
|
|
728
|
+
#### Service Advertise Options Advertise Custom Ports HTTP Loadbalancer Specific Routes Routes Direct Response Route Route Direct Response
|
|
729
|
+
|
|
730
|
+
<a id="deep-5d8fe5"></a>Deeply nested **Response** block collapsed for readability.
|
|
731
|
+
|
|
732
|
+
#### Service Advertise Options Advertise Custom Ports HTTP Loadbalancer Specific Routes Routes Redirect Route
|
|
733
|
+
|
|
734
|
+
<a id="deep-2db089"></a>Deeply nested **Route** block collapsed for readability.
|
|
735
|
+
|
|
736
|
+
#### Service Advertise Options Advertise Custom Ports HTTP Loadbalancer Specific Routes Routes Redirect Route Headers
|
|
737
|
+
|
|
738
|
+
<a id="deep-26f51e"></a>Deeply nested **Headers** block collapsed for readability.
|
|
739
|
+
|
|
740
|
+
#### Service Advertise Options Advertise Custom Ports HTTP Loadbalancer Specific Routes Routes Redirect Route Incoming Port
|
|
741
|
+
|
|
742
|
+
<a id="deep-664ee8"></a>Deeply nested **Port** block collapsed for readability.
|
|
743
|
+
|
|
744
|
+
#### Service Advertise Options Advertise Custom Ports HTTP Loadbalancer Specific Routes Routes Redirect Route Path
|
|
745
|
+
|
|
746
|
+
<a id="deep-7c04a1"></a>Deeply nested **Path** block collapsed for readability.
|
|
747
|
+
|
|
748
|
+
#### Service Advertise Options Advertise Custom Ports HTTP Loadbalancer Specific Routes Routes Redirect Route Route Redirect
|
|
749
|
+
|
|
750
|
+
<a id="deep-126497"></a>Deeply nested **Redirect** block collapsed for readability.
|
|
751
|
+
|
|
752
|
+
#### Service Advertise Options Advertise Custom Ports HTTP Loadbalancer Specific Routes Routes Simple Route
|
|
753
|
+
|
|
754
|
+
<a id="deep-2d1a5a"></a>Deeply nested **Route** block collapsed for readability.
|
|
755
|
+
|
|
756
|
+
#### Service Advertise Options Advertise Custom Ports HTTP Loadbalancer Specific Routes Routes Simple Route Path
|
|
757
|
+
|
|
758
|
+
<a id="deep-9a6802"></a>Deeply nested **Path** block collapsed for readability.
|
|
759
|
+
|
|
760
|
+
#### Service Advertise Options Advertise Custom Ports Port
|
|
761
|
+
|
|
762
|
+
A [`port`](#port-49f116) block (within [`service.advertise_options.advertise_custom.ports`](#ports-b755b5)) supports the following:
|
|
763
|
+
|
|
764
|
+
<a id="info-66bbf6"></a>• [`info`](#info-66bbf6) - Optional Block<br>Port Information. Port information<br>See [Info](#info-66bbf6) below.
|
|
765
|
+
|
|
766
|
+
<a id="name-6799ba"></a>• [`name`](#name-6799ba) - Optional String<br>Name. Name of the Port
|
|
767
|
+
|
|
768
|
+
#### Service Advertise Options Advertise Custom Ports Port Info
|
|
769
|
+
|
|
770
|
+
<a id="deep-aab026"></a>Deeply nested **Info** block collapsed for readability.
|
|
771
|
+
|
|
772
|
+
#### Service Advertise Options Advertise Custom Ports TCP Loadbalancer
|
|
773
|
+
|
|
774
|
+
<a id="deep-94c104"></a>Deeply nested **Loadbalancer** block collapsed for readability.
|
|
775
|
+
|
|
776
|
+
#### Service Advertise Options Advertise In Cluster
|
|
777
|
+
|
|
778
|
+
An [`advertise_in_cluster`](#cluster-9d3c24) block (within [`service.advertise_options`](#service-advertise-options)) supports the following:
|
|
779
|
+
|
|
780
|
+
<a id="ports-47cae5"></a>• [`multi_ports`](#ports-47cae5) - Optional Block<br>Multiple Ports. Multiple ports<br>See [Multi Ports](#ports-47cae5) below.
|
|
781
|
+
|
|
782
|
+
<a id="port-fc2a3b"></a>• [`port`](#port-fc2a3b) - Optional Block<br>Port. Single port<br>See [Port](#port-fc2a3b) below.
|
|
783
|
+
|
|
784
|
+
#### Service Advertise Options Advertise In Cluster Multi Ports
|
|
785
|
+
|
|
786
|
+
<a id="deep-9d2ae1"></a>Deeply nested **Ports** block collapsed for readability.
|
|
787
|
+
|
|
788
|
+
#### Service Advertise Options Advertise In Cluster Multi Ports Ports
|
|
789
|
+
|
|
790
|
+
<a id="deep-3744bf"></a>Deeply nested **Ports** block collapsed for readability.
|
|
791
|
+
|
|
792
|
+
#### Service Advertise Options Advertise In Cluster Multi Ports Ports Info
|
|
793
|
+
|
|
794
|
+
<a id="deep-8dde36"></a>Deeply nested **Info** block collapsed for readability.
|
|
795
|
+
|
|
796
|
+
#### Service Advertise Options Advertise In Cluster Port
|
|
797
|
+
|
|
798
|
+
A [`port`](#port-fc2a3b) block (within [`service.advertise_options.advertise_in_cluster`](#cluster-9d3c24)) supports the following:
|
|
799
|
+
|
|
800
|
+
<a id="info-73ea02"></a>• [`info`](#info-73ea02) - Optional Block<br>Port Information. Port information<br>See [Info](#info-73ea02) below.
|
|
801
|
+
|
|
802
|
+
#### Service Advertise Options Advertise In Cluster Port Info
|
|
803
|
+
|
|
804
|
+
<a id="deep-936296"></a>Deeply nested **Info** block collapsed for readability.
|
|
805
|
+
|
|
806
|
+
#### Service Advertise Options Advertise On Public
|
|
807
|
+
|
|
808
|
+
An [`advertise_on_public`](#public-fac1e6) block (within [`service.advertise_options`](#service-advertise-options)) supports the following:
|
|
809
|
+
|
|
810
|
+
<a id="ports-b4a2d0"></a>• [`multi_ports`](#ports-b4a2d0) - Optional Block<br>Advertise Multiple Ports. Advertise multiple ports<br>See [Multi Ports](#ports-b4a2d0) below.
|
|
811
|
+
|
|
812
|
+
<a id="port-c54e32"></a>• [`port`](#port-c54e32) - Optional Block<br>Advertise Port. Advertise single port<br>See [Port](#port-c54e32) below.
|
|
813
|
+
|
|
814
|
+
#### Service Advertise Options Advertise On Public Multi Ports
|
|
815
|
+
|
|
816
|
+
<a id="deep-780c5a"></a>Deeply nested **Ports** block collapsed for readability.
|
|
817
|
+
|
|
818
|
+
#### Service Advertise Options Advertise On Public Multi Ports Ports
|
|
819
|
+
|
|
820
|
+
<a id="deep-d87391"></a>Deeply nested **Ports** block collapsed for readability.
|
|
821
|
+
|
|
822
|
+
#### Service Advertise Options Advertise On Public Multi Ports Ports HTTP Loadbalancer
|
|
823
|
+
|
|
824
|
+
<a id="deep-2b84f8"></a>Deeply nested **Loadbalancer** block collapsed for readability.
|
|
825
|
+
|
|
826
|
+
#### Service Advertise Options Advertise On Public Multi Ports Ports HTTP Loadbalancer Default Route
|
|
827
|
+
|
|
828
|
+
<a id="deep-db98d3"></a>Deeply nested **Route** block collapsed for readability.
|
|
829
|
+
|
|
830
|
+
#### Service Advertise Options Advertise On Public Multi Ports Ports HTTP Loadbalancer HTTP
|
|
831
|
+
|
|
832
|
+
<a id="deep-db7f35"></a>Deeply nested **HTTP** block collapsed for readability.
|
|
833
|
+
|
|
834
|
+
#### Service Advertise Options Advertise On Public Multi Ports Ports HTTP Loadbalancer HTTPS
|
|
835
|
+
|
|
836
|
+
<a id="deep-e24bdc"></a>Deeply nested **HTTPS** block collapsed for readability.
|
|
837
|
+
|
|
838
|
+
#### Service Advertise Options Advertise On Public Multi Ports Ports HTTP Loadbalancer HTTPS Coalescing Options
|
|
839
|
+
|
|
840
|
+
<a id="deep-202620"></a>Deeply nested **Options** block collapsed for readability.
|
|
841
|
+
|
|
842
|
+
#### Service Advertise Options Advertise On Public Multi Ports Ports HTTP Loadbalancer HTTPS HTTP Protocol Options
|
|
843
|
+
|
|
844
|
+
<a id="deep-7ec77e"></a>Deeply nested **Options** block collapsed for readability.
|
|
845
|
+
|
|
846
|
+
#### Service Advertise Options Advertise On Public Multi Ports Ports HTTP Loadbalancer HTTPS HTTP Protocol Options HTTP Protocol Enable V1 Only
|
|
847
|
+
|
|
848
|
+
<a id="deep-84a652"></a>Deeply nested **Only** block collapsed for readability.
|
|
849
|
+
|
|
850
|
+
#### Service Advertise Options Advertise On Public Multi Ports Ports HTTP Loadbalancer HTTPS HTTP Protocol Options HTTP Protocol Enable V1 Only Header Transformation
|
|
851
|
+
|
|
852
|
+
<a id="deep-a51019"></a>Deeply nested **Transformation** block collapsed for readability.
|
|
853
|
+
|
|
854
|
+
#### Service Advertise Options Advertise On Public Multi Ports Ports HTTP Loadbalancer HTTPS TLS Cert Params
|
|
855
|
+
|
|
856
|
+
<a id="deep-659a12"></a>Deeply nested **Params** block collapsed for readability.
|
|
857
|
+
|
|
858
|
+
#### Service Advertise Options Advertise On Public Multi Ports Ports HTTP Loadbalancer HTTPS TLS Cert Params Certificates
|
|
859
|
+
|
|
860
|
+
<a id="deep-315ba5"></a>Deeply nested **Certificates** block collapsed for readability.
|
|
861
|
+
|
|
862
|
+
#### Service Advertise Options Advertise On Public Multi Ports Ports HTTP Loadbalancer HTTPS TLS Cert Params TLS Config
|
|
863
|
+
|
|
864
|
+
<a id="deep-504635"></a>Deeply nested **Config** block collapsed for readability.
|
|
865
|
+
|
|
866
|
+
#### Service Advertise Options Advertise On Public Multi Ports Ports HTTP Loadbalancer HTTPS TLS Cert Params TLS Config Custom Security
|
|
867
|
+
|
|
868
|
+
<a id="deep-4a5832"></a>Deeply nested **Security** block collapsed for readability.
|
|
869
|
+
|
|
870
|
+
#### Service Advertise Options Advertise On Public Multi Ports Ports HTTP Loadbalancer HTTPS TLS Cert Params Use mTLS
|
|
871
|
+
|
|
872
|
+
<a id="deep-ae20aa"></a>Deeply nested **mTLS** block collapsed for readability.
|
|
873
|
+
|
|
874
|
+
#### Service Advertise Options Advertise On Public Multi Ports Ports HTTP Loadbalancer HTTPS TLS Cert Params Use mTLS CRL
|
|
875
|
+
|
|
876
|
+
<a id="deep-2d5cca"></a>Deeply nested **CRL** block collapsed for readability.
|
|
877
|
+
|
|
878
|
+
#### Service Advertise Options Advertise On Public Multi Ports Ports HTTP Loadbalancer HTTPS TLS Cert Params Use mTLS Trusted CA
|
|
879
|
+
|
|
880
|
+
<a id="deep-6f57c1"></a>Deeply nested **CA** block collapsed for readability.
|
|
881
|
+
|
|
882
|
+
#### Service Advertise Options Advertise On Public Multi Ports Ports HTTP Loadbalancer HTTPS TLS Cert Params Use mTLS Xfcc Options
|
|
883
|
+
|
|
884
|
+
<a id="deep-5b1fe8"></a>Deeply nested **Options** block collapsed for readability.
|
|
885
|
+
|
|
886
|
+
#### Service Advertise Options Advertise On Public Multi Ports Ports HTTP Loadbalancer HTTPS TLS Parameters
|
|
887
|
+
|
|
888
|
+
<a id="deep-f5509b"></a>Deeply nested **Parameters** block collapsed for readability.
|
|
889
|
+
|
|
890
|
+
#### Service Advertise Options Advertise On Public Multi Ports Ports HTTP Loadbalancer HTTPS TLS Parameters TLS Certificates
|
|
891
|
+
|
|
892
|
+
<a id="deep-ae0e3b"></a>Deeply nested **Certificates** block collapsed for readability.
|
|
893
|
+
|
|
894
|
+
#### Service Advertise Options Advertise On Public Multi Ports Ports HTTP Loadbalancer HTTPS TLS Parameters TLS Certificates Custom Hash Algorithms
|
|
895
|
+
|
|
896
|
+
<a id="deep-c90287"></a>Deeply nested **Algorithms** block collapsed for readability.
|
|
897
|
+
|
|
898
|
+
#### Service Advertise Options Advertise On Public Multi Ports Ports HTTP Loadbalancer HTTPS TLS Parameters TLS Certificates Private Key
|
|
899
|
+
|
|
900
|
+
<a id="deep-e1d299"></a>Deeply nested **Key** block collapsed for readability.
|
|
901
|
+
|
|
902
|
+
#### Service Advertise Options Advertise On Public Multi Ports Ports HTTP Loadbalancer HTTPS TLS Parameters TLS Certificates Private Key Blindfold Secret Info
|
|
903
|
+
|
|
904
|
+
<a id="deep-56478b"></a>Deeply nested **Info** block collapsed for readability.
|
|
905
|
+
|
|
906
|
+
#### Service Advertise Options Advertise On Public Multi Ports Ports HTTP Loadbalancer HTTPS TLS Parameters TLS Certificates Private Key Clear Secret Info
|
|
907
|
+
|
|
908
|
+
<a id="deep-9fa0e2"></a>Deeply nested **Info** block collapsed for readability.
|
|
909
|
+
|
|
910
|
+
#### Service Advertise Options Advertise On Public Multi Ports Ports HTTP Loadbalancer HTTPS TLS Parameters TLS Config
|
|
911
|
+
|
|
912
|
+
<a id="deep-3a10ee"></a>Deeply nested **Config** block collapsed for readability.
|
|
913
|
+
|
|
914
|
+
#### Service Advertise Options Advertise On Public Multi Ports Ports HTTP Loadbalancer HTTPS TLS Parameters TLS Config Custom Security
|
|
915
|
+
|
|
916
|
+
<a id="deep-3252f9"></a>Deeply nested **Security** block collapsed for readability.
|
|
917
|
+
|
|
918
|
+
#### Service Advertise Options Advertise On Public Multi Ports Ports HTTP Loadbalancer HTTPS TLS Parameters Use mTLS
|
|
919
|
+
|
|
920
|
+
<a id="deep-71d78a"></a>Deeply nested **mTLS** block collapsed for readability.
|
|
921
|
+
|
|
922
|
+
#### Service Advertise Options Advertise On Public Multi Ports Ports HTTP Loadbalancer HTTPS TLS Parameters Use mTLS CRL
|
|
923
|
+
|
|
924
|
+
<a id="deep-9c38dd"></a>Deeply nested **CRL** block collapsed for readability.
|
|
925
|
+
|
|
926
|
+
#### Service Advertise Options Advertise On Public Multi Ports Ports HTTP Loadbalancer HTTPS TLS Parameters Use mTLS Trusted CA
|
|
927
|
+
|
|
928
|
+
<a id="deep-76a1d2"></a>Deeply nested **CA** block collapsed for readability.
|
|
929
|
+
|
|
930
|
+
#### Service Advertise Options Advertise On Public Multi Ports Ports HTTP Loadbalancer HTTPS TLS Parameters Use mTLS Xfcc Options
|
|
931
|
+
|
|
932
|
+
<a id="deep-e042ef"></a>Deeply nested **Options** block collapsed for readability.
|
|
933
|
+
|
|
934
|
+
#### Service Advertise Options Advertise On Public Multi Ports Ports HTTP Loadbalancer HTTPS Auto Cert
|
|
935
|
+
|
|
936
|
+
<a id="deep-1f5bf4"></a>Deeply nested **Cert** block collapsed for readability.
|
|
937
|
+
|
|
938
|
+
#### Service Advertise Options Advertise On Public Multi Ports Ports HTTP Loadbalancer HTTPS Auto Cert Coalescing Options
|
|
939
|
+
|
|
940
|
+
<a id="deep-0c944d"></a>Deeply nested **Options** block collapsed for readability.
|
|
941
|
+
|
|
942
|
+
#### Service Advertise Options Advertise On Public Multi Ports Ports HTTP Loadbalancer HTTPS Auto Cert HTTP Protocol Options
|
|
943
|
+
|
|
944
|
+
<a id="deep-644074"></a>Deeply nested **Options** block collapsed for readability.
|
|
945
|
+
|
|
946
|
+
#### Service Advertise Options Advertise On Public Multi Ports Ports HTTP Loadbalancer HTTPS Auto Cert HTTP Protocol Options HTTP Protocol Enable V1 Only
|
|
947
|
+
|
|
948
|
+
<a id="deep-fa1fde"></a>Deeply nested **Only** block collapsed for readability.
|
|
949
|
+
|
|
950
|
+
#### Service Advertise Options Advertise On Public Multi Ports Ports HTTP Loadbalancer HTTPS Auto Cert HTTP Protocol Options HTTP Protocol Enable V1 Only Header Transformation
|
|
951
|
+
|
|
952
|
+
<a id="deep-2f7e39"></a>Deeply nested **Transformation** block collapsed for readability.
|
|
953
|
+
|
|
954
|
+
#### Service Advertise Options Advertise On Public Multi Ports Ports HTTP Loadbalancer HTTPS Auto Cert TLS Config
|
|
955
|
+
|
|
956
|
+
<a id="deep-67b420"></a>Deeply nested **Config** block collapsed for readability.
|
|
957
|
+
|
|
958
|
+
#### Service Advertise Options Advertise On Public Multi Ports Ports HTTP Loadbalancer HTTPS Auto Cert TLS Config Custom Security
|
|
959
|
+
|
|
960
|
+
<a id="deep-d9d763"></a>Deeply nested **Security** block collapsed for readability.
|
|
961
|
+
|
|
962
|
+
#### Service Advertise Options Advertise On Public Multi Ports Ports HTTP Loadbalancer HTTPS Auto Cert Use mTLS
|
|
963
|
+
|
|
964
|
+
<a id="deep-4b8890"></a>Deeply nested **mTLS** block collapsed for readability.
|
|
965
|
+
|
|
966
|
+
#### Service Advertise Options Advertise On Public Multi Ports Ports HTTP Loadbalancer HTTPS Auto Cert Use mTLS CRL
|
|
967
|
+
|
|
968
|
+
<a id="deep-99074b"></a>Deeply nested **CRL** block collapsed for readability.
|
|
969
|
+
|
|
970
|
+
#### Service Advertise Options Advertise On Public Multi Ports Ports HTTP Loadbalancer HTTPS Auto Cert Use mTLS Trusted CA
|
|
971
|
+
|
|
972
|
+
<a id="deep-f9f4c3"></a>Deeply nested **CA** block collapsed for readability.
|
|
973
|
+
|
|
974
|
+
#### Service Advertise Options Advertise On Public Multi Ports Ports HTTP Loadbalancer HTTPS Auto Cert Use mTLS Xfcc Options
|
|
975
|
+
|
|
976
|
+
<a id="deep-66d7da"></a>Deeply nested **Options** block collapsed for readability.
|
|
977
|
+
|
|
978
|
+
#### Service Advertise Options Advertise On Public Multi Ports Ports HTTP Loadbalancer Specific Routes
|
|
979
|
+
|
|
980
|
+
<a id="deep-30820a"></a>Deeply nested **Routes** block collapsed for readability.
|
|
981
|
+
|
|
982
|
+
#### Service Advertise Options Advertise On Public Multi Ports Ports HTTP Loadbalancer Specific Routes Routes
|
|
983
|
+
|
|
984
|
+
<a id="deep-b4c6e8"></a>Deeply nested **Routes** block collapsed for readability.
|
|
985
|
+
|
|
986
|
+
#### Service Advertise Options Advertise On Public Multi Ports Ports HTTP Loadbalancer Specific Routes Routes Custom Route Object
|
|
987
|
+
|
|
988
|
+
<a id="deep-b3f649"></a>Deeply nested **Object** block collapsed for readability.
|
|
989
|
+
|
|
990
|
+
#### Service Advertise Options Advertise On Public Multi Ports Ports HTTP Loadbalancer Specific Routes Routes Custom Route Object Route Ref
|
|
991
|
+
|
|
992
|
+
<a id="deep-fa356c"></a>Deeply nested **Ref** block collapsed for readability.
|
|
993
|
+
|
|
994
|
+
#### Service Advertise Options Advertise On Public Multi Ports Ports HTTP Loadbalancer Specific Routes Routes Direct Response Route
|
|
995
|
+
|
|
996
|
+
<a id="deep-8d239e"></a>Deeply nested **Route** block collapsed for readability.
|
|
997
|
+
|
|
998
|
+
#### Service Advertise Options Advertise On Public Multi Ports Ports HTTP Loadbalancer Specific Routes Routes Direct Response Route Headers
|
|
999
|
+
|
|
1000
|
+
<a id="deep-ca1e3f"></a>Deeply nested **Headers** block collapsed for readability.
|
|
1001
|
+
|
|
1002
|
+
#### Service Advertise Options Advertise On Public Multi Ports Ports HTTP Loadbalancer Specific Routes Routes Direct Response Route Incoming Port
|
|
1003
|
+
|
|
1004
|
+
<a id="deep-337787"></a>Deeply nested **Port** block collapsed for readability.
|
|
1005
|
+
|
|
1006
|
+
#### Service Advertise Options Advertise On Public Multi Ports Ports HTTP Loadbalancer Specific Routes Routes Direct Response Route Path
|
|
1007
|
+
|
|
1008
|
+
<a id="deep-3daf64"></a>Deeply nested **Path** block collapsed for readability.
|
|
1009
|
+
|
|
1010
|
+
#### Service Advertise Options Advertise On Public Multi Ports Ports HTTP Loadbalancer Specific Routes Routes Direct Response Route Route Direct Response
|
|
1011
|
+
|
|
1012
|
+
<a id="deep-640d68"></a>Deeply nested **Response** block collapsed for readability.
|
|
1013
|
+
|
|
1014
|
+
#### Service Advertise Options Advertise On Public Multi Ports Ports HTTP Loadbalancer Specific Routes Routes Redirect Route
|
|
1015
|
+
|
|
1016
|
+
<a id="deep-e97b13"></a>Deeply nested **Route** block collapsed for readability.
|
|
1017
|
+
|
|
1018
|
+
#### Service Advertise Options Advertise On Public Multi Ports Ports HTTP Loadbalancer Specific Routes Routes Redirect Route Headers
|
|
1019
|
+
|
|
1020
|
+
<a id="deep-893273"></a>Deeply nested **Headers** block collapsed for readability.
|
|
1021
|
+
|
|
1022
|
+
#### Service Advertise Options Advertise On Public Multi Ports Ports HTTP Loadbalancer Specific Routes Routes Redirect Route Incoming Port
|
|
1023
|
+
|
|
1024
|
+
<a id="deep-7d903b"></a>Deeply nested **Port** block collapsed for readability.
|
|
1025
|
+
|
|
1026
|
+
#### Service Advertise Options Advertise On Public Multi Ports Ports HTTP Loadbalancer Specific Routes Routes Redirect Route Path
|
|
1027
|
+
|
|
1028
|
+
<a id="deep-8eea80"></a>Deeply nested **Path** block collapsed for readability.
|
|
1029
|
+
|
|
1030
|
+
#### Service Advertise Options Advertise On Public Multi Ports Ports HTTP Loadbalancer Specific Routes Routes Redirect Route Route Redirect
|
|
1031
|
+
|
|
1032
|
+
<a id="deep-016eb6"></a>Deeply nested **Redirect** block collapsed for readability.
|
|
1033
|
+
|
|
1034
|
+
#### Service Advertise Options Advertise On Public Multi Ports Ports HTTP Loadbalancer Specific Routes Routes Simple Route
|
|
1035
|
+
|
|
1036
|
+
<a id="deep-1e7841"></a>Deeply nested **Route** block collapsed for readability.
|
|
1037
|
+
|
|
1038
|
+
#### Service Advertise Options Advertise On Public Multi Ports Ports HTTP Loadbalancer Specific Routes Routes Simple Route Path
|
|
1039
|
+
|
|
1040
|
+
<a id="deep-1ab782"></a>Deeply nested **Path** block collapsed for readability.
|
|
1041
|
+
|
|
1042
|
+
#### Service Advertise Options Advertise On Public Multi Ports Ports Port
|
|
1043
|
+
|
|
1044
|
+
<a id="deep-f4ab08"></a>Deeply nested **Port** block collapsed for readability.
|
|
1045
|
+
|
|
1046
|
+
#### Service Advertise Options Advertise On Public Multi Ports Ports Port Info
|
|
1047
|
+
|
|
1048
|
+
<a id="deep-1ce2ae"></a>Deeply nested **Info** block collapsed for readability.
|
|
1049
|
+
|
|
1050
|
+
#### Service Advertise Options Advertise On Public Multi Ports Ports TCP Loadbalancer
|
|
1051
|
+
|
|
1052
|
+
<a id="deep-5977e4"></a>Deeply nested **Loadbalancer** block collapsed for readability.
|
|
1053
|
+
|
|
1054
|
+
#### Service Advertise Options Advertise On Public Port
|
|
1055
|
+
|
|
1056
|
+
A [`port`](#port-c54e32) block (within [`service.advertise_options.advertise_on_public`](#public-fac1e6)) supports the following:
|
|
1057
|
+
|
|
1058
|
+
<a id="loadbalancer-96cb17"></a>• [`http_loadbalancer`](#loadbalancer-96cb17) - Optional Block<br>HTTP/HTTPS Load Balancer. HTTP/HTTPS Load balancer<br>See [HTTP Loadbalancer](#loadbalancer-96cb17) below.
|
|
1059
|
+
|
|
1060
|
+
<a id="port-c1fca3"></a>• [`port`](#port-c1fca3) - Optional Block<br>Port. Single port<br>See [Port](#port-c1fca3) below.
|
|
1061
|
+
|
|
1062
|
+
<a id="loadbalancer-eb1f77"></a>• [`tcp_loadbalancer`](#loadbalancer-eb1f77) - Optional Block<br>TCP Load Balancer. TCP loadbalancer<br>See [TCP Loadbalancer](#loadbalancer-eb1f77) below.
|
|
1063
|
+
|
|
1064
|
+
#### Service Advertise Options Advertise On Public Port HTTP Loadbalancer
|
|
1065
|
+
|
|
1066
|
+
<a id="deep-8f00d7"></a>Deeply nested **Loadbalancer** block collapsed for readability.
|
|
1067
|
+
|
|
1068
|
+
#### Service Advertise Options Advertise On Public Port HTTP Loadbalancer Default Route
|
|
1069
|
+
|
|
1070
|
+
<a id="deep-48638b"></a>Deeply nested **Route** block collapsed for readability.
|
|
1071
|
+
|
|
1072
|
+
#### Service Advertise Options Advertise On Public Port HTTP Loadbalancer HTTP
|
|
1073
|
+
|
|
1074
|
+
<a id="deep-f2a50d"></a>Deeply nested **HTTP** block collapsed for readability.
|
|
1075
|
+
|
|
1076
|
+
#### Service Advertise Options Advertise On Public Port HTTP Loadbalancer HTTPS
|
|
1077
|
+
|
|
1078
|
+
<a id="deep-67821c"></a>Deeply nested **HTTPS** block collapsed for readability.
|
|
1079
|
+
|
|
1080
|
+
#### Service Advertise Options Advertise On Public Port HTTP Loadbalancer HTTPS Coalescing Options
|
|
1081
|
+
|
|
1082
|
+
<a id="deep-424d68"></a>Deeply nested **Options** block collapsed for readability.
|
|
1083
|
+
|
|
1084
|
+
#### Service Advertise Options Advertise On Public Port HTTP Loadbalancer HTTPS HTTP Protocol Options
|
|
1085
|
+
|
|
1086
|
+
<a id="deep-e9a072"></a>Deeply nested **Options** block collapsed for readability.
|
|
1087
|
+
|
|
1088
|
+
#### Service Advertise Options Advertise On Public Port HTTP Loadbalancer HTTPS HTTP Protocol Options HTTP Protocol Enable V1 Only
|
|
1089
|
+
|
|
1090
|
+
<a id="deep-0c6299"></a>Deeply nested **Only** block collapsed for readability.
|
|
1091
|
+
|
|
1092
|
+
#### Service Advertise Options Advertise On Public Port HTTP Loadbalancer HTTPS HTTP Protocol Options HTTP Protocol Enable V1 Only Header Transformation
|
|
1093
|
+
|
|
1094
|
+
<a id="deep-4f3e9b"></a>Deeply nested **Transformation** block collapsed for readability.
|
|
1095
|
+
|
|
1096
|
+
#### Service Advertise Options Advertise On Public Port HTTP Loadbalancer HTTPS TLS Cert Params
|
|
1097
|
+
|
|
1098
|
+
<a id="deep-e981ba"></a>Deeply nested **Params** block collapsed for readability.
|
|
1099
|
+
|
|
1100
|
+
#### Service Advertise Options Advertise On Public Port HTTP Loadbalancer HTTPS TLS Cert Params Certificates
|
|
1101
|
+
|
|
1102
|
+
<a id="deep-090632"></a>Deeply nested **Certificates** block collapsed for readability.
|
|
1103
|
+
|
|
1104
|
+
#### Service Advertise Options Advertise On Public Port HTTP Loadbalancer HTTPS TLS Cert Params TLS Config
|
|
1105
|
+
|
|
1106
|
+
<a id="deep-2945ab"></a>Deeply nested **Config** block collapsed for readability.
|
|
1107
|
+
|
|
1108
|
+
#### Service Advertise Options Advertise On Public Port HTTP Loadbalancer HTTPS TLS Cert Params TLS Config Custom Security
|
|
1109
|
+
|
|
1110
|
+
<a id="deep-f05e85"></a>Deeply nested **Security** block collapsed for readability.
|
|
1111
|
+
|
|
1112
|
+
#### Service Advertise Options Advertise On Public Port HTTP Loadbalancer HTTPS TLS Cert Params Use mTLS
|
|
1113
|
+
|
|
1114
|
+
<a id="deep-f06f40"></a>Deeply nested **mTLS** block collapsed for readability.
|
|
1115
|
+
|
|
1116
|
+
#### Service Advertise Options Advertise On Public Port HTTP Loadbalancer HTTPS TLS Cert Params Use mTLS CRL
|
|
1117
|
+
|
|
1118
|
+
<a id="deep-79b558"></a>Deeply nested **CRL** block collapsed for readability.
|
|
1119
|
+
|
|
1120
|
+
#### Service Advertise Options Advertise On Public Port HTTP Loadbalancer HTTPS TLS Cert Params Use mTLS Trusted CA
|
|
1121
|
+
|
|
1122
|
+
<a id="deep-02b65c"></a>Deeply nested **CA** block collapsed for readability.
|
|
1123
|
+
|
|
1124
|
+
#### Service Advertise Options Advertise On Public Port HTTP Loadbalancer HTTPS TLS Cert Params Use mTLS Xfcc Options
|
|
1125
|
+
|
|
1126
|
+
<a id="deep-93c7bc"></a>Deeply nested **Options** block collapsed for readability.
|
|
1127
|
+
|
|
1128
|
+
#### Service Advertise Options Advertise On Public Port HTTP Loadbalancer HTTPS TLS Parameters
|
|
1129
|
+
|
|
1130
|
+
<a id="deep-6a5f00"></a>Deeply nested **Parameters** block collapsed for readability.
|
|
1131
|
+
|
|
1132
|
+
#### Service Advertise Options Advertise On Public Port HTTP Loadbalancer HTTPS TLS Parameters TLS Certificates
|
|
1133
|
+
|
|
1134
|
+
<a id="deep-d2decf"></a>Deeply nested **Certificates** block collapsed for readability.
|
|
1135
|
+
|
|
1136
|
+
#### Service Advertise Options Advertise On Public Port HTTP Loadbalancer HTTPS TLS Parameters TLS Certificates Custom Hash Algorithms
|
|
1137
|
+
|
|
1138
|
+
<a id="deep-1c2d40"></a>Deeply nested **Algorithms** block collapsed for readability.
|
|
1139
|
+
|
|
1140
|
+
#### Service Advertise Options Advertise On Public Port HTTP Loadbalancer HTTPS TLS Parameters TLS Certificates Private Key
|
|
1141
|
+
|
|
1142
|
+
<a id="deep-20fd03"></a>Deeply nested **Key** block collapsed for readability.
|
|
1143
|
+
|
|
1144
|
+
#### Service Advertise Options Advertise On Public Port HTTP Loadbalancer HTTPS TLS Parameters TLS Certificates Private Key Blindfold Secret Info
|
|
1145
|
+
|
|
1146
|
+
<a id="deep-81b3c1"></a>Deeply nested **Info** block collapsed for readability.
|
|
1147
|
+
|
|
1148
|
+
#### Service Advertise Options Advertise On Public Port HTTP Loadbalancer HTTPS TLS Parameters TLS Certificates Private Key Clear Secret Info
|
|
1149
|
+
|
|
1150
|
+
<a id="deep-e7afa8"></a>Deeply nested **Info** block collapsed for readability.
|
|
1151
|
+
|
|
1152
|
+
#### Service Advertise Options Advertise On Public Port HTTP Loadbalancer HTTPS TLS Parameters TLS Config
|
|
1153
|
+
|
|
1154
|
+
<a id="deep-976d3d"></a>Deeply nested **Config** block collapsed for readability.
|
|
1155
|
+
|
|
1156
|
+
#### Service Advertise Options Advertise On Public Port HTTP Loadbalancer HTTPS TLS Parameters TLS Config Custom Security
|
|
1157
|
+
|
|
1158
|
+
<a id="deep-332564"></a>Deeply nested **Security** block collapsed for readability.
|
|
1159
|
+
|
|
1160
|
+
#### Service Advertise Options Advertise On Public Port HTTP Loadbalancer HTTPS TLS Parameters Use mTLS
|
|
1161
|
+
|
|
1162
|
+
<a id="deep-6f5f3a"></a>Deeply nested **mTLS** block collapsed for readability.
|
|
1163
|
+
|
|
1164
|
+
#### Service Advertise Options Advertise On Public Port HTTP Loadbalancer HTTPS TLS Parameters Use mTLS CRL
|
|
1165
|
+
|
|
1166
|
+
<a id="deep-55496a"></a>Deeply nested **CRL** block collapsed for readability.
|
|
1167
|
+
|
|
1168
|
+
#### Service Advertise Options Advertise On Public Port HTTP Loadbalancer HTTPS TLS Parameters Use mTLS Trusted CA
|
|
1169
|
+
|
|
1170
|
+
<a id="deep-20e21b"></a>Deeply nested **CA** block collapsed for readability.
|
|
1171
|
+
|
|
1172
|
+
#### Service Advertise Options Advertise On Public Port HTTP Loadbalancer HTTPS TLS Parameters Use mTLS Xfcc Options
|
|
1173
|
+
|
|
1174
|
+
<a id="deep-123824"></a>Deeply nested **Options** block collapsed for readability.
|
|
1175
|
+
|
|
1176
|
+
#### Service Advertise Options Advertise On Public Port HTTP Loadbalancer HTTPS Auto Cert
|
|
1177
|
+
|
|
1178
|
+
<a id="deep-d33ae7"></a>Deeply nested **Cert** block collapsed for readability.
|
|
1179
|
+
|
|
1180
|
+
#### Service Advertise Options Advertise On Public Port HTTP Loadbalancer HTTPS Auto Cert Coalescing Options
|
|
1181
|
+
|
|
1182
|
+
<a id="deep-04759a"></a>Deeply nested **Options** block collapsed for readability.
|
|
1183
|
+
|
|
1184
|
+
#### Service Advertise Options Advertise On Public Port HTTP Loadbalancer HTTPS Auto Cert HTTP Protocol Options
|
|
1185
|
+
|
|
1186
|
+
<a id="deep-67fd92"></a>Deeply nested **Options** block collapsed for readability.
|
|
1187
|
+
|
|
1188
|
+
#### Service Advertise Options Advertise On Public Port HTTP Loadbalancer HTTPS Auto Cert HTTP Protocol Options HTTP Protocol Enable V1 Only
|
|
1189
|
+
|
|
1190
|
+
<a id="deep-66c7c3"></a>Deeply nested **Only** block collapsed for readability.
|
|
1191
|
+
|
|
1192
|
+
#### Service Advertise Options Advertise On Public Port HTTP Loadbalancer HTTPS Auto Cert HTTP Protocol Options HTTP Protocol Enable V1 Only Header Transformation
|
|
1193
|
+
|
|
1194
|
+
<a id="deep-8b6fcc"></a>Deeply nested **Transformation** block collapsed for readability.
|
|
1195
|
+
|
|
1196
|
+
#### Service Advertise Options Advertise On Public Port HTTP Loadbalancer HTTPS Auto Cert TLS Config
|
|
1197
|
+
|
|
1198
|
+
<a id="deep-e0e48d"></a>Deeply nested **Config** block collapsed for readability.
|
|
1199
|
+
|
|
1200
|
+
#### Service Advertise Options Advertise On Public Port HTTP Loadbalancer HTTPS Auto Cert TLS Config Custom Security
|
|
1201
|
+
|
|
1202
|
+
<a id="deep-de57d7"></a>Deeply nested **Security** block collapsed for readability.
|
|
1203
|
+
|
|
1204
|
+
#### Service Advertise Options Advertise On Public Port HTTP Loadbalancer HTTPS Auto Cert Use mTLS
|
|
1205
|
+
|
|
1206
|
+
<a id="deep-3f768b"></a>Deeply nested **mTLS** block collapsed for readability.
|
|
1207
|
+
|
|
1208
|
+
#### Service Advertise Options Advertise On Public Port HTTP Loadbalancer HTTPS Auto Cert Use mTLS CRL
|
|
1209
|
+
|
|
1210
|
+
<a id="deep-e15bac"></a>Deeply nested **CRL** block collapsed for readability.
|
|
1211
|
+
|
|
1212
|
+
#### Service Advertise Options Advertise On Public Port HTTP Loadbalancer HTTPS Auto Cert Use mTLS Trusted CA
|
|
1213
|
+
|
|
1214
|
+
<a id="deep-2315b8"></a>Deeply nested **CA** block collapsed for readability.
|
|
1215
|
+
|
|
1216
|
+
#### Service Advertise Options Advertise On Public Port HTTP Loadbalancer HTTPS Auto Cert Use mTLS Xfcc Options
|
|
1217
|
+
|
|
1218
|
+
<a id="deep-f33892"></a>Deeply nested **Options** block collapsed for readability.
|
|
1219
|
+
|
|
1220
|
+
#### Service Advertise Options Advertise On Public Port HTTP Loadbalancer Specific Routes
|
|
1221
|
+
|
|
1222
|
+
<a id="deep-b6228c"></a>Deeply nested **Routes** block collapsed for readability.
|
|
1223
|
+
|
|
1224
|
+
#### Service Advertise Options Advertise On Public Port HTTP Loadbalancer Specific Routes Routes
|
|
1225
|
+
|
|
1226
|
+
<a id="deep-3856c3"></a>Deeply nested **Routes** block collapsed for readability.
|
|
1227
|
+
|
|
1228
|
+
#### Service Advertise Options Advertise On Public Port HTTP Loadbalancer Specific Routes Routes Custom Route Object
|
|
1229
|
+
|
|
1230
|
+
<a id="deep-167a98"></a>Deeply nested **Object** block collapsed for readability.
|
|
1231
|
+
|
|
1232
|
+
#### Service Advertise Options Advertise On Public Port HTTP Loadbalancer Specific Routes Routes Custom Route Object Route Ref
|
|
1233
|
+
|
|
1234
|
+
<a id="deep-6c1d94"></a>Deeply nested **Ref** block collapsed for readability.
|
|
1235
|
+
|
|
1236
|
+
#### Service Advertise Options Advertise On Public Port HTTP Loadbalancer Specific Routes Routes Direct Response Route
|
|
1237
|
+
|
|
1238
|
+
<a id="deep-1a89cd"></a>Deeply nested **Route** block collapsed for readability.
|
|
1239
|
+
|
|
1240
|
+
#### Service Advertise Options Advertise On Public Port HTTP Loadbalancer Specific Routes Routes Direct Response Route Headers
|
|
1241
|
+
|
|
1242
|
+
<a id="deep-9754bd"></a>Deeply nested **Headers** block collapsed for readability.
|
|
1243
|
+
|
|
1244
|
+
#### Service Advertise Options Advertise On Public Port HTTP Loadbalancer Specific Routes Routes Direct Response Route Incoming Port
|
|
1245
|
+
|
|
1246
|
+
<a id="deep-babbdb"></a>Deeply nested **Port** block collapsed for readability.
|
|
1247
|
+
|
|
1248
|
+
#### Service Advertise Options Advertise On Public Port HTTP Loadbalancer Specific Routes Routes Direct Response Route Path
|
|
1249
|
+
|
|
1250
|
+
<a id="deep-3b276b"></a>Deeply nested **Path** block collapsed for readability.
|
|
1251
|
+
|
|
1252
|
+
#### Service Advertise Options Advertise On Public Port HTTP Loadbalancer Specific Routes Routes Direct Response Route Route Direct Response
|
|
1253
|
+
|
|
1254
|
+
<a id="deep-317ed4"></a>Deeply nested **Response** block collapsed for readability.
|
|
1255
|
+
|
|
1256
|
+
#### Service Advertise Options Advertise On Public Port HTTP Loadbalancer Specific Routes Routes Redirect Route
|
|
1257
|
+
|
|
1258
|
+
<a id="deep-e4e340"></a>Deeply nested **Route** block collapsed for readability.
|
|
1259
|
+
|
|
1260
|
+
#### Service Advertise Options Advertise On Public Port HTTP Loadbalancer Specific Routes Routes Redirect Route Headers
|
|
1261
|
+
|
|
1262
|
+
<a id="deep-d5e00a"></a>Deeply nested **Headers** block collapsed for readability.
|
|
1263
|
+
|
|
1264
|
+
#### Service Advertise Options Advertise On Public Port HTTP Loadbalancer Specific Routes Routes Redirect Route Incoming Port
|
|
1265
|
+
|
|
1266
|
+
<a id="deep-916460"></a>Deeply nested **Port** block collapsed for readability.
|
|
1267
|
+
|
|
1268
|
+
#### Service Advertise Options Advertise On Public Port HTTP Loadbalancer Specific Routes Routes Redirect Route Path
|
|
1269
|
+
|
|
1270
|
+
<a id="deep-2006d5"></a>Deeply nested **Path** block collapsed for readability.
|
|
1271
|
+
|
|
1272
|
+
#### Service Advertise Options Advertise On Public Port HTTP Loadbalancer Specific Routes Routes Redirect Route Route Redirect
|
|
1273
|
+
|
|
1274
|
+
<a id="deep-971b67"></a>Deeply nested **Redirect** block collapsed for readability.
|
|
1275
|
+
|
|
1276
|
+
#### Service Advertise Options Advertise On Public Port HTTP Loadbalancer Specific Routes Routes Simple Route
|
|
1277
|
+
|
|
1278
|
+
<a id="deep-babfd4"></a>Deeply nested **Route** block collapsed for readability.
|
|
1279
|
+
|
|
1280
|
+
#### Service Advertise Options Advertise On Public Port HTTP Loadbalancer Specific Routes Routes Simple Route Path
|
|
1281
|
+
|
|
1282
|
+
<a id="deep-7d51e7"></a>Deeply nested **Path** block collapsed for readability.
|
|
1283
|
+
|
|
1284
|
+
#### Service Advertise Options Advertise On Public Port Port
|
|
1285
|
+
|
|
1286
|
+
<a id="deep-0c31dd"></a>Deeply nested **Port** block collapsed for readability.
|
|
1287
|
+
|
|
1288
|
+
#### Service Advertise Options Advertise On Public Port Port Info
|
|
1289
|
+
|
|
1290
|
+
<a id="deep-1d882f"></a>Deeply nested **Info** block collapsed for readability.
|
|
1291
|
+
|
|
1292
|
+
#### Service Advertise Options Advertise On Public Port TCP Loadbalancer
|
|
1293
|
+
|
|
1294
|
+
<a id="deep-d0b793"></a>Deeply nested **Loadbalancer** block collapsed for readability.
|
|
1295
|
+
|
|
1296
|
+
#### Service Configuration
|
|
1297
|
+
|
|
1298
|
+
A [`configuration`](#service-configuration) block (within [`service`](#service)) supports the following:
|
|
1299
|
+
|
|
1300
|
+
<a id="service-configuration-parameters"></a>• [`parameters`](#service-configuration-parameters) - Optional Block<br>Parameters. Parameters for the workload<br>See [Parameters](#service-configuration-parameters) below.
|
|
1301
|
+
|
|
1302
|
+
#### Service Configuration Parameters
|
|
1303
|
+
|
|
1304
|
+
A [`parameters`](#service-configuration-parameters) block (within [`service.configuration`](#service-configuration)) supports the following:
|
|
1305
|
+
|
|
1306
|
+
<a id="var-0376c3"></a>• [`env_var`](#var-0376c3) - Optional Block<br>Environment Variable. Environment Variable<br>See [Env Var](#var-0376c3) below.
|
|
1307
|
+
|
|
1308
|
+
<a id="service-configuration-parameters-file"></a>• [`file`](#service-configuration-parameters-file) - Optional Block<br>Configuration File. Configuration File for the workload<br>See [File](#service-configuration-parameters-file) below.
|
|
1309
|
+
|
|
1310
|
+
#### Service Configuration Parameters Env Var
|
|
1311
|
+
|
|
1312
|
+
An [`env_var`](#var-0376c3) block (within [`service.configuration.parameters`](#service-configuration-parameters)) supports the following:
|
|
1313
|
+
|
|
1314
|
+
<a id="name-9bd43a"></a>• [`name`](#name-9bd43a) - Optional String<br>Name. Name of Environment Variable
|
|
1315
|
+
|
|
1316
|
+
<a id="value-d14ca5"></a>• [`value`](#value-d14ca5) - Optional String<br>Value. Value of Environment Variable
|
|
1317
|
+
|
|
1318
|
+
#### Service Configuration Parameters File
|
|
1319
|
+
|
|
1320
|
+
A [`file`](#service-configuration-parameters-file) block (within [`service.configuration.parameters`](#service-configuration-parameters)) supports the following:
|
|
1321
|
+
|
|
1322
|
+
<a id="data-d0d370"></a>• [`data`](#data-d0d370) - Optional String<br>Data. File data
|
|
1323
|
+
|
|
1324
|
+
<a id="mount-b0c9b7"></a>• [`mount`](#mount-b0c9b7) - Optional Block<br>Volume mount describes how volume is mounted inside a workload<br>See [Mount](#mount-b0c9b7) below.
|
|
1325
|
+
|
|
1326
|
+
<a id="name-a1546d"></a>• [`name`](#name-a1546d) - Optional String<br>Name. Name of the file
|
|
1327
|
+
|
|
1328
|
+
<a id="name-c99c09"></a>• [`volume_name`](#name-c99c09) - Optional String<br>Volume Name. Name of the Volume
|
|
1329
|
+
|
|
1330
|
+
#### Service Configuration Parameters File Mount
|
|
1331
|
+
|
|
1332
|
+
A [`mount`](#mount-b0c9b7) block (within [`service.configuration.parameters.file`](#service-configuration-parameters-file)) supports the following:
|
|
1333
|
+
|
|
1334
|
+
<a id="mode-ba89fd"></a>• [`mode`](#mode-ba89fd) - Optional String Defaults to `VOLUME_MOUNT_READ_ONLY`<br>Possible values are `VOLUME_MOUNT_READ_ONLY`, `VOLUME_MOUNT_READ_WRITE`<br>[Enum: VOLUME_MOUNT_READ_ONLY|VOLUME_MOUNT_READ_WRITE] Mode in which the volume should be mounted to the workload - VOLUME_MOUNT_READ_ONLY: ReadOnly Mount the volume in read-only mode - VOLUME_MOUNT_READ_WRITE: Read Write Mount the volume in read-write mode
|
|
1335
|
+
|
|
1336
|
+
<a id="path-7998af"></a>• [`mount_path`](#path-7998af) - Optional String<br>Path within the workload container at which the volume should be mounted. Must not contain ':'
|
|
1337
|
+
|
|
1338
|
+
<a id="path-98e114"></a>• [`sub_path`](#path-98e114) - Optional String Defaults to `'' (volume's root)`<br>Path within the volume from which the workload's volume should be mounted
|
|
1339
|
+
|
|
1340
|
+
#### Service Containers
|
|
1341
|
+
|
|
1342
|
+
A [`containers`](#service-containers) block (within [`service`](#service)) supports the following:
|
|
1343
|
+
|
|
1344
|
+
<a id="service-containers-args"></a>• [`args`](#service-containers-args) - Optional List<br>Arguments to the entrypoint. Overrides the docker image's CMD
|
|
1345
|
+
|
|
1346
|
+
<a id="service-containers-command"></a>• [`command`](#service-containers-command) - Optional List<br>Command to execute. Overrides the docker image's ENTRYPOINT
|
|
1347
|
+
|
|
1348
|
+
<a id="service-containers-custom-flavor"></a>• [`custom_flavor`](#service-containers-custom-flavor) - Optional Block<br>Type establishes a direct reference from one object(the referrer) to another(the referred). Such a reference is in form of tenant/namespace/name<br>See [Custom Flavor](#service-containers-custom-flavor) below.
|
|
1349
|
+
|
|
1350
|
+
<a id="service-containers-default-flavor"></a>• [`default_flavor`](#service-containers-default-flavor) - Optional Block<br>Enable this option
|
|
1351
|
+
|
|
1352
|
+
<a id="service-containers-flavor"></a>• [`flavor`](#service-containers-flavor) - Optional String Defaults to `CONTAINER_FLAVOR_TYPE_TINY`<br>Possible values are `CONTAINER_FLAVOR_TYPE_TINY`, `CONTAINER_FLAVOR_TYPE_MEDIUM`, `CONTAINER_FLAVOR_TYPE_LARGE`<br>[Enum: CONTAINER_FLAVOR_TYPE_TINY|CONTAINER_FLAVOR_TYPE_MEDIUM|CONTAINER_FLAVOR_TYPE_LARGE] Container Flavor type - CONTAINER_FLAVOR_TYPE_TINY: Tiny Tiny containers have limit of 0.1 vCPU and 256 MiB (mebibyte) memory - CONTAINER_FLAVOR_TYPE_MEDIUM: Medium Medium containers have limit of 0.25 vCPU and 512 MiB (mebibyte) memory - CONTAINER_FLAVOR_TYPE_LARGE: Large Large containers have
|
|
1353
|
+
|
|
1354
|
+
<a id="service-containers-image"></a>• [`image`](#service-containers-image) - Optional Block<br>ImageType configures the image to use, how to pull the image, and the associated secrets to use if any<br>See [Image](#service-containers-image) below.
|
|
1355
|
+
|
|
1356
|
+
<a id="service-containers-init-container"></a>• [`init_container`](#service-containers-init-container) - Optional Bool<br>Specialized container that runs before application container and runs to completion
|
|
1357
|
+
|
|
1358
|
+
<a id="service-containers-liveness-check"></a>• [`liveness_check`](#service-containers-liveness-check) - Optional Block<br>HealthCheckType describes a health check to be performed against a container to determine whether it has started up or is alive or ready to receive traffic<br>See [Liveness Check](#service-containers-liveness-check) below.
|
|
1359
|
+
|
|
1360
|
+
<a id="service-containers-name"></a>• [`name`](#service-containers-name) - Optional String<br>Name. Name of the container
|
|
1361
|
+
|
|
1362
|
+
<a id="service-containers-readiness-check"></a>• [`readiness_check`](#service-containers-readiness-check) - Optional Block<br>HealthCheckType describes a health check to be performed against a container to determine whether it has started up or is alive or ready to receive traffic<br>See [Readiness Check](#service-containers-readiness-check) below.
|
|
1363
|
+
|
|
1364
|
+
#### Service Containers Custom Flavor
|
|
1365
|
+
|
|
1366
|
+
A [`custom_flavor`](#service-containers-custom-flavor) block (within [`service.containers`](#service-containers)) supports the following:
|
|
1367
|
+
|
|
1368
|
+
<a id="service-containers-custom-flavor-name"></a>• [`name`](#service-containers-custom-flavor-name) - Optional String<br>When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object's(e.g. Route's) name
|
|
1369
|
+
|
|
1370
|
+
<a id="namespace-d5d342"></a>• [`namespace`](#namespace-d5d342) - Optional String<br>When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object's(e.g. Route's) namespace
|
|
1371
|
+
|
|
1372
|
+
<a id="service-containers-custom-flavor-tenant"></a>• [`tenant`](#service-containers-custom-flavor-tenant) - Optional String<br>When a configuration object(e.g. Virtual_host) refers to another(e.g route) then tenant will hold the referred object's(e.g. Route's) tenant
|
|
1373
|
+
|
|
1374
|
+
#### Service Containers Image
|
|
1375
|
+
|
|
1376
|
+
An [`image`](#service-containers-image) block (within [`service.containers`](#service-containers)) supports the following:
|
|
1377
|
+
|
|
1378
|
+
<a id="registry-ad1f41"></a>• [`container_registry`](#registry-ad1f41) - Optional Block<br>Type establishes a direct reference from one object(the referrer) to another(the referred). Such a reference is in form of tenant/namespace/name<br>See [Container Registry](#registry-ad1f41) below.
|
|
1379
|
+
|
|
1380
|
+
<a id="service-containers-image-name"></a>• [`name`](#service-containers-image-name) - Optional String<br>Name is a container image which are usually given a name such as alpine, ubuntu, or quay.I/O/etcd:0.13. The format is registry/image:tag or registry/image@image-digest. If registry is not specified, the Docker public registry is assumed
|
|
1381
|
+
|
|
1382
|
+
<a id="service-containers-image-public"></a>• [`public`](#service-containers-image-public) - Optional Block<br>Enable this option
|
|
1383
|
+
|
|
1384
|
+
<a id="service-containers-image-pull-policy"></a>• [`pull_policy`](#service-containers-image-pull-policy) - Optional String Defaults to `IMAGE_PULL_POLICY_DEFAULT`<br>Possible values are `IMAGE_PULL_POLICY_DEFAULT`, `IMAGE_PULL_POLICY_IF_NOT_PRESENT`, `IMAGE_PULL_POLICY_ALWAYS`, `IMAGE_PULL_POLICY_NEVER`<br>[Enum: IMAGE_PULL_POLICY_DEFAULT|IMAGE_PULL_POLICY_IF_NOT_PRESENT|IMAGE_PULL_POLICY_ALWAYS|IMAGE_PULL_POLICY_NEVER] Image pull policy type enumerates the policy choices to use for pulling the image prior to starting the workload - IMAGE_PULL_POLICY_DEFAULT: Default Default will always pull image if :latest tag is specified in image name. If :latest tag is not specified in image name, it will pull image only
|
|
1385
|
+
|
|
1386
|
+
#### Service Containers Image Container Registry
|
|
1387
|
+
|
|
1388
|
+
A [`container_registry`](#registry-ad1f41) block (within [`service.containers.image`](#service-containers-image)) supports the following:
|
|
1389
|
+
|
|
1390
|
+
<a id="name-b1a7e7"></a>• [`name`](#name-b1a7e7) - Optional String<br>When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object's(e.g. Route's) name
|
|
1391
|
+
|
|
1392
|
+
<a id="namespace-993dc9"></a>• [`namespace`](#namespace-993dc9) - Optional String<br>When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object's(e.g. Route's) namespace
|
|
1393
|
+
|
|
1394
|
+
<a id="tenant-882aa5"></a>• [`tenant`](#tenant-882aa5) - Optional String<br>When a configuration object(e.g. Virtual_host) refers to another(e.g route) then tenant will hold the referred object's(e.g. Route's) tenant
|
|
1395
|
+
|
|
1396
|
+
#### Service Containers Liveness Check
|
|
1397
|
+
|
|
1398
|
+
A [`liveness_check`](#service-containers-liveness-check) block (within [`service.containers`](#service-containers)) supports the following:
|
|
1399
|
+
|
|
1400
|
+
<a id="check-f4a0a5"></a>• [`exec_health_check`](#check-f4a0a5) - Optional Block<br>ExecHealthCheckType describes a health check based on 'run in container' action. Exit status of 0 is treated as live/healthy and non-zero is unhealthy<br>See [Exec Health Check](#check-f4a0a5) below.
|
|
1401
|
+
|
|
1402
|
+
<a id="threshold-e58da7"></a>• [`healthy_threshold`](#threshold-e58da7) - Optional Number<br>Number of consecutive successful responses after having failed before declaring healthy. In other words, this is the number of healthy health checks required before marking healthy. Note that during startup and liveliness, only a single successful health check is required to mark a container
|
|
1403
|
+
|
|
1404
|
+
<a id="check-d4d023"></a>• [`http_health_check`](#check-d4d023) - Optional Block<br>HTTPHealthCheckType describes a health check based on HTTP GET requests<br>See [HTTP Health Check](#check-d4d023) below.
|
|
1405
|
+
|
|
1406
|
+
<a id="delay-5a594c"></a>• [`initial_delay`](#delay-5a594c) - Optional Number<br>Number of seconds after the container has started before health checks are initiated
|
|
1407
|
+
|
|
1408
|
+
<a id="interval-84cdc4"></a>• [`interval`](#interval-84cdc4) - Optional Number<br>Time interval in seconds between two health check requests
|
|
1409
|
+
|
|
1410
|
+
<a id="check-b2633e"></a>• [`tcp_health_check`](#check-b2633e) - Optional Block<br>TCPHealthCheckType describes a health check based on opening a TCP connection<br>See [TCP Health Check](#check-b2633e) below.
|
|
1411
|
+
|
|
1412
|
+
<a id="timeout-cea9e6"></a>• [`timeout`](#timeout-cea9e6) - Optional Number<br>Timeout in seconds to wait for successful response. In other words, it is the time to wait for a health check response. If the timeout is reached the health check attempt will be considered a failure
|
|
1413
|
+
|
|
1414
|
+
<a id="threshold-b85e9e"></a>• [`unhealthy_threshold`](#threshold-b85e9e) - Optional Number<br>Number of consecutive failed responses before declaring unhealthy. In other words, this is the number of unhealthy health checks required before a container is marked unhealthy
|
|
1415
|
+
|
|
1416
|
+
#### Service Containers Liveness Check Exec Health Check
|
|
1417
|
+
|
|
1418
|
+
An [`exec_health_check`](#check-f4a0a5) block (within [`service.containers.liveness_check`](#service-containers-liveness-check)) supports the following:
|
|
1419
|
+
|
|
1420
|
+
<a id="command-2a2705"></a>• [`command`](#command-2a2705) - Optional List<br>Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to
|
|
1421
|
+
|
|
1422
|
+
#### Service Containers Liveness Check HTTP Health Check
|
|
1423
|
+
|
|
1424
|
+
A [`http_health_check`](#check-d4d023) block (within [`service.containers.liveness_check`](#service-containers-liveness-check)) supports the following:
|
|
1425
|
+
|
|
1426
|
+
<a id="headers-10e4cf"></a>• [`headers`](#headers-10e4cf) - Optional Block<br>Specifies a list of HTTP headers that should be added to each request that is sent to the health checked container. This is a list of key-value pairs
|
|
1427
|
+
|
|
1428
|
+
<a id="header-d00d0a"></a>• [`host_header`](#header-d00d0a) - Optional String<br>The value of the host header in the HTTP health check request
|
|
1429
|
+
|
|
1430
|
+
<a id="path-ab95e6"></a>• [`path`](#path-ab95e6) - Optional String<br>Path to access on the HTTP server
|
|
1431
|
+
|
|
1432
|
+
<a id="port-df543d"></a>• [`port`](#port-df543d) - Optional Block<br>Port. Port<br>See [Port](#port-df543d) below.
|
|
1433
|
+
|
|
1434
|
+
#### Service Containers Liveness Check HTTP Health Check Port
|
|
1435
|
+
|
|
1436
|
+
<a id="deep-ff14cb"></a>Deeply nested **Port** block collapsed for readability.
|
|
1437
|
+
|
|
1438
|
+
#### Service Containers Liveness Check TCP Health Check
|
|
1439
|
+
|
|
1440
|
+
A [`tcp_health_check`](#check-b2633e) block (within [`service.containers.liveness_check`](#service-containers-liveness-check)) supports the following:
|
|
1441
|
+
|
|
1442
|
+
<a id="port-7d7fdc"></a>• [`port`](#port-7d7fdc) - Optional Block<br>Port. Port<br>See [Port](#port-7d7fdc) below.
|
|
1443
|
+
|
|
1444
|
+
#### Service Containers Liveness Check TCP Health Check Port
|
|
1445
|
+
|
|
1446
|
+
<a id="deep-6e7f23"></a>Deeply nested **Port** block collapsed for readability.
|
|
1447
|
+
|
|
1448
|
+
#### Service Containers Readiness Check
|
|
1449
|
+
|
|
1450
|
+
A [`readiness_check`](#service-containers-readiness-check) block (within [`service.containers`](#service-containers)) supports the following:
|
|
1451
|
+
|
|
1452
|
+
<a id="check-b467be"></a>• [`exec_health_check`](#check-b467be) - Optional Block<br>ExecHealthCheckType describes a health check based on 'run in container' action. Exit status of 0 is treated as live/healthy and non-zero is unhealthy<br>See [Exec Health Check](#check-b467be) below.
|
|
1453
|
+
|
|
1454
|
+
<a id="threshold-1015f0"></a>• [`healthy_threshold`](#threshold-1015f0) - Optional Number<br>Number of consecutive successful responses after having failed before declaring healthy. In other words, this is the number of healthy health checks required before marking healthy. Note that during startup and liveliness, only a single successful health check is required to mark a container
|
|
1455
|
+
|
|
1456
|
+
<a id="check-2e8715"></a>• [`http_health_check`](#check-2e8715) - Optional Block<br>HTTPHealthCheckType describes a health check based on HTTP GET requests<br>See [HTTP Health Check](#check-2e8715) below.
|
|
1457
|
+
|
|
1458
|
+
<a id="delay-6b92df"></a>• [`initial_delay`](#delay-6b92df) - Optional Number<br>Number of seconds after the container has started before health checks are initiated
|
|
1459
|
+
|
|
1460
|
+
<a id="interval-ddc93b"></a>• [`interval`](#interval-ddc93b) - Optional Number<br>Time interval in seconds between two health check requests
|
|
1461
|
+
|
|
1462
|
+
<a id="check-6b7ea7"></a>• [`tcp_health_check`](#check-6b7ea7) - Optional Block<br>TCPHealthCheckType describes a health check based on opening a TCP connection<br>See [TCP Health Check](#check-6b7ea7) below.
|
|
1463
|
+
|
|
1464
|
+
<a id="timeout-3e7e3a"></a>• [`timeout`](#timeout-3e7e3a) - Optional Number<br>Timeout in seconds to wait for successful response. In other words, it is the time to wait for a health check response. If the timeout is reached the health check attempt will be considered a failure
|
|
1465
|
+
|
|
1466
|
+
<a id="threshold-01c2b9"></a>• [`unhealthy_threshold`](#threshold-01c2b9) - Optional Number<br>Number of consecutive failed responses before declaring unhealthy. In other words, this is the number of unhealthy health checks required before a container is marked unhealthy
|
|
1467
|
+
|
|
1468
|
+
#### Service Containers Readiness Check Exec Health Check
|
|
1469
|
+
|
|
1470
|
+
An [`exec_health_check`](#check-b467be) block (within [`service.containers.readiness_check`](#service-containers-readiness-check)) supports the following:
|
|
1471
|
+
|
|
1472
|
+
<a id="command-ad2ba2"></a>• [`command`](#command-ad2ba2) - Optional List<br>Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to
|
|
1473
|
+
|
|
1474
|
+
#### Service Containers Readiness Check HTTP Health Check
|
|
1475
|
+
|
|
1476
|
+
A [`http_health_check`](#check-2e8715) block (within [`service.containers.readiness_check`](#service-containers-readiness-check)) supports the following:
|
|
1477
|
+
|
|
1478
|
+
<a id="headers-eb2094"></a>• [`headers`](#headers-eb2094) - Optional Block<br>Specifies a list of HTTP headers that should be added to each request that is sent to the health checked container. This is a list of key-value pairs
|
|
1479
|
+
|
|
1480
|
+
<a id="header-62e026"></a>• [`host_header`](#header-62e026) - Optional String<br>The value of the host header in the HTTP health check request
|
|
1481
|
+
|
|
1482
|
+
<a id="path-f132ec"></a>• [`path`](#path-f132ec) - Optional String<br>Path to access on the HTTP server
|
|
1483
|
+
|
|
1484
|
+
<a id="port-3d625e"></a>• [`port`](#port-3d625e) - Optional Block<br>Port. Port<br>See [Port](#port-3d625e) below.
|
|
1485
|
+
|
|
1486
|
+
#### Service Containers Readiness Check HTTP Health Check Port
|
|
1487
|
+
|
|
1488
|
+
<a id="deep-b02908"></a>Deeply nested **Port** block collapsed for readability.
|
|
1489
|
+
|
|
1490
|
+
#### Service Containers Readiness Check TCP Health Check
|
|
1491
|
+
|
|
1492
|
+
A [`tcp_health_check`](#check-6b7ea7) block (within [`service.containers.readiness_check`](#service-containers-readiness-check)) supports the following:
|
|
1493
|
+
|
|
1494
|
+
<a id="port-6de51f"></a>• [`port`](#port-6de51f) - Optional Block<br>Port. Port<br>See [Port](#port-6de51f) below.
|
|
1495
|
+
|
|
1496
|
+
#### Service Containers Readiness Check TCP Health Check Port
|
|
1497
|
+
|
|
1498
|
+
<a id="deep-fcfc8b"></a>Deeply nested **Port** block collapsed for readability.
|
|
1499
|
+
|
|
1500
|
+
#### Service Deploy Options
|
|
1501
|
+
|
|
1502
|
+
A [`deploy_options`](#service-deploy-options) block (within [`service`](#service)) supports the following:
|
|
1503
|
+
|
|
1504
|
+
<a id="service-deploy-options-all-res"></a>• [`all_res`](#service-deploy-options-all-res) - Optional Block<br>Enable this option
|
|
1505
|
+
|
|
1506
|
+
<a id="sites-736a02"></a>• [`default_virtual_sites`](#sites-736a02) - Optional Block<br>Enable this option
|
|
1507
|
+
|
|
1508
|
+
<a id="service-deploy-options-deploy-ce-sites"></a>• [`deploy_ce_sites`](#service-deploy-options-deploy-ce-sites) - Optional Block<br>Defines a way to deploy a workload on specific Customer sites<br>See [Deploy CE Sites](#service-deploy-options-deploy-ce-sites) below.
|
|
1509
|
+
|
|
1510
|
+
<a id="sites-d63f27"></a>• [`deploy_ce_virtual_sites`](#sites-d63f27) - Optional Block<br>Defines a way to deploy a workload on specific Customer virtual sites<br>See [Deploy CE Virtual Sites](#sites-d63f27) below.
|
|
1511
|
+
|
|
1512
|
+
<a id="service-deploy-options-deploy-re-sites"></a>• [`deploy_re_sites`](#service-deploy-options-deploy-re-sites) - Optional Block<br>Defines a way to deploy a workload on specific Regional Edge sites<br>See [Deploy RE Sites](#service-deploy-options-deploy-re-sites) below.
|
|
1513
|
+
|
|
1514
|
+
<a id="sites-e0dada"></a>• [`deploy_re_virtual_sites`](#sites-e0dada) - Optional Block<br>Defines a way to deploy a workload on specific Regional Edge virtual sites<br>See [Deploy RE Virtual Sites](#sites-e0dada) below.
|
|
1515
|
+
|
|
1516
|
+
#### Service Deploy Options Deploy CE Sites
|
|
1517
|
+
|
|
1518
|
+
A [`deploy_ce_sites`](#service-deploy-options-deploy-ce-sites) block (within [`service.deploy_options`](#service-deploy-options)) supports the following:
|
|
1519
|
+
|
|
1520
|
+
<a id="site-8d4fa5"></a>• [`site`](#site-8d4fa5) - Optional Block<br>Which customer sites should this workload be deployed<br>See [Site](#site-8d4fa5) below.
|
|
1521
|
+
|
|
1522
|
+
#### Service Deploy Options Deploy CE Sites Site
|
|
1523
|
+
|
|
1524
|
+
A [`site`](#site-8d4fa5) block (within [`service.deploy_options.deploy_ce_sites`](#service-deploy-options-deploy-ce-sites)) supports the following:
|
|
1525
|
+
|
|
1526
|
+
<a id="name-48099d"></a>• [`name`](#name-48099d) - Optional String<br>When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object's(e.g. Route's) name
|
|
1527
|
+
|
|
1528
|
+
<a id="namespace-23fa32"></a>• [`namespace`](#namespace-23fa32) - Optional String<br>When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object's(e.g. Route's) namespace
|
|
1529
|
+
|
|
1530
|
+
<a id="tenant-75f6c4"></a>• [`tenant`](#tenant-75f6c4) - Optional String<br>When a configuration object(e.g. Virtual_host) refers to another(e.g route) then tenant will hold the referred object's(e.g. Route's) tenant
|
|
1531
|
+
|
|
1532
|
+
#### Service Deploy Options Deploy CE Virtual Sites
|
|
1533
|
+
|
|
1534
|
+
A [`deploy_ce_virtual_sites`](#sites-d63f27) block (within [`service.deploy_options`](#service-deploy-options)) supports the following:
|
|
1535
|
+
|
|
1536
|
+
<a id="site-044146"></a>• [`virtual_site`](#site-044146) - Optional Block<br>Which customer virtual sites should this workload be deployed<br>See [Virtual Site](#site-044146) below.
|
|
1537
|
+
|
|
1538
|
+
#### Service Deploy Options Deploy CE Virtual Sites Virtual Site
|
|
1539
|
+
|
|
1540
|
+
<a id="deep-ae5488"></a>Deeply nested **Site** block collapsed for readability.
|
|
1541
|
+
|
|
1542
|
+
#### Service Deploy Options Deploy RE Sites
|
|
1543
|
+
|
|
1544
|
+
A [`deploy_re_sites`](#service-deploy-options-deploy-re-sites) block (within [`service.deploy_options`](#service-deploy-options)) supports the following:
|
|
1545
|
+
|
|
1546
|
+
<a id="site-e7bf20"></a>• [`site`](#site-e7bf20) - Optional Block<br>Which regional edge sites should this workload be deployed<br>See [Site](#site-e7bf20) below.
|
|
1547
|
+
|
|
1548
|
+
#### Service Deploy Options Deploy RE Sites Site
|
|
1549
|
+
|
|
1550
|
+
A [`site`](#site-e7bf20) block (within [`service.deploy_options.deploy_re_sites`](#service-deploy-options-deploy-re-sites)) supports the following:
|
|
1551
|
+
|
|
1552
|
+
<a id="name-1ebeb9"></a>• [`name`](#name-1ebeb9) - Optional String<br>When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object's(e.g. Route's) name
|
|
1553
|
+
|
|
1554
|
+
<a id="namespace-b4b743"></a>• [`namespace`](#namespace-b4b743) - Optional String<br>When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object's(e.g. Route's) namespace
|
|
1555
|
+
|
|
1556
|
+
<a id="tenant-68f3c1"></a>• [`tenant`](#tenant-68f3c1) - Optional String<br>When a configuration object(e.g. Virtual_host) refers to another(e.g route) then tenant will hold the referred object's(e.g. Route's) tenant
|
|
1557
|
+
|
|
1558
|
+
#### Service Deploy Options Deploy RE Virtual Sites
|
|
1559
|
+
|
|
1560
|
+
A [`deploy_re_virtual_sites`](#sites-e0dada) block (within [`service.deploy_options`](#service-deploy-options)) supports the following:
|
|
1561
|
+
|
|
1562
|
+
<a id="site-5bb43f"></a>• [`virtual_site`](#site-5bb43f) - Optional Block<br>Which regional edge virtual sites should this workload be deployed<br>See [Virtual Site](#site-5bb43f) below.
|
|
1563
|
+
|
|
1564
|
+
#### Service Deploy Options Deploy RE Virtual Sites Virtual Site
|
|
1565
|
+
|
|
1566
|
+
<a id="deep-50a367"></a>Deeply nested **Site** block collapsed for readability.
|
|
1567
|
+
|
|
1568
|
+
#### Service Volumes
|
|
1569
|
+
|
|
1570
|
+
A [`volumes`](#service-volumes) block (within [`service`](#service)) supports the following:
|
|
1571
|
+
|
|
1572
|
+
<a id="service-volumes-empty-dir"></a>• [`empty_dir`](#service-volumes-empty-dir) - Optional Block<br>Volume containing a temporary directory whose lifetime is the same as a replica of a workload<br>See [Empty Dir](#service-volumes-empty-dir) below.
|
|
1573
|
+
|
|
1574
|
+
<a id="service-volumes-host-path"></a>• [`host_path`](#service-volumes-host-path) - Optional Block<br>Volume containing a host mapped path into the workload<br>See [Host Path](#service-volumes-host-path) below.
|
|
1575
|
+
|
|
1576
|
+
<a id="service-volumes-name"></a>• [`name`](#service-volumes-name) - Optional String<br>Name. Name of the volume
|
|
1577
|
+
|
|
1578
|
+
<a id="service-volumes-persistent-volume"></a>• [`persistent_volume`](#service-volumes-persistent-volume) - Optional Block<br>Volume containing the Persistent Storage for the workload<br>See [Persistent Volume](#service-volumes-persistent-volume) below.
|
|
1579
|
+
|
|
1580
|
+
#### Service Volumes Empty Dir
|
|
1581
|
+
|
|
1582
|
+
An [`empty_dir`](#service-volumes-empty-dir) block (within [`service.volumes`](#service-volumes)) supports the following:
|
|
1583
|
+
|
|
1584
|
+
<a id="service-volumes-empty-dir-mount"></a>• [`mount`](#service-volumes-empty-dir-mount) - Optional Block<br>Volume mount describes how volume is mounted inside a workload<br>See [Mount](#service-volumes-empty-dir-mount) below.
|
|
1585
|
+
|
|
1586
|
+
<a id="service-volumes-empty-dir-size-limit"></a>• [`size_limit`](#service-volumes-empty-dir-size-limit) - Optional Number<br>Size Limit (in GiB)
|
|
1587
|
+
|
|
1588
|
+
#### Service Volumes Empty Dir Mount
|
|
1589
|
+
|
|
1590
|
+
A [`mount`](#service-volumes-empty-dir-mount) block (within [`service.volumes.empty_dir`](#service-volumes-empty-dir)) supports the following:
|
|
1591
|
+
|
|
1592
|
+
<a id="service-volumes-empty-dir-mount-mode"></a>• [`mode`](#service-volumes-empty-dir-mount-mode) - Optional String Defaults to `VOLUME_MOUNT_READ_ONLY`<br>Possible values are `VOLUME_MOUNT_READ_ONLY`, `VOLUME_MOUNT_READ_WRITE`<br>[Enum: VOLUME_MOUNT_READ_ONLY|VOLUME_MOUNT_READ_WRITE] Mode in which the volume should be mounted to the workload - VOLUME_MOUNT_READ_ONLY: ReadOnly Mount the volume in read-only mode - VOLUME_MOUNT_READ_WRITE: Read Write Mount the volume in read-write mode
|
|
1593
|
+
|
|
1594
|
+
<a id="path-db6f81"></a>• [`mount_path`](#path-db6f81) - Optional String<br>Path within the workload container at which the volume should be mounted. Must not contain ':'
|
|
1595
|
+
|
|
1596
|
+
<a id="path-3009de"></a>• [`sub_path`](#path-3009de) - Optional String Defaults to `'' (volume's root)`<br>Path within the volume from which the workload's volume should be mounted
|
|
1597
|
+
|
|
1598
|
+
#### Service Volumes Host Path
|
|
1599
|
+
|
|
1600
|
+
A [`host_path`](#service-volumes-host-path) block (within [`service.volumes`](#service-volumes)) supports the following:
|
|
1601
|
+
|
|
1602
|
+
<a id="service-volumes-host-path-mount"></a>• [`mount`](#service-volumes-host-path-mount) - Optional Block<br>Volume mount describes how volume is mounted inside a workload<br>See [Mount](#service-volumes-host-path-mount) below.
|
|
1603
|
+
|
|
1604
|
+
<a id="service-volumes-host-path-path"></a>• [`path`](#service-volumes-host-path-path) - Optional String<br>Path of the directory on the host
|
|
1605
|
+
|
|
1606
|
+
#### Service Volumes Host Path Mount
|
|
1607
|
+
|
|
1608
|
+
A [`mount`](#service-volumes-host-path-mount) block (within [`service.volumes.host_path`](#service-volumes-host-path)) supports the following:
|
|
1609
|
+
|
|
1610
|
+
<a id="service-volumes-host-path-mount-mode"></a>• [`mode`](#service-volumes-host-path-mount-mode) - Optional String Defaults to `VOLUME_MOUNT_READ_ONLY`<br>Possible values are `VOLUME_MOUNT_READ_ONLY`, `VOLUME_MOUNT_READ_WRITE`<br>[Enum: VOLUME_MOUNT_READ_ONLY|VOLUME_MOUNT_READ_WRITE] Mode in which the volume should be mounted to the workload - VOLUME_MOUNT_READ_ONLY: ReadOnly Mount the volume in read-only mode - VOLUME_MOUNT_READ_WRITE: Read Write Mount the volume in read-write mode
|
|
1611
|
+
|
|
1612
|
+
<a id="path-0b89b4"></a>• [`mount_path`](#path-0b89b4) - Optional String<br>Path within the workload container at which the volume should be mounted. Must not contain ':'
|
|
1613
|
+
|
|
1614
|
+
<a id="path-7cee3d"></a>• [`sub_path`](#path-7cee3d) - Optional String Defaults to `'' (volume's root)`<br>Path within the volume from which the workload's volume should be mounted
|
|
1615
|
+
|
|
1616
|
+
#### Service Volumes Persistent Volume
|
|
1617
|
+
|
|
1618
|
+
A [`persistent_volume`](#service-volumes-persistent-volume) block (within [`service.volumes`](#service-volumes)) supports the following:
|
|
1619
|
+
|
|
1620
|
+
<a id="service-volumes-persistent-volume-mount"></a>• [`mount`](#service-volumes-persistent-volume-mount) - Optional Block<br>Volume mount describes how volume is mounted inside a workload<br>See [Mount](#service-volumes-persistent-volume-mount) below.
|
|
1621
|
+
|
|
1622
|
+
<a id="storage-aa2194"></a>• [`storage`](#storage-aa2194) - Optional Block<br>Persistent storage configuration is used to configure Persistent Volume Claim (PVC)<br>See [Storage](#storage-aa2194) below.
|
|
1623
|
+
|
|
1624
|
+
#### Service Volumes Persistent Volume Mount
|
|
1625
|
+
|
|
1626
|
+
A [`mount`](#service-volumes-persistent-volume-mount) block (within [`service.volumes.persistent_volume`](#service-volumes-persistent-volume)) supports the following:
|
|
1627
|
+
|
|
1628
|
+
<a id="mode-134e61"></a>• [`mode`](#mode-134e61) - Optional String Defaults to `VOLUME_MOUNT_READ_ONLY`<br>Possible values are `VOLUME_MOUNT_READ_ONLY`, `VOLUME_MOUNT_READ_WRITE`<br>[Enum: VOLUME_MOUNT_READ_ONLY|VOLUME_MOUNT_READ_WRITE] Mode in which the volume should be mounted to the workload - VOLUME_MOUNT_READ_ONLY: ReadOnly Mount the volume in read-only mode - VOLUME_MOUNT_READ_WRITE: Read Write Mount the volume in read-write mode
|
|
1629
|
+
|
|
1630
|
+
<a id="path-7af794"></a>• [`mount_path`](#path-7af794) - Optional String<br>Path within the workload container at which the volume should be mounted. Must not contain ':'
|
|
1631
|
+
|
|
1632
|
+
<a id="path-18ad39"></a>• [`sub_path`](#path-18ad39) - Optional String Defaults to `'' (volume's root)`<br>Path within the volume from which the workload's volume should be mounted
|
|
1633
|
+
|
|
1634
|
+
#### Service Volumes Persistent Volume Storage
|
|
1635
|
+
|
|
1636
|
+
A [`storage`](#storage-aa2194) block (within [`service.volumes.persistent_volume`](#service-volumes-persistent-volume)) supports the following:
|
|
1637
|
+
|
|
1638
|
+
<a id="mode-1d091d"></a>• [`access_mode`](#mode-1d091d) - Optional String Defaults to `ACCESS_MODE_READ_WRITE_ONCE`<br>Possible values are `ACCESS_MODE_READ_WRITE_ONCE`, `ACCESS_MODE_READ_WRITE_MANY`, `ACCESS_MODE_READ_ONLY_MANY`<br>[Enum: ACCESS_MODE_READ_WRITE_ONCE|ACCESS_MODE_READ_WRITE_MANY|ACCESS_MODE_READ_ONLY_MANY] Persistence storage access mode is used to configure access mode for persistent storage - ACCESS_MODE_READ_WRITE_ONCE: Read Write Once Read Write Once is used to mount persistent storage in read/write mode to exactly 1 host - ACCESS_MODE_READ_WRITE_MANY: Read Write Many Read Write Many is used
|
|
1639
|
+
|
|
1640
|
+
<a id="name-4c16c5"></a>• [`class_name`](#name-4c16c5) - Optional String<br>Use the specified class name
|
|
1641
|
+
|
|
1642
|
+
<a id="default-36c85c"></a>• [`default`](#default-36c85c) - Optional Block<br>Enable this option
|
|
1643
|
+
|
|
1644
|
+
<a id="size-fea8d4"></a>• [`storage_size`](#size-fea8d4) - Optional Number<br>Size in GiB of the persistent storage
|
|
1645
|
+
|
|
1646
|
+
#### Simple Service
|
|
1647
|
+
|
|
1648
|
+
A [`simple_service`](#simple-service) block supports the following:
|
|
1649
|
+
|
|
1650
|
+
<a id="simple-service-configuration"></a>• [`configuration`](#simple-service-configuration) - Optional Block<br>Configuration parameters of the workload<br>See [Configuration](#simple-service-configuration) below.
|
|
1651
|
+
|
|
1652
|
+
<a id="simple-service-container"></a>• [`container`](#simple-service-container) - Optional Block<br>ContainerType configures the container information<br>See [Container](#simple-service-container) below.
|
|
1653
|
+
|
|
1654
|
+
<a id="simple-service-disabled"></a>• [`disabled`](#simple-service-disabled) - Optional Block<br>Enable this option
|
|
1655
|
+
|
|
1656
|
+
<a id="simple-service-do-not-advertise"></a>• [`do_not_advertise`](#simple-service-do-not-advertise) - Optional Block<br>Enable this option
|
|
1657
|
+
|
|
1658
|
+
<a id="simple-service-enabled"></a>• [`enabled`](#simple-service-enabled) - Optional Block<br>Persistent storage volume configuration for the workload<br>See [Enabled](#simple-service-enabled) below.
|
|
1659
|
+
|
|
1660
|
+
<a id="simple-service-scale-to-zero"></a>• [`scale_to_zero`](#simple-service-scale-to-zero) - Optional Bool<br>Scale down replicas of the service to zero
|
|
1661
|
+
|
|
1662
|
+
<a id="simple-service-simple-advertise"></a>• [`simple_advertise`](#simple-service-simple-advertise) - Optional Block<br>Advertise OPTIONS For Simple Service. Advertise OPTIONS for Simple Service<br>See [Simple Advertise](#simple-service-simple-advertise) below.
|
|
1663
|
+
|
|
1664
|
+
#### Simple Service Configuration
|
|
1665
|
+
|
|
1666
|
+
A [`configuration`](#simple-service-configuration) block (within [`simple_service`](#simple-service)) supports the following:
|
|
1667
|
+
|
|
1668
|
+
<a id="simple-service-configuration-parameters"></a>• [`parameters`](#simple-service-configuration-parameters) - Optional Block<br>Parameters. Parameters for the workload<br>See [Parameters](#simple-service-configuration-parameters) below.
|
|
1669
|
+
|
|
1670
|
+
#### Simple Service Configuration Parameters
|
|
1671
|
+
|
|
1672
|
+
A [`parameters`](#simple-service-configuration-parameters) block (within [`simple_service.configuration`](#simple-service-configuration)) supports the following:
|
|
1673
|
+
|
|
1674
|
+
<a id="var-e566e9"></a>• [`env_var`](#var-e566e9) - Optional Block<br>Environment Variable. Environment Variable<br>See [Env Var](#var-e566e9) below.
|
|
1675
|
+
|
|
1676
|
+
<a id="file-b5c200"></a>• [`file`](#file-b5c200) - Optional Block<br>Configuration File. Configuration File for the workload<br>See [File](#file-b5c200) below.
|
|
1677
|
+
|
|
1678
|
+
#### Simple Service Configuration Parameters Env Var
|
|
1679
|
+
|
|
1680
|
+
An [`env_var`](#var-e566e9) block (within [`simple_service.configuration.parameters`](#simple-service-configuration-parameters)) supports the following:
|
|
1681
|
+
|
|
1682
|
+
<a id="name-e5e695"></a>• [`name`](#name-e5e695) - Optional String<br>Name. Name of Environment Variable
|
|
1683
|
+
|
|
1684
|
+
<a id="value-4694ef"></a>• [`value`](#value-4694ef) - Optional String<br>Value. Value of Environment Variable
|
|
1685
|
+
|
|
1686
|
+
#### Simple Service Configuration Parameters File
|
|
1687
|
+
|
|
1688
|
+
A [`file`](#file-b5c200) block (within [`simple_service.configuration.parameters`](#simple-service-configuration-parameters)) supports the following:
|
|
1689
|
+
|
|
1690
|
+
<a id="data-5368fd"></a>• [`data`](#data-5368fd) - Optional String<br>Data. File data
|
|
1691
|
+
|
|
1692
|
+
<a id="mount-decdef"></a>• [`mount`](#mount-decdef) - Optional Block<br>Volume mount describes how volume is mounted inside a workload<br>See [Mount](#mount-decdef) below.
|
|
1693
|
+
|
|
1694
|
+
<a id="name-251776"></a>• [`name`](#name-251776) - Optional String<br>Name. Name of the file
|
|
1695
|
+
|
|
1696
|
+
<a id="name-0d865e"></a>• [`volume_name`](#name-0d865e) - Optional String<br>Volume Name. Name of the Volume
|
|
1697
|
+
|
|
1698
|
+
#### Simple Service Configuration Parameters File Mount
|
|
1699
|
+
|
|
1700
|
+
A [`mount`](#mount-decdef) block (within [`simple_service.configuration.parameters.file`](#file-b5c200)) supports the following:
|
|
1701
|
+
|
|
1702
|
+
<a id="mode-c071a8"></a>• [`mode`](#mode-c071a8) - Optional String Defaults to `VOLUME_MOUNT_READ_ONLY`<br>Possible values are `VOLUME_MOUNT_READ_ONLY`, `VOLUME_MOUNT_READ_WRITE`<br>[Enum: VOLUME_MOUNT_READ_ONLY|VOLUME_MOUNT_READ_WRITE] Mode in which the volume should be mounted to the workload - VOLUME_MOUNT_READ_ONLY: ReadOnly Mount the volume in read-only mode - VOLUME_MOUNT_READ_WRITE: Read Write Mount the volume in read-write mode
|
|
1703
|
+
|
|
1704
|
+
<a id="path-8115be"></a>• [`mount_path`](#path-8115be) - Optional String<br>Path within the workload container at which the volume should be mounted. Must not contain ':'
|
|
1705
|
+
|
|
1706
|
+
<a id="path-b15eb2"></a>• [`sub_path`](#path-b15eb2) - Optional String Defaults to `'' (volume's root)`<br>Path within the volume from which the workload's volume should be mounted
|
|
1707
|
+
|
|
1708
|
+
#### Simple Service Container
|
|
1709
|
+
|
|
1710
|
+
A [`container`](#simple-service-container) block (within [`simple_service`](#simple-service)) supports the following:
|
|
1711
|
+
|
|
1712
|
+
<a id="simple-service-container-args"></a>• [`args`](#simple-service-container-args) - Optional List<br>Arguments to the entrypoint. Overrides the docker image's CMD
|
|
1713
|
+
|
|
1714
|
+
<a id="simple-service-container-command"></a>• [`command`](#simple-service-container-command) - Optional List<br>Command to execute. Overrides the docker image's ENTRYPOINT
|
|
1715
|
+
|
|
1716
|
+
<a id="simple-service-container-custom-flavor"></a>• [`custom_flavor`](#simple-service-container-custom-flavor) - Optional Block<br>Type establishes a direct reference from one object(the referrer) to another(the referred). Such a reference is in form of tenant/namespace/name<br>See [Custom Flavor](#simple-service-container-custom-flavor) below.
|
|
1717
|
+
|
|
1718
|
+
<a id="simple-service-container-default-flavor"></a>• [`default_flavor`](#simple-service-container-default-flavor) - Optional Block<br>Enable this option
|
|
1719
|
+
|
|
1720
|
+
<a id="simple-service-container-flavor"></a>• [`flavor`](#simple-service-container-flavor) - Optional String Defaults to `CONTAINER_FLAVOR_TYPE_TINY`<br>Possible values are `CONTAINER_FLAVOR_TYPE_TINY`, `CONTAINER_FLAVOR_TYPE_MEDIUM`, `CONTAINER_FLAVOR_TYPE_LARGE`<br>[Enum: CONTAINER_FLAVOR_TYPE_TINY|CONTAINER_FLAVOR_TYPE_MEDIUM|CONTAINER_FLAVOR_TYPE_LARGE] Container Flavor type - CONTAINER_FLAVOR_TYPE_TINY: Tiny Tiny containers have limit of 0.1 vCPU and 256 MiB (mebibyte) memory - CONTAINER_FLAVOR_TYPE_MEDIUM: Medium Medium containers have limit of 0.25 vCPU and 512 MiB (mebibyte) memory - CONTAINER_FLAVOR_TYPE_LARGE: Large Large containers have
|
|
1721
|
+
|
|
1722
|
+
<a id="simple-service-container-image"></a>• [`image`](#simple-service-container-image) - Optional Block<br>ImageType configures the image to use, how to pull the image, and the associated secrets to use if any<br>See [Image](#simple-service-container-image) below.
|
|
1723
|
+
|
|
1724
|
+
<a id="simple-service-container-init-container"></a>• [`init_container`](#simple-service-container-init-container) - Optional Bool<br>Specialized container that runs before application container and runs to completion
|
|
1725
|
+
|
|
1726
|
+
<a id="simple-service-container-liveness-check"></a>• [`liveness_check`](#simple-service-container-liveness-check) - Optional Block<br>HealthCheckType describes a health check to be performed against a container to determine whether it has started up or is alive or ready to receive traffic<br>See [Liveness Check](#simple-service-container-liveness-check) below.
|
|
1727
|
+
|
|
1728
|
+
<a id="simple-service-container-name"></a>• [`name`](#simple-service-container-name) - Optional String<br>Name. Name of the container
|
|
1729
|
+
|
|
1730
|
+
<a id="check-9028f0"></a>• [`readiness_check`](#check-9028f0) - Optional Block<br>HealthCheckType describes a health check to be performed against a container to determine whether it has started up or is alive or ready to receive traffic<br>See [Readiness Check](#check-9028f0) below.
|
|
1731
|
+
|
|
1732
|
+
#### Simple Service Container Custom Flavor
|
|
1733
|
+
|
|
1734
|
+
A [`custom_flavor`](#simple-service-container-custom-flavor) block (within [`simple_service.container`](#simple-service-container)) supports the following:
|
|
1735
|
+
|
|
1736
|
+
<a id="name-256e2d"></a>• [`name`](#name-256e2d) - Optional String<br>When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object's(e.g. Route's) name
|
|
1737
|
+
|
|
1738
|
+
<a id="namespace-3dbb57"></a>• [`namespace`](#namespace-3dbb57) - Optional String<br>When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object's(e.g. Route's) namespace
|
|
1739
|
+
|
|
1740
|
+
<a id="tenant-bf6176"></a>• [`tenant`](#tenant-bf6176) - Optional String<br>When a configuration object(e.g. Virtual_host) refers to another(e.g route) then tenant will hold the referred object's(e.g. Route's) tenant
|
|
1741
|
+
|
|
1742
|
+
#### Simple Service Container Image
|
|
1743
|
+
|
|
1744
|
+
An [`image`](#simple-service-container-image) block (within [`simple_service.container`](#simple-service-container)) supports the following:
|
|
1745
|
+
|
|
1746
|
+
<a id="registry-f7f6d1"></a>• [`container_registry`](#registry-f7f6d1) - Optional Block<br>Type establishes a direct reference from one object(the referrer) to another(the referred). Such a reference is in form of tenant/namespace/name<br>See [Container Registry](#registry-f7f6d1) below.
|
|
1747
|
+
|
|
1748
|
+
<a id="simple-service-container-image-name"></a>• [`name`](#simple-service-container-image-name) - Optional String<br>Name is a container image which are usually given a name such as alpine, ubuntu, or quay.I/O/etcd:0.13. The format is registry/image:tag or registry/image@image-digest. If registry is not specified, the Docker public registry is assumed
|
|
1749
|
+
|
|
1750
|
+
<a id="simple-service-container-image-public"></a>• [`public`](#simple-service-container-image-public) - Optional Block<br>Enable this option
|
|
1751
|
+
|
|
1752
|
+
<a id="policy-b2dd3c"></a>• [`pull_policy`](#policy-b2dd3c) - Optional String Defaults to `IMAGE_PULL_POLICY_DEFAULT`<br>Possible values are `IMAGE_PULL_POLICY_DEFAULT`, `IMAGE_PULL_POLICY_IF_NOT_PRESENT`, `IMAGE_PULL_POLICY_ALWAYS`, `IMAGE_PULL_POLICY_NEVER`<br>[Enum: IMAGE_PULL_POLICY_DEFAULT|IMAGE_PULL_POLICY_IF_NOT_PRESENT|IMAGE_PULL_POLICY_ALWAYS|IMAGE_PULL_POLICY_NEVER] Image pull policy type enumerates the policy choices to use for pulling the image prior to starting the workload - IMAGE_PULL_POLICY_DEFAULT: Default Default will always pull image if :latest tag is specified in image name. If :latest tag is not specified in image name, it will pull image only
|
|
1753
|
+
|
|
1754
|
+
#### Simple Service Container Image Container Registry
|
|
1755
|
+
|
|
1756
|
+
A [`container_registry`](#registry-f7f6d1) block (within [`simple_service.container.image`](#simple-service-container-image)) supports the following:
|
|
1757
|
+
|
|
1758
|
+
<a id="name-d862eb"></a>• [`name`](#name-d862eb) - Optional String<br>When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object's(e.g. Route's) name
|
|
1759
|
+
|
|
1760
|
+
<a id="namespace-3251f2"></a>• [`namespace`](#namespace-3251f2) - Optional String<br>When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object's(e.g. Route's) namespace
|
|
1761
|
+
|
|
1762
|
+
<a id="tenant-86a541"></a>• [`tenant`](#tenant-86a541) - Optional String<br>When a configuration object(e.g. Virtual_host) refers to another(e.g route) then tenant will hold the referred object's(e.g. Route's) tenant
|
|
1763
|
+
|
|
1764
|
+
#### Simple Service Container Liveness Check
|
|
1765
|
+
|
|
1766
|
+
A [`liveness_check`](#simple-service-container-liveness-check) block (within [`simple_service.container`](#simple-service-container)) supports the following:
|
|
1767
|
+
|
|
1768
|
+
<a id="check-16db8f"></a>• [`exec_health_check`](#check-16db8f) - Optional Block<br>ExecHealthCheckType describes a health check based on 'run in container' action. Exit status of 0 is treated as live/healthy and non-zero is unhealthy<br>See [Exec Health Check](#check-16db8f) below.
|
|
1769
|
+
|
|
1770
|
+
<a id="threshold-b6ea90"></a>• [`healthy_threshold`](#threshold-b6ea90) - Optional Number<br>Number of consecutive successful responses after having failed before declaring healthy. In other words, this is the number of healthy health checks required before marking healthy. Note that during startup and liveliness, only a single successful health check is required to mark a container
|
|
1771
|
+
|
|
1772
|
+
<a id="check-25986b"></a>• [`http_health_check`](#check-25986b) - Optional Block<br>HTTPHealthCheckType describes a health check based on HTTP GET requests<br>See [HTTP Health Check](#check-25986b) below.
|
|
1773
|
+
|
|
1774
|
+
<a id="delay-758ad8"></a>• [`initial_delay`](#delay-758ad8) - Optional Number<br>Number of seconds after the container has started before health checks are initiated
|
|
1775
|
+
|
|
1776
|
+
<a id="interval-a75912"></a>• [`interval`](#interval-a75912) - Optional Number<br>Time interval in seconds between two health check requests
|
|
1777
|
+
|
|
1778
|
+
<a id="check-f33b9a"></a>• [`tcp_health_check`](#check-f33b9a) - Optional Block<br>TCPHealthCheckType describes a health check based on opening a TCP connection<br>See [TCP Health Check](#check-f33b9a) below.
|
|
1779
|
+
|
|
1780
|
+
<a id="timeout-cca4da"></a>• [`timeout`](#timeout-cca4da) - Optional Number<br>Timeout in seconds to wait for successful response. In other words, it is the time to wait for a health check response. If the timeout is reached the health check attempt will be considered a failure
|
|
1781
|
+
|
|
1782
|
+
<a id="threshold-d8ab4a"></a>• [`unhealthy_threshold`](#threshold-d8ab4a) - Optional Number<br>Number of consecutive failed responses before declaring unhealthy. In other words, this is the number of unhealthy health checks required before a container is marked unhealthy
|
|
1783
|
+
|
|
1784
|
+
#### Simple Service Container Liveness Check Exec Health Check
|
|
1785
|
+
|
|
1786
|
+
<a id="deep-718ea8"></a>Deeply nested **Check** block collapsed for readability.
|
|
1787
|
+
|
|
1788
|
+
#### Simple Service Container Liveness Check HTTP Health Check
|
|
1789
|
+
|
|
1790
|
+
<a id="deep-dbda88"></a>Deeply nested **Check** block collapsed for readability.
|
|
1791
|
+
|
|
1792
|
+
#### Simple Service Container Liveness Check HTTP Health Check Port
|
|
1793
|
+
|
|
1794
|
+
<a id="deep-172371"></a>Deeply nested **Port** block collapsed for readability.
|
|
1795
|
+
|
|
1796
|
+
#### Simple Service Container Liveness Check TCP Health Check
|
|
1797
|
+
|
|
1798
|
+
<a id="deep-cd2848"></a>Deeply nested **Check** block collapsed for readability.
|
|
1799
|
+
|
|
1800
|
+
#### Simple Service Container Liveness Check TCP Health Check Port
|
|
1801
|
+
|
|
1802
|
+
<a id="deep-40c0b7"></a>Deeply nested **Port** block collapsed for readability.
|
|
1803
|
+
|
|
1804
|
+
#### Simple Service Container Readiness Check
|
|
1805
|
+
|
|
1806
|
+
A [`readiness_check`](#check-9028f0) block (within [`simple_service.container`](#simple-service-container)) supports the following:
|
|
1807
|
+
|
|
1808
|
+
<a id="check-083116"></a>• [`exec_health_check`](#check-083116) - Optional Block<br>ExecHealthCheckType describes a health check based on 'run in container' action. Exit status of 0 is treated as live/healthy and non-zero is unhealthy<br>See [Exec Health Check](#check-083116) below.
|
|
1809
|
+
|
|
1810
|
+
<a id="threshold-b19598"></a>• [`healthy_threshold`](#threshold-b19598) - Optional Number<br>Number of consecutive successful responses after having failed before declaring healthy. In other words, this is the number of healthy health checks required before marking healthy. Note that during startup and liveliness, only a single successful health check is required to mark a container
|
|
1811
|
+
|
|
1812
|
+
<a id="check-71ae5b"></a>• [`http_health_check`](#check-71ae5b) - Optional Block<br>HTTPHealthCheckType describes a health check based on HTTP GET requests<br>See [HTTP Health Check](#check-71ae5b) below.
|
|
1813
|
+
|
|
1814
|
+
<a id="delay-f56b24"></a>• [`initial_delay`](#delay-f56b24) - Optional Number<br>Number of seconds after the container has started before health checks are initiated
|
|
1815
|
+
|
|
1816
|
+
<a id="interval-0aaa38"></a>• [`interval`](#interval-0aaa38) - Optional Number<br>Time interval in seconds between two health check requests
|
|
1817
|
+
|
|
1818
|
+
<a id="check-074b55"></a>• [`tcp_health_check`](#check-074b55) - Optional Block<br>TCPHealthCheckType describes a health check based on opening a TCP connection<br>See [TCP Health Check](#check-074b55) below.
|
|
1819
|
+
|
|
1820
|
+
<a id="timeout-354826"></a>• [`timeout`](#timeout-354826) - Optional Number<br>Timeout in seconds to wait for successful response. In other words, it is the time to wait for a health check response. If the timeout is reached the health check attempt will be considered a failure
|
|
1821
|
+
|
|
1822
|
+
<a id="threshold-b99edb"></a>• [`unhealthy_threshold`](#threshold-b99edb) - Optional Number<br>Number of consecutive failed responses before declaring unhealthy. In other words, this is the number of unhealthy health checks required before a container is marked unhealthy
|
|
1823
|
+
|
|
1824
|
+
#### Simple Service Container Readiness Check Exec Health Check
|
|
1825
|
+
|
|
1826
|
+
<a id="deep-43a0b9"></a>Deeply nested **Check** block collapsed for readability.
|
|
1827
|
+
|
|
1828
|
+
#### Simple Service Container Readiness Check HTTP Health Check
|
|
1829
|
+
|
|
1830
|
+
<a id="deep-6e41fe"></a>Deeply nested **Check** block collapsed for readability.
|
|
1831
|
+
|
|
1832
|
+
#### Simple Service Container Readiness Check HTTP Health Check Port
|
|
1833
|
+
|
|
1834
|
+
<a id="deep-a15304"></a>Deeply nested **Port** block collapsed for readability.
|
|
1835
|
+
|
|
1836
|
+
#### Simple Service Container Readiness Check TCP Health Check
|
|
1837
|
+
|
|
1838
|
+
<a id="deep-ff1fc9"></a>Deeply nested **Check** block collapsed for readability.
|
|
1839
|
+
|
|
1840
|
+
#### Simple Service Container Readiness Check TCP Health Check Port
|
|
1841
|
+
|
|
1842
|
+
<a id="deep-253286"></a>Deeply nested **Port** block collapsed for readability.
|
|
1843
|
+
|
|
1844
|
+
#### Simple Service Enabled
|
|
1845
|
+
|
|
1846
|
+
An [`enabled`](#simple-service-enabled) block (within [`simple_service`](#simple-service)) supports the following:
|
|
1847
|
+
|
|
1848
|
+
<a id="simple-service-enabled-name"></a>• [`name`](#simple-service-enabled-name) - Optional String<br>Name. Name of the volume
|
|
1849
|
+
|
|
1850
|
+
<a id="volume-64b8ac"></a>• [`persistent_volume`](#volume-64b8ac) - Optional Block<br>Volume containing the Persistent Storage for the workload<br>See [Persistent Volume](#volume-64b8ac) below.
|
|
1851
|
+
|
|
1852
|
+
#### Simple Service Enabled Persistent Volume
|
|
1853
|
+
|
|
1854
|
+
A [`persistent_volume`](#volume-64b8ac) block (within [`simple_service.enabled`](#simple-service-enabled)) supports the following:
|
|
1855
|
+
|
|
1856
|
+
<a id="mount-80f853"></a>• [`mount`](#mount-80f853) - Optional Block<br>Volume mount describes how volume is mounted inside a workload<br>See [Mount](#mount-80f853) below.
|
|
1857
|
+
|
|
1858
|
+
<a id="storage-8c6930"></a>• [`storage`](#storage-8c6930) - Optional Block<br>Persistent storage configuration is used to configure Persistent Volume Claim (PVC)<br>See [Storage](#storage-8c6930) below.
|
|
1859
|
+
|
|
1860
|
+
#### Simple Service Enabled Persistent Volume Mount
|
|
1861
|
+
|
|
1862
|
+
A [`mount`](#mount-80f853) block (within [`simple_service.enabled.persistent_volume`](#volume-64b8ac)) supports the following:
|
|
1863
|
+
|
|
1864
|
+
<a id="mode-c91e4c"></a>• [`mode`](#mode-c91e4c) - Optional String Defaults to `VOLUME_MOUNT_READ_ONLY`<br>Possible values are `VOLUME_MOUNT_READ_ONLY`, `VOLUME_MOUNT_READ_WRITE`<br>[Enum: VOLUME_MOUNT_READ_ONLY|VOLUME_MOUNT_READ_WRITE] Mode in which the volume should be mounted to the workload - VOLUME_MOUNT_READ_ONLY: ReadOnly Mount the volume in read-only mode - VOLUME_MOUNT_READ_WRITE: Read Write Mount the volume in read-write mode
|
|
1865
|
+
|
|
1866
|
+
<a id="path-7949ef"></a>• [`mount_path`](#path-7949ef) - Optional String<br>Path within the workload container at which the volume should be mounted. Must not contain ':'
|
|
1867
|
+
|
|
1868
|
+
<a id="path-7a72f2"></a>• [`sub_path`](#path-7a72f2) - Optional String Defaults to `'' (volume's root)`<br>Path within the volume from which the workload's volume should be mounted
|
|
1869
|
+
|
|
1870
|
+
#### Simple Service Enabled Persistent Volume Storage
|
|
1871
|
+
|
|
1872
|
+
A [`storage`](#storage-8c6930) block (within [`simple_service.enabled.persistent_volume`](#volume-64b8ac)) supports the following:
|
|
1873
|
+
|
|
1874
|
+
<a id="mode-acb744"></a>• [`access_mode`](#mode-acb744) - Optional String Defaults to `ACCESS_MODE_READ_WRITE_ONCE`<br>Possible values are `ACCESS_MODE_READ_WRITE_ONCE`, `ACCESS_MODE_READ_WRITE_MANY`, `ACCESS_MODE_READ_ONLY_MANY`<br>[Enum: ACCESS_MODE_READ_WRITE_ONCE|ACCESS_MODE_READ_WRITE_MANY|ACCESS_MODE_READ_ONLY_MANY] Persistence storage access mode is used to configure access mode for persistent storage - ACCESS_MODE_READ_WRITE_ONCE: Read Write Once Read Write Once is used to mount persistent storage in read/write mode to exactly 1 host - ACCESS_MODE_READ_WRITE_MANY: Read Write Many Read Write Many is used
|
|
1875
|
+
|
|
1876
|
+
<a id="name-b14a4c"></a>• [`class_name`](#name-b14a4c) - Optional String<br>Use the specified class name
|
|
1877
|
+
|
|
1878
|
+
<a id="default-f48482"></a>• [`default`](#default-f48482) - Optional Block<br>Enable this option
|
|
1879
|
+
|
|
1880
|
+
<a id="size-17db0b"></a>• [`storage_size`](#size-17db0b) - Optional Number<br>Size in GiB of the persistent storage
|
|
1881
|
+
|
|
1882
|
+
#### Simple Service Simple Advertise
|
|
1883
|
+
|
|
1884
|
+
A [`simple_advertise`](#simple-service-simple-advertise) block (within [`simple_service`](#simple-service)) supports the following:
|
|
1885
|
+
|
|
1886
|
+
<a id="simple-service-simple-advertise-domains"></a>• [`domains`](#simple-service-simple-advertise-domains) - Optional List<br>List of Domains (host/authority header) that will be matched to Load Balancer. Wildcard hosts are supported in the suffix or prefix form Supported Domains and search order: 1. Exact Domain names: `www.example.com.` 2
|
|
1887
|
+
|
|
1888
|
+
<a id="port-b7cc36"></a>• [`service_port`](#port-b7cc36) - Optional Number<br>Service port to advertise on Internet via HTTP loadbalancer using port 80
|
|
1889
|
+
|
|
1890
|
+
#### Stateful Service
|
|
1891
|
+
|
|
1892
|
+
A [`stateful_service`](#stateful-service) block supports the following:
|
|
1893
|
+
|
|
1894
|
+
<a id="stateful-service-advertise-options"></a>• [`advertise_options`](#stateful-service-advertise-options) - Optional Block<br>Advertise OPTIONS are used to configure how and where to advertise the workload using load balancers<br>See [Advertise Options](#stateful-service-advertise-options) below.
|
|
1895
|
+
|
|
1896
|
+
<a id="stateful-service-configuration"></a>• [`configuration`](#stateful-service-configuration) - Optional Block<br>Configuration parameters of the workload<br>See [Configuration](#stateful-service-configuration) below.
|
|
1897
|
+
|
|
1898
|
+
<a id="stateful-service-containers"></a>• [`containers`](#stateful-service-containers) - Optional Block<br>Containers to use for service<br>See [Containers](#stateful-service-containers) below.
|
|
1899
|
+
|
|
1900
|
+
<a id="stateful-service-deploy-options"></a>• [`deploy_options`](#stateful-service-deploy-options) - Optional Block<br>Deploy OPTIONS are used to configure the workload deployment OPTIONS<br>See [Deploy Options](#stateful-service-deploy-options) below.
|
|
1901
|
+
|
|
1902
|
+
<a id="stateful-service-num-replicas"></a>• [`num_replicas`](#stateful-service-num-replicas) - Optional Number<br>Number of replicas of service to spawn per site
|
|
1903
|
+
|
|
1904
|
+
<a id="stateful-service-persistent-volumes"></a>• [`persistent_volumes`](#stateful-service-persistent-volumes) - Optional Block<br>Persistent storage configuration for the service<br>See [Persistent Volumes](#stateful-service-persistent-volumes) below.
|
|
1905
|
+
|
|
1906
|
+
<a id="stateful-service-scale-to-zero"></a>• [`scale_to_zero`](#stateful-service-scale-to-zero) - Optional Block<br>Enable this option
|
|
1907
|
+
|
|
1908
|
+
<a id="stateful-service-volumes"></a>• [`volumes`](#stateful-service-volumes) - Optional Block<br>Ephemeral Volumes. Ephemeral volumes for the service<br>See [Volumes](#stateful-service-volumes) below.
|
|
1909
|
+
|
|
1910
|
+
#### Stateful Service Advertise Options
|
|
1911
|
+
|
|
1912
|
+
An [`advertise_options`](#stateful-service-advertise-options) block (within [`stateful_service`](#stateful-service)) supports the following:
|
|
1913
|
+
|
|
1914
|
+
<a id="custom-2e9653"></a>• [`advertise_custom`](#custom-2e9653) - Optional Block<br>Advertise this workload via loadbalancer on specific sites<br>See [Advertise Custom](#custom-2e9653) below.
|
|
1915
|
+
|
|
1916
|
+
<a id="cluster-e091a1"></a>• [`advertise_in_cluster`](#cluster-e091a1) - Optional Block<br>Advertise the workload locally in-cluster<br>See [Advertise In Cluster](#cluster-e091a1) below.
|
|
1917
|
+
|
|
1918
|
+
<a id="public-86b094"></a>• [`advertise_on_public`](#public-86b094) - Optional Block<br>Advertise this workload via loadbalancer on Internet with default VIP<br>See [Advertise On Public](#public-86b094) below.
|
|
1919
|
+
|
|
1920
|
+
<a id="advertise-a4c726"></a>• [`do_not_advertise`](#advertise-a4c726) - Optional Block<br>Enable this option
|
|
1921
|
+
|
|
1922
|
+
#### Stateful Service Advertise Options Advertise Custom
|
|
1923
|
+
|
|
1924
|
+
An [`advertise_custom`](#custom-2e9653) block (within [`stateful_service.advertise_options`](#stateful-service-advertise-options)) supports the following:
|
|
1925
|
+
|
|
1926
|
+
<a id="where-ecb677"></a>• [`advertise_where`](#where-ecb677) - Optional Block<br>Where should this load balancer be available<br>See [Advertise Where](#where-ecb677) below.
|
|
1927
|
+
|
|
1928
|
+
<a id="ports-17a1c0"></a>• [`ports`](#ports-17a1c0) - Optional Block<br>Ports. Ports to advertise<br>See [Ports](#ports-17a1c0) below.
|
|
1929
|
+
|
|
1930
|
+
#### Stateful Service Advertise Options Advertise Custom Advertise Where
|
|
1931
|
+
|
|
1932
|
+
<a id="deep-1b9a8d"></a>Deeply nested **Where** block collapsed for readability.
|
|
1933
|
+
|
|
1934
|
+
#### Stateful Service Advertise Options Advertise Custom Advertise Where Site
|
|
1935
|
+
|
|
1936
|
+
<a id="deep-9ff9ec"></a>Deeply nested **Site** block collapsed for readability.
|
|
1937
|
+
|
|
1938
|
+
#### Stateful Service Advertise Options Advertise Custom Advertise Where Site Site
|
|
1939
|
+
|
|
1940
|
+
<a id="deep-329be6"></a>Deeply nested **Site** block collapsed for readability.
|
|
1941
|
+
|
|
1942
|
+
#### Stateful Service Advertise Options Advertise Custom Advertise Where Virtual Site
|
|
1943
|
+
|
|
1944
|
+
<a id="deep-15a54c"></a>Deeply nested **Site** block collapsed for readability.
|
|
1945
|
+
|
|
1946
|
+
#### Stateful Service Advertise Options Advertise Custom Advertise Where Virtual Site Virtual Site
|
|
1947
|
+
|
|
1948
|
+
<a id="deep-3af2c4"></a>Deeply nested **Site** block collapsed for readability.
|
|
1949
|
+
|
|
1950
|
+
#### Stateful Service Advertise Options Advertise Custom Advertise Where Vk8s Service
|
|
1951
|
+
|
|
1952
|
+
<a id="deep-78688d"></a>Deeply nested **Service** block collapsed for readability.
|
|
1953
|
+
|
|
1954
|
+
#### Stateful Service Advertise Options Advertise Custom Advertise Where Vk8s Service Site
|
|
1955
|
+
|
|
1956
|
+
<a id="deep-911694"></a>Deeply nested **Site** block collapsed for readability.
|
|
1957
|
+
|
|
1958
|
+
#### Stateful Service Advertise Options Advertise Custom Advertise Where Vk8s Service Virtual Site
|
|
1959
|
+
|
|
1960
|
+
<a id="deep-ec2a75"></a>Deeply nested **Site** block collapsed for readability.
|
|
1961
|
+
|
|
1962
|
+
#### Stateful Service Advertise Options Advertise Custom Ports
|
|
1963
|
+
|
|
1964
|
+
A [`ports`](#ports-17a1c0) block (within [`stateful_service.advertise_options.advertise_custom`](#custom-2e9653)) supports the following:
|
|
1965
|
+
|
|
1966
|
+
<a id="loadbalancer-6acd33"></a>• [`http_loadbalancer`](#loadbalancer-6acd33) - Optional Block<br>HTTP/HTTPS Load Balancer. HTTP/HTTPS Load balancer<br>See [HTTP Loadbalancer](#loadbalancer-6acd33) below.
|
|
1967
|
+
|
|
1968
|
+
<a id="port-018c8a"></a>• [`port`](#port-018c8a) - Optional Block<br>Port. Port of the workload<br>See [Port](#port-018c8a) below.
|
|
1969
|
+
|
|
1970
|
+
<a id="loadbalancer-6147bf"></a>• [`tcp_loadbalancer`](#loadbalancer-6147bf) - Optional Block<br>TCP Load Balancer. TCP loadbalancer<br>See [TCP Loadbalancer](#loadbalancer-6147bf) below.
|
|
1971
|
+
|
|
1972
|
+
#### Stateful Service Advertise Options Advertise Custom Ports HTTP Loadbalancer
|
|
1973
|
+
|
|
1974
|
+
<a id="deep-deba7b"></a>Deeply nested **Loadbalancer** block collapsed for readability.
|
|
1975
|
+
|
|
1976
|
+
#### Stateful Service Advertise Options Advertise Custom Ports HTTP Loadbalancer Default Route
|
|
1977
|
+
|
|
1978
|
+
<a id="deep-c23a03"></a>Deeply nested **Route** block collapsed for readability.
|
|
1979
|
+
|
|
1980
|
+
#### Stateful Service Advertise Options Advertise Custom Ports HTTP Loadbalancer HTTP
|
|
1981
|
+
|
|
1982
|
+
<a id="deep-c5f207"></a>Deeply nested **HTTP** block collapsed for readability.
|
|
1983
|
+
|
|
1984
|
+
#### Stateful Service Advertise Options Advertise Custom Ports HTTP Loadbalancer HTTPS
|
|
1985
|
+
|
|
1986
|
+
<a id="deep-54c2b3"></a>Deeply nested **HTTPS** block collapsed for readability.
|
|
1987
|
+
|
|
1988
|
+
#### Stateful Service Advertise Options Advertise Custom Ports HTTP Loadbalancer HTTPS Coalescing Options
|
|
1989
|
+
|
|
1990
|
+
<a id="deep-b206e8"></a>Deeply nested **Options** block collapsed for readability.
|
|
1991
|
+
|
|
1992
|
+
#### Stateful Service Advertise Options Advertise Custom Ports HTTP Loadbalancer HTTPS HTTP Protocol Options
|
|
1993
|
+
|
|
1994
|
+
<a id="deep-386653"></a>Deeply nested **Options** block collapsed for readability.
|
|
1995
|
+
|
|
1996
|
+
#### Stateful Service Advertise Options Advertise Custom Ports HTTP Loadbalancer HTTPS HTTP Protocol Options HTTP Protocol Enable V1 Only
|
|
1997
|
+
|
|
1998
|
+
<a id="deep-9c8446"></a>Deeply nested **Only** block collapsed for readability.
|
|
1999
|
+
|
|
2000
|
+
#### Stateful Service Advertise Options Advertise Custom Ports HTTP Loadbalancer HTTPS HTTP Protocol Options HTTP Protocol Enable V1 Only Header Transformation
|
|
2001
|
+
|
|
2002
|
+
<a id="deep-71e625"></a>Deeply nested **Transformation** block collapsed for readability.
|
|
2003
|
+
|
|
2004
|
+
#### Stateful Service Advertise Options Advertise Custom Ports HTTP Loadbalancer HTTPS TLS Cert Params
|
|
2005
|
+
|
|
2006
|
+
<a id="deep-cf6057"></a>Deeply nested **Params** block collapsed for readability.
|
|
2007
|
+
|
|
2008
|
+
#### Stateful Service Advertise Options Advertise Custom Ports HTTP Loadbalancer HTTPS TLS Cert Params Certificates
|
|
2009
|
+
|
|
2010
|
+
<a id="deep-025b6a"></a>Deeply nested **Certificates** block collapsed for readability.
|
|
2011
|
+
|
|
2012
|
+
#### Stateful Service Advertise Options Advertise Custom Ports HTTP Loadbalancer HTTPS TLS Cert Params TLS Config
|
|
2013
|
+
|
|
2014
|
+
<a id="deep-12bb98"></a>Deeply nested **Config** block collapsed for readability.
|
|
2015
|
+
|
|
2016
|
+
#### Stateful Service Advertise Options Advertise Custom Ports HTTP Loadbalancer HTTPS TLS Cert Params TLS Config Custom Security
|
|
2017
|
+
|
|
2018
|
+
<a id="deep-51e56c"></a>Deeply nested **Security** block collapsed for readability.
|
|
2019
|
+
|
|
2020
|
+
#### Stateful Service Advertise Options Advertise Custom Ports HTTP Loadbalancer HTTPS TLS Cert Params Use mTLS
|
|
2021
|
+
|
|
2022
|
+
<a id="deep-16fb45"></a>Deeply nested **mTLS** block collapsed for readability.
|
|
2023
|
+
|
|
2024
|
+
#### Stateful Service Advertise Options Advertise Custom Ports HTTP Loadbalancer HTTPS TLS Cert Params Use mTLS CRL
|
|
2025
|
+
|
|
2026
|
+
<a id="deep-21c207"></a>Deeply nested **CRL** block collapsed for readability.
|
|
2027
|
+
|
|
2028
|
+
#### Stateful Service Advertise Options Advertise Custom Ports HTTP Loadbalancer HTTPS TLS Cert Params Use mTLS Trusted CA
|
|
2029
|
+
|
|
2030
|
+
<a id="deep-260b64"></a>Deeply nested **CA** block collapsed for readability.
|
|
2031
|
+
|
|
2032
|
+
#### Stateful Service Advertise Options Advertise Custom Ports HTTP Loadbalancer HTTPS TLS Cert Params Use mTLS Xfcc Options
|
|
2033
|
+
|
|
2034
|
+
<a id="deep-ae9db4"></a>Deeply nested **Options** block collapsed for readability.
|
|
2035
|
+
|
|
2036
|
+
#### Stateful Service Advertise Options Advertise Custom Ports HTTP Loadbalancer HTTPS TLS Parameters
|
|
2037
|
+
|
|
2038
|
+
<a id="deep-1b3cda"></a>Deeply nested **Parameters** block collapsed for readability.
|
|
2039
|
+
|
|
2040
|
+
#### Stateful Service Advertise Options Advertise Custom Ports HTTP Loadbalancer HTTPS TLS Parameters TLS Certificates
|
|
2041
|
+
|
|
2042
|
+
<a id="deep-286dbf"></a>Deeply nested **Certificates** block collapsed for readability.
|
|
2043
|
+
|
|
2044
|
+
#### Stateful Service Advertise Options Advertise Custom Ports HTTP Loadbalancer HTTPS TLS Parameters TLS Certificates Custom Hash Algorithms
|
|
2045
|
+
|
|
2046
|
+
<a id="deep-669e16"></a>Deeply nested **Algorithms** block collapsed for readability.
|
|
2047
|
+
|
|
2048
|
+
#### Stateful Service Advertise Options Advertise Custom Ports HTTP Loadbalancer HTTPS TLS Parameters TLS Certificates Private Key
|
|
2049
|
+
|
|
2050
|
+
<a id="deep-0cd780"></a>Deeply nested **Key** block collapsed for readability.
|
|
2051
|
+
|
|
2052
|
+
#### Stateful Service Advertise Options Advertise Custom Ports HTTP Loadbalancer HTTPS TLS Parameters TLS Certificates Private Key Blindfold Secret Info
|
|
2053
|
+
|
|
2054
|
+
<a id="deep-9a3590"></a>Deeply nested **Info** block collapsed for readability.
|
|
2055
|
+
|
|
2056
|
+
#### Stateful Service Advertise Options Advertise Custom Ports HTTP Loadbalancer HTTPS TLS Parameters TLS Certificates Private Key Clear Secret Info
|
|
2057
|
+
|
|
2058
|
+
<a id="deep-c93871"></a>Deeply nested **Info** block collapsed for readability.
|
|
2059
|
+
|
|
2060
|
+
#### Stateful Service Advertise Options Advertise Custom Ports HTTP Loadbalancer HTTPS TLS Parameters TLS Config
|
|
2061
|
+
|
|
2062
|
+
<a id="deep-b5ca7c"></a>Deeply nested **Config** block collapsed for readability.
|
|
2063
|
+
|
|
2064
|
+
#### Stateful Service Advertise Options Advertise Custom Ports HTTP Loadbalancer HTTPS TLS Parameters TLS Config Custom Security
|
|
2065
|
+
|
|
2066
|
+
<a id="deep-ac03b7"></a>Deeply nested **Security** block collapsed for readability.
|
|
2067
|
+
|
|
2068
|
+
#### Stateful Service Advertise Options Advertise Custom Ports HTTP Loadbalancer HTTPS TLS Parameters Use mTLS
|
|
2069
|
+
|
|
2070
|
+
<a id="deep-4662e7"></a>Deeply nested **mTLS** block collapsed for readability.
|
|
2071
|
+
|
|
2072
|
+
#### Stateful Service Advertise Options Advertise Custom Ports HTTP Loadbalancer HTTPS TLS Parameters Use mTLS CRL
|
|
2073
|
+
|
|
2074
|
+
<a id="deep-2fe5d1"></a>Deeply nested **CRL** block collapsed for readability.
|
|
2075
|
+
|
|
2076
|
+
#### Stateful Service Advertise Options Advertise Custom Ports HTTP Loadbalancer HTTPS TLS Parameters Use mTLS Trusted CA
|
|
2077
|
+
|
|
2078
|
+
<a id="deep-d70642"></a>Deeply nested **CA** block collapsed for readability.
|
|
2079
|
+
|
|
2080
|
+
#### Stateful Service Advertise Options Advertise Custom Ports HTTP Loadbalancer HTTPS TLS Parameters Use mTLS Xfcc Options
|
|
2081
|
+
|
|
2082
|
+
<a id="deep-ec5644"></a>Deeply nested **Options** block collapsed for readability.
|
|
2083
|
+
|
|
2084
|
+
#### Stateful Service Advertise Options Advertise Custom Ports HTTP Loadbalancer HTTPS Auto Cert
|
|
2085
|
+
|
|
2086
|
+
<a id="deep-1c1e39"></a>Deeply nested **Cert** block collapsed for readability.
|
|
2087
|
+
|
|
2088
|
+
#### Stateful Service Advertise Options Advertise Custom Ports HTTP Loadbalancer HTTPS Auto Cert Coalescing Options
|
|
2089
|
+
|
|
2090
|
+
<a id="deep-f4d48f"></a>Deeply nested **Options** block collapsed for readability.
|
|
2091
|
+
|
|
2092
|
+
#### Stateful Service Advertise Options Advertise Custom Ports HTTP Loadbalancer HTTPS Auto Cert HTTP Protocol Options
|
|
2093
|
+
|
|
2094
|
+
<a id="deep-b88856"></a>Deeply nested **Options** block collapsed for readability.
|
|
2095
|
+
|
|
2096
|
+
#### Stateful Service Advertise Options Advertise Custom Ports HTTP Loadbalancer HTTPS Auto Cert HTTP Protocol Options HTTP Protocol Enable V1 Only
|
|
2097
|
+
|
|
2098
|
+
<a id="deep-06612a"></a>Deeply nested **Only** block collapsed for readability.
|
|
2099
|
+
|
|
2100
|
+
#### Stateful Service Advertise Options Advertise Custom Ports HTTP Loadbalancer HTTPS Auto Cert HTTP Protocol Options HTTP Protocol Enable V1 Only Header Transformation
|
|
2101
|
+
|
|
2102
|
+
<a id="deep-53e3b9"></a>Deeply nested **Transformation** block collapsed for readability.
|
|
2103
|
+
|
|
2104
|
+
#### Stateful Service Advertise Options Advertise Custom Ports HTTP Loadbalancer HTTPS Auto Cert TLS Config
|
|
2105
|
+
|
|
2106
|
+
<a id="deep-8738dd"></a>Deeply nested **Config** block collapsed for readability.
|
|
2107
|
+
|
|
2108
|
+
#### Stateful Service Advertise Options Advertise Custom Ports HTTP Loadbalancer HTTPS Auto Cert TLS Config Custom Security
|
|
2109
|
+
|
|
2110
|
+
<a id="deep-5b07d2"></a>Deeply nested **Security** block collapsed for readability.
|
|
2111
|
+
|
|
2112
|
+
#### Stateful Service Advertise Options Advertise Custom Ports HTTP Loadbalancer HTTPS Auto Cert Use mTLS
|
|
2113
|
+
|
|
2114
|
+
<a id="deep-dfaa70"></a>Deeply nested **mTLS** block collapsed for readability.
|
|
2115
|
+
|
|
2116
|
+
#### Stateful Service Advertise Options Advertise Custom Ports HTTP Loadbalancer HTTPS Auto Cert Use mTLS CRL
|
|
2117
|
+
|
|
2118
|
+
<a id="deep-81e77c"></a>Deeply nested **CRL** block collapsed for readability.
|
|
2119
|
+
|
|
2120
|
+
#### Stateful Service Advertise Options Advertise Custom Ports HTTP Loadbalancer HTTPS Auto Cert Use mTLS Trusted CA
|
|
2121
|
+
|
|
2122
|
+
<a id="deep-f3a926"></a>Deeply nested **CA** block collapsed for readability.
|
|
2123
|
+
|
|
2124
|
+
#### Stateful Service Advertise Options Advertise Custom Ports HTTP Loadbalancer HTTPS Auto Cert Use mTLS Xfcc Options
|
|
2125
|
+
|
|
2126
|
+
<a id="deep-b48146"></a>Deeply nested **Options** block collapsed for readability.
|
|
2127
|
+
|
|
2128
|
+
#### Stateful Service Advertise Options Advertise Custom Ports HTTP Loadbalancer Specific Routes
|
|
2129
|
+
|
|
2130
|
+
<a id="deep-8dc3bb"></a>Deeply nested **Routes** block collapsed for readability.
|
|
2131
|
+
|
|
2132
|
+
#### Stateful Service Advertise Options Advertise Custom Ports HTTP Loadbalancer Specific Routes Routes
|
|
2133
|
+
|
|
2134
|
+
<a id="deep-434413"></a>Deeply nested **Routes** block collapsed for readability.
|
|
2135
|
+
|
|
2136
|
+
#### Stateful Service Advertise Options Advertise Custom Ports HTTP Loadbalancer Specific Routes Routes Custom Route Object
|
|
2137
|
+
|
|
2138
|
+
<a id="deep-5bd8c8"></a>Deeply nested **Object** block collapsed for readability.
|
|
2139
|
+
|
|
2140
|
+
#### Stateful Service Advertise Options Advertise Custom Ports HTTP Loadbalancer Specific Routes Routes Custom Route Object Route Ref
|
|
2141
|
+
|
|
2142
|
+
<a id="deep-a55e57"></a>Deeply nested **Ref** block collapsed for readability.
|
|
2143
|
+
|
|
2144
|
+
#### Stateful Service Advertise Options Advertise Custom Ports HTTP Loadbalancer Specific Routes Routes Direct Response Route
|
|
2145
|
+
|
|
2146
|
+
<a id="deep-de733a"></a>Deeply nested **Route** block collapsed for readability.
|
|
2147
|
+
|
|
2148
|
+
#### Stateful Service Advertise Options Advertise Custom Ports HTTP Loadbalancer Specific Routes Routes Direct Response Route Headers
|
|
2149
|
+
|
|
2150
|
+
<a id="deep-42ca44"></a>Deeply nested **Headers** block collapsed for readability.
|
|
2151
|
+
|
|
2152
|
+
#### Stateful Service Advertise Options Advertise Custom Ports HTTP Loadbalancer Specific Routes Routes Direct Response Route Incoming Port
|
|
2153
|
+
|
|
2154
|
+
<a id="deep-bd8afd"></a>Deeply nested **Port** block collapsed for readability.
|
|
2155
|
+
|
|
2156
|
+
#### Stateful Service Advertise Options Advertise Custom Ports HTTP Loadbalancer Specific Routes Routes Direct Response Route Path
|
|
2157
|
+
|
|
2158
|
+
<a id="deep-b65bc6"></a>Deeply nested **Path** block collapsed for readability.
|
|
2159
|
+
|
|
2160
|
+
#### Stateful Service Advertise Options Advertise Custom Ports HTTP Loadbalancer Specific Routes Routes Direct Response Route Route Direct Response
|
|
2161
|
+
|
|
2162
|
+
<a id="deep-1e1cf0"></a>Deeply nested **Response** block collapsed for readability.
|
|
2163
|
+
|
|
2164
|
+
#### Stateful Service Advertise Options Advertise Custom Ports HTTP Loadbalancer Specific Routes Routes Redirect Route
|
|
2165
|
+
|
|
2166
|
+
<a id="deep-ae9934"></a>Deeply nested **Route** block collapsed for readability.
|
|
2167
|
+
|
|
2168
|
+
#### Stateful Service Advertise Options Advertise Custom Ports HTTP Loadbalancer Specific Routes Routes Redirect Route Headers
|
|
2169
|
+
|
|
2170
|
+
<a id="deep-c73ff5"></a>Deeply nested **Headers** block collapsed for readability.
|
|
2171
|
+
|
|
2172
|
+
#### Stateful Service Advertise Options Advertise Custom Ports HTTP Loadbalancer Specific Routes Routes Redirect Route Incoming Port
|
|
2173
|
+
|
|
2174
|
+
<a id="deep-2b2330"></a>Deeply nested **Port** block collapsed for readability.
|
|
2175
|
+
|
|
2176
|
+
#### Stateful Service Advertise Options Advertise Custom Ports HTTP Loadbalancer Specific Routes Routes Redirect Route Path
|
|
2177
|
+
|
|
2178
|
+
<a id="deep-65c019"></a>Deeply nested **Path** block collapsed for readability.
|
|
2179
|
+
|
|
2180
|
+
#### Stateful Service Advertise Options Advertise Custom Ports HTTP Loadbalancer Specific Routes Routes Redirect Route Route Redirect
|
|
2181
|
+
|
|
2182
|
+
<a id="deep-248f98"></a>Deeply nested **Redirect** block collapsed for readability.
|
|
2183
|
+
|
|
2184
|
+
#### Stateful Service Advertise Options Advertise Custom Ports HTTP Loadbalancer Specific Routes Routes Simple Route
|
|
2185
|
+
|
|
2186
|
+
<a id="deep-c9c5c6"></a>Deeply nested **Route** block collapsed for readability.
|
|
2187
|
+
|
|
2188
|
+
#### Stateful Service Advertise Options Advertise Custom Ports HTTP Loadbalancer Specific Routes Routes Simple Route Path
|
|
2189
|
+
|
|
2190
|
+
<a id="deep-1e4d1b"></a>Deeply nested **Path** block collapsed for readability.
|
|
2191
|
+
|
|
2192
|
+
#### Stateful Service Advertise Options Advertise Custom Ports Port
|
|
2193
|
+
|
|
2194
|
+
<a id="deep-13234e"></a>Deeply nested **Port** block collapsed for readability.
|
|
2195
|
+
|
|
2196
|
+
#### Stateful Service Advertise Options Advertise Custom Ports Port Info
|
|
2197
|
+
|
|
2198
|
+
<a id="deep-afe3d5"></a>Deeply nested **Info** block collapsed for readability.
|
|
2199
|
+
|
|
2200
|
+
#### Stateful Service Advertise Options Advertise Custom Ports TCP Loadbalancer
|
|
2201
|
+
|
|
2202
|
+
<a id="deep-ed0465"></a>Deeply nested **Loadbalancer** block collapsed for readability.
|
|
2203
|
+
|
|
2204
|
+
#### Stateful Service Advertise Options Advertise In Cluster
|
|
2205
|
+
|
|
2206
|
+
An [`advertise_in_cluster`](#cluster-e091a1) block (within [`stateful_service.advertise_options`](#stateful-service-advertise-options)) supports the following:
|
|
2207
|
+
|
|
2208
|
+
<a id="ports-8e674f"></a>• [`multi_ports`](#ports-8e674f) - Optional Block<br>Multiple Ports. Multiple ports<br>See [Multi Ports](#ports-8e674f) below.
|
|
2209
|
+
|
|
2210
|
+
<a id="port-9af3c4"></a>• [`port`](#port-9af3c4) - Optional Block<br>Port. Single port<br>See [Port](#port-9af3c4) below.
|
|
2211
|
+
|
|
2212
|
+
#### Stateful Service Advertise Options Advertise In Cluster Multi Ports
|
|
2213
|
+
|
|
2214
|
+
<a id="deep-9b9d6a"></a>Deeply nested **Ports** block collapsed for readability.
|
|
2215
|
+
|
|
2216
|
+
#### Stateful Service Advertise Options Advertise In Cluster Multi Ports Ports
|
|
2217
|
+
|
|
2218
|
+
<a id="deep-b2c5c2"></a>Deeply nested **Ports** block collapsed for readability.
|
|
2219
|
+
|
|
2220
|
+
#### Stateful Service Advertise Options Advertise In Cluster Multi Ports Ports Info
|
|
2221
|
+
|
|
2222
|
+
<a id="deep-5d6955"></a>Deeply nested **Info** block collapsed for readability.
|
|
2223
|
+
|
|
2224
|
+
#### Stateful Service Advertise Options Advertise In Cluster Port
|
|
2225
|
+
|
|
2226
|
+
<a id="deep-149104"></a>Deeply nested **Port** block collapsed for readability.
|
|
2227
|
+
|
|
2228
|
+
#### Stateful Service Advertise Options Advertise In Cluster Port Info
|
|
2229
|
+
|
|
2230
|
+
<a id="deep-318fb3"></a>Deeply nested **Info** block collapsed for readability.
|
|
2231
|
+
|
|
2232
|
+
#### Stateful Service Advertise Options Advertise On Public
|
|
2233
|
+
|
|
2234
|
+
An [`advertise_on_public`](#public-86b094) block (within [`stateful_service.advertise_options`](#stateful-service-advertise-options)) supports the following:
|
|
2235
|
+
|
|
2236
|
+
<a id="ports-63766e"></a>• [`multi_ports`](#ports-63766e) - Optional Block<br>Advertise Multiple Ports. Advertise multiple ports<br>See [Multi Ports](#ports-63766e) below.
|
|
2237
|
+
|
|
2238
|
+
<a id="port-1247eb"></a>• [`port`](#port-1247eb) - Optional Block<br>Advertise Port. Advertise single port<br>See [Port](#port-1247eb) below.
|
|
2239
|
+
|
|
2240
|
+
#### Stateful Service Advertise Options Advertise On Public Multi Ports
|
|
2241
|
+
|
|
2242
|
+
<a id="deep-fd3c5a"></a>Deeply nested **Ports** block collapsed for readability.
|
|
2243
|
+
|
|
2244
|
+
#### Stateful Service Advertise Options Advertise On Public Multi Ports Ports
|
|
2245
|
+
|
|
2246
|
+
<a id="deep-448f55"></a>Deeply nested **Ports** block collapsed for readability.
|
|
2247
|
+
|
|
2248
|
+
#### Stateful Service Advertise Options Advertise On Public Multi Ports Ports HTTP Loadbalancer
|
|
2249
|
+
|
|
2250
|
+
<a id="deep-c554c9"></a>Deeply nested **Loadbalancer** block collapsed for readability.
|
|
2251
|
+
|
|
2252
|
+
#### Stateful Service Advertise Options Advertise On Public Multi Ports Ports HTTP Loadbalancer Default Route
|
|
2253
|
+
|
|
2254
|
+
<a id="deep-30e133"></a>Deeply nested **Route** block collapsed for readability.
|
|
2255
|
+
|
|
2256
|
+
#### Stateful Service Advertise Options Advertise On Public Multi Ports Ports HTTP Loadbalancer HTTP
|
|
2257
|
+
|
|
2258
|
+
<a id="deep-d9564b"></a>Deeply nested **HTTP** block collapsed for readability.
|
|
2259
|
+
|
|
2260
|
+
#### Stateful Service Advertise Options Advertise On Public Multi Ports Ports HTTP Loadbalancer HTTPS
|
|
2261
|
+
|
|
2262
|
+
<a id="deep-fd8161"></a>Deeply nested **HTTPS** block collapsed for readability.
|
|
2263
|
+
|
|
2264
|
+
#### Stateful Service Advertise Options Advertise On Public Multi Ports Ports HTTP Loadbalancer HTTPS Coalescing Options
|
|
2265
|
+
|
|
2266
|
+
<a id="deep-1ebf1e"></a>Deeply nested **Options** block collapsed for readability.
|
|
2267
|
+
|
|
2268
|
+
#### Stateful Service Advertise Options Advertise On Public Multi Ports Ports HTTP Loadbalancer HTTPS HTTP Protocol Options
|
|
2269
|
+
|
|
2270
|
+
<a id="deep-91710b"></a>Deeply nested **Options** block collapsed for readability.
|
|
2271
|
+
|
|
2272
|
+
#### Stateful Service Advertise Options Advertise On Public Multi Ports Ports HTTP Loadbalancer HTTPS HTTP Protocol Options HTTP Protocol Enable V1 Only
|
|
2273
|
+
|
|
2274
|
+
<a id="deep-5f8f3e"></a>Deeply nested **Only** block collapsed for readability.
|
|
2275
|
+
|
|
2276
|
+
#### Stateful Service Advertise Options Advertise On Public Multi Ports Ports HTTP Loadbalancer HTTPS HTTP Protocol Options HTTP Protocol Enable V1 Only Header Transformation
|
|
2277
|
+
|
|
2278
|
+
<a id="deep-023b71"></a>Deeply nested **Transformation** block collapsed for readability.
|
|
2279
|
+
|
|
2280
|
+
#### Stateful Service Advertise Options Advertise On Public Multi Ports Ports HTTP Loadbalancer HTTPS TLS Cert Params
|
|
2281
|
+
|
|
2282
|
+
<a id="deep-772343"></a>Deeply nested **Params** block collapsed for readability.
|
|
2283
|
+
|
|
2284
|
+
#### Stateful Service Advertise Options Advertise On Public Multi Ports Ports HTTP Loadbalancer HTTPS TLS Cert Params Certificates
|
|
2285
|
+
|
|
2286
|
+
<a id="deep-853555"></a>Deeply nested **Certificates** block collapsed for readability.
|
|
2287
|
+
|
|
2288
|
+
#### Stateful Service Advertise Options Advertise On Public Multi Ports Ports HTTP Loadbalancer HTTPS TLS Cert Params TLS Config
|
|
2289
|
+
|
|
2290
|
+
<a id="deep-dcee5a"></a>Deeply nested **Config** block collapsed for readability.
|
|
2291
|
+
|
|
2292
|
+
#### Stateful Service Advertise Options Advertise On Public Multi Ports Ports HTTP Loadbalancer HTTPS TLS Cert Params TLS Config Custom Security
|
|
2293
|
+
|
|
2294
|
+
<a id="deep-fb52de"></a>Deeply nested **Security** block collapsed for readability.
|
|
2295
|
+
|
|
2296
|
+
#### Stateful Service Advertise Options Advertise On Public Multi Ports Ports HTTP Loadbalancer HTTPS TLS Cert Params Use mTLS
|
|
2297
|
+
|
|
2298
|
+
<a id="deep-c23b6d"></a>Deeply nested **mTLS** block collapsed for readability.
|
|
2299
|
+
|
|
2300
|
+
#### Stateful Service Advertise Options Advertise On Public Multi Ports Ports HTTP Loadbalancer HTTPS TLS Cert Params Use mTLS CRL
|
|
2301
|
+
|
|
2302
|
+
<a id="deep-0f1756"></a>Deeply nested **CRL** block collapsed for readability.
|
|
2303
|
+
|
|
2304
|
+
#### Stateful Service Advertise Options Advertise On Public Multi Ports Ports HTTP Loadbalancer HTTPS TLS Cert Params Use mTLS Trusted CA
|
|
2305
|
+
|
|
2306
|
+
<a id="deep-5c48ac"></a>Deeply nested **CA** block collapsed for readability.
|
|
2307
|
+
|
|
2308
|
+
#### Stateful Service Advertise Options Advertise On Public Multi Ports Ports HTTP Loadbalancer HTTPS TLS Cert Params Use mTLS Xfcc Options
|
|
2309
|
+
|
|
2310
|
+
<a id="deep-802e32"></a>Deeply nested **Options** block collapsed for readability.
|
|
2311
|
+
|
|
2312
|
+
#### Stateful Service Advertise Options Advertise On Public Multi Ports Ports HTTP Loadbalancer HTTPS TLS Parameters
|
|
2313
|
+
|
|
2314
|
+
<a id="deep-82afe1"></a>Deeply nested **Parameters** block collapsed for readability.
|
|
2315
|
+
|
|
2316
|
+
#### Stateful Service Advertise Options Advertise On Public Multi Ports Ports HTTP Loadbalancer HTTPS TLS Parameters TLS Certificates
|
|
2317
|
+
|
|
2318
|
+
<a id="deep-00a8ec"></a>Deeply nested **Certificates** block collapsed for readability.
|
|
2319
|
+
|
|
2320
|
+
#### Stateful Service Advertise Options Advertise On Public Multi Ports Ports HTTP Loadbalancer HTTPS TLS Parameters TLS Certificates Custom Hash Algorithms
|
|
2321
|
+
|
|
2322
|
+
<a id="deep-5a20af"></a>Deeply nested **Algorithms** block collapsed for readability.
|
|
2323
|
+
|
|
2324
|
+
#### Stateful Service Advertise Options Advertise On Public Multi Ports Ports HTTP Loadbalancer HTTPS TLS Parameters TLS Certificates Private Key
|
|
2325
|
+
|
|
2326
|
+
<a id="deep-49489e"></a>Deeply nested **Key** block collapsed for readability.
|
|
2327
|
+
|
|
2328
|
+
#### Stateful Service Advertise Options Advertise On Public Multi Ports Ports HTTP Loadbalancer HTTPS TLS Parameters TLS Certificates Private Key Blindfold Secret Info
|
|
2329
|
+
|
|
2330
|
+
<a id="deep-b28abf"></a>Deeply nested **Info** block collapsed for readability.
|
|
2331
|
+
|
|
2332
|
+
#### Stateful Service Advertise Options Advertise On Public Multi Ports Ports HTTP Loadbalancer HTTPS TLS Parameters TLS Certificates Private Key Clear Secret Info
|
|
2333
|
+
|
|
2334
|
+
<a id="deep-639d38"></a>Deeply nested **Info** block collapsed for readability.
|
|
2335
|
+
|
|
2336
|
+
#### Stateful Service Advertise Options Advertise On Public Multi Ports Ports HTTP Loadbalancer HTTPS TLS Parameters TLS Config
|
|
2337
|
+
|
|
2338
|
+
<a id="deep-68cec9"></a>Deeply nested **Config** block collapsed for readability.
|
|
2339
|
+
|
|
2340
|
+
#### Stateful Service Advertise Options Advertise On Public Multi Ports Ports HTTP Loadbalancer HTTPS TLS Parameters TLS Config Custom Security
|
|
2341
|
+
|
|
2342
|
+
<a id="deep-e36b2c"></a>Deeply nested **Security** block collapsed for readability.
|
|
2343
|
+
|
|
2344
|
+
#### Stateful Service Advertise Options Advertise On Public Multi Ports Ports HTTP Loadbalancer HTTPS TLS Parameters Use mTLS
|
|
2345
|
+
|
|
2346
|
+
<a id="deep-a4b527"></a>Deeply nested **mTLS** block collapsed for readability.
|
|
2347
|
+
|
|
2348
|
+
#### Stateful Service Advertise Options Advertise On Public Multi Ports Ports HTTP Loadbalancer HTTPS TLS Parameters Use mTLS CRL
|
|
2349
|
+
|
|
2350
|
+
<a id="deep-c3e12f"></a>Deeply nested **CRL** block collapsed for readability.
|
|
2351
|
+
|
|
2352
|
+
#### Stateful Service Advertise Options Advertise On Public Multi Ports Ports HTTP Loadbalancer HTTPS TLS Parameters Use mTLS Trusted CA
|
|
2353
|
+
|
|
2354
|
+
<a id="deep-c797ab"></a>Deeply nested **CA** block collapsed for readability.
|
|
2355
|
+
|
|
2356
|
+
#### Stateful Service Advertise Options Advertise On Public Multi Ports Ports HTTP Loadbalancer HTTPS TLS Parameters Use mTLS Xfcc Options
|
|
2357
|
+
|
|
2358
|
+
<a id="deep-2df252"></a>Deeply nested **Options** block collapsed for readability.
|
|
2359
|
+
|
|
2360
|
+
#### Stateful Service Advertise Options Advertise On Public Multi Ports Ports HTTP Loadbalancer HTTPS Auto Cert
|
|
2361
|
+
|
|
2362
|
+
<a id="deep-43ef50"></a>Deeply nested **Cert** block collapsed for readability.
|
|
2363
|
+
|
|
2364
|
+
#### Stateful Service Advertise Options Advertise On Public Multi Ports Ports HTTP Loadbalancer HTTPS Auto Cert Coalescing Options
|
|
2365
|
+
|
|
2366
|
+
<a id="deep-040bd4"></a>Deeply nested **Options** block collapsed for readability.
|
|
2367
|
+
|
|
2368
|
+
#### Stateful Service Advertise Options Advertise On Public Multi Ports Ports HTTP Loadbalancer HTTPS Auto Cert HTTP Protocol Options
|
|
2369
|
+
|
|
2370
|
+
<a id="deep-3fe0dd"></a>Deeply nested **Options** block collapsed for readability.
|
|
2371
|
+
|
|
2372
|
+
#### Stateful Service Advertise Options Advertise On Public Multi Ports Ports HTTP Loadbalancer HTTPS Auto Cert HTTP Protocol Options HTTP Protocol Enable V1 Only
|
|
2373
|
+
|
|
2374
|
+
<a id="deep-a1efa3"></a>Deeply nested **Only** block collapsed for readability.
|
|
2375
|
+
|
|
2376
|
+
#### Stateful Service Advertise Options Advertise On Public Multi Ports Ports HTTP Loadbalancer HTTPS Auto Cert HTTP Protocol Options HTTP Protocol Enable V1 Only Header Transformation
|
|
2377
|
+
|
|
2378
|
+
<a id="deep-f94784"></a>Deeply nested **Transformation** block collapsed for readability.
|
|
2379
|
+
|
|
2380
|
+
#### Stateful Service Advertise Options Advertise On Public Multi Ports Ports HTTP Loadbalancer HTTPS Auto Cert TLS Config
|
|
2381
|
+
|
|
2382
|
+
<a id="deep-165f40"></a>Deeply nested **Config** block collapsed for readability.
|
|
2383
|
+
|
|
2384
|
+
#### Stateful Service Advertise Options Advertise On Public Multi Ports Ports HTTP Loadbalancer HTTPS Auto Cert TLS Config Custom Security
|
|
2385
|
+
|
|
2386
|
+
<a id="deep-f6ef45"></a>Deeply nested **Security** block collapsed for readability.
|
|
2387
|
+
|
|
2388
|
+
#### Stateful Service Advertise Options Advertise On Public Multi Ports Ports HTTP Loadbalancer HTTPS Auto Cert Use mTLS
|
|
2389
|
+
|
|
2390
|
+
<a id="deep-3db17a"></a>Deeply nested **mTLS** block collapsed for readability.
|
|
2391
|
+
|
|
2392
|
+
#### Stateful Service Advertise Options Advertise On Public Multi Ports Ports HTTP Loadbalancer HTTPS Auto Cert Use mTLS CRL
|
|
2393
|
+
|
|
2394
|
+
<a id="deep-1bc609"></a>Deeply nested **CRL** block collapsed for readability.
|
|
2395
|
+
|
|
2396
|
+
#### Stateful Service Advertise Options Advertise On Public Multi Ports Ports HTTP Loadbalancer HTTPS Auto Cert Use mTLS Trusted CA
|
|
2397
|
+
|
|
2398
|
+
<a id="deep-cd80a3"></a>Deeply nested **CA** block collapsed for readability.
|
|
2399
|
+
|
|
2400
|
+
#### Stateful Service Advertise Options Advertise On Public Multi Ports Ports HTTP Loadbalancer HTTPS Auto Cert Use mTLS Xfcc Options
|
|
2401
|
+
|
|
2402
|
+
<a id="deep-10a93f"></a>Deeply nested **Options** block collapsed for readability.
|
|
2403
|
+
|
|
2404
|
+
#### Stateful Service Advertise Options Advertise On Public Multi Ports Ports HTTP Loadbalancer Specific Routes
|
|
2405
|
+
|
|
2406
|
+
<a id="deep-a22e01"></a>Deeply nested **Routes** block collapsed for readability.
|
|
2407
|
+
|
|
2408
|
+
#### Stateful Service Advertise Options Advertise On Public Multi Ports Ports HTTP Loadbalancer Specific Routes Routes
|
|
2409
|
+
|
|
2410
|
+
<a id="deep-e2338f"></a>Deeply nested **Routes** block collapsed for readability.
|
|
2411
|
+
|
|
2412
|
+
#### Stateful Service Advertise Options Advertise On Public Multi Ports Ports HTTP Loadbalancer Specific Routes Routes Custom Route Object
|
|
2413
|
+
|
|
2414
|
+
<a id="deep-a60631"></a>Deeply nested **Object** block collapsed for readability.
|
|
2415
|
+
|
|
2416
|
+
#### Stateful Service Advertise Options Advertise On Public Multi Ports Ports HTTP Loadbalancer Specific Routes Routes Custom Route Object Route Ref
|
|
2417
|
+
|
|
2418
|
+
<a id="deep-f20d74"></a>Deeply nested **Ref** block collapsed for readability.
|
|
2419
|
+
|
|
2420
|
+
#### Stateful Service Advertise Options Advertise On Public Multi Ports Ports HTTP Loadbalancer Specific Routes Routes Direct Response Route
|
|
2421
|
+
|
|
2422
|
+
<a id="deep-2e3160"></a>Deeply nested **Route** block collapsed for readability.
|
|
2423
|
+
|
|
2424
|
+
#### Stateful Service Advertise Options Advertise On Public Multi Ports Ports HTTP Loadbalancer Specific Routes Routes Direct Response Route Headers
|
|
2425
|
+
|
|
2426
|
+
<a id="deep-d54750"></a>Deeply nested **Headers** block collapsed for readability.
|
|
2427
|
+
|
|
2428
|
+
#### Stateful Service Advertise Options Advertise On Public Multi Ports Ports HTTP Loadbalancer Specific Routes Routes Direct Response Route Incoming Port
|
|
2429
|
+
|
|
2430
|
+
<a id="deep-3776d6"></a>Deeply nested **Port** block collapsed for readability.
|
|
2431
|
+
|
|
2432
|
+
#### Stateful Service Advertise Options Advertise On Public Multi Ports Ports HTTP Loadbalancer Specific Routes Routes Direct Response Route Path
|
|
2433
|
+
|
|
2434
|
+
<a id="deep-e0dc9c"></a>Deeply nested **Path** block collapsed for readability.
|
|
2435
|
+
|
|
2436
|
+
#### Stateful Service Advertise Options Advertise On Public Multi Ports Ports HTTP Loadbalancer Specific Routes Routes Direct Response Route Route Direct Response
|
|
2437
|
+
|
|
2438
|
+
<a id="deep-f31bdb"></a>Deeply nested **Response** block collapsed for readability.
|
|
2439
|
+
|
|
2440
|
+
#### Stateful Service Advertise Options Advertise On Public Multi Ports Ports HTTP Loadbalancer Specific Routes Routes Redirect Route
|
|
2441
|
+
|
|
2442
|
+
<a id="deep-2f195b"></a>Deeply nested **Route** block collapsed for readability.
|
|
2443
|
+
|
|
2444
|
+
#### Stateful Service Advertise Options Advertise On Public Multi Ports Ports HTTP Loadbalancer Specific Routes Routes Redirect Route Headers
|
|
2445
|
+
|
|
2446
|
+
<a id="deep-4d2d9a"></a>Deeply nested **Headers** block collapsed for readability.
|
|
2447
|
+
|
|
2448
|
+
#### Stateful Service Advertise Options Advertise On Public Multi Ports Ports HTTP Loadbalancer Specific Routes Routes Redirect Route Incoming Port
|
|
2449
|
+
|
|
2450
|
+
<a id="deep-6a788d"></a>Deeply nested **Port** block collapsed for readability.
|
|
2451
|
+
|
|
2452
|
+
#### Stateful Service Advertise Options Advertise On Public Multi Ports Ports HTTP Loadbalancer Specific Routes Routes Redirect Route Path
|
|
2453
|
+
|
|
2454
|
+
<a id="deep-478484"></a>Deeply nested **Path** block collapsed for readability.
|
|
2455
|
+
|
|
2456
|
+
#### Stateful Service Advertise Options Advertise On Public Multi Ports Ports HTTP Loadbalancer Specific Routes Routes Redirect Route Route Redirect
|
|
2457
|
+
|
|
2458
|
+
<a id="deep-b9e553"></a>Deeply nested **Redirect** block collapsed for readability.
|
|
2459
|
+
|
|
2460
|
+
#### Stateful Service Advertise Options Advertise On Public Multi Ports Ports HTTP Loadbalancer Specific Routes Routes Simple Route
|
|
2461
|
+
|
|
2462
|
+
<a id="deep-9d5c84"></a>Deeply nested **Route** block collapsed for readability.
|
|
2463
|
+
|
|
2464
|
+
#### Stateful Service Advertise Options Advertise On Public Multi Ports Ports HTTP Loadbalancer Specific Routes Routes Simple Route Path
|
|
2465
|
+
|
|
2466
|
+
<a id="deep-722753"></a>Deeply nested **Path** block collapsed for readability.
|
|
2467
|
+
|
|
2468
|
+
#### Stateful Service Advertise Options Advertise On Public Multi Ports Ports Port
|
|
2469
|
+
|
|
2470
|
+
<a id="deep-4f3d68"></a>Deeply nested **Port** block collapsed for readability.
|
|
2471
|
+
|
|
2472
|
+
#### Stateful Service Advertise Options Advertise On Public Multi Ports Ports Port Info
|
|
2473
|
+
|
|
2474
|
+
<a id="deep-63cbf3"></a>Deeply nested **Info** block collapsed for readability.
|
|
2475
|
+
|
|
2476
|
+
#### Stateful Service Advertise Options Advertise On Public Multi Ports Ports TCP Loadbalancer
|
|
2477
|
+
|
|
2478
|
+
<a id="deep-5fa3a7"></a>Deeply nested **Loadbalancer** block collapsed for readability.
|
|
2479
|
+
|
|
2480
|
+
#### Stateful Service Advertise Options Advertise On Public Port
|
|
2481
|
+
|
|
2482
|
+
<a id="deep-8c94ab"></a>Deeply nested **Port** block collapsed for readability.
|
|
2483
|
+
|
|
2484
|
+
#### Stateful Service Advertise Options Advertise On Public Port HTTP Loadbalancer
|
|
2485
|
+
|
|
2486
|
+
<a id="deep-d7478f"></a>Deeply nested **Loadbalancer** block collapsed for readability.
|
|
2487
|
+
|
|
2488
|
+
#### Stateful Service Advertise Options Advertise On Public Port HTTP Loadbalancer Default Route
|
|
2489
|
+
|
|
2490
|
+
<a id="deep-1317ce"></a>Deeply nested **Route** block collapsed for readability.
|
|
2491
|
+
|
|
2492
|
+
#### Stateful Service Advertise Options Advertise On Public Port HTTP Loadbalancer HTTP
|
|
2493
|
+
|
|
2494
|
+
<a id="deep-f8336f"></a>Deeply nested **HTTP** block collapsed for readability.
|
|
2495
|
+
|
|
2496
|
+
#### Stateful Service Advertise Options Advertise On Public Port HTTP Loadbalancer HTTPS
|
|
2497
|
+
|
|
2498
|
+
<a id="deep-88c203"></a>Deeply nested **HTTPS** block collapsed for readability.
|
|
2499
|
+
|
|
2500
|
+
#### Stateful Service Advertise Options Advertise On Public Port HTTP Loadbalancer HTTPS Coalescing Options
|
|
2501
|
+
|
|
2502
|
+
<a id="deep-5b699c"></a>Deeply nested **Options** block collapsed for readability.
|
|
2503
|
+
|
|
2504
|
+
#### Stateful Service Advertise Options Advertise On Public Port HTTP Loadbalancer HTTPS HTTP Protocol Options
|
|
2505
|
+
|
|
2506
|
+
<a id="deep-3fd15d"></a>Deeply nested **Options** block collapsed for readability.
|
|
2507
|
+
|
|
2508
|
+
#### Stateful Service Advertise Options Advertise On Public Port HTTP Loadbalancer HTTPS HTTP Protocol Options HTTP Protocol Enable V1 Only
|
|
2509
|
+
|
|
2510
|
+
<a id="deep-1e9fea"></a>Deeply nested **Only** block collapsed for readability.
|
|
2511
|
+
|
|
2512
|
+
#### Stateful Service Advertise Options Advertise On Public Port HTTP Loadbalancer HTTPS HTTP Protocol Options HTTP Protocol Enable V1 Only Header Transformation
|
|
2513
|
+
|
|
2514
|
+
<a id="deep-96577f"></a>Deeply nested **Transformation** block collapsed for readability.
|
|
2515
|
+
|
|
2516
|
+
#### Stateful Service Advertise Options Advertise On Public Port HTTP Loadbalancer HTTPS TLS Cert Params
|
|
2517
|
+
|
|
2518
|
+
<a id="deep-cb4920"></a>Deeply nested **Params** block collapsed for readability.
|
|
2519
|
+
|
|
2520
|
+
#### Stateful Service Advertise Options Advertise On Public Port HTTP Loadbalancer HTTPS TLS Cert Params Certificates
|
|
2521
|
+
|
|
2522
|
+
<a id="deep-1406ba"></a>Deeply nested **Certificates** block collapsed for readability.
|
|
2523
|
+
|
|
2524
|
+
#### Stateful Service Advertise Options Advertise On Public Port HTTP Loadbalancer HTTPS TLS Cert Params TLS Config
|
|
2525
|
+
|
|
2526
|
+
<a id="deep-c9f0c1"></a>Deeply nested **Config** block collapsed for readability.
|
|
2527
|
+
|
|
2528
|
+
#### Stateful Service Advertise Options Advertise On Public Port HTTP Loadbalancer HTTPS TLS Cert Params TLS Config Custom Security
|
|
2529
|
+
|
|
2530
|
+
<a id="deep-feb32d"></a>Deeply nested **Security** block collapsed for readability.
|
|
2531
|
+
|
|
2532
|
+
#### Stateful Service Advertise Options Advertise On Public Port HTTP Loadbalancer HTTPS TLS Cert Params Use mTLS
|
|
2533
|
+
|
|
2534
|
+
<a id="deep-5b8a3c"></a>Deeply nested **mTLS** block collapsed for readability.
|
|
2535
|
+
|
|
2536
|
+
#### Stateful Service Advertise Options Advertise On Public Port HTTP Loadbalancer HTTPS TLS Cert Params Use mTLS CRL
|
|
2537
|
+
|
|
2538
|
+
<a id="deep-49d7a4"></a>Deeply nested **CRL** block collapsed for readability.
|
|
2539
|
+
|
|
2540
|
+
#### Stateful Service Advertise Options Advertise On Public Port HTTP Loadbalancer HTTPS TLS Cert Params Use mTLS Trusted CA
|
|
2541
|
+
|
|
2542
|
+
<a id="deep-8d206a"></a>Deeply nested **CA** block collapsed for readability.
|
|
2543
|
+
|
|
2544
|
+
#### Stateful Service Advertise Options Advertise On Public Port HTTP Loadbalancer HTTPS TLS Cert Params Use mTLS Xfcc Options
|
|
2545
|
+
|
|
2546
|
+
<a id="deep-a9b8df"></a>Deeply nested **Options** block collapsed for readability.
|
|
2547
|
+
|
|
2548
|
+
#### Stateful Service Advertise Options Advertise On Public Port HTTP Loadbalancer HTTPS TLS Parameters
|
|
2549
|
+
|
|
2550
|
+
<a id="deep-f7d00f"></a>Deeply nested **Parameters** block collapsed for readability.
|
|
2551
|
+
|
|
2552
|
+
#### Stateful Service Advertise Options Advertise On Public Port HTTP Loadbalancer HTTPS TLS Parameters TLS Certificates
|
|
2553
|
+
|
|
2554
|
+
<a id="deep-24598f"></a>Deeply nested **Certificates** block collapsed for readability.
|
|
2555
|
+
|
|
2556
|
+
#### Stateful Service Advertise Options Advertise On Public Port HTTP Loadbalancer HTTPS TLS Parameters TLS Certificates Custom Hash Algorithms
|
|
2557
|
+
|
|
2558
|
+
<a id="deep-9279c2"></a>Deeply nested **Algorithms** block collapsed for readability.
|
|
2559
|
+
|
|
2560
|
+
#### Stateful Service Advertise Options Advertise On Public Port HTTP Loadbalancer HTTPS TLS Parameters TLS Certificates Private Key
|
|
2561
|
+
|
|
2562
|
+
<a id="deep-6ca79f"></a>Deeply nested **Key** block collapsed for readability.
|
|
2563
|
+
|
|
2564
|
+
#### Stateful Service Advertise Options Advertise On Public Port HTTP Loadbalancer HTTPS TLS Parameters TLS Certificates Private Key Blindfold Secret Info
|
|
2565
|
+
|
|
2566
|
+
<a id="deep-906508"></a>Deeply nested **Info** block collapsed for readability.
|
|
2567
|
+
|
|
2568
|
+
#### Stateful Service Advertise Options Advertise On Public Port HTTP Loadbalancer HTTPS TLS Parameters TLS Certificates Private Key Clear Secret Info
|
|
2569
|
+
|
|
2570
|
+
<a id="deep-2cb08d"></a>Deeply nested **Info** block collapsed for readability.
|
|
2571
|
+
|
|
2572
|
+
#### Stateful Service Advertise Options Advertise On Public Port HTTP Loadbalancer HTTPS TLS Parameters TLS Config
|
|
2573
|
+
|
|
2574
|
+
<a id="deep-822220"></a>Deeply nested **Config** block collapsed for readability.
|
|
2575
|
+
|
|
2576
|
+
#### Stateful Service Advertise Options Advertise On Public Port HTTP Loadbalancer HTTPS TLS Parameters TLS Config Custom Security
|
|
2577
|
+
|
|
2578
|
+
<a id="deep-4ec091"></a>Deeply nested **Security** block collapsed for readability.
|
|
2579
|
+
|
|
2580
|
+
#### Stateful Service Advertise Options Advertise On Public Port HTTP Loadbalancer HTTPS TLS Parameters Use mTLS
|
|
2581
|
+
|
|
2582
|
+
<a id="deep-966ded"></a>Deeply nested **mTLS** block collapsed for readability.
|
|
2583
|
+
|
|
2584
|
+
#### Stateful Service Advertise Options Advertise On Public Port HTTP Loadbalancer HTTPS TLS Parameters Use mTLS CRL
|
|
2585
|
+
|
|
2586
|
+
<a id="deep-f1a4a8"></a>Deeply nested **CRL** block collapsed for readability.
|
|
2587
|
+
|
|
2588
|
+
#### Stateful Service Advertise Options Advertise On Public Port HTTP Loadbalancer HTTPS TLS Parameters Use mTLS Trusted CA
|
|
2589
|
+
|
|
2590
|
+
<a id="deep-16c5e1"></a>Deeply nested **CA** block collapsed for readability.
|
|
2591
|
+
|
|
2592
|
+
#### Stateful Service Advertise Options Advertise On Public Port HTTP Loadbalancer HTTPS TLS Parameters Use mTLS Xfcc Options
|
|
2593
|
+
|
|
2594
|
+
<a id="deep-189054"></a>Deeply nested **Options** block collapsed for readability.
|
|
2595
|
+
|
|
2596
|
+
#### Stateful Service Advertise Options Advertise On Public Port HTTP Loadbalancer HTTPS Auto Cert
|
|
2597
|
+
|
|
2598
|
+
<a id="deep-e6c6ca"></a>Deeply nested **Cert** block collapsed for readability.
|
|
2599
|
+
|
|
2600
|
+
#### Stateful Service Advertise Options Advertise On Public Port HTTP Loadbalancer HTTPS Auto Cert Coalescing Options
|
|
2601
|
+
|
|
2602
|
+
<a id="deep-c60043"></a>Deeply nested **Options** block collapsed for readability.
|
|
2603
|
+
|
|
2604
|
+
#### Stateful Service Advertise Options Advertise On Public Port HTTP Loadbalancer HTTPS Auto Cert HTTP Protocol Options
|
|
2605
|
+
|
|
2606
|
+
<a id="deep-acc31c"></a>Deeply nested **Options** block collapsed for readability.
|
|
2607
|
+
|
|
2608
|
+
#### Stateful Service Advertise Options Advertise On Public Port HTTP Loadbalancer HTTPS Auto Cert HTTP Protocol Options HTTP Protocol Enable V1 Only
|
|
2609
|
+
|
|
2610
|
+
<a id="deep-1e5eee"></a>Deeply nested **Only** block collapsed for readability.
|
|
2611
|
+
|
|
2612
|
+
#### Stateful Service Advertise Options Advertise On Public Port HTTP Loadbalancer HTTPS Auto Cert HTTP Protocol Options HTTP Protocol Enable V1 Only Header Transformation
|
|
2613
|
+
|
|
2614
|
+
<a id="deep-bada35"></a>Deeply nested **Transformation** block collapsed for readability.
|
|
2615
|
+
|
|
2616
|
+
#### Stateful Service Advertise Options Advertise On Public Port HTTP Loadbalancer HTTPS Auto Cert TLS Config
|
|
2617
|
+
|
|
2618
|
+
<a id="deep-57e2ee"></a>Deeply nested **Config** block collapsed for readability.
|
|
2619
|
+
|
|
2620
|
+
#### Stateful Service Advertise Options Advertise On Public Port HTTP Loadbalancer HTTPS Auto Cert TLS Config Custom Security
|
|
2621
|
+
|
|
2622
|
+
<a id="deep-6df39c"></a>Deeply nested **Security** block collapsed for readability.
|
|
2623
|
+
|
|
2624
|
+
#### Stateful Service Advertise Options Advertise On Public Port HTTP Loadbalancer HTTPS Auto Cert Use mTLS
|
|
2625
|
+
|
|
2626
|
+
<a id="deep-43d6c1"></a>Deeply nested **mTLS** block collapsed for readability.
|
|
2627
|
+
|
|
2628
|
+
#### Stateful Service Advertise Options Advertise On Public Port HTTP Loadbalancer HTTPS Auto Cert Use mTLS CRL
|
|
2629
|
+
|
|
2630
|
+
<a id="deep-6bd648"></a>Deeply nested **CRL** block collapsed for readability.
|
|
2631
|
+
|
|
2632
|
+
#### Stateful Service Advertise Options Advertise On Public Port HTTP Loadbalancer HTTPS Auto Cert Use mTLS Trusted CA
|
|
2633
|
+
|
|
2634
|
+
<a id="deep-2e4ca6"></a>Deeply nested **CA** block collapsed for readability.
|
|
2635
|
+
|
|
2636
|
+
#### Stateful Service Advertise Options Advertise On Public Port HTTP Loadbalancer HTTPS Auto Cert Use mTLS Xfcc Options
|
|
2637
|
+
|
|
2638
|
+
<a id="deep-6d2698"></a>Deeply nested **Options** block collapsed for readability.
|
|
2639
|
+
|
|
2640
|
+
#### Stateful Service Advertise Options Advertise On Public Port HTTP Loadbalancer Specific Routes
|
|
2641
|
+
|
|
2642
|
+
<a id="deep-ee8802"></a>Deeply nested **Routes** block collapsed for readability.
|
|
2643
|
+
|
|
2644
|
+
#### Stateful Service Advertise Options Advertise On Public Port HTTP Loadbalancer Specific Routes Routes
|
|
2645
|
+
|
|
2646
|
+
<a id="deep-5b9b7f"></a>Deeply nested **Routes** block collapsed for readability.
|
|
2647
|
+
|
|
2648
|
+
#### Stateful Service Advertise Options Advertise On Public Port HTTP Loadbalancer Specific Routes Routes Custom Route Object
|
|
2649
|
+
|
|
2650
|
+
<a id="deep-139784"></a>Deeply nested **Object** block collapsed for readability.
|
|
2651
|
+
|
|
2652
|
+
#### Stateful Service Advertise Options Advertise On Public Port HTTP Loadbalancer Specific Routes Routes Custom Route Object Route Ref
|
|
2653
|
+
|
|
2654
|
+
<a id="deep-fa0b80"></a>Deeply nested **Ref** block collapsed for readability.
|
|
2655
|
+
|
|
2656
|
+
#### Stateful Service Advertise Options Advertise On Public Port HTTP Loadbalancer Specific Routes Routes Direct Response Route
|
|
2657
|
+
|
|
2658
|
+
<a id="deep-e4cb4d"></a>Deeply nested **Route** block collapsed for readability.
|
|
2659
|
+
|
|
2660
|
+
#### Stateful Service Advertise Options Advertise On Public Port HTTP Loadbalancer Specific Routes Routes Direct Response Route Headers
|
|
2661
|
+
|
|
2662
|
+
<a id="deep-16b389"></a>Deeply nested **Headers** block collapsed for readability.
|
|
2663
|
+
|
|
2664
|
+
#### Stateful Service Advertise Options Advertise On Public Port HTTP Loadbalancer Specific Routes Routes Direct Response Route Incoming Port
|
|
2665
|
+
|
|
2666
|
+
<a id="deep-600cbb"></a>Deeply nested **Port** block collapsed for readability.
|
|
2667
|
+
|
|
2668
|
+
#### Stateful Service Advertise Options Advertise On Public Port HTTP Loadbalancer Specific Routes Routes Direct Response Route Path
|
|
2669
|
+
|
|
2670
|
+
<a id="deep-8d9f69"></a>Deeply nested **Path** block collapsed for readability.
|
|
2671
|
+
|
|
2672
|
+
#### Stateful Service Advertise Options Advertise On Public Port HTTP Loadbalancer Specific Routes Routes Direct Response Route Route Direct Response
|
|
2673
|
+
|
|
2674
|
+
<a id="deep-3e55b0"></a>Deeply nested **Response** block collapsed for readability.
|
|
2675
|
+
|
|
2676
|
+
#### Stateful Service Advertise Options Advertise On Public Port HTTP Loadbalancer Specific Routes Routes Redirect Route
|
|
2677
|
+
|
|
2678
|
+
<a id="deep-b619f2"></a>Deeply nested **Route** block collapsed for readability.
|
|
2679
|
+
|
|
2680
|
+
#### Stateful Service Advertise Options Advertise On Public Port HTTP Loadbalancer Specific Routes Routes Redirect Route Headers
|
|
2681
|
+
|
|
2682
|
+
<a id="deep-869c99"></a>Deeply nested **Headers** block collapsed for readability.
|
|
2683
|
+
|
|
2684
|
+
#### Stateful Service Advertise Options Advertise On Public Port HTTP Loadbalancer Specific Routes Routes Redirect Route Incoming Port
|
|
2685
|
+
|
|
2686
|
+
<a id="deep-df832d"></a>Deeply nested **Port** block collapsed for readability.
|
|
2687
|
+
|
|
2688
|
+
#### Stateful Service Advertise Options Advertise On Public Port HTTP Loadbalancer Specific Routes Routes Redirect Route Path
|
|
2689
|
+
|
|
2690
|
+
<a id="deep-4adff7"></a>Deeply nested **Path** block collapsed for readability.
|
|
2691
|
+
|
|
2692
|
+
#### Stateful Service Advertise Options Advertise On Public Port HTTP Loadbalancer Specific Routes Routes Redirect Route Route Redirect
|
|
2693
|
+
|
|
2694
|
+
<a id="deep-5f4ed2"></a>Deeply nested **Redirect** block collapsed for readability.
|
|
2695
|
+
|
|
2696
|
+
#### Stateful Service Advertise Options Advertise On Public Port HTTP Loadbalancer Specific Routes Routes Simple Route
|
|
2697
|
+
|
|
2698
|
+
<a id="deep-be5f76"></a>Deeply nested **Route** block collapsed for readability.
|
|
2699
|
+
|
|
2700
|
+
#### Stateful Service Advertise Options Advertise On Public Port HTTP Loadbalancer Specific Routes Routes Simple Route Path
|
|
2701
|
+
|
|
2702
|
+
<a id="deep-af937d"></a>Deeply nested **Path** block collapsed for readability.
|
|
2703
|
+
|
|
2704
|
+
#### Stateful Service Advertise Options Advertise On Public Port Port
|
|
2705
|
+
|
|
2706
|
+
<a id="deep-8e2e80"></a>Deeply nested **Port** block collapsed for readability.
|
|
2707
|
+
|
|
2708
|
+
#### Stateful Service Advertise Options Advertise On Public Port Port Info
|
|
2709
|
+
|
|
2710
|
+
<a id="deep-c00eff"></a>Deeply nested **Info** block collapsed for readability.
|
|
2711
|
+
|
|
2712
|
+
#### Stateful Service Advertise Options Advertise On Public Port TCP Loadbalancer
|
|
2713
|
+
|
|
2714
|
+
<a id="deep-ee5fc5"></a>Deeply nested **Loadbalancer** block collapsed for readability.
|
|
2715
|
+
|
|
2716
|
+
#### Stateful Service Configuration
|
|
2717
|
+
|
|
2718
|
+
A [`configuration`](#stateful-service-configuration) block (within [`stateful_service`](#stateful-service)) supports the following:
|
|
2719
|
+
|
|
2720
|
+
<a id="parameters-dc9866"></a>• [`parameters`](#parameters-dc9866) - Optional Block<br>Parameters. Parameters for the workload<br>See [Parameters](#parameters-dc9866) below.
|
|
2721
|
+
|
|
2722
|
+
#### Stateful Service Configuration Parameters
|
|
2723
|
+
|
|
2724
|
+
A [`parameters`](#parameters-dc9866) block (within [`stateful_service.configuration`](#stateful-service-configuration)) supports the following:
|
|
2725
|
+
|
|
2726
|
+
<a id="var-ccabf5"></a>• [`env_var`](#var-ccabf5) - Optional Block<br>Environment Variable. Environment Variable<br>See [Env Var](#var-ccabf5) below.
|
|
2727
|
+
|
|
2728
|
+
<a id="file-343e3f"></a>• [`file`](#file-343e3f) - Optional Block<br>Configuration File. Configuration File for the workload<br>See [File](#file-343e3f) below.
|
|
2729
|
+
|
|
2730
|
+
#### Stateful Service Configuration Parameters Env Var
|
|
2731
|
+
|
|
2732
|
+
An [`env_var`](#var-ccabf5) block (within [`stateful_service.configuration.parameters`](#parameters-dc9866)) supports the following:
|
|
2733
|
+
|
|
2734
|
+
<a id="name-364c07"></a>• [`name`](#name-364c07) - Optional String<br>Name. Name of Environment Variable
|
|
2735
|
+
|
|
2736
|
+
<a id="value-d3bca9"></a>• [`value`](#value-d3bca9) - Optional String<br>Value. Value of Environment Variable
|
|
2737
|
+
|
|
2738
|
+
#### Stateful Service Configuration Parameters File
|
|
2739
|
+
|
|
2740
|
+
A [`file`](#file-343e3f) block (within [`stateful_service.configuration.parameters`](#parameters-dc9866)) supports the following:
|
|
2741
|
+
|
|
2742
|
+
<a id="data-1a89a8"></a>• [`data`](#data-1a89a8) - Optional String<br>Data. File data
|
|
2743
|
+
|
|
2744
|
+
<a id="mount-9251c5"></a>• [`mount`](#mount-9251c5) - Optional Block<br>Volume mount describes how volume is mounted inside a workload<br>See [Mount](#mount-9251c5) below.
|
|
2745
|
+
|
|
2746
|
+
<a id="name-0fb42b"></a>• [`name`](#name-0fb42b) - Optional String<br>Name. Name of the file
|
|
2747
|
+
|
|
2748
|
+
<a id="name-b84d33"></a>• [`volume_name`](#name-b84d33) - Optional String<br>Volume Name. Name of the Volume
|
|
2749
|
+
|
|
2750
|
+
#### Stateful Service Configuration Parameters File Mount
|
|
2751
|
+
|
|
2752
|
+
A [`mount`](#mount-9251c5) block (within [`stateful_service.configuration.parameters.file`](#file-343e3f)) supports the following:
|
|
2753
|
+
|
|
2754
|
+
<a id="mode-744d6b"></a>• [`mode`](#mode-744d6b) - Optional String Defaults to `VOLUME_MOUNT_READ_ONLY`<br>Possible values are `VOLUME_MOUNT_READ_ONLY`, `VOLUME_MOUNT_READ_WRITE`<br>[Enum: VOLUME_MOUNT_READ_ONLY|VOLUME_MOUNT_READ_WRITE] Mode in which the volume should be mounted to the workload - VOLUME_MOUNT_READ_ONLY: ReadOnly Mount the volume in read-only mode - VOLUME_MOUNT_READ_WRITE: Read Write Mount the volume in read-write mode
|
|
2755
|
+
|
|
2756
|
+
<a id="path-6612e2"></a>• [`mount_path`](#path-6612e2) - Optional String<br>Path within the workload container at which the volume should be mounted. Must not contain ':'
|
|
2757
|
+
|
|
2758
|
+
<a id="path-1fc41c"></a>• [`sub_path`](#path-1fc41c) - Optional String Defaults to `'' (volume's root)`<br>Path within the volume from which the workload's volume should be mounted
|
|
2759
|
+
|
|
2760
|
+
#### Stateful Service Containers
|
|
2761
|
+
|
|
2762
|
+
A [`containers`](#stateful-service-containers) block (within [`stateful_service`](#stateful-service)) supports the following:
|
|
2763
|
+
|
|
2764
|
+
<a id="stateful-service-containers-args"></a>• [`args`](#stateful-service-containers-args) - Optional List<br>Arguments to the entrypoint. Overrides the docker image's CMD
|
|
2765
|
+
|
|
2766
|
+
<a id="stateful-service-containers-command"></a>• [`command`](#stateful-service-containers-command) - Optional List<br>Command to execute. Overrides the docker image's ENTRYPOINT
|
|
2767
|
+
|
|
2768
|
+
<a id="flavor-0d2be0"></a>• [`custom_flavor`](#flavor-0d2be0) - Optional Block<br>Type establishes a direct reference from one object(the referrer) to another(the referred). Such a reference is in form of tenant/namespace/name<br>See [Custom Flavor](#flavor-0d2be0) below.
|
|
2769
|
+
|
|
2770
|
+
<a id="flavor-c485c6"></a>• [`default_flavor`](#flavor-c485c6) - Optional Block<br>Enable this option
|
|
2771
|
+
|
|
2772
|
+
<a id="stateful-service-containers-flavor"></a>• [`flavor`](#stateful-service-containers-flavor) - Optional String Defaults to `CONTAINER_FLAVOR_TYPE_TINY`<br>Possible values are `CONTAINER_FLAVOR_TYPE_TINY`, `CONTAINER_FLAVOR_TYPE_MEDIUM`, `CONTAINER_FLAVOR_TYPE_LARGE`<br>[Enum: CONTAINER_FLAVOR_TYPE_TINY|CONTAINER_FLAVOR_TYPE_MEDIUM|CONTAINER_FLAVOR_TYPE_LARGE] Container Flavor type - CONTAINER_FLAVOR_TYPE_TINY: Tiny Tiny containers have limit of 0.1 vCPU and 256 MiB (mebibyte) memory - CONTAINER_FLAVOR_TYPE_MEDIUM: Medium Medium containers have limit of 0.25 vCPU and 512 MiB (mebibyte) memory - CONTAINER_FLAVOR_TYPE_LARGE: Large Large containers have
|
|
2773
|
+
|
|
2774
|
+
<a id="stateful-service-containers-image"></a>• [`image`](#stateful-service-containers-image) - Optional Block<br>ImageType configures the image to use, how to pull the image, and the associated secrets to use if any<br>See [Image](#stateful-service-containers-image) below.
|
|
2775
|
+
|
|
2776
|
+
<a id="container-7dbf25"></a>• [`init_container`](#container-7dbf25) - Optional Bool<br>Specialized container that runs before application container and runs to completion
|
|
2777
|
+
|
|
2778
|
+
<a id="check-82bd07"></a>• [`liveness_check`](#check-82bd07) - Optional Block<br>HealthCheckType describes a health check to be performed against a container to determine whether it has started up or is alive or ready to receive traffic<br>See [Liveness Check](#check-82bd07) below.
|
|
2779
|
+
|
|
2780
|
+
<a id="stateful-service-containers-name"></a>• [`name`](#stateful-service-containers-name) - Optional String<br>Name. Name of the container
|
|
2781
|
+
|
|
2782
|
+
<a id="check-81b532"></a>• [`readiness_check`](#check-81b532) - Optional Block<br>HealthCheckType describes a health check to be performed against a container to determine whether it has started up or is alive or ready to receive traffic<br>See [Readiness Check](#check-81b532) below.
|
|
2783
|
+
|
|
2784
|
+
#### Stateful Service Containers Custom Flavor
|
|
2785
|
+
|
|
2786
|
+
A [`custom_flavor`](#flavor-0d2be0) block (within [`stateful_service.containers`](#stateful-service-containers)) supports the following:
|
|
2787
|
+
|
|
2788
|
+
<a id="name-37698d"></a>• [`name`](#name-37698d) - Optional String<br>When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object's(e.g. Route's) name
|
|
2789
|
+
|
|
2790
|
+
<a id="namespace-db9524"></a>• [`namespace`](#namespace-db9524) - Optional String<br>When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object's(e.g. Route's) namespace
|
|
2791
|
+
|
|
2792
|
+
<a id="tenant-a8296a"></a>• [`tenant`](#tenant-a8296a) - Optional String<br>When a configuration object(e.g. Virtual_host) refers to another(e.g route) then tenant will hold the referred object's(e.g. Route's) tenant
|
|
2793
|
+
|
|
2794
|
+
#### Stateful Service Containers Image
|
|
2795
|
+
|
|
2796
|
+
An [`image`](#stateful-service-containers-image) block (within [`stateful_service.containers`](#stateful-service-containers)) supports the following:
|
|
2797
|
+
|
|
2798
|
+
<a id="registry-78045a"></a>• [`container_registry`](#registry-78045a) - Optional Block<br>Type establishes a direct reference from one object(the referrer) to another(the referred). Such a reference is in form of tenant/namespace/name<br>See [Container Registry](#registry-78045a) below.
|
|
2799
|
+
|
|
2800
|
+
<a id="stateful-service-containers-image-name"></a>• [`name`](#stateful-service-containers-image-name) - Optional String<br>Name is a container image which are usually given a name such as alpine, ubuntu, or quay.I/O/etcd:0.13. The format is registry/image:tag or registry/image@image-digest. If registry is not specified, the Docker public registry is assumed
|
|
2801
|
+
|
|
2802
|
+
<a id="public-27eb7d"></a>• [`public`](#public-27eb7d) - Optional Block<br>Enable this option
|
|
2803
|
+
|
|
2804
|
+
<a id="policy-013972"></a>• [`pull_policy`](#policy-013972) - Optional String Defaults to `IMAGE_PULL_POLICY_DEFAULT`<br>Possible values are `IMAGE_PULL_POLICY_DEFAULT`, `IMAGE_PULL_POLICY_IF_NOT_PRESENT`, `IMAGE_PULL_POLICY_ALWAYS`, `IMAGE_PULL_POLICY_NEVER`<br>[Enum: IMAGE_PULL_POLICY_DEFAULT|IMAGE_PULL_POLICY_IF_NOT_PRESENT|IMAGE_PULL_POLICY_ALWAYS|IMAGE_PULL_POLICY_NEVER] Image pull policy type enumerates the policy choices to use for pulling the image prior to starting the workload - IMAGE_PULL_POLICY_DEFAULT: Default Default will always pull image if :latest tag is specified in image name. If :latest tag is not specified in image name, it will pull image only
|
|
2805
|
+
|
|
2806
|
+
#### Stateful Service Containers Image Container Registry
|
|
2807
|
+
|
|
2808
|
+
A [`container_registry`](#registry-78045a) block (within [`stateful_service.containers.image`](#stateful-service-containers-image)) supports the following:
|
|
2809
|
+
|
|
2810
|
+
<a id="name-4d4804"></a>• [`name`](#name-4d4804) - Optional String<br>When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object's(e.g. Route's) name
|
|
2811
|
+
|
|
2812
|
+
<a id="namespace-f6725d"></a>• [`namespace`](#namespace-f6725d) - Optional String<br>When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object's(e.g. Route's) namespace
|
|
2813
|
+
|
|
2814
|
+
<a id="tenant-1ee737"></a>• [`tenant`](#tenant-1ee737) - Optional String<br>When a configuration object(e.g. Virtual_host) refers to another(e.g route) then tenant will hold the referred object's(e.g. Route's) tenant
|
|
2815
|
+
|
|
2816
|
+
#### Stateful Service Containers Liveness Check
|
|
2817
|
+
|
|
2818
|
+
A [`liveness_check`](#check-82bd07) block (within [`stateful_service.containers`](#stateful-service-containers)) supports the following:
|
|
2819
|
+
|
|
2820
|
+
<a id="check-d745b6"></a>• [`exec_health_check`](#check-d745b6) - Optional Block<br>ExecHealthCheckType describes a health check based on 'run in container' action. Exit status of 0 is treated as live/healthy and non-zero is unhealthy<br>See [Exec Health Check](#check-d745b6) below.
|
|
2821
|
+
|
|
2822
|
+
<a id="threshold-87f287"></a>• [`healthy_threshold`](#threshold-87f287) - Optional Number<br>Number of consecutive successful responses after having failed before declaring healthy. In other words, this is the number of healthy health checks required before marking healthy. Note that during startup and liveliness, only a single successful health check is required to mark a container
|
|
2823
|
+
|
|
2824
|
+
<a id="check-3fba6e"></a>• [`http_health_check`](#check-3fba6e) - Optional Block<br>HTTPHealthCheckType describes a health check based on HTTP GET requests<br>See [HTTP Health Check](#check-3fba6e) below.
|
|
2825
|
+
|
|
2826
|
+
<a id="delay-58e58a"></a>• [`initial_delay`](#delay-58e58a) - Optional Number<br>Number of seconds after the container has started before health checks are initiated
|
|
2827
|
+
|
|
2828
|
+
<a id="interval-2c75b3"></a>• [`interval`](#interval-2c75b3) - Optional Number<br>Time interval in seconds between two health check requests
|
|
2829
|
+
|
|
2830
|
+
<a id="check-485f86"></a>• [`tcp_health_check`](#check-485f86) - Optional Block<br>TCPHealthCheckType describes a health check based on opening a TCP connection<br>See [TCP Health Check](#check-485f86) below.
|
|
2831
|
+
|
|
2832
|
+
<a id="timeout-4a23bd"></a>• [`timeout`](#timeout-4a23bd) - Optional Number<br>Timeout in seconds to wait for successful response. In other words, it is the time to wait for a health check response. If the timeout is reached the health check attempt will be considered a failure
|
|
2833
|
+
|
|
2834
|
+
<a id="threshold-50b947"></a>• [`unhealthy_threshold`](#threshold-50b947) - Optional Number<br>Number of consecutive failed responses before declaring unhealthy. In other words, this is the number of unhealthy health checks required before a container is marked unhealthy
|
|
2835
|
+
|
|
2836
|
+
#### Stateful Service Containers Liveness Check Exec Health Check
|
|
2837
|
+
|
|
2838
|
+
<a id="deep-5f4a6d"></a>Deeply nested **Check** block collapsed for readability.
|
|
2839
|
+
|
|
2840
|
+
#### Stateful Service Containers Liveness Check HTTP Health Check
|
|
2841
|
+
|
|
2842
|
+
<a id="deep-18c5ba"></a>Deeply nested **Check** block collapsed for readability.
|
|
2843
|
+
|
|
2844
|
+
#### Stateful Service Containers Liveness Check HTTP Health Check Port
|
|
2845
|
+
|
|
2846
|
+
<a id="deep-13e4c2"></a>Deeply nested **Port** block collapsed for readability.
|
|
2847
|
+
|
|
2848
|
+
#### Stateful Service Containers Liveness Check TCP Health Check
|
|
2849
|
+
|
|
2850
|
+
<a id="deep-6439d2"></a>Deeply nested **Check** block collapsed for readability.
|
|
2851
|
+
|
|
2852
|
+
#### Stateful Service Containers Liveness Check TCP Health Check Port
|
|
2853
|
+
|
|
2854
|
+
<a id="deep-b68950"></a>Deeply nested **Port** block collapsed for readability.
|
|
2855
|
+
|
|
2856
|
+
#### Stateful Service Containers Readiness Check
|
|
2857
|
+
|
|
2858
|
+
A [`readiness_check`](#check-81b532) block (within [`stateful_service.containers`](#stateful-service-containers)) supports the following:
|
|
2859
|
+
|
|
2860
|
+
<a id="check-d067fc"></a>• [`exec_health_check`](#check-d067fc) - Optional Block<br>ExecHealthCheckType describes a health check based on 'run in container' action. Exit status of 0 is treated as live/healthy and non-zero is unhealthy<br>See [Exec Health Check](#check-d067fc) below.
|
|
2861
|
+
|
|
2862
|
+
<a id="threshold-793b66"></a>• [`healthy_threshold`](#threshold-793b66) - Optional Number<br>Number of consecutive successful responses after having failed before declaring healthy. In other words, this is the number of healthy health checks required before marking healthy. Note that during startup and liveliness, only a single successful health check is required to mark a container
|
|
2863
|
+
|
|
2864
|
+
<a id="check-d4b642"></a>• [`http_health_check`](#check-d4b642) - Optional Block<br>HTTPHealthCheckType describes a health check based on HTTP GET requests<br>See [HTTP Health Check](#check-d4b642) below.
|
|
2865
|
+
|
|
2866
|
+
<a id="delay-e5c176"></a>• [`initial_delay`](#delay-e5c176) - Optional Number<br>Number of seconds after the container has started before health checks are initiated
|
|
2867
|
+
|
|
2868
|
+
<a id="interval-b7509d"></a>• [`interval`](#interval-b7509d) - Optional Number<br>Time interval in seconds between two health check requests
|
|
2869
|
+
|
|
2870
|
+
<a id="check-fde4eb"></a>• [`tcp_health_check`](#check-fde4eb) - Optional Block<br>TCPHealthCheckType describes a health check based on opening a TCP connection<br>See [TCP Health Check](#check-fde4eb) below.
|
|
2871
|
+
|
|
2872
|
+
<a id="timeout-db7e11"></a>• [`timeout`](#timeout-db7e11) - Optional Number<br>Timeout in seconds to wait for successful response. In other words, it is the time to wait for a health check response. If the timeout is reached the health check attempt will be considered a failure
|
|
2873
|
+
|
|
2874
|
+
<a id="threshold-a50cc0"></a>• [`unhealthy_threshold`](#threshold-a50cc0) - Optional Number<br>Number of consecutive failed responses before declaring unhealthy. In other words, this is the number of unhealthy health checks required before a container is marked unhealthy
|
|
2875
|
+
|
|
2876
|
+
#### Stateful Service Containers Readiness Check Exec Health Check
|
|
2877
|
+
|
|
2878
|
+
<a id="deep-082de5"></a>Deeply nested **Check** block collapsed for readability.
|
|
2879
|
+
|
|
2880
|
+
#### Stateful Service Containers Readiness Check HTTP Health Check
|
|
2881
|
+
|
|
2882
|
+
<a id="deep-51404c"></a>Deeply nested **Check** block collapsed for readability.
|
|
2883
|
+
|
|
2884
|
+
#### Stateful Service Containers Readiness Check HTTP Health Check Port
|
|
2885
|
+
|
|
2886
|
+
<a id="deep-b0f7b4"></a>Deeply nested **Port** block collapsed for readability.
|
|
2887
|
+
|
|
2888
|
+
#### Stateful Service Containers Readiness Check TCP Health Check
|
|
2889
|
+
|
|
2890
|
+
<a id="deep-e587e5"></a>Deeply nested **Check** block collapsed for readability.
|
|
2891
|
+
|
|
2892
|
+
#### Stateful Service Containers Readiness Check TCP Health Check Port
|
|
2893
|
+
|
|
2894
|
+
<a id="deep-8ad9e9"></a>Deeply nested **Port** block collapsed for readability.
|
|
2895
|
+
|
|
2896
|
+
#### Stateful Service Deploy Options
|
|
2897
|
+
|
|
2898
|
+
A [`deploy_options`](#stateful-service-deploy-options) block (within [`stateful_service`](#stateful-service)) supports the following:
|
|
2899
|
+
|
|
2900
|
+
<a id="stateful-service-deploy-options-all-res"></a>• [`all_res`](#stateful-service-deploy-options-all-res) - Optional Block<br>Enable this option
|
|
2901
|
+
|
|
2902
|
+
<a id="sites-4ecc3f"></a>• [`default_virtual_sites`](#sites-4ecc3f) - Optional Block<br>Enable this option
|
|
2903
|
+
|
|
2904
|
+
<a id="sites-6c0f50"></a>• [`deploy_ce_sites`](#sites-6c0f50) - Optional Block<br>Defines a way to deploy a workload on specific Customer sites<br>See [Deploy CE Sites](#sites-6c0f50) below.
|
|
2905
|
+
|
|
2906
|
+
<a id="sites-f4950a"></a>• [`deploy_ce_virtual_sites`](#sites-f4950a) - Optional Block<br>Defines a way to deploy a workload on specific Customer virtual sites<br>See [Deploy CE Virtual Sites](#sites-f4950a) below.
|
|
2907
|
+
|
|
2908
|
+
<a id="sites-d00d51"></a>• [`deploy_re_sites`](#sites-d00d51) - Optional Block<br>Defines a way to deploy a workload on specific Regional Edge sites<br>See [Deploy RE Sites](#sites-d00d51) below.
|
|
2909
|
+
|
|
2910
|
+
<a id="sites-4ad049"></a>• [`deploy_re_virtual_sites`](#sites-4ad049) - Optional Block<br>Defines a way to deploy a workload on specific Regional Edge virtual sites<br>See [Deploy RE Virtual Sites](#sites-4ad049) below.
|
|
2911
|
+
|
|
2912
|
+
#### Stateful Service Deploy Options Deploy CE Sites
|
|
2913
|
+
|
|
2914
|
+
A [`deploy_ce_sites`](#sites-6c0f50) block (within [`stateful_service.deploy_options`](#stateful-service-deploy-options)) supports the following:
|
|
2915
|
+
|
|
2916
|
+
<a id="site-0e137b"></a>• [`site`](#site-0e137b) - Optional Block<br>Which customer sites should this workload be deployed<br>See [Site](#site-0e137b) below.
|
|
2917
|
+
|
|
2918
|
+
#### Stateful Service Deploy Options Deploy CE Sites Site
|
|
2919
|
+
|
|
2920
|
+
<a id="deep-d27353"></a>Deeply nested **Site** block collapsed for readability.
|
|
2921
|
+
|
|
2922
|
+
#### Stateful Service Deploy Options Deploy CE Virtual Sites
|
|
2923
|
+
|
|
2924
|
+
<a id="deep-030779"></a>Deeply nested **Sites** block collapsed for readability.
|
|
2925
|
+
|
|
2926
|
+
#### Stateful Service Deploy Options Deploy CE Virtual Sites Virtual Site
|
|
2927
|
+
|
|
2928
|
+
<a id="deep-59c8af"></a>Deeply nested **Site** block collapsed for readability.
|
|
2929
|
+
|
|
2930
|
+
#### Stateful Service Deploy Options Deploy RE Sites
|
|
2931
|
+
|
|
2932
|
+
A [`deploy_re_sites`](#sites-d00d51) block (within [`stateful_service.deploy_options`](#stateful-service-deploy-options)) supports the following:
|
|
2933
|
+
|
|
2934
|
+
<a id="site-92faf4"></a>• [`site`](#site-92faf4) - Optional Block<br>Which regional edge sites should this workload be deployed<br>See [Site](#site-92faf4) below.
|
|
2935
|
+
|
|
2936
|
+
#### Stateful Service Deploy Options Deploy RE Sites Site
|
|
2937
|
+
|
|
2938
|
+
<a id="deep-d51a07"></a>Deeply nested **Site** block collapsed for readability.
|
|
2939
|
+
|
|
2940
|
+
#### Stateful Service Deploy Options Deploy RE Virtual Sites
|
|
2941
|
+
|
|
2942
|
+
<a id="deep-77c59a"></a>Deeply nested **Sites** block collapsed for readability.
|
|
2943
|
+
|
|
2944
|
+
#### Stateful Service Deploy Options Deploy RE Virtual Sites Virtual Site
|
|
2945
|
+
|
|
2946
|
+
<a id="deep-be1ff4"></a>Deeply nested **Site** block collapsed for readability.
|
|
2947
|
+
|
|
2948
|
+
#### Stateful Service Persistent Volumes
|
|
2949
|
+
|
|
2950
|
+
A [`persistent_volumes`](#stateful-service-persistent-volumes) block (within [`stateful_service`](#stateful-service)) supports the following:
|
|
2951
|
+
|
|
2952
|
+
<a id="name-5e24ab"></a>• [`name`](#name-5e24ab) - Optional String<br>Name. Name of the volume
|
|
2953
|
+
|
|
2954
|
+
<a id="volume-9c1fa2"></a>• [`persistent_volume`](#volume-9c1fa2) - Optional Block<br>Volume containing the Persistent Storage for the workload<br>See [Persistent Volume](#volume-9c1fa2) below.
|
|
2955
|
+
|
|
2956
|
+
#### Stateful Service Persistent Volumes Persistent Volume
|
|
2957
|
+
|
|
2958
|
+
A [`persistent_volume`](#volume-9c1fa2) block (within [`stateful_service.persistent_volumes`](#stateful-service-persistent-volumes)) supports the following:
|
|
2959
|
+
|
|
2960
|
+
<a id="mount-332197"></a>• [`mount`](#mount-332197) - Optional Block<br>Volume mount describes how volume is mounted inside a workload<br>See [Mount](#mount-332197) below.
|
|
2961
|
+
|
|
2962
|
+
<a id="storage-33a80f"></a>• [`storage`](#storage-33a80f) - Optional Block<br>Persistent storage configuration is used to configure Persistent Volume Claim (PVC)<br>See [Storage](#storage-33a80f) below.
|
|
2963
|
+
|
|
2964
|
+
#### Stateful Service Persistent Volumes Persistent Volume Mount
|
|
2965
|
+
|
|
2966
|
+
A [`mount`](#mount-332197) block (within [`stateful_service.persistent_volumes.persistent_volume`](#volume-9c1fa2)) supports the following:
|
|
2967
|
+
|
|
2968
|
+
<a id="mode-90ab42"></a>• [`mode`](#mode-90ab42) - Optional String Defaults to `VOLUME_MOUNT_READ_ONLY`<br>Possible values are `VOLUME_MOUNT_READ_ONLY`, `VOLUME_MOUNT_READ_WRITE`<br>[Enum: VOLUME_MOUNT_READ_ONLY|VOLUME_MOUNT_READ_WRITE] Mode in which the volume should be mounted to the workload - VOLUME_MOUNT_READ_ONLY: ReadOnly Mount the volume in read-only mode - VOLUME_MOUNT_READ_WRITE: Read Write Mount the volume in read-write mode
|
|
2969
|
+
|
|
2970
|
+
<a id="path-a261fb"></a>• [`mount_path`](#path-a261fb) - Optional String<br>Path within the workload container at which the volume should be mounted. Must not contain ':'
|
|
2971
|
+
|
|
2972
|
+
<a id="path-056461"></a>• [`sub_path`](#path-056461) - Optional String Defaults to `'' (volume's root)`<br>Path within the volume from which the workload's volume should be mounted
|
|
2973
|
+
|
|
2974
|
+
#### Stateful Service Persistent Volumes Persistent Volume Storage
|
|
2975
|
+
|
|
2976
|
+
A [`storage`](#storage-33a80f) block (within [`stateful_service.persistent_volumes.persistent_volume`](#volume-9c1fa2)) supports the following:
|
|
2977
|
+
|
|
2978
|
+
<a id="mode-04d189"></a>• [`access_mode`](#mode-04d189) - Optional String Defaults to `ACCESS_MODE_READ_WRITE_ONCE`<br>Possible values are `ACCESS_MODE_READ_WRITE_ONCE`, `ACCESS_MODE_READ_WRITE_MANY`, `ACCESS_MODE_READ_ONLY_MANY`<br>[Enum: ACCESS_MODE_READ_WRITE_ONCE|ACCESS_MODE_READ_WRITE_MANY|ACCESS_MODE_READ_ONLY_MANY] Persistence storage access mode is used to configure access mode for persistent storage - ACCESS_MODE_READ_WRITE_ONCE: Read Write Once Read Write Once is used to mount persistent storage in read/write mode to exactly 1 host - ACCESS_MODE_READ_WRITE_MANY: Read Write Many Read Write Many is used
|
|
2979
|
+
|
|
2980
|
+
<a id="name-6dd4e7"></a>• [`class_name`](#name-6dd4e7) - Optional String<br>Use the specified class name
|
|
2981
|
+
|
|
2982
|
+
<a id="default-def9af"></a>• [`default`](#default-def9af) - Optional Block<br>Enable this option
|
|
2983
|
+
|
|
2984
|
+
<a id="size-f9136f"></a>• [`storage_size`](#size-f9136f) - Optional Number<br>Size in GiB of the persistent storage
|
|
2985
|
+
|
|
2986
|
+
#### Stateful Service Volumes
|
|
2987
|
+
|
|
2988
|
+
A [`volumes`](#stateful-service-volumes) block (within [`stateful_service`](#stateful-service)) supports the following:
|
|
2989
|
+
|
|
2990
|
+
<a id="stateful-service-volumes-empty-dir"></a>• [`empty_dir`](#stateful-service-volumes-empty-dir) - Optional Block<br>Volume containing a temporary directory whose lifetime is the same as a replica of a workload<br>See [Empty Dir](#stateful-service-volumes-empty-dir) below.
|
|
2991
|
+
|
|
2992
|
+
<a id="stateful-service-volumes-host-path"></a>• [`host_path`](#stateful-service-volumes-host-path) - Optional Block<br>Volume containing a host mapped path into the workload<br>See [Host Path](#stateful-service-volumes-host-path) below.
|
|
2993
|
+
|
|
2994
|
+
<a id="stateful-service-volumes-name"></a>• [`name`](#stateful-service-volumes-name) - Optional String<br>Name. Name of the volume
|
|
2995
|
+
|
|
2996
|
+
#### Stateful Service Volumes Empty Dir
|
|
2997
|
+
|
|
2998
|
+
An [`empty_dir`](#stateful-service-volumes-empty-dir) block (within [`stateful_service.volumes`](#stateful-service-volumes)) supports the following:
|
|
2999
|
+
|
|
3000
|
+
<a id="mount-0d2125"></a>• [`mount`](#mount-0d2125) - Optional Block<br>Volume mount describes how volume is mounted inside a workload<br>See [Mount](#mount-0d2125) below.
|
|
3001
|
+
|
|
3002
|
+
<a id="limit-15665a"></a>• [`size_limit`](#limit-15665a) - Optional Number<br>Size Limit (in GiB)
|
|
3003
|
+
|
|
3004
|
+
#### Stateful Service Volumes Empty Dir Mount
|
|
3005
|
+
|
|
3006
|
+
A [`mount`](#mount-0d2125) block (within [`stateful_service.volumes.empty_dir`](#stateful-service-volumes-empty-dir)) supports the following:
|
|
3007
|
+
|
|
3008
|
+
<a id="mode-c70f04"></a>• [`mode`](#mode-c70f04) - Optional String Defaults to `VOLUME_MOUNT_READ_ONLY`<br>Possible values are `VOLUME_MOUNT_READ_ONLY`, `VOLUME_MOUNT_READ_WRITE`<br>[Enum: VOLUME_MOUNT_READ_ONLY|VOLUME_MOUNT_READ_WRITE] Mode in which the volume should be mounted to the workload - VOLUME_MOUNT_READ_ONLY: ReadOnly Mount the volume in read-only mode - VOLUME_MOUNT_READ_WRITE: Read Write Mount the volume in read-write mode
|
|
3009
|
+
|
|
3010
|
+
<a id="path-a872b3"></a>• [`mount_path`](#path-a872b3) - Optional String<br>Path within the workload container at which the volume should be mounted. Must not contain ':'
|
|
3011
|
+
|
|
3012
|
+
<a id="path-812c0d"></a>• [`sub_path`](#path-812c0d) - Optional String Defaults to `'' (volume's root)`<br>Path within the volume from which the workload's volume should be mounted
|
|
3013
|
+
|
|
3014
|
+
#### Stateful Service Volumes Host Path
|
|
3015
|
+
|
|
3016
|
+
A [`host_path`](#stateful-service-volumes-host-path) block (within [`stateful_service.volumes`](#stateful-service-volumes)) supports the following:
|
|
3017
|
+
|
|
3018
|
+
<a id="mount-ebf189"></a>• [`mount`](#mount-ebf189) - Optional Block<br>Volume mount describes how volume is mounted inside a workload<br>See [Mount](#mount-ebf189) below.
|
|
3019
|
+
|
|
3020
|
+
<a id="stateful-service-volumes-host-path-path"></a>• [`path`](#stateful-service-volumes-host-path-path) - Optional String<br>Path of the directory on the host
|
|
3021
|
+
|
|
3022
|
+
#### Stateful Service Volumes Host Path Mount
|
|
3023
|
+
|
|
3024
|
+
A [`mount`](#mount-ebf189) block (within [`stateful_service.volumes.host_path`](#stateful-service-volumes-host-path)) supports the following:
|
|
3025
|
+
|
|
3026
|
+
<a id="mode-0cbd14"></a>• [`mode`](#mode-0cbd14) - Optional String Defaults to `VOLUME_MOUNT_READ_ONLY`<br>Possible values are `VOLUME_MOUNT_READ_ONLY`, `VOLUME_MOUNT_READ_WRITE`<br>[Enum: VOLUME_MOUNT_READ_ONLY|VOLUME_MOUNT_READ_WRITE] Mode in which the volume should be mounted to the workload - VOLUME_MOUNT_READ_ONLY: ReadOnly Mount the volume in read-only mode - VOLUME_MOUNT_READ_WRITE: Read Write Mount the volume in read-write mode
|
|
3027
|
+
|
|
3028
|
+
<a id="path-4fa8ea"></a>• [`mount_path`](#path-4fa8ea) - Optional String<br>Path within the workload container at which the volume should be mounted. Must not contain ':'
|
|
3029
|
+
|
|
3030
|
+
<a id="path-acb5bd"></a>• [`sub_path`](#path-acb5bd) - Optional String Defaults to `'' (volume's root)`<br>Path within the volume from which the workload's volume should be mounted
|
|
3031
|
+
|
|
90
3032
|
#### Timeouts
|
|
91
3033
|
|
|
92
3034
|
A [`timeouts`](#timeouts) block supports the following:
|