@robinmordasiewicz/f5xc-terraform-mcp 3.5.0 → 3.6.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +283 -104
- package/dist/docs/data-sources/bgp.md +2 -2
- package/dist/docs/data-sources/discovery.md +2 -2
- package/dist/docs/data-sources/fast_acl.md +2 -2
- package/dist/docs/data-sources/fast_acl_rule.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/route.md +2 -2
- package/dist/docs/data-sources/site.md +2 -2
- package/dist/docs/resources/address_allocator.md +7 -7
- package/dist/docs/resources/advertise_policy.md +57 -57
- package/dist/docs/resources/alert_policy.md +40 -40
- package/dist/docs/resources/alert_receiver.md +57 -57
- package/dist/docs/resources/api_crawler.md +13 -13
- package/dist/docs/resources/api_definition.md +11 -11
- package/dist/docs/resources/api_discovery.md +4 -4
- package/dist/docs/resources/api_testing.md +27 -27
- package/dist/docs/resources/apm.md +40 -40
- package/dist/docs/resources/app_api_group.md +20 -20
- package/dist/docs/resources/app_firewall.md +50 -50
- package/dist/docs/resources/app_setting.md +19 -19
- package/dist/docs/resources/app_type.md +7 -7
- package/dist/docs/resources/authentication.md +29 -29
- package/dist/docs/resources/aws_tgw_site.md +140 -140
- package/dist/docs/resources/aws_vpc_site.md +174 -174
- package/dist/docs/resources/azure_vnet_site.md +245 -245
- package/dist/docs/resources/bgp.md +37 -205
- package/dist/docs/resources/bgp_asn_set.md +1 -1
- package/dist/docs/resources/bgp_routing_policy.md +19 -19
- package/dist/docs/resources/bot_defense_app_infrastructure.md +12 -12
- package/dist/docs/resources/cdn_cache_rule.md +5 -5
- package/dist/docs/resources/cdn_loadbalancer.md +418 -418
- package/dist/docs/resources/certificate.md +1 -1
- package/dist/docs/resources/certificate_chain.md +1 -1
- package/dist/docs/resources/cloud_connect.md +28 -28
- package/dist/docs/resources/cloud_credentials.md +35 -35
- package/dist/docs/resources/cloud_elastic_ip.md +8 -8
- package/dist/docs/resources/cloud_link.md +36 -36
- package/dist/docs/resources/cluster.md +86 -86
- package/dist/docs/resources/cminstance.md +22 -22
- package/dist/docs/resources/code_base_integration.md +24 -24
- package/dist/docs/resources/container_registry.md +13 -13
- package/dist/docs/resources/crl.md +1 -1
- package/dist/docs/resources/data_type.md +16 -16
- package/dist/docs/resources/dc_cluster_group.md +4 -4
- package/dist/docs/resources/discovery.md +8 -259
- package/dist/docs/resources/dns_compliance_checks.md +1 -1
- package/dist/docs/resources/dns_domain.md +3 -3
- package/dist/docs/resources/endpoint.md +44 -44
- package/dist/docs/resources/enhanced_firewall_policy.md +51 -51
- package/dist/docs/resources/external_connector.md +42 -42
- package/dist/docs/resources/fast_acl.md +60 -166
- package/dist/docs/resources/fast_acl_rule.md +28 -28
- package/dist/docs/resources/filter_set.md +10 -10
- package/dist/docs/resources/fleet.md +160 -160
- package/dist/docs/resources/forward_proxy_policy.md +82 -82
- package/dist/docs/resources/forwarding_class.md +14 -14
- package/dist/docs/resources/gcp_vpc_site.md +152 -152
- package/dist/docs/resources/global_log_receiver.md +238 -238
- package/dist/docs/resources/healthcheck.md +17 -17
- package/dist/docs/resources/http_loadbalancer.md +1003 -1003
- package/dist/docs/resources/irule.md +5 -7
- package/dist/docs/resources/log_receiver.md +825 -44
- package/dist/docs/resources/malicious_user_mitigation.md +10 -10
- package/dist/docs/resources/nat_policy.md +86 -86
- package/dist/docs/resources/network_connector.md +31 -31
- package/dist/docs/resources/network_firewall.md +22 -22
- package/dist/docs/resources/network_interface.md +77 -77
- package/dist/docs/resources/network_policy.md +38 -217
- package/dist/docs/resources/network_policy_rule.md +21 -21
- package/dist/docs/resources/network_policy_view.md +65 -65
- package/dist/docs/resources/nfv_service.md +76 -76
- package/dist/docs/resources/nginx_service_discovery.md +10 -10
- package/dist/docs/resources/origin_pool.md +166 -166
- package/dist/docs/resources/policer.md +4 -4
- package/dist/docs/resources/policy_based_routing.md +28 -28
- package/dist/docs/resources/protocol_inspection.md +12 -12
- package/dist/docs/resources/protocol_policer.md +14 -14
- package/dist/docs/resources/proxy.md +111 -111
- package/dist/docs/resources/rate_limiter.md +15 -15
- package/dist/docs/resources/rate_limiter_policy.md +56 -56
- package/dist/docs/resources/route.md +183 -183
- package/dist/docs/resources/secret_management_access.md +68 -68
- package/dist/docs/resources/securemesh_site.md +1619 -258
- package/dist/docs/resources/segment.md +4 -4
- package/dist/docs/resources/sensitive_data_policy.md +9 -9
- package/dist/docs/resources/service_policy.md +175 -175
- package/dist/docs/resources/service_policy_rule.md +142 -142
- package/dist/docs/resources/site.md +381 -303
- package/dist/docs/resources/site_mesh_group.md +18 -18
- package/dist/docs/resources/subnet.md +17 -17
- package/dist/docs/resources/tcp_loadbalancer.md +130 -130
- package/dist/docs/resources/tenant_configuration.md +10 -10
- package/dist/docs/resources/trusted_ca_list.md +1 -1
- package/dist/docs/resources/tunnel.md +36 -36
- package/dist/docs/resources/udp_loadbalancer.md +59 -59
- package/dist/docs/resources/usb_policy.md +6 -6
- package/dist/docs/resources/user_identification.md +16 -16
- package/dist/docs/resources/virtual_host.md +225 -225
- package/dist/docs/resources/virtual_network.md +14 -14
- package/dist/docs/resources/virtual_site.md +3 -3
- package/dist/docs/resources/voltstack_site.md +141 -141
- package/dist/docs/resources/waf_exclusion_policy.md +17 -17
- package/dist/docs/resources/workload.md +327 -327
- package/dist/docs/resources/workload_flavor.md +3 -3
- package/dist/metadata/resource-metadata.json +1484 -942
- package/dist/types.d.ts +11 -0
- package/dist/types.d.ts.map +1 -1
- package/dist/types.js.map +1 -1
- package/package.json +1 -1
|
@@ -72,10 +72,10 @@ resource "f5xc_workload" "example" {
|
|
|
72
72
|
### Spec Argument Reference
|
|
73
73
|
|
|
74
74
|
-> **One of the following:**
|
|
75
|
-
• <a id="job"></a>[`job`](#job) - Optional Block<br>
|
|
76
|
-
<br><br>• <a id="service"></a>[`service`](#service) - Optional Block<br>
|
|
77
|
-
<br><br>• <a id="simple-service"></a>[`simple_service`](#simple-service) - Optional Block<br>
|
|
78
|
-
<br><br>• <a id="stateful-service"></a>[`stateful_service`](#stateful-service) - Optional Block<br>
|
|
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
|
|
79
79
|
|
|
80
80
|
<a id="timeouts"></a>• [`timeouts`](#timeouts) - Optional Block
|
|
81
81
|
|
|
@@ -91,13 +91,13 @@ In addition to all arguments above, the following attributes are exported:
|
|
|
91
91
|
|
|
92
92
|
A [`job`](#job) block supports the following:
|
|
93
93
|
|
|
94
|
-
<a id="job-configuration"></a>• [`configuration`](#job-configuration) - Optional Block<br>Configuration
|
|
94
|
+
<a id="job-configuration"></a>• [`configuration`](#job-configuration) - Optional Block<br>Configuration parameters of the workload<br>See [Configuration](#job-configuration) below.
|
|
95
95
|
|
|
96
|
-
<a id="job-containers"></a>• [`containers`](#job-containers) - Optional Block<br>Containers
|
|
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
97
|
|
|
98
|
-
<a id="job-deploy-options"></a>• [`deploy_options`](#job-deploy-options) - Optional Block<br>Deploy OPTIONS
|
|
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
99
|
|
|
100
|
-
<a id="job-num-replicas"></a>• [`num_replicas`](#job-num-replicas) - Optional Number<br>Number of
|
|
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
101
|
|
|
102
102
|
<a id="job-volumes"></a>• [`volumes`](#job-volumes) - Optional Block<br>Volumes. Volumes for the job<br>See [Volumes](#job-volumes) below.
|
|
103
103
|
|
|
@@ -129,7 +129,7 @@ A [`file`](#job-configuration-parameters-file) block (within [`job.configuration
|
|
|
129
129
|
|
|
130
130
|
<a id="job-configuration-parameters-file-data"></a>• [`data`](#job-configuration-parameters-file-data) - Optional String<br>Data. File data
|
|
131
131
|
|
|
132
|
-
<a id="job-configuration-parameters-file-mount"></a>• [`mount`](#job-configuration-parameters-file-mount) - Optional Block<br>Volume
|
|
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
133
|
|
|
134
134
|
<a id="job-configuration-parameters-file-name"></a>• [`name`](#job-configuration-parameters-file-name) - Optional String<br>Name. Name of the file
|
|
135
135
|
|
|
@@ -139,103 +139,103 @@ A [`file`](#job-configuration-parameters-file) block (within [`job.configuration
|
|
|
139
139
|
|
|
140
140
|
A [`mount`](#job-configuration-parameters-file-mount) block (within [`job.configuration.parameters.file`](#job-configuration-parameters-file)) supports the following:
|
|
141
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
|
|
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
143
|
|
|
144
|
-
<a id="path-4baddf"></a>• [`mount_path`](#path-4baddf) - Optional String<br>
|
|
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
145
|
|
|
146
|
-
<a id="path-5fe649"></a>• [`sub_path`](#path-5fe649) - Optional String Defaults to `'' (volume's root)`<br>
|
|
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
147
|
|
|
148
148
|
#### Job Containers
|
|
149
149
|
|
|
150
150
|
A [`containers`](#job-containers) block (within [`job`](#job)) supports the following:
|
|
151
151
|
|
|
152
|
-
<a id="job-containers-args"></a>• [`args`](#job-containers-args) - Optional List<br>Arguments
|
|
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
153
|
|
|
154
|
-
<a id="job-containers-command"></a>• [`command`](#job-containers-command) - Optional List<br>Command
|
|
154
|
+
<a id="job-containers-command"></a>• [`command`](#job-containers-command) - Optional List<br>Command to execute. Overrides the docker image's ENTRYPOINT
|
|
155
155
|
|
|
156
|
-
<a id="job-containers-custom-flavor"></a>• [`custom_flavor`](#job-containers-custom-flavor) - Optional Block<br>
|
|
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
157
|
|
|
158
|
-
<a id="job-containers-default-flavor"></a>• [`default_flavor`](#job-containers-default-flavor) - Optional Block<br>
|
|
158
|
+
<a id="job-containers-default-flavor"></a>• [`default_flavor`](#job-containers-default-flavor) - Optional Block<br>Can be used for messages where no values are needed
|
|
159
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
|
|
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
161
|
|
|
162
|
-
<a id="job-containers-image"></a>• [`image`](#job-containers-image) - Optional Block<br>
|
|
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
163
|
|
|
164
|
-
<a id="job-containers-init-container"></a>• [`init_container`](#job-containers-init-container) - Optional Bool<br>
|
|
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
165
|
|
|
166
|
-
<a id="job-containers-liveness-check"></a>• [`liveness_check`](#job-containers-liveness-check) - Optional Block<br>
|
|
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
167
|
|
|
168
168
|
<a id="job-containers-name"></a>• [`name`](#job-containers-name) - Optional String<br>Name. Name of the container
|
|
169
169
|
|
|
170
|
-
<a id="job-containers-readiness-check"></a>• [`readiness_check`](#job-containers-readiness-check) - Optional Block<br>
|
|
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
171
|
|
|
172
172
|
#### Job Containers Custom Flavor
|
|
173
173
|
|
|
174
174
|
A [`custom_flavor`](#job-containers-custom-flavor) block (within [`job.containers`](#job-containers)) supports the following:
|
|
175
175
|
|
|
176
|
-
<a id="job-containers-custom-flavor-name"></a>• [`name`](#job-containers-custom-flavor-name) - Optional String<br>
|
|
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
177
|
|
|
178
|
-
<a id="job-containers-custom-flavor-namespace"></a>• [`namespace`](#job-containers-custom-flavor-namespace) - Optional String<br>
|
|
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
179
|
|
|
180
|
-
<a id="job-containers-custom-flavor-tenant"></a>• [`tenant`](#job-containers-custom-flavor-tenant) - Optional String<br>
|
|
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
181
|
|
|
182
182
|
#### Job Containers Image
|
|
183
183
|
|
|
184
184
|
An [`image`](#job-containers-image) block (within [`job.containers`](#job-containers)) supports the following:
|
|
185
185
|
|
|
186
|
-
<a id="job-containers-image-container-registry"></a>• [`container_registry`](#job-containers-image-container-registry) - Optional Block<br>
|
|
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
187
|
|
|
188
|
-
<a id="job-containers-image-name"></a>• [`name`](#job-containers-image-name) - Optional String<br>
|
|
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
189
|
|
|
190
|
-
<a id="job-containers-image-public"></a>• [`public`](#job-containers-image-public) - Optional Block<br>
|
|
190
|
+
<a id="job-containers-image-public"></a>• [`public`](#job-containers-image-public) - Optional Block<br>Can be used for messages where no values are needed
|
|
191
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
|
|
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
193
|
|
|
194
194
|
#### Job Containers Image Container Registry
|
|
195
195
|
|
|
196
196
|
A [`container_registry`](#job-containers-image-container-registry) block (within [`job.containers.image`](#job-containers-image)) supports the following:
|
|
197
197
|
|
|
198
|
-
<a id="name-d8aa8e"></a>• [`name`](#name-d8aa8e) - Optional String<br>
|
|
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
199
|
|
|
200
|
-
<a id="namespace-0744ae"></a>• [`namespace`](#namespace-0744ae) - Optional String<br>
|
|
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
201
|
|
|
202
|
-
<a id="tenant-a2bf58"></a>• [`tenant`](#tenant-a2bf58) - Optional String<br>
|
|
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
203
|
|
|
204
204
|
#### Job Containers Liveness Check
|
|
205
205
|
|
|
206
206
|
A [`liveness_check`](#job-containers-liveness-check) block (within [`job.containers`](#job-containers)) supports the following:
|
|
207
207
|
|
|
208
|
-
<a id="check-738ef8"></a>• [`exec_health_check`](#check-738ef8) - Optional Block<br>
|
|
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
209
|
|
|
210
|
-
<a id="threshold-1e3058"></a>• [`healthy_threshold`](#threshold-1e3058) - Optional Number<br>
|
|
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
211
|
|
|
212
|
-
<a id="check-052b16"></a>• [`http_health_check`](#check-052b16) - Optional Block<br>
|
|
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
213
|
|
|
214
|
-
<a id="delay-3382ba"></a>• [`initial_delay`](#delay-3382ba) - Optional Number<br>
|
|
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
215
|
|
|
216
|
-
<a id="job-containers-liveness-check-interval"></a>• [`interval`](#job-containers-liveness-check-interval) - Optional Number<br>
|
|
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
217
|
|
|
218
|
-
<a id="check-71da8e"></a>• [`tcp_health_check`](#check-71da8e) - Optional Block<br>
|
|
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
219
|
|
|
220
|
-
<a id="job-containers-liveness-check-timeout"></a>• [`timeout`](#job-containers-liveness-check-timeout) - Optional Number<br>Timeout
|
|
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
221
|
|
|
222
|
-
<a id="threshold-3d7b0c"></a>• [`unhealthy_threshold`](#threshold-3d7b0c) - Optional Number<br>
|
|
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
223
|
|
|
224
224
|
#### Job Containers Liveness Check Exec Health Check
|
|
225
225
|
|
|
226
226
|
An [`exec_health_check`](#check-738ef8) block (within [`job.containers.liveness_check`](#job-containers-liveness-check)) supports the following:
|
|
227
227
|
|
|
228
|
-
<a id="command-e9b078"></a>• [`command`](#command-e9b078) - Optional List<br>Command
|
|
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
229
|
|
|
230
230
|
#### Job Containers Liveness Check HTTP Health Check
|
|
231
231
|
|
|
232
232
|
A [`http_health_check`](#check-052b16) block (within [`job.containers.liveness_check`](#job-containers-liveness-check)) supports the following:
|
|
233
233
|
|
|
234
|
-
<a id="headers-202d31"></a>• [`headers`](#headers-202d31) - Optional Block<br>
|
|
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
235
|
|
|
236
|
-
<a id="header-2aa0a5"></a>• [`host_header`](#header-2aa0a5) - Optional String<br>
|
|
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
237
|
|
|
238
|
-
<a id="path-c81de3"></a>• [`path`](#path-c81de3) - Optional String<br>Path
|
|
238
|
+
<a id="path-c81de3"></a>• [`path`](#path-c81de3) - Optional String<br>Path to access on the HTTP server
|
|
239
239
|
|
|
240
240
|
<a id="port-3d627c"></a>• [`port`](#port-3d627c) - Optional Block<br>Port. Port<br>See [Port](#port-3d627c) below.
|
|
241
241
|
|
|
@@ -257,37 +257,37 @@ A [`tcp_health_check`](#check-71da8e) block (within [`job.containers.liveness_ch
|
|
|
257
257
|
|
|
258
258
|
A [`readiness_check`](#job-containers-readiness-check) block (within [`job.containers`](#job-containers)) supports the following:
|
|
259
259
|
|
|
260
|
-
<a id="check-ce28eb"></a>• [`exec_health_check`](#check-ce28eb) - Optional Block<br>
|
|
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
261
|
|
|
262
|
-
<a id="threshold-c93f46"></a>• [`healthy_threshold`](#threshold-c93f46) - Optional Number<br>
|
|
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
263
|
|
|
264
|
-
<a id="check-c5bafc"></a>• [`http_health_check`](#check-c5bafc) - Optional Block<br>
|
|
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
265
|
|
|
266
|
-
<a id="delay-cbd49d"></a>• [`initial_delay`](#delay-cbd49d) - Optional Number<br>
|
|
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
267
|
|
|
268
|
-
<a id="job-containers-readiness-check-interval"></a>• [`interval`](#job-containers-readiness-check-interval) - Optional Number<br>
|
|
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
269
|
|
|
270
|
-
<a id="check-df7310"></a>• [`tcp_health_check`](#check-df7310) - Optional Block<br>
|
|
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
271
|
|
|
272
|
-
<a id="job-containers-readiness-check-timeout"></a>• [`timeout`](#job-containers-readiness-check-timeout) - Optional Number<br>Timeout
|
|
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
273
|
|
|
274
|
-
<a id="threshold-9e6547"></a>• [`unhealthy_threshold`](#threshold-9e6547) - Optional Number<br>
|
|
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
275
|
|
|
276
276
|
#### Job Containers Readiness Check Exec Health Check
|
|
277
277
|
|
|
278
278
|
An [`exec_health_check`](#check-ce28eb) block (within [`job.containers.readiness_check`](#job-containers-readiness-check)) supports the following:
|
|
279
279
|
|
|
280
|
-
<a id="command-c7bef1"></a>• [`command`](#command-c7bef1) - Optional List<br>Command
|
|
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
281
|
|
|
282
282
|
#### Job Containers Readiness Check HTTP Health Check
|
|
283
283
|
|
|
284
284
|
A [`http_health_check`](#check-c5bafc) block (within [`job.containers.readiness_check`](#job-containers-readiness-check)) supports the following:
|
|
285
285
|
|
|
286
|
-
<a id="headers-16116f"></a>• [`headers`](#headers-16116f) - Optional Block<br>
|
|
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
287
|
|
|
288
|
-
<a id="header-389f08"></a>• [`host_header`](#header-389f08) - Optional String<br>
|
|
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
289
|
|
|
290
|
-
<a id="path-c89875"></a>• [`path`](#path-c89875) - Optional String<br>Path
|
|
290
|
+
<a id="path-c89875"></a>• [`path`](#path-c89875) - Optional String<br>Path to access on the HTTP server
|
|
291
291
|
|
|
292
292
|
<a id="port-3b8b2e"></a>• [`port`](#port-3b8b2e) - Optional Block<br>Port. Port<br>See [Port](#port-3b8b2e) below.
|
|
293
293
|
|
|
@@ -309,39 +309,39 @@ A [`tcp_health_check`](#check-df7310) block (within [`job.containers.readiness_c
|
|
|
309
309
|
|
|
310
310
|
A [`deploy_options`](#job-deploy-options) block (within [`job`](#job)) supports the following:
|
|
311
311
|
|
|
312
|
-
<a id="job-deploy-options-all-res"></a>• [`all_res`](#job-deploy-options-all-res) - Optional Block<br>
|
|
312
|
+
<a id="job-deploy-options-all-res"></a>• [`all_res`](#job-deploy-options-all-res) - Optional Block<br>Can be used for messages where no values are needed
|
|
313
313
|
|
|
314
|
-
<a id="sites-7d16a9"></a>• [`default_virtual_sites`](#sites-7d16a9) - Optional Block<br>
|
|
314
|
+
<a id="sites-7d16a9"></a>• [`default_virtual_sites`](#sites-7d16a9) - Optional Block<br>Can be used for messages where no values are needed
|
|
315
315
|
|
|
316
|
-
<a id="job-deploy-options-deploy-ce-sites"></a>• [`deploy_ce_sites`](#job-deploy-options-deploy-ce-sites) - Optional Block<br>
|
|
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
317
|
|
|
318
|
-
<a id="sites-f9f96a"></a>• [`deploy_ce_virtual_sites`](#sites-f9f96a) - Optional Block<br>
|
|
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
319
|
|
|
320
|
-
<a id="job-deploy-options-deploy-re-sites"></a>• [`deploy_re_sites`](#job-deploy-options-deploy-re-sites) - Optional Block<br>
|
|
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
321
|
|
|
322
|
-
<a id="sites-178ece"></a>• [`deploy_re_virtual_sites`](#sites-178ece) - Optional Block<br>
|
|
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
323
|
|
|
324
324
|
#### Job Deploy Options Deploy CE Sites
|
|
325
325
|
|
|
326
326
|
A [`deploy_ce_sites`](#job-deploy-options-deploy-ce-sites) block (within [`job.deploy_options`](#job-deploy-options)) supports the following:
|
|
327
327
|
|
|
328
|
-
<a id="job-deploy-options-deploy-ce-sites-site"></a>• [`site`](#job-deploy-options-deploy-ce-sites-site) - Optional Block<br>
|
|
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
329
|
|
|
330
330
|
#### Job Deploy Options Deploy CE Sites Site
|
|
331
331
|
|
|
332
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
333
|
|
|
334
|
-
<a id="name-e258db"></a>• [`name`](#name-e258db) - Optional String<br>
|
|
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
335
|
|
|
336
|
-
<a id="namespace-064f53"></a>• [`namespace`](#namespace-064f53) - Optional String<br>
|
|
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
337
|
|
|
338
|
-
<a id="tenant-d6cc86"></a>• [`tenant`](#tenant-d6cc86) - Optional String<br>
|
|
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
339
|
|
|
340
340
|
#### Job Deploy Options Deploy CE Virtual Sites
|
|
341
341
|
|
|
342
342
|
A [`deploy_ce_virtual_sites`](#sites-f9f96a) block (within [`job.deploy_options`](#job-deploy-options)) supports the following:
|
|
343
343
|
|
|
344
|
-
<a id="site-0c4045"></a>• [`virtual_site`](#site-0c4045) - Optional Block<br>
|
|
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
345
|
|
|
346
346
|
#### Job Deploy Options Deploy CE Virtual Sites Virtual Site
|
|
347
347
|
|
|
@@ -351,23 +351,23 @@ A [`deploy_ce_virtual_sites`](#sites-f9f96a) block (within [`job.deploy_options`
|
|
|
351
351
|
|
|
352
352
|
A [`deploy_re_sites`](#job-deploy-options-deploy-re-sites) block (within [`job.deploy_options`](#job-deploy-options)) supports the following:
|
|
353
353
|
|
|
354
|
-
<a id="job-deploy-options-deploy-re-sites-site"></a>• [`site`](#job-deploy-options-deploy-re-sites-site) - Optional Block<br>
|
|
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
355
|
|
|
356
356
|
#### Job Deploy Options Deploy RE Sites Site
|
|
357
357
|
|
|
358
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
359
|
|
|
360
|
-
<a id="name-03e074"></a>• [`name`](#name-03e074) - Optional String<br>
|
|
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
361
|
|
|
362
|
-
<a id="namespace-f7dfa3"></a>• [`namespace`](#namespace-f7dfa3) - Optional String<br>
|
|
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
363
|
|
|
364
|
-
<a id="tenant-2ce318"></a>• [`tenant`](#tenant-2ce318) - Optional String<br>
|
|
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
365
|
|
|
366
366
|
#### Job Deploy Options Deploy RE Virtual Sites
|
|
367
367
|
|
|
368
368
|
A [`deploy_re_virtual_sites`](#sites-178ece) block (within [`job.deploy_options`](#job-deploy-options)) supports the following:
|
|
369
369
|
|
|
370
|
-
<a id="site-3ec46d"></a>• [`virtual_site`](#site-3ec46d) - Optional Block<br>
|
|
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
371
|
|
|
372
372
|
#### Job Deploy Options Deploy RE Virtual Sites Virtual Site
|
|
373
373
|
|
|
@@ -377,19 +377,19 @@ A [`deploy_re_virtual_sites`](#sites-178ece) block (within [`job.deploy_options`
|
|
|
377
377
|
|
|
378
378
|
A [`volumes`](#job-volumes) block (within [`job`](#job)) supports the following:
|
|
379
379
|
|
|
380
|
-
<a id="job-volumes-empty-dir"></a>• [`empty_dir`](#job-volumes-empty-dir) - Optional Block<br>
|
|
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
381
|
|
|
382
|
-
<a id="job-volumes-host-path"></a>• [`host_path`](#job-volumes-host-path) - Optional Block<br>
|
|
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
383
|
|
|
384
384
|
<a id="job-volumes-name"></a>• [`name`](#job-volumes-name) - Optional String<br>Name. Name of the volume
|
|
385
385
|
|
|
386
|
-
<a id="job-volumes-persistent-volume"></a>• [`persistent_volume`](#job-volumes-persistent-volume) - Optional Block<br>
|
|
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
387
|
|
|
388
388
|
#### Job Volumes Empty Dir
|
|
389
389
|
|
|
390
390
|
An [`empty_dir`](#job-volumes-empty-dir) block (within [`job.volumes`](#job-volumes)) supports the following:
|
|
391
391
|
|
|
392
|
-
<a id="job-volumes-empty-dir-mount"></a>• [`mount`](#job-volumes-empty-dir-mount) - Optional Block<br>Volume
|
|
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
393
|
|
|
394
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
395
|
|
|
@@ -397,75 +397,75 @@ An [`empty_dir`](#job-volumes-empty-dir) block (within [`job.volumes`](#job-volu
|
|
|
397
397
|
|
|
398
398
|
A [`mount`](#job-volumes-empty-dir-mount) block (within [`job.volumes.empty_dir`](#job-volumes-empty-dir)) supports the following:
|
|
399
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
|
|
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
401
|
|
|
402
|
-
<a id="job-volumes-empty-dir-mount-mount-path"></a>• [`mount_path`](#job-volumes-empty-dir-mount-mount-path) - Optional String<br>
|
|
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
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>
|
|
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
405
|
|
|
406
406
|
#### Job Volumes Host Path
|
|
407
407
|
|
|
408
408
|
A [`host_path`](#job-volumes-host-path) block (within [`job.volumes`](#job-volumes)) supports the following:
|
|
409
409
|
|
|
410
|
-
<a id="job-volumes-host-path-mount"></a>• [`mount`](#job-volumes-host-path-mount) - Optional Block<br>Volume
|
|
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
411
|
|
|
412
|
-
<a id="job-volumes-host-path-path"></a>• [`path`](#job-volumes-host-path-path) - Optional String<br>Path
|
|
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
413
|
|
|
414
414
|
#### Job Volumes Host Path Mount
|
|
415
415
|
|
|
416
416
|
A [`mount`](#job-volumes-host-path-mount) block (within [`job.volumes.host_path`](#job-volumes-host-path)) supports the following:
|
|
417
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
|
|
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
419
|
|
|
420
|
-
<a id="job-volumes-host-path-mount-mount-path"></a>• [`mount_path`](#job-volumes-host-path-mount-mount-path) - Optional String<br>
|
|
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
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>
|
|
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
423
|
|
|
424
424
|
#### Job Volumes Persistent Volume
|
|
425
425
|
|
|
426
426
|
A [`persistent_volume`](#job-volumes-persistent-volume) block (within [`job.volumes`](#job-volumes)) supports the following:
|
|
427
427
|
|
|
428
|
-
<a id="job-volumes-persistent-volume-mount"></a>• [`mount`](#job-volumes-persistent-volume-mount) - Optional Block<br>Volume
|
|
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
429
|
|
|
430
|
-
<a id="job-volumes-persistent-volume-storage"></a>• [`storage`](#job-volumes-persistent-volume-storage) - Optional Block<br>
|
|
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
431
|
|
|
432
432
|
#### Job Volumes Persistent Volume Mount
|
|
433
433
|
|
|
434
434
|
A [`mount`](#job-volumes-persistent-volume-mount) block (within [`job.volumes.persistent_volume`](#job-volumes-persistent-volume)) supports the following:
|
|
435
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
|
|
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
437
|
|
|
438
|
-
<a id="path-fda002"></a>• [`mount_path`](#path-fda002) - Optional String<br>
|
|
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
439
|
|
|
440
|
-
<a id="path-a2ee82"></a>• [`sub_path`](#path-a2ee82) - Optional String Defaults to `'' (volume's root)`<br>
|
|
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
441
|
|
|
442
442
|
#### Job Volumes Persistent Volume Storage
|
|
443
443
|
|
|
444
444
|
A [`storage`](#job-volumes-persistent-volume-storage) block (within [`job.volumes.persistent_volume`](#job-volumes-persistent-volume)) supports the following:
|
|
445
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]
|
|
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
447
|
|
|
448
|
-
<a id="name-a51d52"></a>• [`class_name`](#name-a51d52) - Optional String<br>
|
|
448
|
+
<a id="name-a51d52"></a>• [`class_name`](#name-a51d52) - Optional String<br>Use the specified class name
|
|
449
449
|
|
|
450
|
-
<a id="default-3128b0"></a>• [`default`](#default-3128b0) - Optional Block<br>
|
|
450
|
+
<a id="default-3128b0"></a>• [`default`](#default-3128b0) - Optional Block<br>Can be used for messages where no values are needed
|
|
451
451
|
|
|
452
|
-
<a id="size-81eddf"></a>• [`storage_size`](#size-81eddf) - Optional Number<br>Size
|
|
452
|
+
<a id="size-81eddf"></a>• [`storage_size`](#size-81eddf) - Optional Number<br>Size in GiB of the persistent storage
|
|
453
453
|
|
|
454
454
|
#### Service
|
|
455
455
|
|
|
456
456
|
A [`service`](#service) block supports the following:
|
|
457
457
|
|
|
458
|
-
<a id="service-advertise-options"></a>• [`advertise_options`](#service-advertise-options) - Optional Block<br>Advertise OPTIONS
|
|
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
459
|
|
|
460
|
-
<a id="service-configuration"></a>• [`configuration`](#service-configuration) - Optional Block<br>Configuration
|
|
460
|
+
<a id="service-configuration"></a>• [`configuration`](#service-configuration) - Optional Block<br>Configuration parameters of the workload<br>See [Configuration](#service-configuration) below.
|
|
461
461
|
|
|
462
|
-
<a id="service-containers"></a>• [`containers`](#service-containers) - Optional Block<br>Containers
|
|
462
|
+
<a id="service-containers"></a>• [`containers`](#service-containers) - Optional Block<br>Containers to use for service<br>See [Containers](#service-containers) below.
|
|
463
463
|
|
|
464
|
-
<a id="service-deploy-options"></a>• [`deploy_options`](#service-deploy-options) - Optional Block<br>Deploy OPTIONS
|
|
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
465
|
|
|
466
|
-
<a id="service-num-replicas"></a>• [`num_replicas`](#service-num-replicas) - Optional Number<br>Number of
|
|
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
467
|
|
|
468
|
-
<a id="service-scale-to-zero"></a>• [`scale_to_zero`](#service-scale-to-zero) - Optional Block<br>
|
|
468
|
+
<a id="service-scale-to-zero"></a>• [`scale_to_zero`](#service-scale-to-zero) - Optional Block<br>Can be used for messages where no values are needed
|
|
469
469
|
|
|
470
470
|
<a id="service-volumes"></a>• [`volumes`](#service-volumes) - Optional Block<br>Volumes. Volumes for the service<br>See [Volumes](#service-volumes) below.
|
|
471
471
|
|
|
@@ -473,19 +473,19 @@ A [`service`](#service) block supports the following:
|
|
|
473
473
|
|
|
474
474
|
An [`advertise_options`](#service-advertise-options) block (within [`service`](#service)) supports the following:
|
|
475
475
|
|
|
476
|
-
<a id="custom-206cd2"></a>• [`advertise_custom`](#custom-206cd2) - Optional Block<br>Advertise
|
|
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
477
|
|
|
478
|
-
<a id="cluster-9d3c24"></a>• [`advertise_in_cluster`](#cluster-9d3c24) - Optional Block<br>Advertise
|
|
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
479
|
|
|
480
|
-
<a id="public-fac1e6"></a>• [`advertise_on_public`](#public-fac1e6) - Optional Block<br>Advertise
|
|
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
481
|
|
|
482
|
-
<a id="advertise-e33e18"></a>• [`do_not_advertise`](#advertise-e33e18) - Optional Block<br>
|
|
482
|
+
<a id="advertise-e33e18"></a>• [`do_not_advertise`](#advertise-e33e18) - Optional Block<br>Can be used for messages where no values are needed
|
|
483
483
|
|
|
484
484
|
#### Service Advertise Options Advertise Custom
|
|
485
485
|
|
|
486
486
|
An [`advertise_custom`](#custom-206cd2) block (within [`service.advertise_options`](#service-advertise-options)) supports the following:
|
|
487
487
|
|
|
488
|
-
<a id="where-07a5a8"></a>• [`advertise_where`](#where-07a5a8) - Optional Block<br>
|
|
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
489
|
|
|
490
490
|
<a id="ports-b755b5"></a>• [`ports`](#ports-b755b5) - Optional Block<br>Ports. Ports to advertise<br>See [Ports](#ports-b755b5) below.
|
|
491
491
|
|
|
@@ -493,11 +493,11 @@ An [`advertise_custom`](#custom-206cd2) block (within [`service.advertise_option
|
|
|
493
493
|
|
|
494
494
|
An [`advertise_where`](#where-07a5a8) block (within [`service.advertise_options.advertise_custom`](#custom-206cd2)) supports the following:
|
|
495
495
|
|
|
496
|
-
<a id="site-511518"></a>• [`site`](#site-511518) - Optional Block<br>
|
|
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
497
|
|
|
498
|
-
<a id="site-754a5a"></a>• [`virtual_site`](#site-754a5a) - Optional Block<br>
|
|
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
499
|
|
|
500
|
-
<a id="service-1a83c0"></a>• [`vk8s_service`](#service-1a83c0) - Optional Block<br>
|
|
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
501
|
|
|
502
502
|
#### Service Advertise Options Advertise Custom Advertise Where Site
|
|
503
503
|
|
|
@@ -1321,7 +1321,7 @@ A [`file`](#service-configuration-parameters-file) block (within [`service.confi
|
|
|
1321
1321
|
|
|
1322
1322
|
<a id="data-d0d370"></a>• [`data`](#data-d0d370) - Optional String<br>Data. File data
|
|
1323
1323
|
|
|
1324
|
-
<a id="mount-b0c9b7"></a>• [`mount`](#mount-b0c9b7) - Optional Block<br>Volume
|
|
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
1325
|
|
|
1326
1326
|
<a id="name-a1546d"></a>• [`name`](#name-a1546d) - Optional String<br>Name. Name of the file
|
|
1327
1327
|
|
|
@@ -1331,103 +1331,103 @@ A [`file`](#service-configuration-parameters-file) block (within [`service.confi
|
|
|
1331
1331
|
|
|
1332
1332
|
A [`mount`](#mount-b0c9b7) block (within [`service.configuration.parameters.file`](#service-configuration-parameters-file)) supports the following:
|
|
1333
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
|
|
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
1335
|
|
|
1336
|
-
<a id="path-7998af"></a>• [`mount_path`](#path-7998af) - Optional String<br>
|
|
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
1337
|
|
|
1338
|
-
<a id="path-98e114"></a>• [`sub_path`](#path-98e114) - Optional String Defaults to `'' (volume's root)`<br>
|
|
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
1339
|
|
|
1340
1340
|
#### Service Containers
|
|
1341
1341
|
|
|
1342
1342
|
A [`containers`](#service-containers) block (within [`service`](#service)) supports the following:
|
|
1343
1343
|
|
|
1344
|
-
<a id="service-containers-args"></a>• [`args`](#service-containers-args) - Optional List<br>Arguments
|
|
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
1345
|
|
|
1346
|
-
<a id="service-containers-command"></a>• [`command`](#service-containers-command) - Optional List<br>Command
|
|
1346
|
+
<a id="service-containers-command"></a>• [`command`](#service-containers-command) - Optional List<br>Command to execute. Overrides the docker image's ENTRYPOINT
|
|
1347
1347
|
|
|
1348
|
-
<a id="service-containers-custom-flavor"></a>• [`custom_flavor`](#service-containers-custom-flavor) - Optional Block<br>
|
|
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
1349
|
|
|
1350
|
-
<a id="service-containers-default-flavor"></a>• [`default_flavor`](#service-containers-default-flavor) - Optional Block<br>
|
|
1350
|
+
<a id="service-containers-default-flavor"></a>• [`default_flavor`](#service-containers-default-flavor) - Optional Block<br>Can be used for messages where no values are needed
|
|
1351
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
|
|
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
1353
|
|
|
1354
|
-
<a id="service-containers-image"></a>• [`image`](#service-containers-image) - Optional Block<br>
|
|
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
1355
|
|
|
1356
|
-
<a id="service-containers-init-container"></a>• [`init_container`](#service-containers-init-container) - Optional Bool<br>
|
|
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
1357
|
|
|
1358
|
-
<a id="service-containers-liveness-check"></a>• [`liveness_check`](#service-containers-liveness-check) - Optional Block<br>
|
|
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
1359
|
|
|
1360
1360
|
<a id="service-containers-name"></a>• [`name`](#service-containers-name) - Optional String<br>Name. Name of the container
|
|
1361
1361
|
|
|
1362
|
-
<a id="service-containers-readiness-check"></a>• [`readiness_check`](#service-containers-readiness-check) - Optional Block<br>
|
|
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
1363
|
|
|
1364
1364
|
#### Service Containers Custom Flavor
|
|
1365
1365
|
|
|
1366
1366
|
A [`custom_flavor`](#service-containers-custom-flavor) block (within [`service.containers`](#service-containers)) supports the following:
|
|
1367
1367
|
|
|
1368
|
-
<a id="service-containers-custom-flavor-name"></a>• [`name`](#service-containers-custom-flavor-name) - Optional String<br>
|
|
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
1369
|
|
|
1370
|
-
<a id="namespace-d5d342"></a>• [`namespace`](#namespace-d5d342) - Optional String<br>
|
|
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
1371
|
|
|
1372
|
-
<a id="service-containers-custom-flavor-tenant"></a>• [`tenant`](#service-containers-custom-flavor-tenant) - Optional String<br>
|
|
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
1373
|
|
|
1374
1374
|
#### Service Containers Image
|
|
1375
1375
|
|
|
1376
1376
|
An [`image`](#service-containers-image) block (within [`service.containers`](#service-containers)) supports the following:
|
|
1377
1377
|
|
|
1378
|
-
<a id="registry-ad1f41"></a>• [`container_registry`](#registry-ad1f41) - Optional Block<br>
|
|
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
1379
|
|
|
1380
|
-
<a id="service-containers-image-name"></a>• [`name`](#service-containers-image-name) - Optional String<br>
|
|
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
1381
|
|
|
1382
|
-
<a id="service-containers-image-public"></a>• [`public`](#service-containers-image-public) - Optional Block<br>
|
|
1382
|
+
<a id="service-containers-image-public"></a>• [`public`](#service-containers-image-public) - Optional Block<br>Can be used for messages where no values are needed
|
|
1383
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
|
|
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
1385
|
|
|
1386
1386
|
#### Service Containers Image Container Registry
|
|
1387
1387
|
|
|
1388
1388
|
A [`container_registry`](#registry-ad1f41) block (within [`service.containers.image`](#service-containers-image)) supports the following:
|
|
1389
1389
|
|
|
1390
|
-
<a id="name-b1a7e7"></a>• [`name`](#name-b1a7e7) - Optional String<br>
|
|
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
1391
|
|
|
1392
|
-
<a id="namespace-993dc9"></a>• [`namespace`](#namespace-993dc9) - Optional String<br>
|
|
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
1393
|
|
|
1394
|
-
<a id="tenant-882aa5"></a>• [`tenant`](#tenant-882aa5) - Optional String<br>
|
|
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
1395
|
|
|
1396
1396
|
#### Service Containers Liveness Check
|
|
1397
1397
|
|
|
1398
1398
|
A [`liveness_check`](#service-containers-liveness-check) block (within [`service.containers`](#service-containers)) supports the following:
|
|
1399
1399
|
|
|
1400
|
-
<a id="check-f4a0a5"></a>• [`exec_health_check`](#check-f4a0a5) - Optional Block<br>
|
|
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
1401
|
|
|
1402
|
-
<a id="threshold-e58da7"></a>• [`healthy_threshold`](#threshold-e58da7) - Optional Number<br>
|
|
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
1403
|
|
|
1404
|
-
<a id="check-d4d023"></a>• [`http_health_check`](#check-d4d023) - Optional Block<br>
|
|
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
1405
|
|
|
1406
|
-
<a id="delay-5a594c"></a>• [`initial_delay`](#delay-5a594c) - Optional Number<br>
|
|
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
1407
|
|
|
1408
|
-
<a id="interval-84cdc4"></a>• [`interval`](#interval-84cdc4) - Optional Number<br>
|
|
1408
|
+
<a id="interval-84cdc4"></a>• [`interval`](#interval-84cdc4) - Optional Number<br>Time interval in seconds between two health check requests
|
|
1409
1409
|
|
|
1410
|
-
<a id="check-b2633e"></a>• [`tcp_health_check`](#check-b2633e) - Optional Block<br>
|
|
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
1411
|
|
|
1412
|
-
<a id="timeout-cea9e6"></a>• [`timeout`](#timeout-cea9e6) - Optional Number<br>Timeout
|
|
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
1413
|
|
|
1414
|
-
<a id="threshold-b85e9e"></a>• [`unhealthy_threshold`](#threshold-b85e9e) - Optional Number<br>
|
|
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
1415
|
|
|
1416
1416
|
#### Service Containers Liveness Check Exec Health Check
|
|
1417
1417
|
|
|
1418
1418
|
An [`exec_health_check`](#check-f4a0a5) block (within [`service.containers.liveness_check`](#service-containers-liveness-check)) supports the following:
|
|
1419
1419
|
|
|
1420
|
-
<a id="command-2a2705"></a>• [`command`](#command-2a2705) - Optional List<br>Command
|
|
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
1421
|
|
|
1422
1422
|
#### Service Containers Liveness Check HTTP Health Check
|
|
1423
1423
|
|
|
1424
1424
|
A [`http_health_check`](#check-d4d023) block (within [`service.containers.liveness_check`](#service-containers-liveness-check)) supports the following:
|
|
1425
1425
|
|
|
1426
|
-
<a id="headers-10e4cf"></a>• [`headers`](#headers-10e4cf) - Optional Block<br>
|
|
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
1427
|
|
|
1428
|
-
<a id="header-d00d0a"></a>• [`host_header`](#header-d00d0a) - Optional String<br>
|
|
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
1429
|
|
|
1430
|
-
<a id="path-ab95e6"></a>• [`path`](#path-ab95e6) - Optional String<br>Path
|
|
1430
|
+
<a id="path-ab95e6"></a>• [`path`](#path-ab95e6) - Optional String<br>Path to access on the HTTP server
|
|
1431
1431
|
|
|
1432
1432
|
<a id="port-df543d"></a>• [`port`](#port-df543d) - Optional Block<br>Port. Port<br>See [Port](#port-df543d) below.
|
|
1433
1433
|
|
|
@@ -1449,37 +1449,37 @@ A [`tcp_health_check`](#check-b2633e) block (within [`service.containers.livenes
|
|
|
1449
1449
|
|
|
1450
1450
|
A [`readiness_check`](#service-containers-readiness-check) block (within [`service.containers`](#service-containers)) supports the following:
|
|
1451
1451
|
|
|
1452
|
-
<a id="check-b467be"></a>• [`exec_health_check`](#check-b467be) - Optional Block<br>
|
|
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
1453
|
|
|
1454
|
-
<a id="threshold-1015f0"></a>• [`healthy_threshold`](#threshold-1015f0) - Optional Number<br>
|
|
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
1455
|
|
|
1456
|
-
<a id="check-2e8715"></a>• [`http_health_check`](#check-2e8715) - Optional Block<br>
|
|
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
1457
|
|
|
1458
|
-
<a id="delay-6b92df"></a>• [`initial_delay`](#delay-6b92df) - Optional Number<br>
|
|
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
1459
|
|
|
1460
|
-
<a id="interval-ddc93b"></a>• [`interval`](#interval-ddc93b) - Optional Number<br>
|
|
1460
|
+
<a id="interval-ddc93b"></a>• [`interval`](#interval-ddc93b) - Optional Number<br>Time interval in seconds between two health check requests
|
|
1461
1461
|
|
|
1462
|
-
<a id="check-6b7ea7"></a>• [`tcp_health_check`](#check-6b7ea7) - Optional Block<br>
|
|
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
1463
|
|
|
1464
|
-
<a id="timeout-3e7e3a"></a>• [`timeout`](#timeout-3e7e3a) - Optional Number<br>Timeout
|
|
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
1465
|
|
|
1466
|
-
<a id="threshold-01c2b9"></a>• [`unhealthy_threshold`](#threshold-01c2b9) - Optional Number<br>
|
|
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
1467
|
|
|
1468
1468
|
#### Service Containers Readiness Check Exec Health Check
|
|
1469
1469
|
|
|
1470
1470
|
An [`exec_health_check`](#check-b467be) block (within [`service.containers.readiness_check`](#service-containers-readiness-check)) supports the following:
|
|
1471
1471
|
|
|
1472
|
-
<a id="command-ad2ba2"></a>• [`command`](#command-ad2ba2) - Optional List<br>Command
|
|
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
1473
|
|
|
1474
1474
|
#### Service Containers Readiness Check HTTP Health Check
|
|
1475
1475
|
|
|
1476
1476
|
A [`http_health_check`](#check-2e8715) block (within [`service.containers.readiness_check`](#service-containers-readiness-check)) supports the following:
|
|
1477
1477
|
|
|
1478
|
-
<a id="headers-eb2094"></a>• [`headers`](#headers-eb2094) - Optional Block<br>
|
|
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
1479
|
|
|
1480
|
-
<a id="header-62e026"></a>• [`host_header`](#header-62e026) - Optional String<br>
|
|
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
1481
|
|
|
1482
|
-
<a id="path-f132ec"></a>• [`path`](#path-f132ec) - Optional String<br>Path
|
|
1482
|
+
<a id="path-f132ec"></a>• [`path`](#path-f132ec) - Optional String<br>Path to access on the HTTP server
|
|
1483
1483
|
|
|
1484
1484
|
<a id="port-3d625e"></a>• [`port`](#port-3d625e) - Optional Block<br>Port. Port<br>See [Port](#port-3d625e) below.
|
|
1485
1485
|
|
|
@@ -1501,39 +1501,39 @@ A [`tcp_health_check`](#check-6b7ea7) block (within [`service.containers.readine
|
|
|
1501
1501
|
|
|
1502
1502
|
A [`deploy_options`](#service-deploy-options) block (within [`service`](#service)) supports the following:
|
|
1503
1503
|
|
|
1504
|
-
<a id="service-deploy-options-all-res"></a>• [`all_res`](#service-deploy-options-all-res) - Optional Block<br>
|
|
1504
|
+
<a id="service-deploy-options-all-res"></a>• [`all_res`](#service-deploy-options-all-res) - Optional Block<br>Can be used for messages where no values are needed
|
|
1505
1505
|
|
|
1506
|
-
<a id="sites-736a02"></a>• [`default_virtual_sites`](#sites-736a02) - Optional Block<br>
|
|
1506
|
+
<a id="sites-736a02"></a>• [`default_virtual_sites`](#sites-736a02) - Optional Block<br>Can be used for messages where no values are needed
|
|
1507
1507
|
|
|
1508
|
-
<a id="service-deploy-options-deploy-ce-sites"></a>• [`deploy_ce_sites`](#service-deploy-options-deploy-ce-sites) - Optional Block<br>
|
|
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
1509
|
|
|
1510
|
-
<a id="sites-d63f27"></a>• [`deploy_ce_virtual_sites`](#sites-d63f27) - Optional Block<br>
|
|
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
1511
|
|
|
1512
|
-
<a id="service-deploy-options-deploy-re-sites"></a>• [`deploy_re_sites`](#service-deploy-options-deploy-re-sites) - Optional Block<br>
|
|
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
1513
|
|
|
1514
|
-
<a id="sites-e0dada"></a>• [`deploy_re_virtual_sites`](#sites-e0dada) - Optional Block<br>
|
|
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
1515
|
|
|
1516
1516
|
#### Service Deploy Options Deploy CE Sites
|
|
1517
1517
|
|
|
1518
1518
|
A [`deploy_ce_sites`](#service-deploy-options-deploy-ce-sites) block (within [`service.deploy_options`](#service-deploy-options)) supports the following:
|
|
1519
1519
|
|
|
1520
|
-
<a id="site-8d4fa5"></a>• [`site`](#site-8d4fa5) - Optional Block<br>
|
|
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
1521
|
|
|
1522
1522
|
#### Service Deploy Options Deploy CE Sites Site
|
|
1523
1523
|
|
|
1524
1524
|
A [`site`](#site-8d4fa5) block (within [`service.deploy_options.deploy_ce_sites`](#service-deploy-options-deploy-ce-sites)) supports the following:
|
|
1525
1525
|
|
|
1526
|
-
<a id="name-48099d"></a>• [`name`](#name-48099d) - Optional String<br>
|
|
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
1527
|
|
|
1528
|
-
<a id="namespace-23fa32"></a>• [`namespace`](#namespace-23fa32) - Optional String<br>
|
|
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
1529
|
|
|
1530
|
-
<a id="tenant-75f6c4"></a>• [`tenant`](#tenant-75f6c4) - Optional String<br>
|
|
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
1531
|
|
|
1532
1532
|
#### Service Deploy Options Deploy CE Virtual Sites
|
|
1533
1533
|
|
|
1534
1534
|
A [`deploy_ce_virtual_sites`](#sites-d63f27) block (within [`service.deploy_options`](#service-deploy-options)) supports the following:
|
|
1535
1535
|
|
|
1536
|
-
<a id="site-044146"></a>• [`virtual_site`](#site-044146) - Optional Block<br>
|
|
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
1537
|
|
|
1538
1538
|
#### Service Deploy Options Deploy CE Virtual Sites Virtual Site
|
|
1539
1539
|
|
|
@@ -1543,23 +1543,23 @@ A [`deploy_ce_virtual_sites`](#sites-d63f27) block (within [`service.deploy_opti
|
|
|
1543
1543
|
|
|
1544
1544
|
A [`deploy_re_sites`](#service-deploy-options-deploy-re-sites) block (within [`service.deploy_options`](#service-deploy-options)) supports the following:
|
|
1545
1545
|
|
|
1546
|
-
<a id="site-e7bf20"></a>• [`site`](#site-e7bf20) - Optional Block<br>
|
|
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
1547
|
|
|
1548
1548
|
#### Service Deploy Options Deploy RE Sites Site
|
|
1549
1549
|
|
|
1550
1550
|
A [`site`](#site-e7bf20) block (within [`service.deploy_options.deploy_re_sites`](#service-deploy-options-deploy-re-sites)) supports the following:
|
|
1551
1551
|
|
|
1552
|
-
<a id="name-1ebeb9"></a>• [`name`](#name-1ebeb9) - Optional String<br>
|
|
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
1553
|
|
|
1554
|
-
<a id="namespace-b4b743"></a>• [`namespace`](#namespace-b4b743) - Optional String<br>
|
|
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
1555
|
|
|
1556
|
-
<a id="tenant-68f3c1"></a>• [`tenant`](#tenant-68f3c1) - Optional String<br>
|
|
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
1557
|
|
|
1558
1558
|
#### Service Deploy Options Deploy RE Virtual Sites
|
|
1559
1559
|
|
|
1560
1560
|
A [`deploy_re_virtual_sites`](#sites-e0dada) block (within [`service.deploy_options`](#service-deploy-options)) supports the following:
|
|
1561
1561
|
|
|
1562
|
-
<a id="site-5bb43f"></a>• [`virtual_site`](#site-5bb43f) - Optional Block<br>
|
|
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
1563
|
|
|
1564
1564
|
#### Service Deploy Options Deploy RE Virtual Sites Virtual Site
|
|
1565
1565
|
|
|
@@ -1569,19 +1569,19 @@ A [`deploy_re_virtual_sites`](#sites-e0dada) block (within [`service.deploy_opti
|
|
|
1569
1569
|
|
|
1570
1570
|
A [`volumes`](#service-volumes) block (within [`service`](#service)) supports the following:
|
|
1571
1571
|
|
|
1572
|
-
<a id="service-volumes-empty-dir"></a>• [`empty_dir`](#service-volumes-empty-dir) - Optional Block<br>
|
|
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
1573
|
|
|
1574
|
-
<a id="service-volumes-host-path"></a>• [`host_path`](#service-volumes-host-path) - Optional Block<br>
|
|
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
1575
|
|
|
1576
1576
|
<a id="service-volumes-name"></a>• [`name`](#service-volumes-name) - Optional String<br>Name. Name of the volume
|
|
1577
1577
|
|
|
1578
|
-
<a id="service-volumes-persistent-volume"></a>• [`persistent_volume`](#service-volumes-persistent-volume) - Optional Block<br>
|
|
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
1579
|
|
|
1580
1580
|
#### Service Volumes Empty Dir
|
|
1581
1581
|
|
|
1582
1582
|
An [`empty_dir`](#service-volumes-empty-dir) block (within [`service.volumes`](#service-volumes)) supports the following:
|
|
1583
1583
|
|
|
1584
|
-
<a id="service-volumes-empty-dir-mount"></a>• [`mount`](#service-volumes-empty-dir-mount) - Optional Block<br>Volume
|
|
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
1585
|
|
|
1586
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
1587
|
|
|
@@ -1589,75 +1589,75 @@ An [`empty_dir`](#service-volumes-empty-dir) block (within [`service.volumes`](#
|
|
|
1589
1589
|
|
|
1590
1590
|
A [`mount`](#service-volumes-empty-dir-mount) block (within [`service.volumes.empty_dir`](#service-volumes-empty-dir)) supports the following:
|
|
1591
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
|
|
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
1593
|
|
|
1594
|
-
<a id="path-db6f81"></a>• [`mount_path`](#path-db6f81) - Optional String<br>
|
|
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
1595
|
|
|
1596
|
-
<a id="path-3009de"></a>• [`sub_path`](#path-3009de) - Optional String Defaults to `'' (volume's root)`<br>
|
|
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
1597
|
|
|
1598
1598
|
#### Service Volumes Host Path
|
|
1599
1599
|
|
|
1600
1600
|
A [`host_path`](#service-volumes-host-path) block (within [`service.volumes`](#service-volumes)) supports the following:
|
|
1601
1601
|
|
|
1602
|
-
<a id="service-volumes-host-path-mount"></a>• [`mount`](#service-volumes-host-path-mount) - Optional Block<br>Volume
|
|
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
1603
|
|
|
1604
|
-
<a id="service-volumes-host-path-path"></a>• [`path`](#service-volumes-host-path-path) - Optional String<br>Path
|
|
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
1605
|
|
|
1606
1606
|
#### Service Volumes Host Path Mount
|
|
1607
1607
|
|
|
1608
1608
|
A [`mount`](#service-volumes-host-path-mount) block (within [`service.volumes.host_path`](#service-volumes-host-path)) supports the following:
|
|
1609
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
|
|
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
1611
|
|
|
1612
|
-
<a id="path-0b89b4"></a>• [`mount_path`](#path-0b89b4) - Optional String<br>
|
|
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
1613
|
|
|
1614
|
-
<a id="path-7cee3d"></a>• [`sub_path`](#path-7cee3d) - Optional String Defaults to `'' (volume's root)`<br>
|
|
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
1615
|
|
|
1616
1616
|
#### Service Volumes Persistent Volume
|
|
1617
1617
|
|
|
1618
1618
|
A [`persistent_volume`](#service-volumes-persistent-volume) block (within [`service.volumes`](#service-volumes)) supports the following:
|
|
1619
1619
|
|
|
1620
|
-
<a id="service-volumes-persistent-volume-mount"></a>• [`mount`](#service-volumes-persistent-volume-mount) - Optional Block<br>Volume
|
|
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
1621
|
|
|
1622
|
-
<a id="storage-aa2194"></a>• [`storage`](#storage-aa2194) - Optional Block<br>
|
|
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
1623
|
|
|
1624
1624
|
#### Service Volumes Persistent Volume Mount
|
|
1625
1625
|
|
|
1626
1626
|
A [`mount`](#service-volumes-persistent-volume-mount) block (within [`service.volumes.persistent_volume`](#service-volumes-persistent-volume)) supports the following:
|
|
1627
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
|
|
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
1629
|
|
|
1630
|
-
<a id="path-7af794"></a>• [`mount_path`](#path-7af794) - Optional String<br>
|
|
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
1631
|
|
|
1632
|
-
<a id="path-18ad39"></a>• [`sub_path`](#path-18ad39) - Optional String Defaults to `'' (volume's root)`<br>
|
|
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
1633
|
|
|
1634
1634
|
#### Service Volumes Persistent Volume Storage
|
|
1635
1635
|
|
|
1636
1636
|
A [`storage`](#storage-aa2194) block (within [`service.volumes.persistent_volume`](#service-volumes-persistent-volume)) supports the following:
|
|
1637
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]
|
|
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
1639
|
|
|
1640
|
-
<a id="name-4c16c5"></a>• [`class_name`](#name-4c16c5) - Optional String<br>
|
|
1640
|
+
<a id="name-4c16c5"></a>• [`class_name`](#name-4c16c5) - Optional String<br>Use the specified class name
|
|
1641
1641
|
|
|
1642
|
-
<a id="default-36c85c"></a>• [`default`](#default-36c85c) - Optional Block<br>
|
|
1642
|
+
<a id="default-36c85c"></a>• [`default`](#default-36c85c) - Optional Block<br>Can be used for messages where no values are needed
|
|
1643
1643
|
|
|
1644
|
-
<a id="size-fea8d4"></a>• [`storage_size`](#size-fea8d4) - Optional Number<br>Size
|
|
1644
|
+
<a id="size-fea8d4"></a>• [`storage_size`](#size-fea8d4) - Optional Number<br>Size in GiB of the persistent storage
|
|
1645
1645
|
|
|
1646
1646
|
#### Simple Service
|
|
1647
1647
|
|
|
1648
1648
|
A [`simple_service`](#simple-service) block supports the following:
|
|
1649
1649
|
|
|
1650
|
-
<a id="simple-service-configuration"></a>• [`configuration`](#simple-service-configuration) - Optional Block<br>Configuration
|
|
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
1651
|
|
|
1652
|
-
<a id="simple-service-container"></a>• [`container`](#simple-service-container) - Optional Block<br>
|
|
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
1653
|
|
|
1654
|
-
<a id="simple-service-disabled"></a>• [`disabled`](#simple-service-disabled) - Optional Block<br>
|
|
1654
|
+
<a id="simple-service-disabled"></a>• [`disabled`](#simple-service-disabled) - Optional Block<br>Can be used for messages where no values are needed
|
|
1655
1655
|
|
|
1656
|
-
<a id="simple-service-do-not-advertise"></a>• [`do_not_advertise`](#simple-service-do-not-advertise) - Optional Block<br>
|
|
1656
|
+
<a id="simple-service-do-not-advertise"></a>• [`do_not_advertise`](#simple-service-do-not-advertise) - Optional Block<br>Can be used for messages where no values are needed
|
|
1657
1657
|
|
|
1658
|
-
<a id="simple-service-enabled"></a>• [`enabled`](#simple-service-enabled) - Optional Block<br>Persistent
|
|
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
1659
|
|
|
1660
|
-
<a id="simple-service-scale-to-zero"></a>• [`scale_to_zero`](#simple-service-scale-to-zero) - Optional Bool<br>Scale
|
|
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
1661
|
|
|
1662
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
1663
|
|
|
@@ -1689,7 +1689,7 @@ A [`file`](#file-b5c200) block (within [`simple_service.configuration.parameters
|
|
|
1689
1689
|
|
|
1690
1690
|
<a id="data-5368fd"></a>• [`data`](#data-5368fd) - Optional String<br>Data. File data
|
|
1691
1691
|
|
|
1692
|
-
<a id="mount-decdef"></a>• [`mount`](#mount-decdef) - Optional Block<br>Volume
|
|
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
1693
|
|
|
1694
1694
|
<a id="name-251776"></a>• [`name`](#name-251776) - Optional String<br>Name. Name of the file
|
|
1695
1695
|
|
|
@@ -1699,87 +1699,87 @@ A [`file`](#file-b5c200) block (within [`simple_service.configuration.parameters
|
|
|
1699
1699
|
|
|
1700
1700
|
A [`mount`](#mount-decdef) block (within [`simple_service.configuration.parameters.file`](#file-b5c200)) supports the following:
|
|
1701
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
|
|
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
1703
|
|
|
1704
|
-
<a id="path-8115be"></a>• [`mount_path`](#path-8115be) - Optional String<br>
|
|
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
1705
|
|
|
1706
|
-
<a id="path-b15eb2"></a>• [`sub_path`](#path-b15eb2) - Optional String Defaults to `'' (volume's root)`<br>
|
|
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
1707
|
|
|
1708
1708
|
#### Simple Service Container
|
|
1709
1709
|
|
|
1710
1710
|
A [`container`](#simple-service-container) block (within [`simple_service`](#simple-service)) supports the following:
|
|
1711
1711
|
|
|
1712
|
-
<a id="simple-service-container-args"></a>• [`args`](#simple-service-container-args) - Optional List<br>Arguments
|
|
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
1713
|
|
|
1714
|
-
<a id="simple-service-container-command"></a>• [`command`](#simple-service-container-command) - Optional List<br>Command
|
|
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
1715
|
|
|
1716
|
-
<a id="simple-service-container-custom-flavor"></a>• [`custom_flavor`](#simple-service-container-custom-flavor) - Optional Block<br>
|
|
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
1717
|
|
|
1718
|
-
<a id="simple-service-container-default-flavor"></a>• [`default_flavor`](#simple-service-container-default-flavor) - Optional Block<br>
|
|
1718
|
+
<a id="simple-service-container-default-flavor"></a>• [`default_flavor`](#simple-service-container-default-flavor) - Optional Block<br>Can be used for messages where no values are needed
|
|
1719
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
|
|
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
1721
|
|
|
1722
|
-
<a id="simple-service-container-image"></a>• [`image`](#simple-service-container-image) - Optional Block<br>
|
|
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
1723
|
|
|
1724
|
-
<a id="simple-service-container-init-container"></a>• [`init_container`](#simple-service-container-init-container) - Optional Bool<br>
|
|
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
1725
|
|
|
1726
|
-
<a id="simple-service-container-liveness-check"></a>• [`liveness_check`](#simple-service-container-liveness-check) - Optional Block<br>
|
|
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
1727
|
|
|
1728
1728
|
<a id="simple-service-container-name"></a>• [`name`](#simple-service-container-name) - Optional String<br>Name. Name of the container
|
|
1729
1729
|
|
|
1730
|
-
<a id="check-9028f0"></a>• [`readiness_check`](#check-9028f0) - Optional Block<br>
|
|
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
1731
|
|
|
1732
1732
|
#### Simple Service Container Custom Flavor
|
|
1733
1733
|
|
|
1734
1734
|
A [`custom_flavor`](#simple-service-container-custom-flavor) block (within [`simple_service.container`](#simple-service-container)) supports the following:
|
|
1735
1735
|
|
|
1736
|
-
<a id="name-256e2d"></a>• [`name`](#name-256e2d) - Optional String<br>
|
|
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
1737
|
|
|
1738
|
-
<a id="namespace-3dbb57"></a>• [`namespace`](#namespace-3dbb57) - Optional String<br>
|
|
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
1739
|
|
|
1740
|
-
<a id="tenant-bf6176"></a>• [`tenant`](#tenant-bf6176) - Optional String<br>
|
|
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
1741
|
|
|
1742
1742
|
#### Simple Service Container Image
|
|
1743
1743
|
|
|
1744
1744
|
An [`image`](#simple-service-container-image) block (within [`simple_service.container`](#simple-service-container)) supports the following:
|
|
1745
1745
|
|
|
1746
|
-
<a id="registry-f7f6d1"></a>• [`container_registry`](#registry-f7f6d1) - Optional Block<br>
|
|
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
1747
|
|
|
1748
|
-
<a id="simple-service-container-image-name"></a>• [`name`](#simple-service-container-image-name) - Optional String<br>
|
|
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
1749
|
|
|
1750
|
-
<a id="simple-service-container-image-public"></a>• [`public`](#simple-service-container-image-public) - Optional Block<br>
|
|
1750
|
+
<a id="simple-service-container-image-public"></a>• [`public`](#simple-service-container-image-public) - Optional Block<br>Can be used for messages where no values are needed
|
|
1751
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
|
|
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
1753
|
|
|
1754
1754
|
#### Simple Service Container Image Container Registry
|
|
1755
1755
|
|
|
1756
1756
|
A [`container_registry`](#registry-f7f6d1) block (within [`simple_service.container.image`](#simple-service-container-image)) supports the following:
|
|
1757
1757
|
|
|
1758
|
-
<a id="name-d862eb"></a>• [`name`](#name-d862eb) - Optional String<br>
|
|
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
1759
|
|
|
1760
|
-
<a id="namespace-3251f2"></a>• [`namespace`](#namespace-3251f2) - Optional String<br>
|
|
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
1761
|
|
|
1762
|
-
<a id="tenant-86a541"></a>• [`tenant`](#tenant-86a541) - Optional String<br>
|
|
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
1763
|
|
|
1764
1764
|
#### Simple Service Container Liveness Check
|
|
1765
1765
|
|
|
1766
1766
|
A [`liveness_check`](#simple-service-container-liveness-check) block (within [`simple_service.container`](#simple-service-container)) supports the following:
|
|
1767
1767
|
|
|
1768
|
-
<a id="check-16db8f"></a>• [`exec_health_check`](#check-16db8f) - Optional Block<br>
|
|
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
1769
|
|
|
1770
|
-
<a id="threshold-b6ea90"></a>• [`healthy_threshold`](#threshold-b6ea90) - Optional Number<br>
|
|
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
1771
|
|
|
1772
|
-
<a id="check-25986b"></a>• [`http_health_check`](#check-25986b) - Optional Block<br>
|
|
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
1773
|
|
|
1774
|
-
<a id="delay-758ad8"></a>• [`initial_delay`](#delay-758ad8) - Optional Number<br>
|
|
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
1775
|
|
|
1776
|
-
<a id="interval-a75912"></a>• [`interval`](#interval-a75912) - Optional Number<br>
|
|
1776
|
+
<a id="interval-a75912"></a>• [`interval`](#interval-a75912) - Optional Number<br>Time interval in seconds between two health check requests
|
|
1777
1777
|
|
|
1778
|
-
<a id="check-f33b9a"></a>• [`tcp_health_check`](#check-f33b9a) - Optional Block<br>
|
|
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
1779
|
|
|
1780
|
-
<a id="timeout-cca4da"></a>• [`timeout`](#timeout-cca4da) - Optional Number<br>Timeout
|
|
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
1781
|
|
|
1782
|
-
<a id="threshold-d8ab4a"></a>• [`unhealthy_threshold`](#threshold-d8ab4a) - Optional Number<br>
|
|
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
1783
|
|
|
1784
1784
|
#### Simple Service Container Liveness Check Exec Health Check
|
|
1785
1785
|
|
|
@@ -1805,21 +1805,21 @@ A [`liveness_check`](#simple-service-container-liveness-check) block (within [`s
|
|
|
1805
1805
|
|
|
1806
1806
|
A [`readiness_check`](#check-9028f0) block (within [`simple_service.container`](#simple-service-container)) supports the following:
|
|
1807
1807
|
|
|
1808
|
-
<a id="check-083116"></a>• [`exec_health_check`](#check-083116) - Optional Block<br>
|
|
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
1809
|
|
|
1810
|
-
<a id="threshold-b19598"></a>• [`healthy_threshold`](#threshold-b19598) - Optional Number<br>
|
|
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
1811
|
|
|
1812
|
-
<a id="check-71ae5b"></a>• [`http_health_check`](#check-71ae5b) - Optional Block<br>
|
|
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
1813
|
|
|
1814
|
-
<a id="delay-f56b24"></a>• [`initial_delay`](#delay-f56b24) - Optional Number<br>
|
|
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
1815
|
|
|
1816
|
-
<a id="interval-0aaa38"></a>• [`interval`](#interval-0aaa38) - Optional Number<br>
|
|
1816
|
+
<a id="interval-0aaa38"></a>• [`interval`](#interval-0aaa38) - Optional Number<br>Time interval in seconds between two health check requests
|
|
1817
1817
|
|
|
1818
|
-
<a id="check-074b55"></a>• [`tcp_health_check`](#check-074b55) - Optional Block<br>
|
|
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
1819
|
|
|
1820
|
-
<a id="timeout-354826"></a>• [`timeout`](#timeout-354826) - Optional Number<br>Timeout
|
|
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
1821
|
|
|
1822
|
-
<a id="threshold-b99edb"></a>• [`unhealthy_threshold`](#threshold-b99edb) - Optional Number<br>
|
|
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
1823
|
|
|
1824
1824
|
#### Simple Service Container Readiness Check Exec Health Check
|
|
1825
1825
|
|
|
@@ -1847,63 +1847,63 @@ An [`enabled`](#simple-service-enabled) block (within [`simple_service`](#simple
|
|
|
1847
1847
|
|
|
1848
1848
|
<a id="simple-service-enabled-name"></a>• [`name`](#simple-service-enabled-name) - Optional String<br>Name. Name of the volume
|
|
1849
1849
|
|
|
1850
|
-
<a id="volume-64b8ac"></a>• [`persistent_volume`](#volume-64b8ac) - Optional Block<br>
|
|
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
1851
|
|
|
1852
1852
|
#### Simple Service Enabled Persistent Volume
|
|
1853
1853
|
|
|
1854
1854
|
A [`persistent_volume`](#volume-64b8ac) block (within [`simple_service.enabled`](#simple-service-enabled)) supports the following:
|
|
1855
1855
|
|
|
1856
|
-
<a id="mount-80f853"></a>• [`mount`](#mount-80f853) - Optional Block<br>Volume
|
|
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
1857
|
|
|
1858
|
-
<a id="storage-8c6930"></a>• [`storage`](#storage-8c6930) - Optional Block<br>
|
|
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
1859
|
|
|
1860
1860
|
#### Simple Service Enabled Persistent Volume Mount
|
|
1861
1861
|
|
|
1862
1862
|
A [`mount`](#mount-80f853) block (within [`simple_service.enabled.persistent_volume`](#volume-64b8ac)) supports the following:
|
|
1863
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
|
|
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
1865
|
|
|
1866
|
-
<a id="path-7949ef"></a>• [`mount_path`](#path-7949ef) - Optional String<br>
|
|
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
1867
|
|
|
1868
|
-
<a id="path-7a72f2"></a>• [`sub_path`](#path-7a72f2) - Optional String Defaults to `'' (volume's root)`<br>
|
|
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
1869
|
|
|
1870
1870
|
#### Simple Service Enabled Persistent Volume Storage
|
|
1871
1871
|
|
|
1872
1872
|
A [`storage`](#storage-8c6930) block (within [`simple_service.enabled.persistent_volume`](#volume-64b8ac)) supports the following:
|
|
1873
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]
|
|
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
1875
|
|
|
1876
|
-
<a id="name-b14a4c"></a>• [`class_name`](#name-b14a4c) - Optional String<br>
|
|
1876
|
+
<a id="name-b14a4c"></a>• [`class_name`](#name-b14a4c) - Optional String<br>Use the specified class name
|
|
1877
1877
|
|
|
1878
|
-
<a id="default-f48482"></a>• [`default`](#default-f48482) - Optional Block<br>
|
|
1878
|
+
<a id="default-f48482"></a>• [`default`](#default-f48482) - Optional Block<br>Can be used for messages where no values are needed
|
|
1879
1879
|
|
|
1880
|
-
<a id="size-17db0b"></a>• [`storage_size`](#size-17db0b) - Optional Number<br>Size
|
|
1880
|
+
<a id="size-17db0b"></a>• [`storage_size`](#size-17db0b) - Optional Number<br>Size in GiB of the persistent storage
|
|
1881
1881
|
|
|
1882
1882
|
#### Simple Service Simple Advertise
|
|
1883
1883
|
|
|
1884
1884
|
A [`simple_advertise`](#simple-service-simple-advertise) block (within [`simple_service`](#simple-service)) supports the following:
|
|
1885
1885
|
|
|
1886
|
-
<a id="simple-service-simple-advertise-domains"></a>• [`domains`](#simple-service-simple-advertise-domains) - Optional List<br>
|
|
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
1887
|
|
|
1888
|
-
<a id="port-b7cc36"></a>• [`service_port`](#port-b7cc36) - Optional Number<br>Service
|
|
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
1889
|
|
|
1890
1890
|
#### Stateful Service
|
|
1891
1891
|
|
|
1892
1892
|
A [`stateful_service`](#stateful-service) block supports the following:
|
|
1893
1893
|
|
|
1894
|
-
<a id="stateful-service-advertise-options"></a>• [`advertise_options`](#stateful-service-advertise-options) - Optional Block<br>Advertise OPTIONS
|
|
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
1895
|
|
|
1896
|
-
<a id="stateful-service-configuration"></a>• [`configuration`](#stateful-service-configuration) - Optional Block<br>Configuration
|
|
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
1897
|
|
|
1898
|
-
<a id="stateful-service-containers"></a>• [`containers`](#stateful-service-containers) - Optional Block<br>Containers
|
|
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
1899
|
|
|
1900
|
-
<a id="stateful-service-deploy-options"></a>• [`deploy_options`](#stateful-service-deploy-options) - Optional Block<br>Deploy OPTIONS
|
|
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
1901
|
|
|
1902
|
-
<a id="stateful-service-num-replicas"></a>• [`num_replicas`](#stateful-service-num-replicas) - Optional Number<br>Number of
|
|
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
1903
|
|
|
1904
|
-
<a id="stateful-service-persistent-volumes"></a>• [`persistent_volumes`](#stateful-service-persistent-volumes) - Optional Block<br>Persistent
|
|
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
1905
|
|
|
1906
|
-
<a id="stateful-service-scale-to-zero"></a>• [`scale_to_zero`](#stateful-service-scale-to-zero) - Optional Block<br>
|
|
1906
|
+
<a id="stateful-service-scale-to-zero"></a>• [`scale_to_zero`](#stateful-service-scale-to-zero) - Optional Block<br>Can be used for messages where no values are needed
|
|
1907
1907
|
|
|
1908
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
1909
|
|
|
@@ -1911,19 +1911,19 @@ A [`stateful_service`](#stateful-service) block supports the following:
|
|
|
1911
1911
|
|
|
1912
1912
|
An [`advertise_options`](#stateful-service-advertise-options) block (within [`stateful_service`](#stateful-service)) supports the following:
|
|
1913
1913
|
|
|
1914
|
-
<a id="custom-2e9653"></a>• [`advertise_custom`](#custom-2e9653) - Optional Block<br>Advertise
|
|
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
1915
|
|
|
1916
|
-
<a id="cluster-e091a1"></a>• [`advertise_in_cluster`](#cluster-e091a1) - Optional Block<br>Advertise
|
|
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
1917
|
|
|
1918
|
-
<a id="public-86b094"></a>• [`advertise_on_public`](#public-86b094) - Optional Block<br>Advertise
|
|
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
1919
|
|
|
1920
|
-
<a id="advertise-a4c726"></a>• [`do_not_advertise`](#advertise-a4c726) - Optional Block<br>
|
|
1920
|
+
<a id="advertise-a4c726"></a>• [`do_not_advertise`](#advertise-a4c726) - Optional Block<br>Can be used for messages where no values are needed
|
|
1921
1921
|
|
|
1922
1922
|
#### Stateful Service Advertise Options Advertise Custom
|
|
1923
1923
|
|
|
1924
1924
|
An [`advertise_custom`](#custom-2e9653) block (within [`stateful_service.advertise_options`](#stateful-service-advertise-options)) supports the following:
|
|
1925
1925
|
|
|
1926
|
-
<a id="where-ecb677"></a>• [`advertise_where`](#where-ecb677) - Optional Block<br>
|
|
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
1927
|
|
|
1928
1928
|
<a id="ports-17a1c0"></a>• [`ports`](#ports-17a1c0) - Optional Block<br>Ports. Ports to advertise<br>See [Ports](#ports-17a1c0) below.
|
|
1929
1929
|
|
|
@@ -2741,7 +2741,7 @@ A [`file`](#file-343e3f) block (within [`stateful_service.configuration.paramete
|
|
|
2741
2741
|
|
|
2742
2742
|
<a id="data-1a89a8"></a>• [`data`](#data-1a89a8) - Optional String<br>Data. File data
|
|
2743
2743
|
|
|
2744
|
-
<a id="mount-9251c5"></a>• [`mount`](#mount-9251c5) - Optional Block<br>Volume
|
|
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
2745
|
|
|
2746
2746
|
<a id="name-0fb42b"></a>• [`name`](#name-0fb42b) - Optional String<br>Name. Name of the file
|
|
2747
2747
|
|
|
@@ -2751,87 +2751,87 @@ A [`file`](#file-343e3f) block (within [`stateful_service.configuration.paramete
|
|
|
2751
2751
|
|
|
2752
2752
|
A [`mount`](#mount-9251c5) block (within [`stateful_service.configuration.parameters.file`](#file-343e3f)) supports the following:
|
|
2753
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
|
|
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
2755
|
|
|
2756
|
-
<a id="path-6612e2"></a>• [`mount_path`](#path-6612e2) - Optional String<br>
|
|
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
2757
|
|
|
2758
|
-
<a id="path-1fc41c"></a>• [`sub_path`](#path-1fc41c) - Optional String Defaults to `'' (volume's root)`<br>
|
|
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
2759
|
|
|
2760
2760
|
#### Stateful Service Containers
|
|
2761
2761
|
|
|
2762
2762
|
A [`containers`](#stateful-service-containers) block (within [`stateful_service`](#stateful-service)) supports the following:
|
|
2763
2763
|
|
|
2764
|
-
<a id="stateful-service-containers-args"></a>• [`args`](#stateful-service-containers-args) - Optional List<br>Arguments
|
|
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
2765
|
|
|
2766
|
-
<a id="stateful-service-containers-command"></a>• [`command`](#stateful-service-containers-command) - Optional List<br>Command
|
|
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
2767
|
|
|
2768
|
-
<a id="flavor-0d2be0"></a>• [`custom_flavor`](#flavor-0d2be0) - Optional Block<br>
|
|
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
2769
|
|
|
2770
|
-
<a id="flavor-c485c6"></a>• [`default_flavor`](#flavor-c485c6) - Optional Block<br>
|
|
2770
|
+
<a id="flavor-c485c6"></a>• [`default_flavor`](#flavor-c485c6) - Optional Block<br>Can be used for messages where no values are needed
|
|
2771
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
|
|
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
2773
|
|
|
2774
|
-
<a id="stateful-service-containers-image"></a>• [`image`](#stateful-service-containers-image) - Optional Block<br>
|
|
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
2775
|
|
|
2776
|
-
<a id="container-7dbf25"></a>• [`init_container`](#container-7dbf25) - Optional Bool<br>
|
|
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
2777
|
|
|
2778
|
-
<a id="check-82bd07"></a>• [`liveness_check`](#check-82bd07) - Optional Block<br>
|
|
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
2779
|
|
|
2780
2780
|
<a id="stateful-service-containers-name"></a>• [`name`](#stateful-service-containers-name) - Optional String<br>Name. Name of the container
|
|
2781
2781
|
|
|
2782
|
-
<a id="check-81b532"></a>• [`readiness_check`](#check-81b532) - Optional Block<br>
|
|
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
2783
|
|
|
2784
2784
|
#### Stateful Service Containers Custom Flavor
|
|
2785
2785
|
|
|
2786
2786
|
A [`custom_flavor`](#flavor-0d2be0) block (within [`stateful_service.containers`](#stateful-service-containers)) supports the following:
|
|
2787
2787
|
|
|
2788
|
-
<a id="name-37698d"></a>• [`name`](#name-37698d) - Optional String<br>
|
|
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
2789
|
|
|
2790
|
-
<a id="namespace-db9524"></a>• [`namespace`](#namespace-db9524) - Optional String<br>
|
|
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
2791
|
|
|
2792
|
-
<a id="tenant-a8296a"></a>• [`tenant`](#tenant-a8296a) - Optional String<br>
|
|
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
2793
|
|
|
2794
2794
|
#### Stateful Service Containers Image
|
|
2795
2795
|
|
|
2796
2796
|
An [`image`](#stateful-service-containers-image) block (within [`stateful_service.containers`](#stateful-service-containers)) supports the following:
|
|
2797
2797
|
|
|
2798
|
-
<a id="registry-78045a"></a>• [`container_registry`](#registry-78045a) - Optional Block<br>
|
|
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
2799
|
|
|
2800
|
-
<a id="stateful-service-containers-image-name"></a>• [`name`](#stateful-service-containers-image-name) - Optional String<br>
|
|
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
2801
|
|
|
2802
|
-
<a id="public-27eb7d"></a>• [`public`](#public-27eb7d) - Optional Block<br>
|
|
2802
|
+
<a id="public-27eb7d"></a>• [`public`](#public-27eb7d) - Optional Block<br>Can be used for messages where no values are needed
|
|
2803
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
|
|
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
2805
|
|
|
2806
2806
|
#### Stateful Service Containers Image Container Registry
|
|
2807
2807
|
|
|
2808
2808
|
A [`container_registry`](#registry-78045a) block (within [`stateful_service.containers.image`](#stateful-service-containers-image)) supports the following:
|
|
2809
2809
|
|
|
2810
|
-
<a id="name-4d4804"></a>• [`name`](#name-4d4804) - Optional String<br>
|
|
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
2811
|
|
|
2812
|
-
<a id="namespace-f6725d"></a>• [`namespace`](#namespace-f6725d) - Optional String<br>
|
|
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
2813
|
|
|
2814
|
-
<a id="tenant-1ee737"></a>• [`tenant`](#tenant-1ee737) - Optional String<br>
|
|
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
2815
|
|
|
2816
2816
|
#### Stateful Service Containers Liveness Check
|
|
2817
2817
|
|
|
2818
2818
|
A [`liveness_check`](#check-82bd07) block (within [`stateful_service.containers`](#stateful-service-containers)) supports the following:
|
|
2819
2819
|
|
|
2820
|
-
<a id="check-d745b6"></a>• [`exec_health_check`](#check-d745b6) - Optional Block<br>
|
|
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
2821
|
|
|
2822
|
-
<a id="threshold-87f287"></a>• [`healthy_threshold`](#threshold-87f287) - Optional Number<br>
|
|
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
2823
|
|
|
2824
|
-
<a id="check-3fba6e"></a>• [`http_health_check`](#check-3fba6e) - Optional Block<br>
|
|
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
2825
|
|
|
2826
|
-
<a id="delay-58e58a"></a>• [`initial_delay`](#delay-58e58a) - Optional Number<br>
|
|
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
2827
|
|
|
2828
|
-
<a id="interval-2c75b3"></a>• [`interval`](#interval-2c75b3) - Optional Number<br>
|
|
2828
|
+
<a id="interval-2c75b3"></a>• [`interval`](#interval-2c75b3) - Optional Number<br>Time interval in seconds between two health check requests
|
|
2829
2829
|
|
|
2830
|
-
<a id="check-485f86"></a>• [`tcp_health_check`](#check-485f86) - Optional Block<br>
|
|
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
2831
|
|
|
2832
|
-
<a id="timeout-4a23bd"></a>• [`timeout`](#timeout-4a23bd) - Optional Number<br>Timeout
|
|
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
2833
|
|
|
2834
|
-
<a id="threshold-50b947"></a>• [`unhealthy_threshold`](#threshold-50b947) - Optional Number<br>
|
|
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
2835
|
|
|
2836
2836
|
#### Stateful Service Containers Liveness Check Exec Health Check
|
|
2837
2837
|
|
|
@@ -2857,21 +2857,21 @@ A [`liveness_check`](#check-82bd07) block (within [`stateful_service.containers`
|
|
|
2857
2857
|
|
|
2858
2858
|
A [`readiness_check`](#check-81b532) block (within [`stateful_service.containers`](#stateful-service-containers)) supports the following:
|
|
2859
2859
|
|
|
2860
|
-
<a id="check-d067fc"></a>• [`exec_health_check`](#check-d067fc) - Optional Block<br>
|
|
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
2861
|
|
|
2862
|
-
<a id="threshold-793b66"></a>• [`healthy_threshold`](#threshold-793b66) - Optional Number<br>
|
|
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
2863
|
|
|
2864
|
-
<a id="check-d4b642"></a>• [`http_health_check`](#check-d4b642) - Optional Block<br>
|
|
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
2865
|
|
|
2866
|
-
<a id="delay-e5c176"></a>• [`initial_delay`](#delay-e5c176) - Optional Number<br>
|
|
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
2867
|
|
|
2868
|
-
<a id="interval-b7509d"></a>• [`interval`](#interval-b7509d) - Optional Number<br>
|
|
2868
|
+
<a id="interval-b7509d"></a>• [`interval`](#interval-b7509d) - Optional Number<br>Time interval in seconds between two health check requests
|
|
2869
2869
|
|
|
2870
|
-
<a id="check-fde4eb"></a>• [`tcp_health_check`](#check-fde4eb) - Optional Block<br>
|
|
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
2871
|
|
|
2872
|
-
<a id="timeout-db7e11"></a>• [`timeout`](#timeout-db7e11) - Optional Number<br>Timeout
|
|
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
2873
|
|
|
2874
|
-
<a id="threshold-a50cc0"></a>• [`unhealthy_threshold`](#threshold-a50cc0) - Optional Number<br>
|
|
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
2875
|
|
|
2876
2876
|
#### Stateful Service Containers Readiness Check Exec Health Check
|
|
2877
2877
|
|
|
@@ -2897,23 +2897,23 @@ A [`readiness_check`](#check-81b532) block (within [`stateful_service.containers
|
|
|
2897
2897
|
|
|
2898
2898
|
A [`deploy_options`](#stateful-service-deploy-options) block (within [`stateful_service`](#stateful-service)) supports the following:
|
|
2899
2899
|
|
|
2900
|
-
<a id="stateful-service-deploy-options-all-res"></a>• [`all_res`](#stateful-service-deploy-options-all-res) - Optional Block<br>
|
|
2900
|
+
<a id="stateful-service-deploy-options-all-res"></a>• [`all_res`](#stateful-service-deploy-options-all-res) - Optional Block<br>Can be used for messages where no values are needed
|
|
2901
2901
|
|
|
2902
|
-
<a id="sites-4ecc3f"></a>• [`default_virtual_sites`](#sites-4ecc3f) - Optional Block<br>
|
|
2902
|
+
<a id="sites-4ecc3f"></a>• [`default_virtual_sites`](#sites-4ecc3f) - Optional Block<br>Can be used for messages where no values are needed
|
|
2903
2903
|
|
|
2904
|
-
<a id="sites-6c0f50"></a>• [`deploy_ce_sites`](#sites-6c0f50) - Optional Block<br>
|
|
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
2905
|
|
|
2906
|
-
<a id="sites-f4950a"></a>• [`deploy_ce_virtual_sites`](#sites-f4950a) - Optional Block<br>
|
|
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
2907
|
|
|
2908
|
-
<a id="sites-d00d51"></a>• [`deploy_re_sites`](#sites-d00d51) - Optional Block<br>
|
|
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
2909
|
|
|
2910
|
-
<a id="sites-4ad049"></a>• [`deploy_re_virtual_sites`](#sites-4ad049) - Optional Block<br>
|
|
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
2911
|
|
|
2912
2912
|
#### Stateful Service Deploy Options Deploy CE Sites
|
|
2913
2913
|
|
|
2914
2914
|
A [`deploy_ce_sites`](#sites-6c0f50) block (within [`stateful_service.deploy_options`](#stateful-service-deploy-options)) supports the following:
|
|
2915
2915
|
|
|
2916
|
-
<a id="site-0e137b"></a>• [`site`](#site-0e137b) - Optional Block<br>
|
|
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
2917
|
|
|
2918
2918
|
#### Stateful Service Deploy Options Deploy CE Sites Site
|
|
2919
2919
|
|
|
@@ -2931,7 +2931,7 @@ A [`deploy_ce_sites`](#sites-6c0f50) block (within [`stateful_service.deploy_opt
|
|
|
2931
2931
|
|
|
2932
2932
|
A [`deploy_re_sites`](#sites-d00d51) block (within [`stateful_service.deploy_options`](#stateful-service-deploy-options)) supports the following:
|
|
2933
2933
|
|
|
2934
|
-
<a id="site-92faf4"></a>• [`site`](#site-92faf4) - Optional Block<br>
|
|
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
2935
|
|
|
2936
2936
|
#### Stateful Service Deploy Options Deploy RE Sites Site
|
|
2937
2937
|
|
|
@@ -2951,45 +2951,45 @@ A [`persistent_volumes`](#stateful-service-persistent-volumes) block (within [`s
|
|
|
2951
2951
|
|
|
2952
2952
|
<a id="name-5e24ab"></a>• [`name`](#name-5e24ab) - Optional String<br>Name. Name of the volume
|
|
2953
2953
|
|
|
2954
|
-
<a id="volume-9c1fa2"></a>• [`persistent_volume`](#volume-9c1fa2) - Optional Block<br>
|
|
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
2955
|
|
|
2956
2956
|
#### Stateful Service Persistent Volumes Persistent Volume
|
|
2957
2957
|
|
|
2958
2958
|
A [`persistent_volume`](#volume-9c1fa2) block (within [`stateful_service.persistent_volumes`](#stateful-service-persistent-volumes)) supports the following:
|
|
2959
2959
|
|
|
2960
|
-
<a id="mount-332197"></a>• [`mount`](#mount-332197) - Optional Block<br>Volume
|
|
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
2961
|
|
|
2962
|
-
<a id="storage-33a80f"></a>• [`storage`](#storage-33a80f) - Optional Block<br>
|
|
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
2963
|
|
|
2964
2964
|
#### Stateful Service Persistent Volumes Persistent Volume Mount
|
|
2965
2965
|
|
|
2966
2966
|
A [`mount`](#mount-332197) block (within [`stateful_service.persistent_volumes.persistent_volume`](#volume-9c1fa2)) supports the following:
|
|
2967
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
|
|
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
2969
|
|
|
2970
|
-
<a id="path-a261fb"></a>• [`mount_path`](#path-a261fb) - Optional String<br>
|
|
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
2971
|
|
|
2972
|
-
<a id="path-056461"></a>• [`sub_path`](#path-056461) - Optional String Defaults to `'' (volume's root)`<br>
|
|
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
2973
|
|
|
2974
2974
|
#### Stateful Service Persistent Volumes Persistent Volume Storage
|
|
2975
2975
|
|
|
2976
2976
|
A [`storage`](#storage-33a80f) block (within [`stateful_service.persistent_volumes.persistent_volume`](#volume-9c1fa2)) supports the following:
|
|
2977
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]
|
|
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
2979
|
|
|
2980
|
-
<a id="name-6dd4e7"></a>• [`class_name`](#name-6dd4e7) - Optional String<br>
|
|
2980
|
+
<a id="name-6dd4e7"></a>• [`class_name`](#name-6dd4e7) - Optional String<br>Use the specified class name
|
|
2981
2981
|
|
|
2982
|
-
<a id="default-def9af"></a>• [`default`](#default-def9af) - Optional Block<br>
|
|
2982
|
+
<a id="default-def9af"></a>• [`default`](#default-def9af) - Optional Block<br>Can be used for messages where no values are needed
|
|
2983
2983
|
|
|
2984
|
-
<a id="size-f9136f"></a>• [`storage_size`](#size-f9136f) - Optional Number<br>Size
|
|
2984
|
+
<a id="size-f9136f"></a>• [`storage_size`](#size-f9136f) - Optional Number<br>Size in GiB of the persistent storage
|
|
2985
2985
|
|
|
2986
2986
|
#### Stateful Service Volumes
|
|
2987
2987
|
|
|
2988
2988
|
A [`volumes`](#stateful-service-volumes) block (within [`stateful_service`](#stateful-service)) supports the following:
|
|
2989
2989
|
|
|
2990
|
-
<a id="stateful-service-volumes-empty-dir"></a>• [`empty_dir`](#stateful-service-volumes-empty-dir) - Optional Block<br>
|
|
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
2991
|
|
|
2992
|
-
<a id="stateful-service-volumes-host-path"></a>• [`host_path`](#stateful-service-volumes-host-path) - Optional Block<br>
|
|
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
2993
|
|
|
2994
2994
|
<a id="stateful-service-volumes-name"></a>• [`name`](#stateful-service-volumes-name) - Optional String<br>Name. Name of the volume
|
|
2995
2995
|
|
|
@@ -2997,7 +2997,7 @@ A [`volumes`](#stateful-service-volumes) block (within [`stateful_service`](#sta
|
|
|
2997
2997
|
|
|
2998
2998
|
An [`empty_dir`](#stateful-service-volumes-empty-dir) block (within [`stateful_service.volumes`](#stateful-service-volumes)) supports the following:
|
|
2999
2999
|
|
|
3000
|
-
<a id="mount-0d2125"></a>• [`mount`](#mount-0d2125) - Optional Block<br>Volume
|
|
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
3001
|
|
|
3002
3002
|
<a id="limit-15665a"></a>• [`size_limit`](#limit-15665a) - Optional Number<br>Size Limit (in GiB)
|
|
3003
3003
|
|
|
@@ -3005,29 +3005,29 @@ An [`empty_dir`](#stateful-service-volumes-empty-dir) block (within [`stateful_s
|
|
|
3005
3005
|
|
|
3006
3006
|
A [`mount`](#mount-0d2125) block (within [`stateful_service.volumes.empty_dir`](#stateful-service-volumes-empty-dir)) supports the following:
|
|
3007
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
|
|
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
3009
|
|
|
3010
|
-
<a id="path-a872b3"></a>• [`mount_path`](#path-a872b3) - Optional String<br>
|
|
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
3011
|
|
|
3012
|
-
<a id="path-812c0d"></a>• [`sub_path`](#path-812c0d) - Optional String Defaults to `'' (volume's root)`<br>
|
|
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
3013
|
|
|
3014
3014
|
#### Stateful Service Volumes Host Path
|
|
3015
3015
|
|
|
3016
3016
|
A [`host_path`](#stateful-service-volumes-host-path) block (within [`stateful_service.volumes`](#stateful-service-volumes)) supports the following:
|
|
3017
3017
|
|
|
3018
|
-
<a id="mount-ebf189"></a>• [`mount`](#mount-ebf189) - Optional Block<br>Volume
|
|
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
3019
|
|
|
3020
|
-
<a id="stateful-service-volumes-host-path-path"></a>• [`path`](#stateful-service-volumes-host-path-path) - Optional String<br>Path
|
|
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
3021
|
|
|
3022
3022
|
#### Stateful Service Volumes Host Path Mount
|
|
3023
3023
|
|
|
3024
3024
|
A [`mount`](#mount-ebf189) block (within [`stateful_service.volumes.host_path`](#stateful-service-volumes-host-path)) supports the following:
|
|
3025
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
|
|
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
3027
|
|
|
3028
|
-
<a id="path-4fa8ea"></a>• [`mount_path`](#path-4fa8ea) - Optional String<br>
|
|
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
3029
|
|
|
3030
|
-
<a id="path-acb5bd"></a>• [`sub_path`](#path-acb5bd) - Optional String Defaults to `'' (volume's root)`<br>
|
|
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
3031
|
|
|
3032
3032
|
#### Timeouts
|
|
3033
3033
|
|