@robinmordasiewicz/f5xc-terraform-mcp 3.5.1 → 3.6.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +104 -283
- 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
|
@@ -121,31 +121,31 @@ resource "f5xc_origin_pool" "example" {
|
|
|
121
121
|
|
|
122
122
|
### Spec Argument Reference
|
|
123
123
|
|
|
124
|
-
<a id="advanced-options"></a>• [`advanced_options`](#advanced-options) - Optional Block Defaults to `null`<br>
|
|
124
|
+
<a id="advanced-options"></a>• [`advanced_options`](#advanced-options) - Optional Block Defaults to `null`<br>Configure Advanced OPTIONS for origin pool<br>See [Advanced Options](#advanced-options) below for details.
|
|
125
125
|
|
|
126
126
|
-> **One of the following:**
|
|
127
|
-
• <a id="automatic-port"></a>[`automatic_port`](#automatic-port) - Optional Block<br>
|
|
128
|
-
<br><br>• <a id="lb-port"></a>[`lb_port`](#lb-port) - Optional Block<br>
|
|
129
|
-
<br><br>• <a id="port"></a>[`port`](#port) - Optional Number<br>
|
|
127
|
+
• <a id="automatic-port"></a>[`automatic_port`](#automatic-port) - Optional Block<br>Can be used for messages where no values are needed
|
|
128
|
+
<br><br>• <a id="lb-port"></a>[`lb_port`](#lb-port) - Optional Block<br>Can be used for messages where no values are needed
|
|
129
|
+
<br><br>• <a id="port"></a>[`port`](#port) - Optional Number<br>Endpoint service is available on this port
|
|
130
130
|
|
|
131
|
-
<a id="endpoint-selection"></a>• [`endpoint_selection`](#endpoint-selection) - Optional String Defaults to `DISTRIBUTED`<br>Possible values are `DISTRIBUTED`, `LOCAL_ONLY`, `LOCAL_PREFERRED`<br>[Enum: DISTRIBUTED|LOCAL_ONLY|LOCAL_PREFERRED]
|
|
131
|
+
<a id="endpoint-selection"></a>• [`endpoint_selection`](#endpoint-selection) - Optional String Defaults to `DISTRIBUTED`<br>Possible values are `DISTRIBUTED`, `LOCAL_ONLY`, `LOCAL_PREFERRED`<br>[Enum: DISTRIBUTED|LOCAL_ONLY|LOCAL_PREFERRED] Policy for selection of endpoints from local site/remote site/both Consider both remote and local endpoints for load balancing LOCAL_ONLY: Consider only local endpoints for load balancing Enable this policy to load balance ONLY among locally discovered endpoints Prefer the local endpoints for
|
|
132
132
|
|
|
133
133
|
-> **One of the following:**
|
|
134
|
-
• <a id="health-check-port"></a>[`health_check_port`](#health-check-port) - Optional Number<br>
|
|
135
|
-
<br><br>• <a id="same-as-endpoint-port"></a>[`same_as_endpoint_port`](#same-as-endpoint-port) - Optional Block<br>
|
|
134
|
+
• <a id="health-check-port"></a>[`health_check_port`](#health-check-port) - Optional Number<br>Port used for performing health check
|
|
135
|
+
<br><br>• <a id="same-as-endpoint-port"></a>[`same_as_endpoint_port`](#same-as-endpoint-port) - Optional Block<br>Can be used for messages where no values are needed
|
|
136
136
|
|
|
137
|
-
<a id="healthcheck"></a>• [`healthcheck`](#healthcheck) - Optional Block<br>
|
|
137
|
+
<a id="healthcheck"></a>• [`healthcheck`](#healthcheck) - Optional Block<br>Reference to healthcheck configuration objects<br>See [Healthcheck](#healthcheck) below for details.
|
|
138
138
|
|
|
139
|
-
<a id="loadbalancer-algorithm"></a>• [`loadbalancer_algorithm`](#loadbalancer-algorithm) - Optional String Defaults to `ROUND_ROBIN`<br>Possible values are `ROUND_ROBIN`, `LEAST_REQUEST`, `RING_HASH`, `RANDOM`, `LB_OVERRIDE`<br>[Enum: ROUND_ROBIN|LEAST_REQUEST|RING_HASH|RANDOM|LB_OVERRIDE]
|
|
139
|
+
<a id="loadbalancer-algorithm"></a>• [`loadbalancer_algorithm`](#loadbalancer-algorithm) - Optional String Defaults to `ROUND_ROBIN`<br>Possible values are `ROUND_ROBIN`, `LEAST_REQUEST`, `RING_HASH`, `RANDOM`, `LB_OVERRIDE`<br>[Enum: ROUND_ROBIN|LEAST_REQUEST|RING_HASH|RANDOM|LB_OVERRIDE] Different load balancing algorithms supported When a connection to a endpoint in an upstream cluster is required, the load balancer uses loadbalancer_algorithm to determine which host is selected. - ROUND_ROBIN: ROUND_ROBIN Policy in which each healthy/available upstream endpoint is selected in
|
|
140
140
|
|
|
141
141
|
-> **One of the following:**
|
|
142
|
-
• <a id="no-tls"></a>[`no_tls`](#no-tls) - Optional Block<br>
|
|
142
|
+
• <a id="no-tls"></a>[`no_tls`](#no-tls) - Optional Block<br>Can be used for messages where no values are needed
|
|
143
143
|
|
|
144
|
-
<a id="origin-servers"></a>• [`origin_servers`](#origin-servers) - Optional Block<br>
|
|
144
|
+
<a id="origin-servers"></a>• [`origin_servers`](#origin-servers) - Optional Block<br>List of origin servers in this pool<br>See [Origin Servers](#origin-servers) below for details.
|
|
145
145
|
|
|
146
146
|
<a id="timeouts"></a>• [`timeouts`](#timeouts) - Optional Block
|
|
147
147
|
|
|
148
|
-
<a id="upstream-conn-pool-reuse-type"></a>• [`upstream_conn_pool_reuse_type`](#upstream-conn-pool-reuse-type) - Optional Block Defaults to `null`<br>Select upstream connection pool reuse state
|
|
148
|
+
<a id="upstream-conn-pool-reuse-type"></a>• [`upstream_conn_pool_reuse_type`](#upstream-conn-pool-reuse-type) - Optional Block Defaults to `null`<br>Select upstream connection pool reuse state for every downstream connection. This configuration choice is for HTTP(S) LB only
|
|
149
149
|
|
|
150
150
|
<a id="use-tls"></a>• [`use_tls`](#use-tls) - Optional Block<br>TLS Parameters for Origin Servers. Upstream TLS Parameters
|
|
151
151
|
|
|
@@ -161,173 +161,173 @@ In addition to all arguments above, the following attributes are exported:
|
|
|
161
161
|
|
|
162
162
|
An [`advanced_options`](#advanced-options) block supports the following:
|
|
163
163
|
|
|
164
|
-
<a id="advanced-options-auto-http-config"></a>• [`auto_http_config`](#advanced-options-auto-http-config) - Optional Block<br>
|
|
164
|
+
<a id="advanced-options-auto-http-config"></a>• [`auto_http_config`](#advanced-options-auto-http-config) - Optional Block<br>Can be used for messages where no values are needed
|
|
165
165
|
|
|
166
|
-
<a id="advanced-options-circuit-breaker"></a>• [`circuit_breaker`](#advanced-options-circuit-breaker) - Optional Block<br>
|
|
166
|
+
<a id="advanced-options-circuit-breaker"></a>• [`circuit_breaker`](#advanced-options-circuit-breaker) - Optional Block<br>CircuitBreaker provides a mechanism for watching failures in upstream connections or requests and if the failures reach a certain threshold, automatically fail subsequent requests which allows to apply back pressure on downstream quickly<br>See [Circuit Breaker](#advanced-options-circuit-breaker) below.
|
|
167
167
|
|
|
168
|
-
<a id="advanced-options-connection-timeout"></a>• [`connection_timeout`](#advanced-options-connection-timeout) - Optional Number Defaults to `2` Specified in milliseconds<br>
|
|
168
|
+
<a id="advanced-options-connection-timeout"></a>• [`connection_timeout`](#advanced-options-connection-timeout) - Optional Number Defaults to `2` Specified in milliseconds<br>The timeout for new network connections to endpoints in the cluster. The seconds
|
|
169
169
|
|
|
170
|
-
<a id="breaker-c470cf"></a>• [`default_circuit_breaker`](#breaker-c470cf) - Optional Block<br>
|
|
170
|
+
<a id="breaker-c470cf"></a>• [`default_circuit_breaker`](#breaker-c470cf) - Optional Block<br>Can be used for messages where no values are needed
|
|
171
171
|
|
|
172
|
-
<a id="breaker-222fdc"></a>• [`disable_circuit_breaker`](#breaker-222fdc) - Optional Block<br>
|
|
172
|
+
<a id="breaker-222fdc"></a>• [`disable_circuit_breaker`](#breaker-222fdc) - Optional Block<br>Can be used for messages where no values are needed
|
|
173
173
|
|
|
174
|
-
<a id="persistance-1139ff"></a>• [`disable_lb_source_ip_persistance`](#persistance-1139ff) - Optional Block<br>
|
|
174
|
+
<a id="persistance-1139ff"></a>• [`disable_lb_source_ip_persistance`](#persistance-1139ff) - Optional Block<br>Can be used for messages where no values are needed
|
|
175
175
|
|
|
176
|
-
<a id="detection-c26369"></a>• [`disable_outlier_detection`](#detection-c26369) - Optional Block<br>
|
|
176
|
+
<a id="detection-c26369"></a>• [`disable_outlier_detection`](#detection-c26369) - Optional Block<br>Can be used for messages where no values are needed
|
|
177
177
|
|
|
178
|
-
<a id="advanced-options-disable-proxy-protocol"></a>• [`disable_proxy_protocol`](#advanced-options-disable-proxy-protocol) - Optional Block<br>
|
|
178
|
+
<a id="advanced-options-disable-proxy-protocol"></a>• [`disable_proxy_protocol`](#advanced-options-disable-proxy-protocol) - Optional Block<br>Can be used for messages where no values are needed
|
|
179
179
|
|
|
180
|
-
<a id="advanced-options-disable-subsets"></a>• [`disable_subsets`](#advanced-options-disable-subsets) - Optional Block<br>
|
|
180
|
+
<a id="advanced-options-disable-subsets"></a>• [`disable_subsets`](#advanced-options-disable-subsets) - Optional Block<br>Can be used for messages where no values are needed
|
|
181
181
|
|
|
182
|
-
<a id="persistance-62e70d"></a>• [`enable_lb_source_ip_persistance`](#persistance-62e70d) - Optional Block<br>
|
|
182
|
+
<a id="persistance-62e70d"></a>• [`enable_lb_source_ip_persistance`](#persistance-62e70d) - Optional Block<br>Can be used for messages where no values are needed
|
|
183
183
|
|
|
184
|
-
<a id="advanced-options-enable-subsets"></a>• [`enable_subsets`](#advanced-options-enable-subsets) - Optional Block<br>
|
|
184
|
+
<a id="advanced-options-enable-subsets"></a>• [`enable_subsets`](#advanced-options-enable-subsets) - Optional Block<br>Configure subset OPTIONS for origin pool<br>See [Enable Subsets](#advanced-options-enable-subsets) below.
|
|
185
185
|
|
|
186
|
-
<a id="advanced-options-http1-config"></a>• [`http1_config`](#advanced-options-http1-config) - Optional Block<br>HTTP/1.1 Protocol OPTIONS
|
|
186
|
+
<a id="advanced-options-http1-config"></a>• [`http1_config`](#advanced-options-http1-config) - Optional Block<br>HTTP/1.1 Protocol OPTIONS for upstream connections<br>See [Http1 Config](#advanced-options-http1-config) below.
|
|
187
187
|
|
|
188
|
-
<a id="advanced-options-http2-options"></a>• [`http2_options`](#advanced-options-http2-options) - Optional Block<br>Http2 Protocol OPTIONS
|
|
188
|
+
<a id="advanced-options-http2-options"></a>• [`http2_options`](#advanced-options-http2-options) - Optional Block<br>Http2 Protocol OPTIONS for upstream connections<br>See [Http2 Options](#advanced-options-http2-options) below.
|
|
189
189
|
|
|
190
|
-
<a id="advanced-options-http-idle-timeout"></a>• [`http_idle_timeout`](#advanced-options-http-idle-timeout) - Optional Number
|
|
190
|
+
<a id="advanced-options-http-idle-timeout"></a>• [`http_idle_timeout`](#advanced-options-http-idle-timeout) - Optional Number<br>The idle timeout for upstream connection pool connections. The idle timeout is defined as the period in which there are no active requests. When the idle timeout is reached the connection will be closed
|
|
191
191
|
|
|
192
|
-
<a id="advanced-options-no-panic-threshold"></a>• [`no_panic_threshold`](#advanced-options-no-panic-threshold) - Optional Block<br>
|
|
192
|
+
<a id="advanced-options-no-panic-threshold"></a>• [`no_panic_threshold`](#advanced-options-no-panic-threshold) - Optional Block<br>Can be used for messages where no values are needed
|
|
193
193
|
|
|
194
|
-
<a id="advanced-options-outlier-detection"></a>• [`outlier_detection`](#advanced-options-outlier-detection) - Optional Block<br>Outlier
|
|
194
|
+
<a id="advanced-options-outlier-detection"></a>• [`outlier_detection`](#advanced-options-outlier-detection) - Optional Block<br>Outlier detection and ejection is the process of dynamically determining whether some number of hosts in an upstream cluster are performing unlike the others and removing them from the healthy load balancing set. Outlier detection is a form of passive health checking. Algorithm 1<br>See [Outlier Detection](#advanced-options-outlier-detection) below.
|
|
195
195
|
|
|
196
|
-
<a id="advanced-options-panic-threshold"></a>• [`panic_threshold`](#advanced-options-panic-threshold) - Optional Number<br>
|
|
196
|
+
<a id="advanced-options-panic-threshold"></a>• [`panic_threshold`](#advanced-options-panic-threshold) - Optional Number<br>Configure a threshold (percentage of unhealthy endpoints) below which all endpoints will be considered for load balancing ignoring its health status
|
|
197
197
|
|
|
198
|
-
<a id="advanced-options-proxy-protocol-v1"></a>• [`proxy_protocol_v1`](#advanced-options-proxy-protocol-v1) - Optional Block<br>
|
|
198
|
+
<a id="advanced-options-proxy-protocol-v1"></a>• [`proxy_protocol_v1`](#advanced-options-proxy-protocol-v1) - Optional Block<br>Can be used for messages where no values are needed
|
|
199
199
|
|
|
200
|
-
<a id="advanced-options-proxy-protocol-v2"></a>• [`proxy_protocol_v2`](#advanced-options-proxy-protocol-v2) - Optional Block<br>
|
|
200
|
+
<a id="advanced-options-proxy-protocol-v2"></a>• [`proxy_protocol_v2`](#advanced-options-proxy-protocol-v2) - Optional Block<br>Can be used for messages where no values are needed
|
|
201
201
|
|
|
202
202
|
#### Advanced Options Circuit Breaker
|
|
203
203
|
|
|
204
204
|
A [`circuit_breaker`](#advanced-options-circuit-breaker) block (within [`advanced_options`](#advanced-options)) supports the following:
|
|
205
205
|
|
|
206
|
-
<a id="limit-2f511c"></a>• [`connection_limit`](#limit-2f511c) - Optional Number<br>
|
|
206
|
+
<a id="limit-2f511c"></a>• [`connection_limit`](#limit-2f511c) - Optional Number<br>The maximum number of connections that loadbalancer will establish to all hosts in an upstream cluster. In practice this is only applicable to TCP and HTTP/1.1 clusters since HTTP/2 uses a single connection to each host. Remove endpoint out of load balancing decision, if number of connections
|
|
207
207
|
|
|
208
|
-
<a id="requests-f8e924"></a>• [`max_requests`](#requests-f8e924) - Optional Number<br>
|
|
208
|
+
<a id="requests-f8e924"></a>• [`max_requests`](#requests-f8e924) - Optional Number<br>The maximum number of requests that can be outstanding to all hosts in a cluster at any given time. In practice this is applicable to HTTP/2 clusters since HTTP/1.1 clusters are governed by the maximum connections (connection_limit). Remove endpoint out of load balancing decision, if requests
|
|
209
209
|
|
|
210
|
-
<a id="requests-51e30f"></a>• [`pending_requests`](#requests-51e30f) - Optional Number<br>
|
|
210
|
+
<a id="requests-51e30f"></a>• [`pending_requests`](#requests-51e30f) - Optional Number<br>The maximum number of requests that will be queued while waiting for a ready connection pool connection. Since HTTP/2 requests are sent over a single connection, this circuit breaker only comes into play as the initial connection is created, as requests will be multiplexed immediately
|
|
211
211
|
|
|
212
|
-
<a id="priority-0e16c5"></a>• [`priority`](#priority-0e16c5) - Optional String Defaults to `DEFAULT`<br>Possible values are `DEFAULT`, `HIGH`<br>[Enum: DEFAULT|HIGH]
|
|
212
|
+
<a id="priority-0e16c5"></a>• [`priority`](#priority-0e16c5) - Optional String Defaults to `DEFAULT`<br>Possible values are `DEFAULT`, `HIGH`<br>[Enum: DEFAULT|HIGH] Priority routing for each request. Different connection pools are used based on the priority selected for the request. Also, circuit-breaker configuration at destination cluster is chosen based on selected priority
|
|
213
213
|
|
|
214
|
-
<a id="retries-18e401"></a>• [`retries`](#retries-18e401) - Optional Number<br>
|
|
214
|
+
<a id="retries-18e401"></a>• [`retries`](#retries-18e401) - Optional Number<br>The maximum number of retries that can be outstanding to all hosts in a cluster at any given time. Remove endpoint out of load balancing decision, if retries for request exceed this count
|
|
215
215
|
|
|
216
216
|
#### Advanced Options Enable Subsets
|
|
217
217
|
|
|
218
218
|
An [`enable_subsets`](#advanced-options-enable-subsets) block (within [`advanced_options`](#advanced-options)) supports the following:
|
|
219
219
|
|
|
220
|
-
<a id="endpoint-0fc3f9"></a>• [`any_endpoint`](#endpoint-0fc3f9) - Optional Block<br>
|
|
220
|
+
<a id="endpoint-0fc3f9"></a>• [`any_endpoint`](#endpoint-0fc3f9) - Optional Block<br>Can be used for messages where no values are needed
|
|
221
221
|
|
|
222
222
|
<a id="subset-276c69"></a>• [`default_subset`](#subset-276c69) - Optional Block<br>Origin Pool Default Subset. Default Subset definition<br>See [Default Subset](#subset-276c69) below.
|
|
223
223
|
|
|
224
|
-
<a id="subsets-25c75e"></a>• [`endpoint_subsets`](#subsets-25c75e) - Optional Block<br>
|
|
224
|
+
<a id="subsets-25c75e"></a>• [`endpoint_subsets`](#subsets-25c75e) - Optional Block<br>List of subset class. Subsets class is defined using list of keys. Every unique combination of values of these keys form a subset withing the class<br>See [Endpoint Subsets](#subsets-25c75e) below.
|
|
225
225
|
|
|
226
|
-
<a id="request-49c0b8"></a>• [`fail_request`](#request-49c0b8) - Optional Block<br>
|
|
226
|
+
<a id="request-49c0b8"></a>• [`fail_request`](#request-49c0b8) - Optional Block<br>Can be used for messages where no values are needed
|
|
227
227
|
|
|
228
228
|
#### Advanced Options Enable Subsets Default Subset
|
|
229
229
|
|
|
230
230
|
A [`default_subset`](#subset-276c69) block (within [`advanced_options.enable_subsets`](#advanced-options-enable-subsets)) supports the following:
|
|
231
231
|
|
|
232
|
-
<a id="subset-4951d9"></a>• [`default_subset`](#subset-4951d9) - Optional Block<br>
|
|
232
|
+
<a id="subset-4951d9"></a>• [`default_subset`](#subset-4951d9) - Optional Block<br>List of key-value pairs that define default subset. Which gets used when route specifies no metadata or no subset matching the metadata exists
|
|
233
233
|
|
|
234
234
|
#### Advanced Options Enable Subsets Endpoint Subsets
|
|
235
235
|
|
|
236
236
|
An [`endpoint_subsets`](#subsets-25c75e) block (within [`advanced_options.enable_subsets`](#advanced-options-enable-subsets)) supports the following:
|
|
237
237
|
|
|
238
|
-
<a id="keys-3828db"></a>• [`keys`](#keys-3828db) - Optional List<br>
|
|
238
|
+
<a id="keys-3828db"></a>• [`keys`](#keys-3828db) - Optional List<br>List of keys that define a cluster subset class
|
|
239
239
|
|
|
240
240
|
#### Advanced Options Http1 Config
|
|
241
241
|
|
|
242
242
|
A [`http1_config`](#advanced-options-http1-config) block (within [`advanced_options`](#advanced-options)) supports the following:
|
|
243
243
|
|
|
244
|
-
<a id="transformation-1e4851"></a>• [`header_transformation`](#transformation-1e4851) - Optional Block<br>Header Transformation
|
|
244
|
+
<a id="transformation-1e4851"></a>• [`header_transformation`](#transformation-1e4851) - Optional Block<br>Header Transformation OPTIONS for HTTP/1.1 request/response headers<br>See [Header Transformation](#transformation-1e4851) below.
|
|
245
245
|
|
|
246
246
|
#### Advanced Options Http1 Config Header Transformation
|
|
247
247
|
|
|
248
248
|
A [`header_transformation`](#transformation-1e4851) block (within [`advanced_options.http1_config`](#advanced-options-http1-config)) supports the following:
|
|
249
249
|
|
|
250
|
-
<a id="transformation-6fa15c"></a>• [`default_header_transformation`](#transformation-6fa15c) - Optional Block<br>
|
|
250
|
+
<a id="transformation-6fa15c"></a>• [`default_header_transformation`](#transformation-6fa15c) - Optional Block<br>Can be used for messages where no values are needed
|
|
251
251
|
|
|
252
|
-
<a id="transformation-c4c936"></a>• [`legacy_header_transformation`](#transformation-c4c936) - Optional Block<br>
|
|
252
|
+
<a id="transformation-c4c936"></a>• [`legacy_header_transformation`](#transformation-c4c936) - Optional Block<br>Can be used for messages where no values are needed
|
|
253
253
|
|
|
254
|
-
<a id="transformation-923ab8"></a>• [`preserve_case_header_transformation`](#transformation-923ab8) - Optional Block<br>
|
|
254
|
+
<a id="transformation-923ab8"></a>• [`preserve_case_header_transformation`](#transformation-923ab8) - Optional Block<br>Can be used for messages where no values are needed
|
|
255
255
|
|
|
256
|
-
<a id="transformation-1ce9d5"></a>• [`proper_case_header_transformation`](#transformation-1ce9d5) - Optional Block<br>
|
|
256
|
+
<a id="transformation-1ce9d5"></a>• [`proper_case_header_transformation`](#transformation-1ce9d5) - Optional Block<br>Can be used for messages where no values are needed
|
|
257
257
|
|
|
258
258
|
#### Advanced Options Http2 Options
|
|
259
259
|
|
|
260
260
|
A [`http2_options`](#advanced-options-http2-options) block (within [`advanced_options`](#advanced-options)) supports the following:
|
|
261
261
|
|
|
262
|
-
<a id="advanced-options-http2-options-enabled"></a>• [`enabled`](#advanced-options-http2-options-enabled) - Optional Bool<br>
|
|
262
|
+
<a id="advanced-options-http2-options-enabled"></a>• [`enabled`](#advanced-options-http2-options-enabled) - Optional Bool<br>Enable/disable HTTP2 Protocol for upstream connections
|
|
263
263
|
|
|
264
264
|
#### Advanced Options Outlier Detection
|
|
265
265
|
|
|
266
266
|
An [`outlier_detection`](#advanced-options-outlier-detection) block (within [`advanced_options`](#advanced-options)) supports the following:
|
|
267
267
|
|
|
268
|
-
<a id="time-3534e9"></a>• [`base_ejection_time`](#time-3534e9) - Optional Number
|
|
268
|
+
<a id="time-3534e9"></a>• [`base_ejection_time`](#time-3534e9) - Optional Number<br>The base time that a host is ejected for. The real time is equal to the base time multiplied by the number of times the host has been ejected. This causes hosts to GET ejected for longer periods if they continue to fail
|
|
269
269
|
|
|
270
|
-
<a id="5xx-ff28ef"></a>• [`consecutive_5xx`](#5xx-ff28ef) - Optional Number
|
|
270
|
+
<a id="5xx-ff28ef"></a>• [`consecutive_5xx`](#5xx-ff28ef) - Optional Number<br>If an upstream endpoint returns some number of consecutive 5xx, it will be ejected. Note that in this case a 5xx means an actual 5xx respond code, or an event that would cause the HTTP router to return one on the upstream’s behalf(reset, connection failure, etc.) consecutive_5xx indicates the
|
|
271
271
|
|
|
272
|
-
<a id="failure-fbd9bf"></a>• [`consecutive_gateway_failure`](#failure-fbd9bf) - Optional Number
|
|
272
|
+
<a id="failure-fbd9bf"></a>• [`consecutive_gateway_failure`](#failure-fbd9bf) - Optional Number<br>If an upstream endpoint returns some number of consecutive “gateway errors” (502, 503 or 504 status code), it will be ejected. Note that this includes events that would cause the HTTP router to return one of these status codes on the upstream’s behalf (reset, connection failure, etc.)
|
|
273
273
|
|
|
274
|
-
<a id="interval-5cb76c"></a>• [`interval`](#interval-5cb76c) - Optional Number Defaults to `10000ms
|
|
274
|
+
<a id="interval-5cb76c"></a>• [`interval`](#interval-5cb76c) - Optional Number Defaults to `10000ms`<br>The time interval between ejection analysis sweeps. This can result in both new ejections as well as endpoints being returned to service
|
|
275
275
|
|
|
276
|
-
<a id="percent-6b6ee2"></a>• [`max_ejection_percent`](#percent-6b6ee2) - Optional Number Defaults to `10%`<br>
|
|
276
|
+
<a id="percent-6b6ee2"></a>• [`max_ejection_percent`](#percent-6b6ee2) - Optional Number Defaults to `10%`<br>The maximum % of an upstream cluster that can be ejected due to outlier detection. but will eject at least one host regardless of the value
|
|
277
277
|
|
|
278
278
|
#### Healthcheck
|
|
279
279
|
|
|
280
280
|
A [`healthcheck`](#healthcheck) block supports the following:
|
|
281
281
|
|
|
282
|
-
<a id="healthcheck-name"></a>• [`name`](#healthcheck-name) - Optional String<br>
|
|
282
|
+
<a id="healthcheck-name"></a>• [`name`](#healthcheck-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
|
|
283
283
|
|
|
284
|
-
<a id="healthcheck-namespace"></a>• [`namespace`](#healthcheck-namespace) - Optional String<br>
|
|
284
|
+
<a id="healthcheck-namespace"></a>• [`namespace`](#healthcheck-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
|
|
285
285
|
|
|
286
|
-
<a id="healthcheck-tenant"></a>• [`tenant`](#healthcheck-tenant) - Optional String<br>
|
|
286
|
+
<a id="healthcheck-tenant"></a>• [`tenant`](#healthcheck-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
|
|
287
287
|
|
|
288
288
|
#### Origin Servers
|
|
289
289
|
|
|
290
290
|
An [`origin_servers`](#origin-servers) block supports the following:
|
|
291
291
|
|
|
292
|
-
<a id="origin-servers-cbip-service"></a>• [`cbip_service`](#origin-servers-cbip-service) - Optional Block<br>
|
|
292
|
+
<a id="origin-servers-cbip-service"></a>• [`cbip_service`](#origin-servers-cbip-service) - Optional Block<br>Specify origin server with Classic BIG-IP Service (Virtual Server)<br>See [Cbip Service](#origin-servers-cbip-service) below.
|
|
293
293
|
|
|
294
|
-
<a id="origin-servers-consul-service"></a>• [`consul_service`](#origin-servers-consul-service) - Optional Block<br>
|
|
294
|
+
<a id="origin-servers-consul-service"></a>• [`consul_service`](#origin-servers-consul-service) - Optional Block<br>Specify origin server with Hashi Corp Consul service name and site information<br>See [Consul Service](#origin-servers-consul-service) below.
|
|
295
295
|
|
|
296
|
-
<a id="origin-servers-custom-endpoint-object"></a>• [`custom_endpoint_object`](#origin-servers-custom-endpoint-object) - Optional Block<br>
|
|
296
|
+
<a id="origin-servers-custom-endpoint-object"></a>• [`custom_endpoint_object`](#origin-servers-custom-endpoint-object) - Optional Block<br>Specify origin server with a reference to endpoint object<br>See [Custom Endpoint Object](#origin-servers-custom-endpoint-object) below.
|
|
297
297
|
|
|
298
|
-
<a id="origin-servers-k8s-service"></a>• [`k8s_service`](#origin-servers-k8s-service) - Optional Block<br>
|
|
298
|
+
<a id="origin-servers-k8s-service"></a>• [`k8s_service`](#origin-servers-k8s-service) - Optional Block<br>Specify origin server with K8S service name and site information<br>See [K8S Service](#origin-servers-k8s-service) below.
|
|
299
299
|
|
|
300
|
-
<a id="origin-servers-labels"></a>• [`labels`](#origin-servers-labels) - Optional Block<br>
|
|
300
|
+
<a id="origin-servers-labels"></a>• [`labels`](#origin-servers-labels) - Optional Block<br>Add Labels for this origin server, these labels can be used to form subset
|
|
301
301
|
|
|
302
|
-
<a id="origin-servers-private-ip"></a>• [`private_ip`](#origin-servers-private-ip) - Optional Block<br>
|
|
302
|
+
<a id="origin-servers-private-ip"></a>• [`private_ip`](#origin-servers-private-ip) - Optional Block<br>Specify origin server with private or public IP address and site information<br>See [Private IP](#origin-servers-private-ip) below.
|
|
303
303
|
|
|
304
|
-
<a id="origin-servers-private-name"></a>• [`private_name`](#origin-servers-private-name) - Optional Block<br>
|
|
304
|
+
<a id="origin-servers-private-name"></a>• [`private_name`](#origin-servers-private-name) - Optional Block<br>Specify origin server with private or public DNS name and site information<br>See [Private Name](#origin-servers-private-name) below.
|
|
305
305
|
|
|
306
|
-
<a id="origin-servers-public-ip"></a>• [`public_ip`](#origin-servers-public-ip) - Optional Block<br>
|
|
306
|
+
<a id="origin-servers-public-ip"></a>• [`public_ip`](#origin-servers-public-ip) - Optional Block<br>Specify origin server with public IP address<br>See [Public IP](#origin-servers-public-ip) below.
|
|
307
307
|
|
|
308
|
-
<a id="origin-servers-public-name"></a>• [`public_name`](#origin-servers-public-name) - Optional Block<br>
|
|
308
|
+
<a id="origin-servers-public-name"></a>• [`public_name`](#origin-servers-public-name) - Optional Block<br>Specify origin server with public DNS name<br>See [Public Name](#origin-servers-public-name) below.
|
|
309
309
|
|
|
310
|
-
<a id="origin-servers-vn-private-ip"></a>• [`vn_private_ip`](#origin-servers-vn-private-ip) - Optional Block<br>
|
|
310
|
+
<a id="origin-servers-vn-private-ip"></a>• [`vn_private_ip`](#origin-servers-vn-private-ip) - Optional Block<br>Specify origin server with IP on Virtual Network<br>See [Vn Private IP](#origin-servers-vn-private-ip) below.
|
|
311
311
|
|
|
312
|
-
<a id="origin-servers-vn-private-name"></a>• [`vn_private_name`](#origin-servers-vn-private-name) - Optional Block<br>
|
|
312
|
+
<a id="origin-servers-vn-private-name"></a>• [`vn_private_name`](#origin-servers-vn-private-name) - Optional Block<br>Specify origin server with DNS name on Virtual Network<br>See [Vn Private Name](#origin-servers-vn-private-name) below.
|
|
313
313
|
|
|
314
314
|
#### Origin Servers Cbip Service
|
|
315
315
|
|
|
316
316
|
A [`cbip_service`](#origin-servers-cbip-service) block (within [`origin_servers`](#origin-servers)) supports the following:
|
|
317
317
|
|
|
318
|
-
<a id="name-d75410"></a>• [`service_name`](#name-d75410) - Optional String<br>
|
|
318
|
+
<a id="name-d75410"></a>• [`service_name`](#name-d75410) - Optional String<br>Name of the discovered Classic BIG-IP virtual server to be used as origin
|
|
319
319
|
|
|
320
320
|
#### Origin Servers Consul Service
|
|
321
321
|
|
|
322
322
|
A [`consul_service`](#origin-servers-consul-service) block (within [`origin_servers`](#origin-servers)) supports the following:
|
|
323
323
|
|
|
324
|
-
<a id="network-5b2697"></a>• [`inside_network`](#network-5b2697) - Optional Block<br>
|
|
324
|
+
<a id="network-5b2697"></a>• [`inside_network`](#network-5b2697) - Optional Block<br>Can be used for messages where no values are needed
|
|
325
325
|
|
|
326
|
-
<a id="network-844fc7"></a>• [`outside_network`](#network-844fc7) - Optional Block<br>
|
|
326
|
+
<a id="network-844fc7"></a>• [`outside_network`](#network-844fc7) - Optional Block<br>Can be used for messages where no values are needed
|
|
327
327
|
|
|
328
|
-
<a id="name-e2ff9a"></a>• [`service_name`](#name-e2ff9a) - Optional String<br>
|
|
328
|
+
<a id="name-e2ff9a"></a>• [`service_name`](#name-e2ff9a) - Optional String<br>Consul service name of this origin server will be listed, including cluster-ID. The format is servicename:cluster-ID
|
|
329
329
|
|
|
330
|
-
<a id="locator-0ecb39"></a>• [`site_locator`](#locator-0ecb39) - Optional Block<br>
|
|
330
|
+
<a id="locator-0ecb39"></a>• [`site_locator`](#locator-0ecb39) - Optional Block<br>Message defines a reference to a site or virtual site object<br>See [Site Locator](#locator-0ecb39) below.
|
|
331
331
|
|
|
332
332
|
<a id="origin-servers-consul-service-snat-pool"></a>• [`snat_pool`](#origin-servers-consul-service-snat-pool) - Optional Block<br>SNAT Pool. SNAT Pool configuration<br>See [Snat Pool](#origin-servers-consul-service-snat-pool) below.
|
|
333
333
|
|
|
@@ -335,19 +335,19 @@ A [`consul_service`](#origin-servers-consul-service) block (within [`origin_serv
|
|
|
335
335
|
|
|
336
336
|
A [`site_locator`](#locator-0ecb39) block (within [`origin_servers.consul_service`](#origin-servers-consul-service)) supports the following:
|
|
337
337
|
|
|
338
|
-
<a id="site-a096eb"></a>• [`site`](#site-a096eb) - Optional Block<br>
|
|
338
|
+
<a id="site-a096eb"></a>• [`site`](#site-a096eb) - 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 [Site](#site-a096eb) below.
|
|
339
339
|
|
|
340
|
-
<a id="site-faf4b5"></a>• [`virtual_site`](#site-faf4b5) - Optional Block<br>
|
|
340
|
+
<a id="site-faf4b5"></a>• [`virtual_site`](#site-faf4b5) - 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 [Virtual Site](#site-faf4b5) below.
|
|
341
341
|
|
|
342
342
|
#### Origin Servers Consul Service Site Locator Site
|
|
343
343
|
|
|
344
344
|
A [`site`](#site-a096eb) block (within [`origin_servers.consul_service.site_locator`](#locator-0ecb39)) supports the following:
|
|
345
345
|
|
|
346
|
-
<a id="name-8a907a"></a>• [`name`](#name-8a907a) - Optional String<br>
|
|
346
|
+
<a id="name-8a907a"></a>• [`name`](#name-8a907a) - 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
|
|
347
347
|
|
|
348
|
-
<a id="namespace-933dcd"></a>• [`namespace`](#namespace-933dcd) - Optional String<br>
|
|
348
|
+
<a id="namespace-933dcd"></a>• [`namespace`](#namespace-933dcd) - 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
|
|
349
349
|
|
|
350
|
-
<a id="tenant-c92ea9"></a>• [`tenant`](#tenant-c92ea9) - Optional String<br>
|
|
350
|
+
<a id="tenant-c92ea9"></a>• [`tenant`](#tenant-c92ea9) - 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
|
|
351
351
|
|
|
352
352
|
#### Origin Servers Consul Service Site Locator Virtual Site
|
|
353
353
|
|
|
@@ -357,9 +357,9 @@ A [`site`](#site-a096eb) block (within [`origin_servers.consul_service.site_loca
|
|
|
357
357
|
|
|
358
358
|
A [`snat_pool`](#origin-servers-consul-service-snat-pool) block (within [`origin_servers.consul_service`](#origin-servers-consul-service)) supports the following:
|
|
359
359
|
|
|
360
|
-
<a id="pool-8eb799"></a>• [`no_snat_pool`](#pool-8eb799) - Optional Block<br>
|
|
360
|
+
<a id="pool-8eb799"></a>• [`no_snat_pool`](#pool-8eb799) - Optional Block<br>Can be used for messages where no values are needed
|
|
361
361
|
|
|
362
|
-
<a id="pool-fc27df"></a>• [`snat_pool`](#pool-fc27df) - Optional Block<br>
|
|
362
|
+
<a id="pool-fc27df"></a>• [`snat_pool`](#pool-fc27df) - Optional Block<br>List of IPv4 prefixes that represent an endpoint<br>See [Snat Pool](#pool-fc27df) below.
|
|
363
363
|
|
|
364
364
|
#### Origin Servers Consul Service Snat Pool Snat Pool
|
|
365
365
|
|
|
@@ -369,53 +369,53 @@ A [`snat_pool`](#origin-servers-consul-service-snat-pool) block (within [`origin
|
|
|
369
369
|
|
|
370
370
|
A [`custom_endpoint_object`](#origin-servers-custom-endpoint-object) block (within [`origin_servers`](#origin-servers)) supports the following:
|
|
371
371
|
|
|
372
|
-
<a id="endpoint-6a2e33"></a>• [`endpoint`](#endpoint-6a2e33) - Optional Block<br>
|
|
372
|
+
<a id="endpoint-6a2e33"></a>• [`endpoint`](#endpoint-6a2e33) - 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 [Endpoint](#endpoint-6a2e33) below.
|
|
373
373
|
|
|
374
374
|
#### Origin Servers Custom Endpoint Object Endpoint
|
|
375
375
|
|
|
376
376
|
An [`endpoint`](#endpoint-6a2e33) block (within [`origin_servers.custom_endpoint_object`](#origin-servers-custom-endpoint-object)) supports the following:
|
|
377
377
|
|
|
378
|
-
<a id="name-33e632"></a>• [`name`](#name-33e632) - Optional String<br>
|
|
378
|
+
<a id="name-33e632"></a>• [`name`](#name-33e632) - 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
|
|
379
379
|
|
|
380
|
-
<a id="namespace-ea699e"></a>• [`namespace`](#namespace-ea699e) - Optional String<br>
|
|
380
|
+
<a id="namespace-ea699e"></a>• [`namespace`](#namespace-ea699e) - 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
|
|
381
381
|
|
|
382
|
-
<a id="tenant-45ea6c"></a>• [`tenant`](#tenant-45ea6c) - Optional String<br>
|
|
382
|
+
<a id="tenant-45ea6c"></a>• [`tenant`](#tenant-45ea6c) - 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
|
|
383
383
|
|
|
384
384
|
#### Origin Servers K8S Service
|
|
385
385
|
|
|
386
386
|
A [`k8s_service`](#origin-servers-k8s-service) block (within [`origin_servers`](#origin-servers)) supports the following:
|
|
387
387
|
|
|
388
|
-
<a id="network-698e40"></a>• [`inside_network`](#network-698e40) - Optional Block<br>
|
|
388
|
+
<a id="network-698e40"></a>• [`inside_network`](#network-698e40) - Optional Block<br>Can be used for messages where no values are needed
|
|
389
389
|
|
|
390
|
-
<a id="network-4852ec"></a>• [`outside_network`](#network-4852ec) - Optional Block<br>
|
|
390
|
+
<a id="network-4852ec"></a>• [`outside_network`](#network-4852ec) - Optional Block<br>Can be used for messages where no values are needed
|
|
391
391
|
|
|
392
|
-
<a id="origin-servers-k8s-service-protocol"></a>• [`protocol`](#origin-servers-k8s-service-protocol) - Optional String Defaults to `PROTOCOL_TCP`<br>Possible values are `PROTOCOL_TCP`, `PROTOCOL_UDP`<br>[Enum: PROTOCOL_TCP|PROTOCOL_UDP]
|
|
392
|
+
<a id="origin-servers-k8s-service-protocol"></a>• [`protocol`](#origin-servers-k8s-service-protocol) - Optional String Defaults to `PROTOCOL_TCP`<br>Possible values are `PROTOCOL_TCP`, `PROTOCOL_UDP`<br>[Enum: PROTOCOL_TCP|PROTOCOL_UDP] Type of protocol - PROTOCOL_TCP: TCP - PROTOCOL_UDP: UDP
|
|
393
393
|
|
|
394
|
-
<a id="origin-servers-k8s-service-service-name"></a>• [`service_name`](#origin-servers-k8s-service-service-name) - Optional String<br>
|
|
394
|
+
<a id="origin-servers-k8s-service-service-name"></a>• [`service_name`](#origin-servers-k8s-service-service-name) - Optional String<br>K8S service name of the origin server will be listed, including the namespace and cluster-ID. For vK8s services, you need to enter a string with the format servicename.namespace:cluster-ID. If the servicename is 'frontend', namespace is 'speedtest' and cluster-ID is 'prod'
|
|
395
395
|
|
|
396
|
-
<a id="origin-servers-k8s-service-site-locator"></a>• [`site_locator`](#origin-servers-k8s-service-site-locator) - Optional Block<br>
|
|
396
|
+
<a id="origin-servers-k8s-service-site-locator"></a>• [`site_locator`](#origin-servers-k8s-service-site-locator) - Optional Block<br>Message defines a reference to a site or virtual site object<br>See [Site Locator](#origin-servers-k8s-service-site-locator) below.
|
|
397
397
|
|
|
398
398
|
<a id="origin-servers-k8s-service-snat-pool"></a>• [`snat_pool`](#origin-servers-k8s-service-snat-pool) - Optional Block<br>SNAT Pool. SNAT Pool configuration<br>See [Snat Pool](#origin-servers-k8s-service-snat-pool) below.
|
|
399
399
|
|
|
400
|
-
<a id="networks-d41308"></a>• [`vk8s_networks`](#networks-d41308) - Optional Block<br>
|
|
400
|
+
<a id="networks-d41308"></a>• [`vk8s_networks`](#networks-d41308) - Optional Block<br>Can be used for messages where no values are needed
|
|
401
401
|
|
|
402
402
|
#### Origin Servers K8S Service Site Locator
|
|
403
403
|
|
|
404
404
|
A [`site_locator`](#origin-servers-k8s-service-site-locator) block (within [`origin_servers.k8s_service`](#origin-servers-k8s-service)) supports the following:
|
|
405
405
|
|
|
406
|
-
<a id="site-e35217"></a>• [`site`](#site-e35217) - Optional Block<br>
|
|
406
|
+
<a id="site-e35217"></a>• [`site`](#site-e35217) - 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 [Site](#site-e35217) below.
|
|
407
407
|
|
|
408
|
-
<a id="site-0ef9ba"></a>• [`virtual_site`](#site-0ef9ba) - Optional Block<br>
|
|
408
|
+
<a id="site-0ef9ba"></a>• [`virtual_site`](#site-0ef9ba) - 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 [Virtual Site](#site-0ef9ba) below.
|
|
409
409
|
|
|
410
410
|
#### Origin Servers K8S Service Site Locator Site
|
|
411
411
|
|
|
412
412
|
A [`site`](#site-e35217) block (within [`origin_servers.k8s_service.site_locator`](#origin-servers-k8s-service-site-locator)) supports the following:
|
|
413
413
|
|
|
414
|
-
<a id="name-b0bc0e"></a>• [`name`](#name-b0bc0e) - Optional String<br>
|
|
414
|
+
<a id="name-b0bc0e"></a>• [`name`](#name-b0bc0e) - 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
|
|
415
415
|
|
|
416
|
-
<a id="namespace-bc6979"></a>• [`namespace`](#namespace-bc6979) - Optional String<br>
|
|
416
|
+
<a id="namespace-bc6979"></a>• [`namespace`](#namespace-bc6979) - 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
|
|
417
417
|
|
|
418
|
-
<a id="tenant-097ea8"></a>• [`tenant`](#tenant-097ea8) - Optional String<br>
|
|
418
|
+
<a id="tenant-097ea8"></a>• [`tenant`](#tenant-097ea8) - 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
|
|
419
419
|
|
|
420
420
|
#### Origin Servers K8S Service Site Locator Virtual Site
|
|
421
421
|
|
|
@@ -425,9 +425,9 @@ A [`site`](#site-e35217) block (within [`origin_servers.k8s_service.site_locator
|
|
|
425
425
|
|
|
426
426
|
A [`snat_pool`](#origin-servers-k8s-service-snat-pool) block (within [`origin_servers.k8s_service`](#origin-servers-k8s-service)) supports the following:
|
|
427
427
|
|
|
428
|
-
<a id="pool-57d5fe"></a>• [`no_snat_pool`](#pool-57d5fe) - Optional Block<br>
|
|
428
|
+
<a id="pool-57d5fe"></a>• [`no_snat_pool`](#pool-57d5fe) - Optional Block<br>Can be used for messages where no values are needed
|
|
429
429
|
|
|
430
|
-
<a id="pool-8c0889"></a>• [`snat_pool`](#pool-8c0889) - Optional Block<br>
|
|
430
|
+
<a id="pool-8c0889"></a>• [`snat_pool`](#pool-8c0889) - Optional Block<br>List of IPv4 prefixes that represent an endpoint<br>See [Snat Pool](#pool-8c0889) below.
|
|
431
431
|
|
|
432
432
|
#### Origin Servers K8S Service Snat Pool Snat Pool
|
|
433
433
|
|
|
@@ -437,15 +437,15 @@ A [`snat_pool`](#origin-servers-k8s-service-snat-pool) block (within [`origin_se
|
|
|
437
437
|
|
|
438
438
|
A [`private_ip`](#origin-servers-private-ip) block (within [`origin_servers`](#origin-servers)) supports the following:
|
|
439
439
|
|
|
440
|
-
<a id="network-340769"></a>• [`inside_network`](#network-340769) - Optional Block<br>
|
|
440
|
+
<a id="network-340769"></a>• [`inside_network`](#network-340769) - Optional Block<br>Can be used for messages where no values are needed
|
|
441
441
|
|
|
442
442
|
<a id="origin-servers-private-ip-ip"></a>• [`ip`](#origin-servers-private-ip-ip) - Optional String<br>IP. Private IPv4 address
|
|
443
443
|
|
|
444
|
-
<a id="network-4b8cd1"></a>• [`outside_network`](#network-4b8cd1) - Optional Block<br>
|
|
444
|
+
<a id="network-4b8cd1"></a>• [`outside_network`](#network-4b8cd1) - Optional Block<br>Can be used for messages where no values are needed
|
|
445
445
|
|
|
446
|
-
<a id="origin-servers-private-ip-segment"></a>• [`segment`](#origin-servers-private-ip-segment) - Optional Block<br>
|
|
446
|
+
<a id="origin-servers-private-ip-segment"></a>• [`segment`](#origin-servers-private-ip-segment) - 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 [Segment](#origin-servers-private-ip-segment) below.
|
|
447
447
|
|
|
448
|
-
<a id="origin-servers-private-ip-site-locator"></a>• [`site_locator`](#origin-servers-private-ip-site-locator) - Optional Block<br>
|
|
448
|
+
<a id="origin-servers-private-ip-site-locator"></a>• [`site_locator`](#origin-servers-private-ip-site-locator) - Optional Block<br>Message defines a reference to a site or virtual site object<br>See [Site Locator](#origin-servers-private-ip-site-locator) below.
|
|
449
449
|
|
|
450
450
|
<a id="origin-servers-private-ip-snat-pool"></a>• [`snat_pool`](#origin-servers-private-ip-snat-pool) - Optional Block<br>SNAT Pool. SNAT Pool configuration<br>See [Snat Pool](#origin-servers-private-ip-snat-pool) below.
|
|
451
451
|
|
|
@@ -453,29 +453,29 @@ A [`private_ip`](#origin-servers-private-ip) block (within [`origin_servers`](#o
|
|
|
453
453
|
|
|
454
454
|
A [`segment`](#origin-servers-private-ip-segment) block (within [`origin_servers.private_ip`](#origin-servers-private-ip)) supports the following:
|
|
455
455
|
|
|
456
|
-
<a id="origin-servers-private-ip-segment-name"></a>• [`name`](#origin-servers-private-ip-segment-name) - Optional String<br>
|
|
456
|
+
<a id="origin-servers-private-ip-segment-name"></a>• [`name`](#origin-servers-private-ip-segment-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
|
|
457
457
|
|
|
458
|
-
<a id="namespace-a2f7e0"></a>• [`namespace`](#namespace-a2f7e0) - Optional String<br>
|
|
458
|
+
<a id="namespace-a2f7e0"></a>• [`namespace`](#namespace-a2f7e0) - 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
|
|
459
459
|
|
|
460
|
-
<a id="tenant-4d8d8b"></a>• [`tenant`](#tenant-4d8d8b) - Optional String<br>
|
|
460
|
+
<a id="tenant-4d8d8b"></a>• [`tenant`](#tenant-4d8d8b) - 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
|
|
461
461
|
|
|
462
462
|
#### Origin Servers Private IP Site Locator
|
|
463
463
|
|
|
464
464
|
A [`site_locator`](#origin-servers-private-ip-site-locator) block (within [`origin_servers.private_ip`](#origin-servers-private-ip)) supports the following:
|
|
465
465
|
|
|
466
|
-
<a id="site-9000e8"></a>• [`site`](#site-9000e8) - Optional Block<br>
|
|
466
|
+
<a id="site-9000e8"></a>• [`site`](#site-9000e8) - 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 [Site](#site-9000e8) below.
|
|
467
467
|
|
|
468
|
-
<a id="site-5bd329"></a>• [`virtual_site`](#site-5bd329) - Optional Block<br>
|
|
468
|
+
<a id="site-5bd329"></a>• [`virtual_site`](#site-5bd329) - 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 [Virtual Site](#site-5bd329) below.
|
|
469
469
|
|
|
470
470
|
#### Origin Servers Private IP Site Locator Site
|
|
471
471
|
|
|
472
472
|
A [`site`](#site-9000e8) block (within [`origin_servers.private_ip.site_locator`](#origin-servers-private-ip-site-locator)) supports the following:
|
|
473
473
|
|
|
474
|
-
<a id="name-dc4f48"></a>• [`name`](#name-dc4f48) - Optional String<br>
|
|
474
|
+
<a id="name-dc4f48"></a>• [`name`](#name-dc4f48) - 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
|
|
475
475
|
|
|
476
|
-
<a id="namespace-43a893"></a>• [`namespace`](#namespace-43a893) - Optional String<br>
|
|
476
|
+
<a id="namespace-43a893"></a>• [`namespace`](#namespace-43a893) - 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
|
|
477
477
|
|
|
478
|
-
<a id="tenant-ae5087"></a>• [`tenant`](#tenant-ae5087) - Optional String<br>
|
|
478
|
+
<a id="tenant-ae5087"></a>• [`tenant`](#tenant-ae5087) - 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
|
|
479
479
|
|
|
480
480
|
#### Origin Servers Private IP Site Locator Virtual Site
|
|
481
481
|
|
|
@@ -485,9 +485,9 @@ A [`site`](#site-9000e8) block (within [`origin_servers.private_ip.site_locator`
|
|
|
485
485
|
|
|
486
486
|
A [`snat_pool`](#origin-servers-private-ip-snat-pool) block (within [`origin_servers.private_ip`](#origin-servers-private-ip)) supports the following:
|
|
487
487
|
|
|
488
|
-
<a id="pool-c826de"></a>• [`no_snat_pool`](#pool-c826de) - Optional Block<br>
|
|
488
|
+
<a id="pool-c826de"></a>• [`no_snat_pool`](#pool-c826de) - Optional Block<br>Can be used for messages where no values are needed
|
|
489
489
|
|
|
490
|
-
<a id="pool-cc6a33"></a>• [`snat_pool`](#pool-cc6a33) - Optional Block<br>
|
|
490
|
+
<a id="pool-cc6a33"></a>• [`snat_pool`](#pool-cc6a33) - Optional Block<br>List of IPv4 prefixes that represent an endpoint<br>See [Snat Pool](#pool-cc6a33) below.
|
|
491
491
|
|
|
492
492
|
#### Origin Servers Private IP Snat Pool Snat Pool
|
|
493
493
|
|
|
@@ -499,15 +499,15 @@ A [`private_name`](#origin-servers-private-name) block (within [`origin_servers`
|
|
|
499
499
|
|
|
500
500
|
<a id="origin-servers-private-name-dns-name"></a>• [`dns_name`](#origin-servers-private-name-dns-name) - Optional String<br>DNS Name. DNS Name
|
|
501
501
|
|
|
502
|
-
<a id="network-1921f3"></a>• [`inside_network`](#network-1921f3) - Optional Block<br>
|
|
502
|
+
<a id="network-1921f3"></a>• [`inside_network`](#network-1921f3) - Optional Block<br>Can be used for messages where no values are needed
|
|
503
503
|
|
|
504
|
-
<a id="network-a1ed83"></a>• [`outside_network`](#network-a1ed83) - Optional Block<br>
|
|
504
|
+
<a id="network-a1ed83"></a>• [`outside_network`](#network-a1ed83) - Optional Block<br>Can be used for messages where no values are needed
|
|
505
505
|
|
|
506
|
-
<a id="interval-4bd915"></a>• [`refresh_interval`](#interval-4bd915) - Optional Number<br>
|
|
506
|
+
<a id="interval-4bd915"></a>• [`refresh_interval`](#interval-4bd915) - Optional Number<br>Interval for DNS refresh in seconds. Max value is 7 days as per `HTTPS://datatracker.ietf.org/doc/HTML/rfc8767.`
|
|
507
507
|
|
|
508
|
-
<a id="origin-servers-private-name-segment"></a>• [`segment`](#origin-servers-private-name-segment) - Optional Block<br>
|
|
508
|
+
<a id="origin-servers-private-name-segment"></a>• [`segment`](#origin-servers-private-name-segment) - 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 [Segment](#origin-servers-private-name-segment) below.
|
|
509
509
|
|
|
510
|
-
<a id="locator-0c95f1"></a>• [`site_locator`](#locator-0c95f1) - Optional Block<br>
|
|
510
|
+
<a id="locator-0c95f1"></a>• [`site_locator`](#locator-0c95f1) - Optional Block<br>Message defines a reference to a site or virtual site object<br>See [Site Locator](#locator-0c95f1) below.
|
|
511
511
|
|
|
512
512
|
<a id="origin-servers-private-name-snat-pool"></a>• [`snat_pool`](#origin-servers-private-name-snat-pool) - Optional Block<br>SNAT Pool. SNAT Pool configuration<br>See [Snat Pool](#origin-servers-private-name-snat-pool) below.
|
|
513
513
|
|
|
@@ -515,29 +515,29 @@ A [`private_name`](#origin-servers-private-name) block (within [`origin_servers`
|
|
|
515
515
|
|
|
516
516
|
A [`segment`](#origin-servers-private-name-segment) block (within [`origin_servers.private_name`](#origin-servers-private-name)) supports the following:
|
|
517
517
|
|
|
518
|
-
<a id="name-6839c1"></a>• [`name`](#name-6839c1) - Optional String<br>
|
|
518
|
+
<a id="name-6839c1"></a>• [`name`](#name-6839c1) - 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
|
|
519
519
|
|
|
520
|
-
<a id="namespace-217e43"></a>• [`namespace`](#namespace-217e43) - Optional String<br>
|
|
520
|
+
<a id="namespace-217e43"></a>• [`namespace`](#namespace-217e43) - 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
|
|
521
521
|
|
|
522
|
-
<a id="tenant-522e3c"></a>• [`tenant`](#tenant-522e3c) - Optional String<br>
|
|
522
|
+
<a id="tenant-522e3c"></a>• [`tenant`](#tenant-522e3c) - 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
|
|
523
523
|
|
|
524
524
|
#### Origin Servers Private Name Site Locator
|
|
525
525
|
|
|
526
526
|
A [`site_locator`](#locator-0c95f1) block (within [`origin_servers.private_name`](#origin-servers-private-name)) supports the following:
|
|
527
527
|
|
|
528
|
-
<a id="site-771c33"></a>• [`site`](#site-771c33) - Optional Block<br>
|
|
528
|
+
<a id="site-771c33"></a>• [`site`](#site-771c33) - 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 [Site](#site-771c33) below.
|
|
529
529
|
|
|
530
|
-
<a id="site-cf2f53"></a>• [`virtual_site`](#site-cf2f53) - Optional Block<br>
|
|
530
|
+
<a id="site-cf2f53"></a>• [`virtual_site`](#site-cf2f53) - 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 [Virtual Site](#site-cf2f53) below.
|
|
531
531
|
|
|
532
532
|
#### Origin Servers Private Name Site Locator Site
|
|
533
533
|
|
|
534
534
|
A [`site`](#site-771c33) block (within [`origin_servers.private_name.site_locator`](#locator-0c95f1)) supports the following:
|
|
535
535
|
|
|
536
|
-
<a id="name-5e7e2b"></a>• [`name`](#name-5e7e2b) - Optional String<br>
|
|
536
|
+
<a id="name-5e7e2b"></a>• [`name`](#name-5e7e2b) - 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
|
|
537
537
|
|
|
538
|
-
<a id="namespace-a2ea97"></a>• [`namespace`](#namespace-a2ea97) - Optional String<br>
|
|
538
|
+
<a id="namespace-a2ea97"></a>• [`namespace`](#namespace-a2ea97) - 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
|
|
539
539
|
|
|
540
|
-
<a id="tenant-33ad25"></a>• [`tenant`](#tenant-33ad25) - Optional String<br>
|
|
540
|
+
<a id="tenant-33ad25"></a>• [`tenant`](#tenant-33ad25) - 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
|
|
541
541
|
|
|
542
542
|
#### Origin Servers Private Name Site Locator Virtual Site
|
|
543
543
|
|
|
@@ -547,9 +547,9 @@ A [`site`](#site-771c33) block (within [`origin_servers.private_name.site_locato
|
|
|
547
547
|
|
|
548
548
|
A [`snat_pool`](#origin-servers-private-name-snat-pool) block (within [`origin_servers.private_name`](#origin-servers-private-name)) supports the following:
|
|
549
549
|
|
|
550
|
-
<a id="pool-569cef"></a>• [`no_snat_pool`](#pool-569cef) - Optional Block<br>
|
|
550
|
+
<a id="pool-569cef"></a>• [`no_snat_pool`](#pool-569cef) - Optional Block<br>Can be used for messages where no values are needed
|
|
551
551
|
|
|
552
|
-
<a id="pool-b6c3f7"></a>• [`snat_pool`](#pool-b6c3f7) - Optional Block<br>
|
|
552
|
+
<a id="pool-b6c3f7"></a>• [`snat_pool`](#pool-b6c3f7) - Optional Block<br>List of IPv4 prefixes that represent an endpoint<br>See [Snat Pool](#pool-b6c3f7) below.
|
|
553
553
|
|
|
554
554
|
#### Origin Servers Private Name Snat Pool Snat Pool
|
|
555
555
|
|
|
@@ -567,7 +567,7 @@ A [`public_name`](#origin-servers-public-name) block (within [`origin_servers`](
|
|
|
567
567
|
|
|
568
568
|
<a id="origin-servers-public-name-dns-name"></a>• [`dns_name`](#origin-servers-public-name-dns-name) - Optional String<br>DNS Name. DNS Name
|
|
569
569
|
|
|
570
|
-
<a id="interval-b4ce5c"></a>• [`refresh_interval`](#interval-b4ce5c) - Optional Number<br>
|
|
570
|
+
<a id="interval-b4ce5c"></a>• [`refresh_interval`](#interval-b4ce5c) - Optional Number<br>Interval for DNS refresh in seconds. Max value is 7 days as per `HTTPS://datatracker.ietf.org/doc/HTML/rfc8767.`
|
|
571
571
|
|
|
572
572
|
#### Origin Servers Vn Private IP
|
|
573
573
|
|
|
@@ -575,17 +575,17 @@ A [`vn_private_ip`](#origin-servers-vn-private-ip) block (within [`origin_server
|
|
|
575
575
|
|
|
576
576
|
<a id="origin-servers-vn-private-ip-ip"></a>• [`ip`](#origin-servers-vn-private-ip-ip) - Optional String<br>IPv4. IPv4 address
|
|
577
577
|
|
|
578
|
-
<a id="network-e703ab"></a>• [`virtual_network`](#network-e703ab) - Optional Block<br>
|
|
578
|
+
<a id="network-e703ab"></a>• [`virtual_network`](#network-e703ab) - 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 [Virtual Network](#network-e703ab) below.
|
|
579
579
|
|
|
580
580
|
#### Origin Servers Vn Private IP Virtual Network
|
|
581
581
|
|
|
582
582
|
A [`virtual_network`](#network-e703ab) block (within [`origin_servers.vn_private_ip`](#origin-servers-vn-private-ip)) supports the following:
|
|
583
583
|
|
|
584
|
-
<a id="name-6c5e61"></a>• [`name`](#name-6c5e61) - Optional String<br>
|
|
584
|
+
<a id="name-6c5e61"></a>• [`name`](#name-6c5e61) - 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
|
|
585
585
|
|
|
586
|
-
<a id="namespace-fd2396"></a>• [`namespace`](#namespace-fd2396) - Optional String<br>
|
|
586
|
+
<a id="namespace-fd2396"></a>• [`namespace`](#namespace-fd2396) - 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
|
|
587
587
|
|
|
588
|
-
<a id="tenant-550f0b"></a>• [`tenant`](#tenant-550f0b) - Optional String<br>
|
|
588
|
+
<a id="tenant-550f0b"></a>• [`tenant`](#tenant-550f0b) - 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
|
|
589
589
|
|
|
590
590
|
#### Origin Servers Vn Private Name
|
|
591
591
|
|
|
@@ -593,17 +593,17 @@ A [`vn_private_name`](#origin-servers-vn-private-name) block (within [`origin_se
|
|
|
593
593
|
|
|
594
594
|
<a id="origin-servers-vn-private-name-dns-name"></a>• [`dns_name`](#origin-servers-vn-private-name-dns-name) - Optional String<br>DNS Name. DNS Name
|
|
595
595
|
|
|
596
|
-
<a id="network-ff3b00"></a>• [`private_network`](#network-ff3b00) - Optional Block<br>
|
|
596
|
+
<a id="network-ff3b00"></a>• [`private_network`](#network-ff3b00) - 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 [Private Network](#network-ff3b00) below.
|
|
597
597
|
|
|
598
598
|
#### Origin Servers Vn Private Name Private Network
|
|
599
599
|
|
|
600
600
|
A [`private_network`](#network-ff3b00) block (within [`origin_servers.vn_private_name`](#origin-servers-vn-private-name)) supports the following:
|
|
601
601
|
|
|
602
|
-
<a id="name-6e42c8"></a>• [`name`](#name-6e42c8) - Optional String<br>
|
|
602
|
+
<a id="name-6e42c8"></a>• [`name`](#name-6e42c8) - 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
|
|
603
603
|
|
|
604
|
-
<a id="namespace-145fbd"></a>• [`namespace`](#namespace-145fbd) - Optional String<br>
|
|
604
|
+
<a id="namespace-145fbd"></a>• [`namespace`](#namespace-145fbd) - 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
|
|
605
605
|
|
|
606
|
-
<a id="tenant-e702ea"></a>• [`tenant`](#tenant-e702ea) - Optional String<br>
|
|
606
|
+
<a id="tenant-e702ea"></a>• [`tenant`](#tenant-e702ea) - 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
|
|
607
607
|
|
|
608
608
|
#### Timeouts
|
|
609
609
|
|
|
@@ -621,61 +621,61 @@ A [`timeouts`](#timeouts) block supports the following:
|
|
|
621
621
|
|
|
622
622
|
An [`upstream_conn_pool_reuse_type`](#upstream-conn-pool-reuse-type) block supports the following:
|
|
623
623
|
|
|
624
|
-
<a id="reuse-008a14"></a>• [`disable_conn_pool_reuse`](#reuse-008a14) - Optional Block<br>
|
|
624
|
+
<a id="reuse-008a14"></a>• [`disable_conn_pool_reuse`](#reuse-008a14) - Optional Block<br>Can be used for messages where no values are needed
|
|
625
625
|
|
|
626
|
-
<a id="reuse-ad4462"></a>• [`enable_conn_pool_reuse`](#reuse-ad4462) - Optional Block<br>
|
|
626
|
+
<a id="reuse-ad4462"></a>• [`enable_conn_pool_reuse`](#reuse-ad4462) - Optional Block<br>Can be used for messages where no values are needed
|
|
627
627
|
|
|
628
628
|
#### Use TLS
|
|
629
629
|
|
|
630
630
|
An [`use_tls`](#use-tls) block supports the following:
|
|
631
631
|
|
|
632
|
-
<a id="use-tls-default-session-key-caching"></a>• [`default_session_key_caching`](#use-tls-default-session-key-caching) - Optional Block<br>
|
|
632
|
+
<a id="use-tls-default-session-key-caching"></a>• [`default_session_key_caching`](#use-tls-default-session-key-caching) - Optional Block<br>Can be used for messages where no values are needed
|
|
633
633
|
|
|
634
|
-
<a id="use-tls-disable-session-key-caching"></a>• [`disable_session_key_caching`](#use-tls-disable-session-key-caching) - Optional Block<br>
|
|
634
|
+
<a id="use-tls-disable-session-key-caching"></a>• [`disable_session_key_caching`](#use-tls-disable-session-key-caching) - Optional Block<br>Can be used for messages where no values are needed
|
|
635
635
|
|
|
636
|
-
<a id="use-tls-disable-sni"></a>• [`disable_sni`](#use-tls-disable-sni) - Optional Block<br>
|
|
636
|
+
<a id="use-tls-disable-sni"></a>• [`disable_sni`](#use-tls-disable-sni) - Optional Block<br>Can be used for messages where no values are needed
|
|
637
637
|
|
|
638
|
-
<a id="use-tls-max-session-keys"></a>• [`max_session_keys`](#use-tls-max-session-keys) - Optional Number<br>
|
|
638
|
+
<a id="use-tls-max-session-keys"></a>• [`max_session_keys`](#use-tls-max-session-keys) - Optional Number<br>Number of session keys that are cached
|
|
639
639
|
|
|
640
|
-
<a id="use-tls-no-mtls"></a>• [`no_mtls`](#use-tls-no-mtls) - Optional Block<br>
|
|
640
|
+
<a id="use-tls-no-mtls"></a>• [`no_mtls`](#use-tls-no-mtls) - Optional Block<br>Can be used for messages where no values are needed
|
|
641
641
|
|
|
642
|
-
<a id="use-tls-skip-server-verification"></a>• [`skip_server_verification`](#use-tls-skip-server-verification) - Optional Block<br>
|
|
642
|
+
<a id="use-tls-skip-server-verification"></a>• [`skip_server_verification`](#use-tls-skip-server-verification) - Optional Block<br>Can be used for messages where no values are needed
|
|
643
643
|
|
|
644
|
-
<a id="use-tls-sni"></a>• [`sni`](#use-tls-sni) - Optional String<br>SNI
|
|
644
|
+
<a id="use-tls-sni"></a>• [`sni`](#use-tls-sni) - Optional String<br>SNI value to be used
|
|
645
645
|
|
|
646
|
-
<a id="use-tls-tls-config"></a>• [`tls_config`](#use-tls-tls-config) - Optional Block<br>
|
|
646
|
+
<a id="use-tls-tls-config"></a>• [`tls_config`](#use-tls-tls-config) - Optional Block<br>Defines various OPTIONS to configure TLS configuration parameters<br>See [TLS Config](#use-tls-tls-config) below.
|
|
647
647
|
|
|
648
|
-
<a id="use-tls-use-host-header-as-sni"></a>• [`use_host_header_as_sni`](#use-tls-use-host-header-as-sni) - Optional Block<br>
|
|
648
|
+
<a id="use-tls-use-host-header-as-sni"></a>• [`use_host_header_as_sni`](#use-tls-use-host-header-as-sni) - Optional Block<br>Can be used for messages where no values are needed
|
|
649
649
|
|
|
650
650
|
<a id="use-tls-use-mtls"></a>• [`use_mtls`](#use-tls-use-mtls) - Optional Block<br>mTLS Certificate. mTLS Client Certificate<br>See [Use mTLS](#use-tls-use-mtls) below.
|
|
651
651
|
|
|
652
|
-
<a id="use-tls-use-mtls-obj"></a>• [`use_mtls_obj`](#use-tls-use-mtls-obj) - Optional Block<br>
|
|
652
|
+
<a id="use-tls-use-mtls-obj"></a>• [`use_mtls_obj`](#use-tls-use-mtls-obj) - 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 [Use mTLS Obj](#use-tls-use-mtls-obj) below.
|
|
653
653
|
|
|
654
654
|
<a id="use-tls-use-server-verification"></a>• [`use_server_verification`](#use-tls-use-server-verification) - Optional Block<br>TLS Validation Context for Origin Servers. Upstream TLS Validation Context<br>See [Use Server Verification](#use-tls-use-server-verification) below.
|
|
655
655
|
|
|
656
|
-
<a id="use-tls-volterra-trusted-ca"></a>• [`volterra_trusted_ca`](#use-tls-volterra-trusted-ca) - Optional Block<br>
|
|
656
|
+
<a id="use-tls-volterra-trusted-ca"></a>• [`volterra_trusted_ca`](#use-tls-volterra-trusted-ca) - Optional Block<br>Can be used for messages where no values are needed
|
|
657
657
|
|
|
658
658
|
#### Use TLS TLS Config
|
|
659
659
|
|
|
660
660
|
A [`tls_config`](#use-tls-tls-config) block (within [`use_tls`](#use-tls)) supports the following:
|
|
661
661
|
|
|
662
|
-
<a id="use-tls-tls-config-custom-security"></a>• [`custom_security`](#use-tls-tls-config-custom-security) - Optional Block<br>
|
|
662
|
+
<a id="use-tls-tls-config-custom-security"></a>• [`custom_security`](#use-tls-tls-config-custom-security) - Optional Block<br>Defines TLS protocol config including min/max versions and allowed ciphers<br>See [Custom Security](#use-tls-tls-config-custom-security) below.
|
|
663
663
|
|
|
664
|
-
<a id="use-tls-tls-config-default-security"></a>• [`default_security`](#use-tls-tls-config-default-security) - Optional Block<br>
|
|
664
|
+
<a id="use-tls-tls-config-default-security"></a>• [`default_security`](#use-tls-tls-config-default-security) - Optional Block<br>Can be used for messages where no values are needed
|
|
665
665
|
|
|
666
|
-
<a id="use-tls-tls-config-low-security"></a>• [`low_security`](#use-tls-tls-config-low-security) - Optional Block<br>
|
|
666
|
+
<a id="use-tls-tls-config-low-security"></a>• [`low_security`](#use-tls-tls-config-low-security) - Optional Block<br>Can be used for messages where no values are needed
|
|
667
667
|
|
|
668
|
-
<a id="use-tls-tls-config-medium-security"></a>• [`medium_security`](#use-tls-tls-config-medium-security) - Optional Block<br>
|
|
668
|
+
<a id="use-tls-tls-config-medium-security"></a>• [`medium_security`](#use-tls-tls-config-medium-security) - Optional Block<br>Can be used for messages where no values are needed
|
|
669
669
|
|
|
670
670
|
#### Use TLS TLS Config Custom Security
|
|
671
671
|
|
|
672
672
|
A [`custom_security`](#use-tls-tls-config-custom-security) block (within [`use_tls.tls_config`](#use-tls-tls-config)) supports the following:
|
|
673
673
|
|
|
674
|
-
<a id="suites-2d975b"></a>• [`cipher_suites`](#suites-2d975b) - Optional List<br>
|
|
674
|
+
<a id="suites-2d975b"></a>• [`cipher_suites`](#suites-2d975b) - Optional List<br>The TLS listener will only support the specified cipher list
|
|
675
675
|
|
|
676
|
-
<a id="version-11230d"></a>• [`max_version`](#version-11230d) - Optional String Defaults to `TLS_AUTO`<br>Possible values are `TLS_AUTO`, `TLSv1_0`, `TLSv1_1`, `TLSv1_2`, `TLSv1_3`<br>[Enum: TLS_AUTO|TLSv1_0|TLSv1_1|TLSv1_2|TLSv1_3]
|
|
676
|
+
<a id="version-11230d"></a>• [`max_version`](#version-11230d) - Optional String Defaults to `TLS_AUTO`<br>Possible values are `TLS_AUTO`, `TLSv1_0`, `TLSv1_1`, `TLSv1_2`, `TLSv1_3`<br>[Enum: TLS_AUTO|TLSv1_0|TLSv1_1|TLSv1_2|TLSv1_3] TlsProtocol is enumeration of supported TLS versions F5 Distributed Cloud will choose the optimal TLS version
|
|
677
677
|
|
|
678
|
-
<a id="version-a76fa4"></a>• [`min_version`](#version-a76fa4) - Optional String Defaults to `TLS_AUTO`<br>Possible values are `TLS_AUTO`, `TLSv1_0`, `TLSv1_1`, `TLSv1_2`, `TLSv1_3`<br>[Enum: TLS_AUTO|TLSv1_0|TLSv1_1|TLSv1_2|TLSv1_3]
|
|
678
|
+
<a id="version-a76fa4"></a>• [`min_version`](#version-a76fa4) - Optional String Defaults to `TLS_AUTO`<br>Possible values are `TLS_AUTO`, `TLSv1_0`, `TLSv1_1`, `TLSv1_2`, `TLSv1_3`<br>[Enum: TLS_AUTO|TLSv1_0|TLSv1_1|TLSv1_2|TLSv1_3] TlsProtocol is enumeration of supported TLS versions F5 Distributed Cloud will choose the optimal TLS version
|
|
679
679
|
|
|
680
680
|
#### Use TLS Use mTLS
|
|
681
681
|
|
|
@@ -687,17 +687,17 @@ An [`use_mtls`](#use-tls-use-mtls) block (within [`use_tls`](#use-tls)) supports
|
|
|
687
687
|
|
|
688
688
|
A [`tls_certificates`](#use-tls-use-mtls-tls-certificates) block (within [`use_tls.use_mtls`](#use-tls-use-mtls)) supports the following:
|
|
689
689
|
|
|
690
|
-
<a id="url-26c7eb"></a>• [`certificate_url`](#url-26c7eb) - Optional String<br>
|
|
690
|
+
<a id="url-26c7eb"></a>• [`certificate_url`](#url-26c7eb) - Optional String<br>TLS certificate. Certificate or certificate chain in PEM format including the PEM headers
|
|
691
691
|
|
|
692
|
-
<a id="algorithms-d28b5f"></a>• [`custom_hash_algorithms`](#algorithms-d28b5f) - Optional Block<br>
|
|
692
|
+
<a id="algorithms-d28b5f"></a>• [`custom_hash_algorithms`](#algorithms-d28b5f) - Optional Block<br>Specifies the hash algorithms to be used<br>See [Custom Hash Algorithms](#algorithms-d28b5f) below.
|
|
693
693
|
|
|
694
694
|
<a id="spec-ad9c6c"></a>• [`description_spec`](#spec-ad9c6c) - Optional String<br>Description. Description for the certificate
|
|
695
695
|
|
|
696
|
-
<a id="stapling-242d9f"></a>• [`disable_ocsp_stapling`](#stapling-242d9f) - Optional Block<br>
|
|
696
|
+
<a id="stapling-242d9f"></a>• [`disable_ocsp_stapling`](#stapling-242d9f) - Optional Block<br>Can be used for messages where no values are needed
|
|
697
697
|
|
|
698
|
-
<a id="key-dc1b14"></a>• [`private_key`](#key-dc1b14) - Optional Block<br>
|
|
698
|
+
<a id="key-dc1b14"></a>• [`private_key`](#key-dc1b14) - Optional Block<br>SecretType is used in an object to indicate a sensitive/confidential field<br>See [Private Key](#key-dc1b14) below.
|
|
699
699
|
|
|
700
|
-
<a id="defaults-413d06"></a>• [`use_system_defaults`](#defaults-413d06) - Optional Block<br>
|
|
700
|
+
<a id="defaults-413d06"></a>• [`use_system_defaults`](#defaults-413d06) - Optional Block<br>Can be used for messages where no values are needed
|
|
701
701
|
|
|
702
702
|
#### Use TLS Use mTLS TLS Certificates Custom Hash Algorithms
|
|
703
703
|
|
|
@@ -719,29 +719,29 @@ A [`tls_certificates`](#use-tls-use-mtls-tls-certificates) block (within [`use_t
|
|
|
719
719
|
|
|
720
720
|
An [`use_mtls_obj`](#use-tls-use-mtls-obj) block (within [`use_tls`](#use-tls)) supports the following:
|
|
721
721
|
|
|
722
|
-
<a id="use-tls-use-mtls-obj-name"></a>• [`name`](#use-tls-use-mtls-obj-name) - Optional String<br>
|
|
722
|
+
<a id="use-tls-use-mtls-obj-name"></a>• [`name`](#use-tls-use-mtls-obj-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
|
|
723
723
|
|
|
724
|
-
<a id="use-tls-use-mtls-obj-namespace"></a>• [`namespace`](#use-tls-use-mtls-obj-namespace) - Optional String<br>
|
|
724
|
+
<a id="use-tls-use-mtls-obj-namespace"></a>• [`namespace`](#use-tls-use-mtls-obj-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
|
|
725
725
|
|
|
726
|
-
<a id="use-tls-use-mtls-obj-tenant"></a>• [`tenant`](#use-tls-use-mtls-obj-tenant) - Optional String<br>
|
|
726
|
+
<a id="use-tls-use-mtls-obj-tenant"></a>• [`tenant`](#use-tls-use-mtls-obj-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
|
|
727
727
|
|
|
728
728
|
#### Use TLS Use Server Verification
|
|
729
729
|
|
|
730
730
|
An [`use_server_verification`](#use-tls-use-server-verification) block (within [`use_tls`](#use-tls)) supports the following:
|
|
731
731
|
|
|
732
|
-
<a id="trusted-ca-965dea"></a>• [`trusted_ca`](#trusted-ca-965dea) - Optional Block<br>
|
|
732
|
+
<a id="trusted-ca-965dea"></a>• [`trusted_ca`](#trusted-ca-965dea) - 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 [Trusted CA](#trusted-ca-965dea) below.
|
|
733
733
|
|
|
734
|
-
<a id="url-21c5a6"></a>• [`trusted_ca_url`](#url-21c5a6) - Optional String<br>
|
|
734
|
+
<a id="url-21c5a6"></a>• [`trusted_ca_url`](#url-21c5a6) - Optional String<br>Upload a Root CA Certificate specifically for this Origin Pool for verification of server's certificate
|
|
735
735
|
|
|
736
736
|
#### Use TLS Use Server Verification Trusted CA
|
|
737
737
|
|
|
738
738
|
A [`trusted_ca`](#trusted-ca-965dea) block (within [`use_tls.use_server_verification`](#use-tls-use-server-verification)) supports the following:
|
|
739
739
|
|
|
740
|
-
<a id="name-3590a2"></a>• [`name`](#name-3590a2) - Optional String<br>
|
|
740
|
+
<a id="name-3590a2"></a>• [`name`](#name-3590a2) - 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
|
|
741
741
|
|
|
742
|
-
<a id="namespace-ac41ae"></a>• [`namespace`](#namespace-ac41ae) - Optional String<br>
|
|
742
|
+
<a id="namespace-ac41ae"></a>• [`namespace`](#namespace-ac41ae) - 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
|
|
743
743
|
|
|
744
|
-
<a id="tenant-892ff9"></a>• [`tenant`](#tenant-892ff9) - Optional String<br>
|
|
744
|
+
<a id="tenant-892ff9"></a>• [`tenant`](#tenant-892ff9) - 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
|
|
745
745
|
|
|
746
746
|
---
|
|
747
747
|
|