@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
|
@@ -32,15 +32,15 @@ resource "f5xc_cluster" "example" {
|
|
|
32
32
|
}
|
|
33
33
|
|
|
34
34
|
# Resource-specific configuration
|
|
35
|
-
# [OneOf: auto_http_config, http1_config, http2_options]
|
|
35
|
+
# [OneOf: auto_http_config, http1_config, http2_options] Ca...
|
|
36
36
|
auto_http_config {
|
|
37
37
|
# Configure auto_http_config settings
|
|
38
38
|
}
|
|
39
|
-
#
|
|
39
|
+
# CircuitBreaker provides a mechanism for watching failures...
|
|
40
40
|
circuit_breaker {
|
|
41
41
|
# Configure circuit_breaker settings
|
|
42
42
|
}
|
|
43
|
-
#
|
|
43
|
+
# List of key-value pairs that define default subset. This ...
|
|
44
44
|
default_subset {
|
|
45
45
|
# Configure default_subset settings
|
|
46
46
|
}
|
|
@@ -67,48 +67,48 @@ resource "f5xc_cluster" "example" {
|
|
|
67
67
|
### Spec Argument Reference
|
|
68
68
|
|
|
69
69
|
-> **One of the following:**
|
|
70
|
-
• <a id="auto-http-config"></a>[`auto_http_config`](#auto-http-config) - Optional Block<br>
|
|
71
|
-
<br><br>• <a id="http1-config"></a>[`http1_config`](#http1-config) - Optional Block<br>HTTP/1.1 Protocol OPTIONS
|
|
72
|
-
<br><br>• <a id="http2-options"></a>[`http2_options`](#http2-options) - Optional Block<br>Http2 Protocol OPTIONS
|
|
70
|
+
• <a id="auto-http-config"></a>[`auto_http_config`](#auto-http-config) - Optional Block<br>Can be used for messages where no values are needed
|
|
71
|
+
<br><br>• <a id="http1-config"></a>[`http1_config`](#http1-config) - Optional Block<br>HTTP/1.1 Protocol OPTIONS for upstream connections<br>See [Http1 Config](#http1-config) below for details.
|
|
72
|
+
<br><br>• <a id="http2-options"></a>[`http2_options`](#http2-options) - Optional Block<br>Http2 Protocol OPTIONS for upstream connections<br>See [Http2 Options](#http2-options) below for details.
|
|
73
73
|
|
|
74
|
-
<a id="circuit-breaker"></a>• [`circuit_breaker`](#circuit-breaker) - Optional Block<br>
|
|
74
|
+
<a id="circuit-breaker"></a>• [`circuit_breaker`](#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](#circuit-breaker) below for details.
|
|
75
75
|
|
|
76
|
-
<a id="connection-timeout"></a>• [`connection_timeout`](#connection-timeout) - Optional Number Defaults to `2` Specified in milliseconds<br>
|
|
76
|
+
<a id="connection-timeout"></a>• [`connection_timeout`](#connection-timeout) - Optional Number Defaults to `2` Specified in milliseconds<br>The timeout for new network connections to endpoints in the cluster. The seconds
|
|
77
77
|
|
|
78
|
-
<a id="default-subset"></a>• [`default_subset`](#default-subset) - Optional Block<br>
|
|
78
|
+
<a id="default-subset"></a>• [`default_subset`](#default-subset) - Optional Block<br>List of key-value pairs that define default subset. This subset can be referred in fallback_policy which gets used when route specifies no metadata or no subset matching the metadata exists
|
|
79
79
|
|
|
80
80
|
-> **One of the following:**
|
|
81
|
-
• <a id="disable-proxy-protocol"></a>[`disable_proxy_protocol`](#disable-proxy-protocol) - Optional Block<br>
|
|
82
|
-
<br><br>• <a id="proxy-protocol-v1"></a>[`proxy_protocol_v1`](#proxy-protocol-v1) - Optional Block<br>
|
|
81
|
+
• <a id="disable-proxy-protocol"></a>[`disable_proxy_protocol`](#disable-proxy-protocol) - Optional Block<br>Can be used for messages where no values are needed
|
|
82
|
+
<br><br>• <a id="proxy-protocol-v1"></a>[`proxy_protocol_v1`](#proxy-protocol-v1) - Optional Block<br>Can be used for messages where no values are needed
|
|
83
83
|
|
|
84
|
-
<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]
|
|
84
|
+
<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
|
|
85
85
|
|
|
86
|
-
<a id="endpoint-subsets"></a>• [`endpoint_subsets`](#endpoint-subsets) - Optional Block<br>
|
|
86
|
+
<a id="endpoint-subsets"></a>• [`endpoint_subsets`](#endpoint-subsets) - Optional Block<br>Configure endpoint groups based on metadata labels for traffic routing. Supports weighted distribution and session affinity across labeled endpoints<br>See [Endpoint Subsets](#endpoint-subsets) below for details.
|
|
87
87
|
|
|
88
|
-
<a id="endpoints"></a>• [`endpoints`](#endpoints) - Optional Block<br>
|
|
88
|
+
<a id="endpoints"></a>• [`endpoints`](#endpoints) - Optional Block<br>List of endpoints for this cluster<br>See [Endpoints](#endpoints) below for details.
|
|
89
89
|
|
|
90
|
-
<a id="fallback-policy"></a>• [`fallback_policy`](#fallback-policy) - Optional String Defaults to `NO_FALLBACK`<br>Possible values are `NO_FALLBACK`, `ANY_ENDPOINT`, `DEFAULT_SUBSET`<br>[Enum: NO_FALLBACK|ANY_ENDPOINT|DEFAULT_SUBSET]
|
|
90
|
+
<a id="fallback-policy"></a>• [`fallback_policy`](#fallback-policy) - Optional String Defaults to `NO_FALLBACK`<br>Possible values are `NO_FALLBACK`, `ANY_ENDPOINT`, `DEFAULT_SUBSET`<br>[Enum: NO_FALLBACK|ANY_ENDPOINT|DEFAULT_SUBSET] Enumeration for SubsetFallbackPolicy if subset match is not found. The request fails as if the cluster had no endpoint matching the subset policy Any cluster endpoint may be selected if the cluster had no endpoint matching the subset policy Load balancing is done over endpoints matching
|
|
91
91
|
|
|
92
|
-
<a id="health-checks"></a>• [`health_checks`](#health-checks) - Optional Block<br>Health
|
|
92
|
+
<a id="health-checks"></a>• [`health_checks`](#health-checks) - Optional Block<br>Health check configuration for backend monitoring<br>See [Health Checks](#health-checks) below for details.
|
|
93
93
|
|
|
94
|
-
<a id="http-idle-timeout"></a>• [`http_idle_timeout`](#http-idle-timeout) - Optional Number
|
|
94
|
+
<a id="http-idle-timeout"></a>• [`http_idle_timeout`](#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
|
|
95
95
|
|
|
96
|
-
<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]
|
|
96
|
+
<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
|
|
97
97
|
|
|
98
98
|
-> **One of the following:**
|
|
99
|
-
• <a id="no-panic-threshold"></a>[`no_panic_threshold`](#no-panic-threshold) - Optional Block<br>
|
|
99
|
+
• <a id="no-panic-threshold"></a>[`no_panic_threshold`](#no-panic-threshold) - Optional Block<br>Can be used for messages where no values are needed
|
|
100
100
|
|
|
101
|
-
<a id="outlier-detection"></a>• [`outlier_detection`](#outlier-detection) - Optional Block<br>Outlier
|
|
101
|
+
<a id="outlier-detection"></a>• [`outlier_detection`](#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](#outlier-detection) below for details.
|
|
102
102
|
|
|
103
|
-
<a id="panic-threshold"></a>• [`panic_threshold`](#panic-threshold) - Optional Number<br>
|
|
103
|
+
<a id="panic-threshold"></a>• [`panic_threshold`](#panic-threshold) - Optional Number<br>Configure a threshold (percentage of unhealthy endpoints) below which all endpoints will be considered for loadbalancing ignoring its health status
|
|
104
104
|
|
|
105
|
-
<a id="proxy-protocol-v2"></a>• [`proxy_protocol_v2`](#proxy-protocol-v2) - Optional Block<br>
|
|
105
|
+
<a id="proxy-protocol-v2"></a>• [`proxy_protocol_v2`](#proxy-protocol-v2) - Optional Block<br>Can be used for messages where no values are needed
|
|
106
106
|
|
|
107
107
|
<a id="timeouts"></a>• [`timeouts`](#timeouts) - Optional Block<br>See [Timeouts](#timeouts) below for details.
|
|
108
108
|
|
|
109
|
-
<a id="tls-parameters"></a>• [`tls_parameters`](#tls-parameters) - Optional Block<br>
|
|
109
|
+
<a id="tls-parameters"></a>• [`tls_parameters`](#tls-parameters) - Optional Block<br>TLS configuration for upstream connections<br>See [TLS Parameters](#tls-parameters) below for details.
|
|
110
110
|
|
|
111
|
-
<a id="upstream-conn-pool-reuse-type"></a>• [`upstream_conn_pool_reuse_type`](#upstream-conn-pool-reuse-type) - Optional Block<br>Select upstream connection pool reuse state
|
|
111
|
+
<a id="upstream-conn-pool-reuse-type"></a>• [`upstream_conn_pool_reuse_type`](#upstream-conn-pool-reuse-type) - Optional Block<br>Select upstream connection pool reuse state for every downstream connection. This configuration choice is for HTTP(S) LB only<br>See [Upstream Conn Pool Reuse Type](#upstream-conn-pool-reuse-type) below for details.
|
|
112
112
|
|
|
113
113
|
### Attributes Reference
|
|
114
114
|
|
|
@@ -122,87 +122,87 @@ In addition to all arguments above, the following attributes are exported:
|
|
|
122
122
|
|
|
123
123
|
A [`circuit_breaker`](#circuit-breaker) block supports the following:
|
|
124
124
|
|
|
125
|
-
<a id="circuit-breaker-connection-limit"></a>• [`connection_limit`](#circuit-breaker-connection-limit) - Optional Number<br>
|
|
125
|
+
<a id="circuit-breaker-connection-limit"></a>• [`connection_limit`](#circuit-breaker-connection-limit) - 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
|
|
126
126
|
|
|
127
|
-
<a id="circuit-breaker-max-requests"></a>• [`max_requests`](#circuit-breaker-max-requests) - Optional Number<br>
|
|
127
|
+
<a id="circuit-breaker-max-requests"></a>• [`max_requests`](#circuit-breaker-max-requests) - 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
|
|
128
128
|
|
|
129
|
-
<a id="circuit-breaker-pending-requests"></a>• [`pending_requests`](#circuit-breaker-pending-requests) - Optional Number<br>
|
|
129
|
+
<a id="circuit-breaker-pending-requests"></a>• [`pending_requests`](#circuit-breaker-pending-requests) - 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
|
|
130
130
|
|
|
131
|
-
<a id="circuit-breaker-priority"></a>• [`priority`](#circuit-breaker-priority) - Optional String Defaults to `DEFAULT`<br>Possible values are `DEFAULT`, `HIGH`<br>[Enum: DEFAULT|HIGH]
|
|
131
|
+
<a id="circuit-breaker-priority"></a>• [`priority`](#circuit-breaker-priority) - 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
|
|
132
132
|
|
|
133
|
-
<a id="circuit-breaker-retries"></a>• [`retries`](#circuit-breaker-retries) - Optional Number<br>
|
|
133
|
+
<a id="circuit-breaker-retries"></a>• [`retries`](#circuit-breaker-retries) - 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
|
|
134
134
|
|
|
135
135
|
#### Endpoint Subsets
|
|
136
136
|
|
|
137
137
|
An [`endpoint_subsets`](#endpoint-subsets) block supports the following:
|
|
138
138
|
|
|
139
|
-
<a id="endpoint-subsets-keys"></a>• [`keys`](#endpoint-subsets-keys) - Optional List<br>
|
|
139
|
+
<a id="endpoint-subsets-keys"></a>• [`keys`](#endpoint-subsets-keys) - Optional List<br>List of keys that define a cluster subset class
|
|
140
140
|
|
|
141
141
|
#### Endpoints
|
|
142
142
|
|
|
143
143
|
An [`endpoints`](#endpoints) block supports the following:
|
|
144
144
|
|
|
145
|
-
<a id="endpoints-kind"></a>• [`kind`](#endpoints-kind) - Optional String<br>
|
|
145
|
+
<a id="endpoints-kind"></a>• [`kind`](#endpoints-kind) - Optional String<br>When a configuration object(e.g. Virtual_host) refers to another(e.g route) then kind will hold the referred object's kind (e.g. 'route')
|
|
146
146
|
|
|
147
|
-
<a id="endpoints-name"></a>• [`name`](#endpoints-name) - Optional String<br>
|
|
147
|
+
<a id="endpoints-name"></a>• [`name`](#endpoints-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
|
|
148
148
|
|
|
149
|
-
<a id="endpoints-namespace"></a>• [`namespace`](#endpoints-namespace) - Optional String<br>
|
|
149
|
+
<a id="endpoints-namespace"></a>• [`namespace`](#endpoints-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
|
|
150
150
|
|
|
151
|
-
<a id="endpoints-tenant"></a>• [`tenant`](#endpoints-tenant) - Optional String<br>
|
|
151
|
+
<a id="endpoints-tenant"></a>• [`tenant`](#endpoints-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
|
|
152
152
|
|
|
153
|
-
<a id="endpoints-uid"></a>• [`uid`](#endpoints-uid) - Optional String<br>
|
|
153
|
+
<a id="endpoints-uid"></a>• [`uid`](#endpoints-uid) - Optional String<br>When a configuration object(e.g. Virtual_host) refers to another(e.g route) then uid will hold the referred object's(e.g. Route's) uid
|
|
154
154
|
|
|
155
155
|
#### Health Checks
|
|
156
156
|
|
|
157
157
|
A [`health_checks`](#health-checks) block supports the following:
|
|
158
158
|
|
|
159
|
-
<a id="health-checks-kind"></a>• [`kind`](#health-checks-kind) - Optional String<br>
|
|
159
|
+
<a id="health-checks-kind"></a>• [`kind`](#health-checks-kind) - Optional String<br>When a configuration object(e.g. Virtual_host) refers to another(e.g route) then kind will hold the referred object's kind (e.g. 'route')
|
|
160
160
|
|
|
161
|
-
<a id="health-checks-name"></a>• [`name`](#health-checks-name) - Optional String<br>
|
|
161
|
+
<a id="health-checks-name"></a>• [`name`](#health-checks-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
|
|
162
162
|
|
|
163
|
-
<a id="health-checks-namespace"></a>• [`namespace`](#health-checks-namespace) - Optional String<br>
|
|
163
|
+
<a id="health-checks-namespace"></a>• [`namespace`](#health-checks-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
|
|
164
164
|
|
|
165
|
-
<a id="health-checks-tenant"></a>• [`tenant`](#health-checks-tenant) - Optional String<br>
|
|
165
|
+
<a id="health-checks-tenant"></a>• [`tenant`](#health-checks-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
|
|
166
166
|
|
|
167
|
-
<a id="health-checks-uid"></a>• [`uid`](#health-checks-uid) - Optional String<br>
|
|
167
|
+
<a id="health-checks-uid"></a>• [`uid`](#health-checks-uid) - Optional String<br>When a configuration object(e.g. Virtual_host) refers to another(e.g route) then uid will hold the referred object's(e.g. Route's) uid
|
|
168
168
|
|
|
169
169
|
#### Http1 Config
|
|
170
170
|
|
|
171
171
|
A [`http1_config`](#http1-config) block supports the following:
|
|
172
172
|
|
|
173
|
-
<a id="http1-config-header-transformation"></a>• [`header_transformation`](#http1-config-header-transformation) - Optional Block<br>Header Transformation
|
|
173
|
+
<a id="http1-config-header-transformation"></a>• [`header_transformation`](#http1-config-header-transformation) - Optional Block<br>Header Transformation OPTIONS for HTTP/1.1 request/response headers<br>See [Header Transformation](#http1-config-header-transformation) below.
|
|
174
174
|
|
|
175
175
|
#### Http1 Config Header Transformation
|
|
176
176
|
|
|
177
177
|
A [`header_transformation`](#http1-config-header-transformation) block (within [`http1_config`](#http1-config)) supports the following:
|
|
178
178
|
|
|
179
|
-
<a id="transformation-489a65"></a>• [`default_header_transformation`](#transformation-489a65) - Optional Block<br>
|
|
179
|
+
<a id="transformation-489a65"></a>• [`default_header_transformation`](#transformation-489a65) - Optional Block<br>Can be used for messages where no values are needed
|
|
180
180
|
|
|
181
|
-
<a id="transformation-7adc9e"></a>• [`legacy_header_transformation`](#transformation-7adc9e) - Optional Block<br>
|
|
181
|
+
<a id="transformation-7adc9e"></a>• [`legacy_header_transformation`](#transformation-7adc9e) - Optional Block<br>Can be used for messages where no values are needed
|
|
182
182
|
|
|
183
|
-
<a id="transformation-61c351"></a>• [`preserve_case_header_transformation`](#transformation-61c351) - Optional Block<br>
|
|
183
|
+
<a id="transformation-61c351"></a>• [`preserve_case_header_transformation`](#transformation-61c351) - Optional Block<br>Can be used for messages where no values are needed
|
|
184
184
|
|
|
185
|
-
<a id="transformation-17cea9"></a>• [`proper_case_header_transformation`](#transformation-17cea9) - Optional Block<br>
|
|
185
|
+
<a id="transformation-17cea9"></a>• [`proper_case_header_transformation`](#transformation-17cea9) - Optional Block<br>Can be used for messages where no values are needed
|
|
186
186
|
|
|
187
187
|
#### Http2 Options
|
|
188
188
|
|
|
189
189
|
A [`http2_options`](#http2-options) block supports the following:
|
|
190
190
|
|
|
191
|
-
<a id="http2-options-enabled"></a>• [`enabled`](#http2-options-enabled) - Optional Bool<br>
|
|
191
|
+
<a id="http2-options-enabled"></a>• [`enabled`](#http2-options-enabled) - Optional Bool<br>Enable/disable HTTP2 Protocol for upstream connections
|
|
192
192
|
|
|
193
193
|
#### Outlier Detection
|
|
194
194
|
|
|
195
195
|
An [`outlier_detection`](#outlier-detection) block supports the following:
|
|
196
196
|
|
|
197
|
-
<a id="outlier-detection-base-ejection-time"></a>• [`base_ejection_time`](#outlier-detection-base-ejection-time) - Optional Number
|
|
197
|
+
<a id="outlier-detection-base-ejection-time"></a>• [`base_ejection_time`](#outlier-detection-base-ejection-time) - 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
|
|
198
198
|
|
|
199
|
-
<a id="outlier-detection-consecutive-5xx"></a>• [`consecutive_5xx`](#outlier-detection-consecutive-5xx) - Optional Number
|
|
199
|
+
<a id="outlier-detection-consecutive-5xx"></a>• [`consecutive_5xx`](#outlier-detection-consecutive-5xx) - 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
|
|
200
200
|
|
|
201
|
-
<a id="failure-45be04"></a>• [`consecutive_gateway_failure`](#failure-45be04) - Optional Number
|
|
201
|
+
<a id="failure-45be04"></a>• [`consecutive_gateway_failure`](#failure-45be04) - 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.)
|
|
202
202
|
|
|
203
|
-
<a id="outlier-detection-interval"></a>• [`interval`](#outlier-detection-interval) - Optional Number Defaults to `10000ms
|
|
203
|
+
<a id="outlier-detection-interval"></a>• [`interval`](#outlier-detection-interval) - 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
|
|
204
204
|
|
|
205
|
-
<a id="outlier-detection-max-ejection-percent"></a>• [`max_ejection_percent`](#outlier-detection-max-ejection-percent) - Optional Number Defaults to `10%`<br>
|
|
205
|
+
<a id="outlier-detection-max-ejection-percent"></a>• [`max_ejection_percent`](#outlier-detection-max-ejection-percent) - 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
|
|
206
206
|
|
|
207
207
|
#### Timeouts
|
|
208
208
|
|
|
@@ -220,61 +220,61 @@ A [`timeouts`](#timeouts) block supports the following:
|
|
|
220
220
|
|
|
221
221
|
A [`tls_parameters`](#tls-parameters) block supports the following:
|
|
222
222
|
|
|
223
|
-
<a id="tls-parameters-cert-params"></a>• [`cert_params`](#tls-parameters-cert-params) - Optional Block<br>
|
|
223
|
+
<a id="tls-parameters-cert-params"></a>• [`cert_params`](#tls-parameters-cert-params) - Optional Block<br>Certificate Parameters for authentication, TLS ciphers, and trust store<br>See [Cert Params](#tls-parameters-cert-params) below.
|
|
224
224
|
|
|
225
|
-
<a id="tls-parameters-common-params"></a>• [`common_params`](#tls-parameters-common-params) - Optional Block<br>
|
|
225
|
+
<a id="tls-parameters-common-params"></a>• [`common_params`](#tls-parameters-common-params) - Optional Block<br>Information of different aspects for TLS authentication related to ciphers, certificates and trust store<br>See [Common Params](#tls-parameters-common-params) below.
|
|
226
226
|
|
|
227
|
-
<a id="caching-2e557f"></a>• [`default_session_key_caching`](#caching-2e557f) - Optional Block<br>
|
|
227
|
+
<a id="caching-2e557f"></a>• [`default_session_key_caching`](#caching-2e557f) - Optional Block<br>Can be used for messages where no values are needed
|
|
228
228
|
|
|
229
|
-
<a id="caching-d819c5"></a>• [`disable_session_key_caching`](#caching-d819c5) - Optional Block<br>
|
|
229
|
+
<a id="caching-d819c5"></a>• [`disable_session_key_caching`](#caching-d819c5) - Optional Block<br>Can be used for messages where no values are needed
|
|
230
230
|
|
|
231
|
-
<a id="tls-parameters-disable-sni"></a>• [`disable_sni`](#tls-parameters-disable-sni) - Optional Block<br>
|
|
231
|
+
<a id="tls-parameters-disable-sni"></a>• [`disable_sni`](#tls-parameters-disable-sni) - Optional Block<br>Can be used for messages where no values are needed
|
|
232
232
|
|
|
233
|
-
<a id="tls-parameters-max-session-keys"></a>• [`max_session_keys`](#tls-parameters-max-session-keys) - Optional Number<br>
|
|
233
|
+
<a id="tls-parameters-max-session-keys"></a>• [`max_session_keys`](#tls-parameters-max-session-keys) - Optional Number<br>Number of session keys that are cached
|
|
234
234
|
|
|
235
|
-
<a id="tls-parameters-sni"></a>• [`sni`](#tls-parameters-sni) - Optional String<br>SNI
|
|
235
|
+
<a id="tls-parameters-sni"></a>• [`sni`](#tls-parameters-sni) - Optional String<br>SNI value to be used
|
|
236
236
|
|
|
237
|
-
<a id="tls-parameters-use-host-header-as-sni"></a>• [`use_host_header_as_sni`](#tls-parameters-use-host-header-as-sni) - Optional Block<br>
|
|
237
|
+
<a id="tls-parameters-use-host-header-as-sni"></a>• [`use_host_header_as_sni`](#tls-parameters-use-host-header-as-sni) - Optional Block<br>Can be used for messages where no values are needed
|
|
238
238
|
|
|
239
239
|
#### TLS Parameters Cert Params
|
|
240
240
|
|
|
241
241
|
A [`cert_params`](#tls-parameters-cert-params) block (within [`tls_parameters`](#tls-parameters)) supports the following:
|
|
242
242
|
|
|
243
|
-
<a id="tls-parameters-cert-params-certificates"></a>• [`certificates`](#tls-parameters-cert-params-certificates) - Optional Block<br>Client
|
|
243
|
+
<a id="tls-parameters-cert-params-certificates"></a>• [`certificates`](#tls-parameters-cert-params-certificates) - Optional Block<br>Client TLS Certificate required for mTLS authentication<br>See [Certificates](#tls-parameters-cert-params-certificates) below.
|
|
244
244
|
|
|
245
|
-
<a id="suites-176fce"></a>• [`cipher_suites`](#suites-176fce) - Optional List<br>
|
|
245
|
+
<a id="suites-176fce"></a>• [`cipher_suites`](#suites-176fce) - Optional List<br>The following list specifies the supported cipher suite TLS_AES_128_GCM_SHA256 TLS_AES_256_GCM_SHA384 TLS_CHACHA20_POLY1305_SHA256 TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256 TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384 TLS_ECDHE_ECDSA_WITH_CHACHA20_POLY1305_SHA256 TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
|
|
246
246
|
|
|
247
|
-
<a id="version-4c65cd"></a>• [`maximum_protocol_version`](#version-4c65cd) - 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]
|
|
247
|
+
<a id="version-4c65cd"></a>• [`maximum_protocol_version`](#version-4c65cd) - 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
|
|
248
248
|
|
|
249
|
-
<a id="version-e15b41"></a>• [`minimum_protocol_version`](#version-e15b41) - 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]
|
|
249
|
+
<a id="version-e15b41"></a>• [`minimum_protocol_version`](#version-e15b41) - 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
|
|
250
250
|
|
|
251
|
-
<a id="params-0d9f11"></a>• [`validation_params`](#params-0d9f11) - Optional Block<br>
|
|
251
|
+
<a id="params-0d9f11"></a>• [`validation_params`](#params-0d9f11) - Optional Block<br>Includes URL for a trust store, whether SAN verification is required and list of Subject Alt Names for verification<br>See [Validation Params](#params-0d9f11) below.
|
|
252
252
|
|
|
253
253
|
#### TLS Parameters Cert Params Certificates
|
|
254
254
|
|
|
255
255
|
A [`certificates`](#tls-parameters-cert-params-certificates) block (within [`tls_parameters.cert_params`](#tls-parameters-cert-params)) supports the following:
|
|
256
256
|
|
|
257
|
-
<a id="kind-8b8a07"></a>• [`kind`](#kind-8b8a07) - Optional String<br>
|
|
257
|
+
<a id="kind-8b8a07"></a>• [`kind`](#kind-8b8a07) - Optional String<br>When a configuration object(e.g. Virtual_host) refers to another(e.g route) then kind will hold the referred object's kind (e.g. 'route')
|
|
258
258
|
|
|
259
|
-
<a id="name-d17505"></a>• [`name`](#name-d17505) - Optional String<br>
|
|
259
|
+
<a id="name-d17505"></a>• [`name`](#name-d17505) - 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
|
|
260
260
|
|
|
261
|
-
<a id="namespace-d38fb9"></a>• [`namespace`](#namespace-d38fb9) - Optional String<br>
|
|
261
|
+
<a id="namespace-d38fb9"></a>• [`namespace`](#namespace-d38fb9) - 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
|
|
262
262
|
|
|
263
|
-
<a id="tenant-34f974"></a>• [`tenant`](#tenant-34f974) - Optional String<br>
|
|
263
|
+
<a id="tenant-34f974"></a>• [`tenant`](#tenant-34f974) - 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
|
|
264
264
|
|
|
265
|
-
<a id="uid-29a359"></a>• [`uid`](#uid-29a359) - Optional String<br>
|
|
265
|
+
<a id="uid-29a359"></a>• [`uid`](#uid-29a359) - Optional String<br>When a configuration object(e.g. Virtual_host) refers to another(e.g route) then uid will hold the referred object's(e.g. Route's) uid
|
|
266
266
|
|
|
267
267
|
#### TLS Parameters Cert Params Validation Params
|
|
268
268
|
|
|
269
269
|
A [`validation_params`](#params-0d9f11) block (within [`tls_parameters.cert_params`](#tls-parameters-cert-params)) supports the following:
|
|
270
270
|
|
|
271
|
-
<a id="verification-29bce9"></a>• [`skip_hostname_verification`](#verification-29bce9) - Optional Bool<br>
|
|
271
|
+
<a id="verification-29bce9"></a>• [`skip_hostname_verification`](#verification-29bce9) - Optional Bool<br>When True, skip verification of hostname i.e. CN/Subject Alt Name of certificate is not matched to the connecting hostname
|
|
272
272
|
|
|
273
273
|
<a id="trusted-ca-91d5d8"></a>• [`trusted_ca`](#trusted-ca-91d5d8) - Optional Block<br>Root CA Certificate Reference. Reference to Root CA Certificate<br>See [Trusted CA](#trusted-ca-91d5d8) below.
|
|
274
274
|
|
|
275
|
-
<a id="url-03ea65"></a>• [`trusted_ca_url`](#url-03ea65) - Optional String<br>Inline Root CA Certificate
|
|
275
|
+
<a id="url-03ea65"></a>• [`trusted_ca_url`](#url-03ea65) - Optional String<br>Inline Root CA Certificate
|
|
276
276
|
|
|
277
|
-
<a id="names-4c662c"></a>• [`verify_subject_alt_names`](#names-4c662c) - Optional List<br>List of
|
|
277
|
+
<a id="names-4c662c"></a>• [`verify_subject_alt_names`](#names-4c662c) - Optional List<br>List of acceptable Subject Alt Names/CN in the peer's certificate. When skip_hostname_verification is false and verify_subject_alt_names is empty, the hostname of the peer will be used for matching against SAN/CN of peer's certificate
|
|
278
278
|
|
|
279
279
|
#### TLS Parameters Cert Params Validation Params Trusted CA
|
|
280
280
|
|
|
@@ -288,31 +288,31 @@ A [`validation_params`](#params-0d9f11) block (within [`tls_parameters.cert_para
|
|
|
288
288
|
|
|
289
289
|
A [`common_params`](#tls-parameters-common-params) block (within [`tls_parameters`](#tls-parameters)) supports the following:
|
|
290
290
|
|
|
291
|
-
<a id="suites-f69d86"></a>• [`cipher_suites`](#suites-f69d86) - Optional List<br>
|
|
291
|
+
<a id="suites-f69d86"></a>• [`cipher_suites`](#suites-f69d86) - Optional List<br>The following list specifies the supported cipher suite TLS_AES_128_GCM_SHA256 TLS_AES_256_GCM_SHA384 TLS_CHACHA20_POLY1305_SHA256 TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256 TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384 TLS_ECDHE_ECDSA_WITH_CHACHA20_POLY1305_SHA256 TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
|
|
292
292
|
|
|
293
|
-
<a id="version-e7c6f2"></a>• [`maximum_protocol_version`](#version-e7c6f2) - 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]
|
|
293
|
+
<a id="version-e7c6f2"></a>• [`maximum_protocol_version`](#version-e7c6f2) - 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
|
|
294
294
|
|
|
295
|
-
<a id="version-7d1460"></a>• [`minimum_protocol_version`](#version-7d1460) - 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]
|
|
295
|
+
<a id="version-7d1460"></a>• [`minimum_protocol_version`](#version-7d1460) - 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
|
|
296
296
|
|
|
297
297
|
<a id="certificates-c9caff"></a>• [`tls_certificates`](#certificates-c9caff) - Optional Block<br>TLS Certificates. Set of TLS certificates<br>See [TLS Certificates](#certificates-c9caff) below.
|
|
298
298
|
|
|
299
|
-
<a id="params-6e95a6"></a>• [`validation_params`](#params-6e95a6) - Optional Block<br>
|
|
299
|
+
<a id="params-6e95a6"></a>• [`validation_params`](#params-6e95a6) - Optional Block<br>Includes URL for a trust store, whether SAN verification is required and list of Subject Alt Names for verification<br>See [Validation Params](#params-6e95a6) below.
|
|
300
300
|
|
|
301
301
|
#### TLS Parameters Common Params TLS Certificates
|
|
302
302
|
|
|
303
303
|
A [`tls_certificates`](#certificates-c9caff) block (within [`tls_parameters.common_params`](#tls-parameters-common-params)) supports the following:
|
|
304
304
|
|
|
305
|
-
<a id="url-323181"></a>• [`certificate_url`](#url-323181) - Optional String<br>
|
|
305
|
+
<a id="url-323181"></a>• [`certificate_url`](#url-323181) - Optional String<br>TLS certificate. Certificate or certificate chain in PEM format including the PEM headers
|
|
306
306
|
|
|
307
|
-
<a id="algorithms-eb62be"></a>• [`custom_hash_algorithms`](#algorithms-eb62be) - Optional Block<br>
|
|
307
|
+
<a id="algorithms-eb62be"></a>• [`custom_hash_algorithms`](#algorithms-eb62be) - Optional Block<br>Specifies the hash algorithms to be used<br>See [Custom Hash Algorithms](#algorithms-eb62be) below.
|
|
308
308
|
|
|
309
309
|
<a id="spec-5af02c"></a>• [`description_spec`](#spec-5af02c) - Optional String<br>Description. Description for the certificate
|
|
310
310
|
|
|
311
|
-
<a id="stapling-c091fa"></a>• [`disable_ocsp_stapling`](#stapling-c091fa) - Optional Block<br>
|
|
311
|
+
<a id="stapling-c091fa"></a>• [`disable_ocsp_stapling`](#stapling-c091fa) - Optional Block<br>Can be used for messages where no values are needed
|
|
312
312
|
|
|
313
|
-
<a id="key-da7979"></a>• [`private_key`](#key-da7979) - Optional Block<br>
|
|
313
|
+
<a id="key-da7979"></a>• [`private_key`](#key-da7979) - Optional Block<br>SecretType is used in an object to indicate a sensitive/confidential field<br>See [Private Key](#key-da7979) below.
|
|
314
314
|
|
|
315
|
-
<a id="defaults-f58bc7"></a>• [`use_system_defaults`](#defaults-f58bc7) - Optional Block<br>
|
|
315
|
+
<a id="defaults-f58bc7"></a>• [`use_system_defaults`](#defaults-f58bc7) - Optional Block<br>Can be used for messages where no values are needed
|
|
316
316
|
|
|
317
317
|
#### TLS Parameters Common Params TLS Certificates Custom Hash Algorithms
|
|
318
318
|
|
|
@@ -334,13 +334,13 @@ A [`tls_certificates`](#certificates-c9caff) block (within [`tls_parameters.comm
|
|
|
334
334
|
|
|
335
335
|
A [`validation_params`](#params-6e95a6) block (within [`tls_parameters.common_params`](#tls-parameters-common-params)) supports the following:
|
|
336
336
|
|
|
337
|
-
<a id="verification-30d13d"></a>• [`skip_hostname_verification`](#verification-30d13d) - Optional Bool<br>
|
|
337
|
+
<a id="verification-30d13d"></a>• [`skip_hostname_verification`](#verification-30d13d) - Optional Bool<br>When True, skip verification of hostname i.e. CN/Subject Alt Name of certificate is not matched to the connecting hostname
|
|
338
338
|
|
|
339
339
|
<a id="trusted-ca-39c22f"></a>• [`trusted_ca`](#trusted-ca-39c22f) - Optional Block<br>Root CA Certificate Reference. Reference to Root CA Certificate<br>See [Trusted CA](#trusted-ca-39c22f) below.
|
|
340
340
|
|
|
341
|
-
<a id="url-910417"></a>• [`trusted_ca_url`](#url-910417) - Optional String<br>Inline Root CA Certificate
|
|
341
|
+
<a id="url-910417"></a>• [`trusted_ca_url`](#url-910417) - Optional String<br>Inline Root CA Certificate
|
|
342
342
|
|
|
343
|
-
<a id="names-1c97ed"></a>• [`verify_subject_alt_names`](#names-1c97ed) - Optional List<br>List of
|
|
343
|
+
<a id="names-1c97ed"></a>• [`verify_subject_alt_names`](#names-1c97ed) - Optional List<br>List of acceptable Subject Alt Names/CN in the peer's certificate. When skip_hostname_verification is false and verify_subject_alt_names is empty, the hostname of the peer will be used for matching against SAN/CN of peer's certificate
|
|
344
344
|
|
|
345
345
|
#### TLS Parameters Common Params Validation Params Trusted CA
|
|
346
346
|
|
|
@@ -354,9 +354,9 @@ A [`validation_params`](#params-6e95a6) block (within [`tls_parameters.common_pa
|
|
|
354
354
|
|
|
355
355
|
An [`upstream_conn_pool_reuse_type`](#upstream-conn-pool-reuse-type) block supports the following:
|
|
356
356
|
|
|
357
|
-
<a id="reuse-008a14"></a>• [`disable_conn_pool_reuse`](#reuse-008a14) - Optional Block<br>
|
|
357
|
+
<a id="reuse-008a14"></a>• [`disable_conn_pool_reuse`](#reuse-008a14) - Optional Block<br>Can be used for messages where no values are needed
|
|
358
358
|
|
|
359
|
-
<a id="reuse-ad4462"></a>• [`enable_conn_pool_reuse`](#reuse-ad4462) - Optional Block<br>
|
|
359
|
+
<a id="reuse-ad4462"></a>• [`enable_conn_pool_reuse`](#reuse-ad4462) - Optional Block<br>Can be used for messages where no values are needed
|
|
360
360
|
|
|
361
361
|
---
|
|
362
362
|
|
|
@@ -32,15 +32,15 @@ resource "f5xc_cminstance" "example" {
|
|
|
32
32
|
}
|
|
33
33
|
|
|
34
34
|
# Resource-specific configuration
|
|
35
|
-
#
|
|
35
|
+
# SecretType is used in an object to indicate a sensitive/c...
|
|
36
36
|
api_token {
|
|
37
37
|
# Configure api_token settings
|
|
38
38
|
}
|
|
39
|
-
#
|
|
39
|
+
# BlindfoldSecretInfoType specifies information about the S...
|
|
40
40
|
blindfold_secret_info {
|
|
41
41
|
# Configure blindfold_secret_info settings
|
|
42
42
|
}
|
|
43
|
-
#
|
|
43
|
+
# ClearSecretInfoType specifies information about the Secre...
|
|
44
44
|
clear_secret_info {
|
|
45
45
|
# Configure clear_secret_info settings
|
|
46
46
|
}
|
|
@@ -66,17 +66,17 @@ resource "f5xc_cminstance" "example" {
|
|
|
66
66
|
|
|
67
67
|
### Spec Argument Reference
|
|
68
68
|
|
|
69
|
-
<a id="api-token"></a>• [`api_token`](#api-token) - Optional Block<br>
|
|
69
|
+
<a id="api-token"></a>• [`api_token`](#api-token) - Optional Block<br>SecretType is used in an object to indicate a sensitive/confidential field<br>See [API Token](#api-token) below for details.
|
|
70
70
|
|
|
71
71
|
<a id="ip"></a>• [`ip`](#ip) - Optional Block<br>IPv4 Address. IPv4 Address in dot-decimal notation<br>See [IP](#ip) below for details.
|
|
72
72
|
|
|
73
|
-
<a id="password"></a>• [`password`](#password) - Optional Block<br>
|
|
73
|
+
<a id="password"></a>• [`password`](#password) - Optional Block<br>SecretType is used in an object to indicate a sensitive/confidential field<br>See [Password](#password) below for details.
|
|
74
74
|
|
|
75
|
-
<a id="port"></a>• [`port`](#port) - Optional Number<br>Port
|
|
75
|
+
<a id="port"></a>• [`port`](#port) - Optional Number<br>Port of the Central Manager instance to connect to
|
|
76
76
|
|
|
77
77
|
<a id="timeouts"></a>• [`timeouts`](#timeouts) - Optional Block<br>See [Timeouts](#timeouts) below for details.
|
|
78
78
|
|
|
79
|
-
<a id="username"></a>• [`username`](#username) - Optional String<br>Username
|
|
79
|
+
<a id="username"></a>• [`username`](#username) - Optional String<br>Username for the Central Manager instance
|
|
80
80
|
|
|
81
81
|
### Attributes Reference
|
|
82
82
|
|
|
@@ -90,59 +90,59 @@ In addition to all arguments above, the following attributes are exported:
|
|
|
90
90
|
|
|
91
91
|
An [`api_token`](#api-token) block supports the following:
|
|
92
92
|
|
|
93
|
-
<a id="api-token-blindfold-secret-info"></a>• [`blindfold_secret_info`](#api-token-blindfold-secret-info) - Optional Block<br>
|
|
93
|
+
<a id="api-token-blindfold-secret-info"></a>• [`blindfold_secret_info`](#api-token-blindfold-secret-info) - Optional Block<br>BlindfoldSecretInfoType specifies information about the Secret managed by F5XC Secret Management<br>See [Blindfold Secret Info](#api-token-blindfold-secret-info) below.
|
|
94
94
|
|
|
95
|
-
<a id="api-token-clear-secret-info"></a>• [`clear_secret_info`](#api-token-clear-secret-info) - Optional Block<br>
|
|
95
|
+
<a id="api-token-clear-secret-info"></a>• [`clear_secret_info`](#api-token-clear-secret-info) - Optional Block<br>ClearSecretInfoType specifies information about the Secret that is not encrypted<br>See [Clear Secret Info](#api-token-clear-secret-info) below.
|
|
96
96
|
|
|
97
97
|
#### API Token Blindfold Secret Info
|
|
98
98
|
|
|
99
99
|
A [`blindfold_secret_info`](#api-token-blindfold-secret-info) block (within [`api_token`](#api-token)) supports the following:
|
|
100
100
|
|
|
101
|
-
<a id="provider-9e1a18"></a>• [`decryption_provider`](#provider-9e1a18) - Optional String<br>
|
|
101
|
+
<a id="provider-9e1a18"></a>• [`decryption_provider`](#provider-9e1a18) - Optional String<br>Name of the Secret Management Access object that contains information about the backend Secret Management service
|
|
102
102
|
|
|
103
|
-
<a id="location-ae079d"></a>• [`location`](#location-ae079d) - Optional String<br>Location
|
|
103
|
+
<a id="location-ae079d"></a>• [`location`](#location-ae079d) - Optional String<br>Location is the uri_ref. It could be in URL format for string:/// Or it could be a path if the store provider is an HTTP/HTTPS location
|
|
104
104
|
|
|
105
|
-
<a id="provider-924a2a"></a>• [`store_provider`](#provider-924a2a) - Optional String<br>
|
|
105
|
+
<a id="provider-924a2a"></a>• [`store_provider`](#provider-924a2a) - Optional String<br>Name of the Secret Management Access object that contains information about the store to GET encrypted bytes This field needs to be provided only if the URL scheme is not string:///
|
|
106
106
|
|
|
107
107
|
#### API Token Clear Secret Info
|
|
108
108
|
|
|
109
109
|
A [`clear_secret_info`](#api-token-clear-secret-info) block (within [`api_token`](#api-token)) supports the following:
|
|
110
110
|
|
|
111
|
-
<a id="ref-c39fa7"></a>• [`provider_ref`](#ref-c39fa7) - Optional String<br>
|
|
111
|
+
<a id="ref-c39fa7"></a>• [`provider_ref`](#ref-c39fa7) - Optional String<br>Name of the Secret Management Access object that contains information about the store to GET encrypted bytes This field needs to be provided only if the URL scheme is not string:///
|
|
112
112
|
|
|
113
|
-
<a id="api-token-clear-secret-info-url"></a>• [`url`](#api-token-clear-secret-info-url) - Optional String<br>URL
|
|
113
|
+
<a id="api-token-clear-secret-info-url"></a>• [`url`](#api-token-clear-secret-info-url) - Optional String<br>URL of the secret. Currently supported URL schemes is string:///. For string:/// scheme, Secret needs to be encoded Base64 format. When asked for this secret, caller will GET Secret bytes after Base64 decoding
|
|
114
114
|
|
|
115
115
|
#### IP
|
|
116
116
|
|
|
117
117
|
An [`ip`](#ip) block supports the following:
|
|
118
118
|
|
|
119
|
-
<a id="ip-addr"></a>• [`addr`](#ip-addr) - Optional String<br>IPv4 Address
|
|
119
|
+
<a id="ip-addr"></a>• [`addr`](#ip-addr) - Optional String<br>IPv4 Address in string form with dot-decimal notation
|
|
120
120
|
|
|
121
121
|
#### Password
|
|
122
122
|
|
|
123
123
|
A [`password`](#password) block supports the following:
|
|
124
124
|
|
|
125
|
-
<a id="password-blindfold-secret-info"></a>• [`blindfold_secret_info`](#password-blindfold-secret-info) - Optional Block<br>
|
|
125
|
+
<a id="password-blindfold-secret-info"></a>• [`blindfold_secret_info`](#password-blindfold-secret-info) - Optional Block<br>BlindfoldSecretInfoType specifies information about the Secret managed by F5XC Secret Management<br>See [Blindfold Secret Info](#password-blindfold-secret-info) below.
|
|
126
126
|
|
|
127
|
-
<a id="password-clear-secret-info"></a>• [`clear_secret_info`](#password-clear-secret-info) - Optional Block<br>
|
|
127
|
+
<a id="password-clear-secret-info"></a>• [`clear_secret_info`](#password-clear-secret-info) - Optional Block<br>ClearSecretInfoType specifies information about the Secret that is not encrypted<br>See [Clear Secret Info](#password-clear-secret-info) below.
|
|
128
128
|
|
|
129
129
|
#### Password Blindfold Secret Info
|
|
130
130
|
|
|
131
131
|
A [`blindfold_secret_info`](#password-blindfold-secret-info) block (within [`password`](#password)) supports the following:
|
|
132
132
|
|
|
133
|
-
<a id="provider-f3d5d2"></a>• [`decryption_provider`](#provider-f3d5d2) - Optional String<br>
|
|
133
|
+
<a id="provider-f3d5d2"></a>• [`decryption_provider`](#provider-f3d5d2) - Optional String<br>Name of the Secret Management Access object that contains information about the backend Secret Management service
|
|
134
134
|
|
|
135
|
-
<a id="password-blindfold-secret-info-location"></a>• [`location`](#password-blindfold-secret-info-location) - Optional String<br>Location
|
|
135
|
+
<a id="password-blindfold-secret-info-location"></a>• [`location`](#password-blindfold-secret-info-location) - Optional String<br>Location is the uri_ref. It could be in URL format for string:/// Or it could be a path if the store provider is an HTTP/HTTPS location
|
|
136
136
|
|
|
137
|
-
<a id="provider-0e4651"></a>• [`store_provider`](#provider-0e4651) - Optional String<br>
|
|
137
|
+
<a id="provider-0e4651"></a>• [`store_provider`](#provider-0e4651) - Optional String<br>Name of the Secret Management Access object that contains information about the store to GET encrypted bytes This field needs to be provided only if the URL scheme is not string:///
|
|
138
138
|
|
|
139
139
|
#### Password Clear Secret Info
|
|
140
140
|
|
|
141
141
|
A [`clear_secret_info`](#password-clear-secret-info) block (within [`password`](#password)) supports the following:
|
|
142
142
|
|
|
143
|
-
<a id="password-clear-secret-info-provider-ref"></a>• [`provider_ref`](#password-clear-secret-info-provider-ref) - Optional String<br>
|
|
143
|
+
<a id="password-clear-secret-info-provider-ref"></a>• [`provider_ref`](#password-clear-secret-info-provider-ref) - Optional String<br>Name of the Secret Management Access object that contains information about the store to GET encrypted bytes This field needs to be provided only if the URL scheme is not string:///
|
|
144
144
|
|
|
145
|
-
<a id="password-clear-secret-info-url"></a>• [`url`](#password-clear-secret-info-url) - Optional String<br>URL
|
|
145
|
+
<a id="password-clear-secret-info-url"></a>• [`url`](#password-clear-secret-info-url) - Optional String<br>URL of the secret. Currently supported URL schemes is string:///. For string:/// scheme, Secret needs to be encoded Base64 format. When asked for this secret, caller will GET Secret bytes after Base64 decoding
|
|
146
146
|
|
|
147
147
|
#### Timeouts
|
|
148
148
|
|