@robinmordasiewicz/f5xc-terraform-mcp 2.4.6 → 2.4.7
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/docs/resources/addon_subscription.md +5 -5
- package/dist/docs/resources/address_allocator.md +3 -3
- package/dist/docs/resources/advertise_policy.md +39 -39
- package/dist/docs/resources/alert_policy.md +6 -6
- package/dist/docs/resources/alert_receiver.md +57 -57
- package/dist/docs/resources/api_crawler.md +9 -9
- package/dist/docs/resources/api_testing.md +40 -40
- package/dist/docs/resources/apm.md +320 -320
- package/dist/docs/resources/app_api_group.md +10 -10
- package/dist/docs/resources/app_firewall.md +36 -36
- package/dist/docs/resources/app_setting.md +46 -46
- package/dist/docs/resources/app_type.md +3 -3
- package/dist/docs/resources/authentication.md +30 -30
- package/dist/docs/resources/aws_tgw_site.md +184 -184
- package/dist/docs/resources/aws_vpc_site.md +296 -296
- package/dist/docs/resources/azure_vnet_site.md +677 -677
- package/dist/docs/resources/bgp.md +20 -20
- package/dist/docs/resources/bgp_routing_policy.md +4 -4
- package/dist/docs/resources/cdn_cache_rule.md +68 -68
- package/dist/docs/resources/cdn_loadbalancer.md +1166 -1166
- package/dist/docs/resources/certificate.md +4 -4
- package/dist/docs/resources/child_tenant.md +2 -2
- package/dist/docs/resources/cloud_connect.md +33 -33
- package/dist/docs/resources/cloud_credentials.md +37 -37
- package/dist/docs/resources/cloud_link.md +16 -16
- package/dist/docs/resources/cluster.md +68 -68
- package/dist/docs/resources/cminstance.md +6 -6
- package/dist/docs/resources/code_base_integration.md +82 -82
- package/dist/docs/resources/container_registry.md +2 -2
- package/dist/docs/resources/data_type.md +12 -12
- package/dist/docs/resources/discovery.md +71 -71
- package/dist/docs/resources/dns_lb_health_check.md +5 -5
- package/dist/docs/resources/dns_load_balancer.md +25 -25
- package/dist/docs/resources/dns_zone.md +144 -144
- package/dist/docs/resources/endpoint.md +1 -1
- package/dist/docs/resources/enhanced_firewall_policy.md +33 -33
- package/dist/docs/resources/external_connector.md +32 -32
- package/dist/docs/resources/fast_acl.md +59 -59
- package/dist/docs/resources/fast_acl_rule.md +2 -2
- package/dist/docs/resources/filter_set.md +3 -3
- package/dist/docs/resources/fleet.md +359 -359
- package/dist/docs/resources/forward_proxy_policy.md +18 -18
- package/dist/docs/resources/gcp_vpc_site.md +280 -280
- package/dist/docs/resources/geo_location_set.md +1 -1
- package/dist/docs/resources/global_log_receiver.md +216 -216
- package/dist/docs/resources/healthcheck.md +2 -2
- package/dist/docs/resources/http_loadbalancer.md +2190 -2190
- package/dist/docs/resources/infraprotect_tunnel.md +9 -9
- package/dist/docs/resources/k8s_cluster.md +39 -39
- package/dist/docs/resources/k8s_cluster_role.md +10 -10
- package/dist/docs/resources/k8s_pod_security_policy.md +9 -9
- package/dist/docs/resources/log_receiver.md +11 -11
- package/dist/docs/resources/malicious_user_mitigation.md +4 -4
- package/dist/docs/resources/managed_tenant.md +2 -2
- package/dist/docs/resources/nat_policy.md +22 -22
- package/dist/docs/resources/network_connector.md +37 -37
- package/dist/docs/resources/network_firewall.md +15 -15
- package/dist/docs/resources/network_interface.md +78 -78
- package/dist/docs/resources/network_policy.md +21 -21
- package/dist/docs/resources/network_policy_view.md +7 -7
- package/dist/docs/resources/nfv_service.md +306 -306
- package/dist/docs/resources/oidc_provider.md +1 -1
- package/dist/docs/resources/origin_pool.md +151 -151
- package/dist/docs/resources/policy_based_routing.md +71 -71
- package/dist/docs/resources/protocol_inspection.md +8 -8
- package/dist/docs/resources/proxy.md +401 -401
- package/dist/docs/resources/rate_limiter_policy.md +4 -4
- package/dist/docs/resources/registration.md +1 -1
- package/dist/docs/resources/route.md +155 -155
- package/dist/docs/resources/secret_management_access.md +103 -103
- package/dist/docs/resources/secret_policy.md +7 -7
- package/dist/docs/resources/securemesh_site.md +274 -274
- package/dist/docs/resources/securemesh_site_v2.md +940 -940
- package/dist/docs/resources/sensitive_data_policy.md +3 -3
- package/dist/docs/resources/service_policy.md +154 -154
- package/dist/docs/resources/service_policy_rule.md +51 -51
- package/dist/docs/resources/subnet.md +7 -7
- package/dist/docs/resources/tcp_loadbalancer.md +138 -138
- package/dist/docs/resources/tenant_configuration.md +1 -1
- package/dist/docs/resources/ticket_tracking_system.md +2 -2
- package/dist/docs/resources/tunnel.md +16 -16
- package/dist/docs/resources/udp_loadbalancer.md +56 -56
- package/dist/docs/resources/virtual_host.md +146 -146
- package/dist/docs/resources/virtual_network.md +7 -7
- package/dist/docs/resources/voltshare_admin_policy.md +22 -22
- package/dist/docs/resources/voltstack_site.md +778 -778
- package/dist/docs/resources/waf_exclusion_policy.md +22 -22
- package/dist/docs/resources/workload.md +2226 -2226
- package/package.json +1 -1
|
@@ -104,53 +104,53 @@ A [`rest_auth_info`](#access-info-rest-auth-info) block (within [`access_info`](
|
|
|
104
104
|
|
|
105
105
|
<a id="access-info-rest-auth-info-headers-auth"></a>• [`headers_auth`](#access-info-rest-auth-info-headers-auth) - Optional Block<br>Authentication Headers. AuthnTypeHeaders is used for setting headers for authentication<br>See [Headers Auth](#access-info-rest-auth-info-headers-auth) below.
|
|
106
106
|
|
|
107
|
-
<a id="
|
|
107
|
+
<a id="auth-f1c802"></a>• [`query_params_auth`](#auth-f1c802) - Optional Block<br>Authentication QueryParams. AuthnTypeQueryParams is used for setting query_params for authentication<br>See [Query Params Auth](#auth-f1c802) below.
|
|
108
108
|
|
|
109
109
|
#### Access Info REST Auth Info Basic Auth
|
|
110
110
|
|
|
111
111
|
A [`basic_auth`](#access-info-rest-auth-info-basic-auth) block (within [`access_info.rest_auth_info`](#access-info-rest-auth-info)) supports the following:
|
|
112
112
|
|
|
113
|
-
<a id="
|
|
113
|
+
<a id="password-969177"></a>• [`password`](#password-969177) - Optional Block<br>Secret. SecretType is used in an object to indicate a sensitive/confidential field<br>See [Password](#password-969177) below.
|
|
114
114
|
|
|
115
|
-
<a id="
|
|
115
|
+
<a id="username-8c2ad8"></a>• [`username`](#username-8c2ad8) - Optional String<br>Username. The username to encode in Basic Auth scheme
|
|
116
116
|
|
|
117
117
|
#### Access Info REST Auth Info Basic Auth Password
|
|
118
118
|
|
|
119
|
-
A [`password`](#
|
|
119
|
+
A [`password`](#password-969177) block (within [`access_info.rest_auth_info.basic_auth`](#access-info-rest-auth-info-basic-auth)) supports the following:
|
|
120
120
|
|
|
121
|
-
<a id="
|
|
121
|
+
<a id="info-fb2aea"></a>• [`blindfold_secret_info`](#info-fb2aea) - Optional Block<br>Blindfold Secret. BlindfoldSecretInfoType specifies information about the Secret managed by F5XC Secret Management<br>See [Blindfold Secret Info](#info-fb2aea) below.
|
|
122
122
|
|
|
123
|
-
<a id="
|
|
123
|
+
<a id="info-e0ed2e"></a>• [`clear_secret_info`](#info-e0ed2e) - Optional Block<br>In-Clear Secret. ClearSecretInfoType specifies information about the Secret that is not encrypted<br>See [Clear Secret Info](#info-e0ed2e) below.
|
|
124
124
|
|
|
125
125
|
#### Access Info REST Auth Info Basic Auth Password Blindfold Secret Info
|
|
126
126
|
|
|
127
|
-
A [`blindfold_secret_info`](#
|
|
127
|
+
A [`blindfold_secret_info`](#info-fb2aea) block (within [`access_info.rest_auth_info.basic_auth.password`](#password-969177)) supports the following:
|
|
128
128
|
|
|
129
|
-
<a id="
|
|
129
|
+
<a id="provider-69e181"></a>• [`decryption_provider`](#provider-69e181) - Optional String<br>Decryption Provider. Name of the Secret Management Access object that contains information about the backend Secret Management service
|
|
130
130
|
|
|
131
|
-
<a id="
|
|
131
|
+
<a id="location-23a23d"></a>• [`location`](#location-23a23d) - Optional String<br>Location. 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
|
|
132
132
|
|
|
133
|
-
<a id="
|
|
133
|
+
<a id="provider-12dcba"></a>• [`store_provider`](#provider-12dcba) - Optional String<br>Store Provider. 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:///
|
|
134
134
|
|
|
135
135
|
#### Access Info REST Auth Info Basic Auth Password Clear Secret Info
|
|
136
136
|
|
|
137
|
-
A [`clear_secret_info`](#
|
|
137
|
+
A [`clear_secret_info`](#info-e0ed2e) block (within [`access_info.rest_auth_info.basic_auth.password`](#password-969177)) supports the following:
|
|
138
138
|
|
|
139
|
-
<a id="
|
|
139
|
+
<a id="ref-2ec5f7"></a>• [`provider_ref`](#ref-2ec5f7) - Optional String<br>Provider. 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:///
|
|
140
140
|
|
|
141
|
-
<a id="
|
|
141
|
+
<a id="url-aefcef"></a>• [`url`](#url-aefcef) - Optional String<br>URL. 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
|
|
142
142
|
|
|
143
143
|
#### Access Info REST Auth Info Headers Auth
|
|
144
144
|
|
|
145
145
|
A [`headers_auth`](#access-info-rest-auth-info-headers-auth) block (within [`access_info.rest_auth_info`](#access-info-rest-auth-info)) supports the following:
|
|
146
146
|
|
|
147
|
-
<a id="
|
|
147
|
+
<a id="headers-8b271f"></a>• [`headers`](#headers-8b271f) - Optional Block<br>Headers. The set of authentication headers to pass in HTTP request
|
|
148
148
|
|
|
149
149
|
#### Access Info REST Auth Info Query Params Auth
|
|
150
150
|
|
|
151
|
-
A [`query_params_auth`](#
|
|
151
|
+
A [`query_params_auth`](#auth-f1c802) block (within [`access_info.rest_auth_info`](#access-info-rest-auth-info)) supports the following:
|
|
152
152
|
|
|
153
|
-
<a id="
|
|
153
|
+
<a id="params-830867"></a>• [`query_params`](#params-830867) - Optional Block<br>Query Parameters. The set of authentication parameters to be passed as query parameters
|
|
154
154
|
|
|
155
155
|
#### Access Info TLS Config
|
|
156
156
|
|
|
@@ -160,9 +160,9 @@ A [`tls_config`](#access-info-tls-config) block (within [`access_info`](#access-
|
|
|
160
160
|
|
|
161
161
|
<a id="access-info-tls-config-common-params"></a>• [`common_params`](#access-info-tls-config-common-params) - Optional Block<br>TLS Parameters. Information of different aspects for TLS authentication related to ciphers, certificates and trust store<br>See [Common Params](#access-info-tls-config-common-params) below.
|
|
162
162
|
|
|
163
|
-
<a id="
|
|
163
|
+
<a id="caching-0f2bd1"></a>• [`default_session_key_caching`](#caching-0f2bd1) - Optional Block<br>Enable this option
|
|
164
164
|
|
|
165
|
-
<a id="
|
|
165
|
+
<a id="caching-c17b8f"></a>• [`disable_session_key_caching`](#caching-c17b8f) - Optional Block<br>Enable this option
|
|
166
166
|
|
|
167
167
|
<a id="access-info-tls-config-disable-sni"></a>• [`disable_sni`](#access-info-tls-config-disable-sni) - Optional Block<br>Enable this option
|
|
168
168
|
|
|
@@ -170,229 +170,229 @@ A [`tls_config`](#access-info-tls-config) block (within [`access_info`](#access-
|
|
|
170
170
|
|
|
171
171
|
<a id="access-info-tls-config-sni"></a>• [`sni`](#access-info-tls-config-sni) - Optional String<br>SNI Value. SNI value to be used
|
|
172
172
|
|
|
173
|
-
<a id="
|
|
173
|
+
<a id="sni-493d0a"></a>• [`use_host_header_as_sni`](#sni-493d0a) - Optional Block<br>Enable this option
|
|
174
174
|
|
|
175
175
|
#### Access Info TLS Config Cert Params
|
|
176
176
|
|
|
177
177
|
A [`cert_params`](#access-info-tls-config-cert-params) block (within [`access_info.tls_config`](#access-info-tls-config)) supports the following:
|
|
178
178
|
|
|
179
|
-
<a id="
|
|
179
|
+
<a id="certificates-817e4b"></a>• [`certificates`](#certificates-817e4b) - Optional Block<br>Client Certificate. Client TLS Certificate required for mTLS authentication<br>See [Certificates](#certificates-817e4b) below.
|
|
180
180
|
|
|
181
|
-
<a id="
|
|
181
|
+
<a id="suites-b1a0f8"></a>• [`cipher_suites`](#suites-b1a0f8) - Optional List<br>Cipher Suites. 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 TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384 TLS_ECDHE_RSA_WITH_CHACHA20_POLY1305_SHA256 TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA TLS_RSA_WITH_AES_128_CBC_SHA TLS_RSA_WITH_AES_128_GCM_SHA256 TLS_RSA_WITH_AES_256_CBC_SHA TLS_RSA_WITH_AES_256_GCM_SHA384 If not specified, the default list: TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256 TLS_ECDHE_ECDSA_WITH_CHACHA20_POLY1305_SHA256 TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256 TLS_ECDHE_RSA_WITH_CHACHA20_POLY1305_SHA256 TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384 TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384 will be used
|
|
182
182
|
|
|
183
|
-
<a id="
|
|
183
|
+
<a id="version-39c150"></a>• [`maximum_protocol_version`](#version-39c150) - 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] TLS Protocol. TlsProtocol is enumeration of supported TLS versions F5 Distributed Cloud will choose the optimal TLS version
|
|
184
184
|
|
|
185
|
-
<a id="
|
|
185
|
+
<a id="version-0f4479"></a>• [`minimum_protocol_version`](#version-0f4479) - 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] TLS Protocol. TlsProtocol is enumeration of supported TLS versions F5 Distributed Cloud will choose the optimal TLS version
|
|
186
186
|
|
|
187
|
-
<a id="
|
|
187
|
+
<a id="params-e516d2"></a>• [`validation_params`](#params-e516d2) - Optional Block<br>TLS Certificate Validation Parameters. This includes URL for a trust store, whether SAN verification is required and list of Subject Alt Names for verification<br>See [Validation Params](#params-e516d2) below.
|
|
188
188
|
|
|
189
189
|
#### Access Info TLS Config Cert Params Certificates
|
|
190
190
|
|
|
191
|
-
A [`certificates`](#
|
|
191
|
+
A [`certificates`](#certificates-817e4b) block (within [`access_info.tls_config.cert_params`](#access-info-tls-config-cert-params)) supports the following:
|
|
192
192
|
|
|
193
|
-
<a id="
|
|
193
|
+
<a id="kind-aa6391"></a>• [`kind`](#kind-aa6391) - Optional String<br>Kind. 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')
|
|
194
194
|
|
|
195
|
-
<a id="
|
|
195
|
+
<a id="name-b60acc"></a>• [`name`](#name-b60acc) - Optional String<br>Name. 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
|
|
196
196
|
|
|
197
|
-
<a id="
|
|
197
|
+
<a id="namespace-5cf8ce"></a>• [`namespace`](#namespace-5cf8ce) - Optional String<br>Namespace. 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
|
|
198
198
|
|
|
199
|
-
<a id="
|
|
199
|
+
<a id="tenant-e34095"></a>• [`tenant`](#tenant-e34095) - Optional String<br>Tenant. 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
|
|
200
200
|
|
|
201
|
-
<a id="
|
|
201
|
+
<a id="uid-9b9cc6"></a>• [`uid`](#uid-9b9cc6) - Optional String<br>UID. 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
|
|
202
202
|
|
|
203
203
|
#### Access Info TLS Config Cert Params Validation Params
|
|
204
204
|
|
|
205
|
-
A [`validation_params`](#
|
|
205
|
+
A [`validation_params`](#params-e516d2) block (within [`access_info.tls_config.cert_params`](#access-info-tls-config-cert-params)) supports the following:
|
|
206
206
|
|
|
207
|
-
<a id="
|
|
207
|
+
<a id="verification-ccf95a"></a>• [`skip_hostname_verification`](#verification-ccf95a) - Optional Bool<br>Skip verification of hostname. When True, skip verification of hostname i.e. CN/Subject Alt Name of certificate is not matched to the connecting hostname
|
|
208
208
|
|
|
209
|
-
<a id="
|
|
209
|
+
<a id="trusted-ca-27c4ba"></a>• [`trusted_ca`](#trusted-ca-27c4ba) - Optional Block<br>Root CA Certificate Reference. Reference to Root CA Certificate<br>See [Trusted CA](#trusted-ca-27c4ba) below.
|
|
210
210
|
|
|
211
|
-
<a id="
|
|
211
|
+
<a id="url-9caf14"></a>• [`trusted_ca_url`](#url-9caf14) - Optional String<br>Inline Root CA Certificate (legacy). Inline Root CA Certificate
|
|
212
212
|
|
|
213
|
-
<a id="
|
|
213
|
+
<a id="names-f5bd05"></a>• [`verify_subject_alt_names`](#names-f5bd05) - Optional List<br>List of SANs for matching. 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
|
|
214
214
|
|
|
215
215
|
#### Access Info TLS Config Cert Params Validation Params Trusted CA
|
|
216
216
|
|
|
217
|
-
A [`trusted_ca`](#
|
|
217
|
+
A [`trusted_ca`](#trusted-ca-27c4ba) block (within [`access_info.tls_config.cert_params.validation_params`](#params-e516d2)) supports the following:
|
|
218
218
|
|
|
219
|
-
<a id="
|
|
219
|
+
<a id="list-8e02e9"></a>• [`trusted_ca_list`](#list-8e02e9) - Optional Block<br>Root CA Certificate Reference. Reference to Root CA Certificate<br>See [Trusted CA List](#list-8e02e9) below.
|
|
220
220
|
|
|
221
221
|
#### Access Info TLS Config Cert Params Validation Params Trusted CA Trusted CA List
|
|
222
222
|
|
|
223
|
-
A [`trusted_ca_list`](#
|
|
223
|
+
A [`trusted_ca_list`](#list-8e02e9) block (within [`access_info.tls_config.cert_params.validation_params.trusted_ca`](#trusted-ca-27c4ba)) supports the following:
|
|
224
224
|
|
|
225
|
-
<a id="
|
|
225
|
+
<a id="kind-5f51c6"></a>• [`kind`](#kind-5f51c6) - Optional String<br>Kind. 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')
|
|
226
226
|
|
|
227
|
-
<a id="
|
|
227
|
+
<a id="name-78a62e"></a>• [`name`](#name-78a62e) - Optional String<br>Name. 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
|
|
228
228
|
|
|
229
|
-
<a id="
|
|
229
|
+
<a id="namespace-c2eda5"></a>• [`namespace`](#namespace-c2eda5) - Optional String<br>Namespace. 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
|
|
230
230
|
|
|
231
|
-
<a id="
|
|
231
|
+
<a id="tenant-61b6f1"></a>• [`tenant`](#tenant-61b6f1) - Optional String<br>Tenant. 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
|
|
232
232
|
|
|
233
|
-
<a id="
|
|
233
|
+
<a id="uid-b7334d"></a>• [`uid`](#uid-b7334d) - Optional String<br>UID. 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
|
|
234
234
|
|
|
235
235
|
#### Access Info TLS Config Common Params
|
|
236
236
|
|
|
237
237
|
A [`common_params`](#access-info-tls-config-common-params) block (within [`access_info.tls_config`](#access-info-tls-config)) supports the following:
|
|
238
238
|
|
|
239
|
-
<a id="
|
|
239
|
+
<a id="suites-f2e231"></a>• [`cipher_suites`](#suites-f2e231) - Optional List<br>Cipher Suites. 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 TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384 TLS_ECDHE_RSA_WITH_CHACHA20_POLY1305_SHA256 TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA TLS_RSA_WITH_AES_128_CBC_SHA TLS_RSA_WITH_AES_128_GCM_SHA256 TLS_RSA_WITH_AES_256_CBC_SHA TLS_RSA_WITH_AES_256_GCM_SHA384 If not specified, the default list: TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256 TLS_ECDHE_ECDSA_WITH_CHACHA20_POLY1305_SHA256 TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256 TLS_ECDHE_RSA_WITH_CHACHA20_POLY1305_SHA256 TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384 TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384 will be used
|
|
240
240
|
|
|
241
|
-
<a id="
|
|
241
|
+
<a id="version-af11d8"></a>• [`maximum_protocol_version`](#version-af11d8) - 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] TLS Protocol. TlsProtocol is enumeration of supported TLS versions F5 Distributed Cloud will choose the optimal TLS version
|
|
242
242
|
|
|
243
|
-
<a id="
|
|
243
|
+
<a id="version-5a0b3d"></a>• [`minimum_protocol_version`](#version-5a0b3d) - 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] TLS Protocol. TlsProtocol is enumeration of supported TLS versions F5 Distributed Cloud will choose the optimal TLS version
|
|
244
244
|
|
|
245
|
-
<a id="
|
|
245
|
+
<a id="certificates-15ac8c"></a>• [`tls_certificates`](#certificates-15ac8c) - Optional Block<br>TLS Certificates. Set of TLS certificates<br>See [TLS Certificates](#certificates-15ac8c) below.
|
|
246
246
|
|
|
247
|
-
<a id="
|
|
247
|
+
<a id="params-952d2c"></a>• [`validation_params`](#params-952d2c) - Optional Block<br>TLS Certificate Validation Parameters. This includes URL for a trust store, whether SAN verification is required and list of Subject Alt Names for verification<br>See [Validation Params](#params-952d2c) below.
|
|
248
248
|
|
|
249
249
|
#### Access Info TLS Config Common Params TLS Certificates
|
|
250
250
|
|
|
251
|
-
A [`tls_certificates`](#
|
|
251
|
+
A [`tls_certificates`](#certificates-15ac8c) block (within [`access_info.tls_config.common_params`](#access-info-tls-config-common-params)) supports the following:
|
|
252
252
|
|
|
253
|
-
<a id="
|
|
253
|
+
<a id="url-14074f"></a>• [`certificate_url`](#url-14074f) - Optional String<br>Certificate. TLS certificate. Certificate or certificate chain in PEM format including the PEM headers
|
|
254
254
|
|
|
255
|
-
<a id="
|
|
255
|
+
<a id="algorithms-518ad0"></a>• [`custom_hash_algorithms`](#algorithms-518ad0) - Optional Block<br>Hash Algorithms. Specifies the hash algorithms to be used<br>See [Custom Hash Algorithms](#algorithms-518ad0) below.
|
|
256
256
|
|
|
257
|
-
<a id="
|
|
257
|
+
<a id="spec-35ec52"></a>• [`description_spec`](#spec-35ec52) - Optional String<br>Description. Description for the certificate
|
|
258
258
|
|
|
259
|
-
<a id="
|
|
259
|
+
<a id="stapling-fa8146"></a>• [`disable_ocsp_stapling`](#stapling-fa8146) - Optional Block<br>Enable this option
|
|
260
260
|
|
|
261
|
-
<a id="
|
|
261
|
+
<a id="key-1f214e"></a>• [`private_key`](#key-1f214e) - Optional Block<br>Secret. SecretType is used in an object to indicate a sensitive/confidential field<br>See [Private Key](#key-1f214e) below.
|
|
262
262
|
|
|
263
|
-
<a id="
|
|
263
|
+
<a id="defaults-5a2e96"></a>• [`use_system_defaults`](#defaults-5a2e96) - Optional Block<br>Enable this option
|
|
264
264
|
|
|
265
265
|
#### Access Info TLS Config Common Params TLS Certificates Custom Hash Algorithms
|
|
266
266
|
|
|
267
|
-
A [`custom_hash_algorithms`](#
|
|
267
|
+
A [`custom_hash_algorithms`](#algorithms-518ad0) block (within [`access_info.tls_config.common_params.tls_certificates`](#certificates-15ac8c)) supports the following:
|
|
268
268
|
|
|
269
|
-
<a id="
|
|
269
|
+
<a id="algorithms-436f46"></a>• [`hash_algorithms`](#algorithms-436f46) - Optional List Defaults to `INVALID_HASH_ALGORITHM`<br>Possible values are `INVALID_HASH_ALGORITHM`, `SHA256`, `SHA1`<br>[Enum: INVALID_HASH_ALGORITHM|SHA256|SHA1] Hash Algorithms. Ordered list of hash algorithms to be used
|
|
270
270
|
|
|
271
271
|
#### Access Info TLS Config Common Params TLS Certificates Private Key
|
|
272
272
|
|
|
273
|
-
A [`private_key`](#
|
|
273
|
+
A [`private_key`](#key-1f214e) block (within [`access_info.tls_config.common_params.tls_certificates`](#certificates-15ac8c)) supports the following:
|
|
274
274
|
|
|
275
|
-
<a id="
|
|
275
|
+
<a id="info-4da3e9"></a>• [`blindfold_secret_info`](#info-4da3e9) - Optional Block<br>Blindfold Secret. BlindfoldSecretInfoType specifies information about the Secret managed by F5XC Secret Management<br>See [Blindfold Secret Info](#info-4da3e9) below.
|
|
276
276
|
|
|
277
|
-
<a id="
|
|
277
|
+
<a id="info-6c6189"></a>• [`clear_secret_info`](#info-6c6189) - Optional Block<br>In-Clear Secret. ClearSecretInfoType specifies information about the Secret that is not encrypted<br>See [Clear Secret Info](#info-6c6189) below.
|
|
278
278
|
|
|
279
279
|
#### Access Info TLS Config Common Params TLS Certificates Private Key Blindfold Secret Info
|
|
280
280
|
|
|
281
|
-
A [`blindfold_secret_info`](#
|
|
281
|
+
A [`blindfold_secret_info`](#info-4da3e9) block (within [`access_info.tls_config.common_params.tls_certificates.private_key`](#key-1f214e)) supports the following:
|
|
282
282
|
|
|
283
|
-
<a id="
|
|
283
|
+
<a id="provider-7825ae"></a>• [`decryption_provider`](#provider-7825ae) - Optional String<br>Decryption Provider. Name of the Secret Management Access object that contains information about the backend Secret Management service
|
|
284
284
|
|
|
285
|
-
<a id="
|
|
285
|
+
<a id="location-c1d414"></a>• [`location`](#location-c1d414) - Optional String<br>Location. 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
|
|
286
286
|
|
|
287
|
-
<a id="
|
|
287
|
+
<a id="provider-424719"></a>• [`store_provider`](#provider-424719) - Optional String<br>Store Provider. 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:///
|
|
288
288
|
|
|
289
289
|
#### Access Info TLS Config Common Params TLS Certificates Private Key Clear Secret Info
|
|
290
290
|
|
|
291
|
-
A [`clear_secret_info`](#
|
|
291
|
+
A [`clear_secret_info`](#info-6c6189) block (within [`access_info.tls_config.common_params.tls_certificates.private_key`](#key-1f214e)) supports the following:
|
|
292
292
|
|
|
293
|
-
<a id="
|
|
293
|
+
<a id="ref-d118a9"></a>• [`provider_ref`](#ref-d118a9) - Optional String<br>Provider. 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:///
|
|
294
294
|
|
|
295
|
-
<a id="
|
|
295
|
+
<a id="url-af4ffb"></a>• [`url`](#url-af4ffb) - Optional String<br>URL. 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
|
|
296
296
|
|
|
297
297
|
#### Access Info TLS Config Common Params Validation Params
|
|
298
298
|
|
|
299
|
-
A [`validation_params`](#
|
|
299
|
+
A [`validation_params`](#params-952d2c) block (within [`access_info.tls_config.common_params`](#access-info-tls-config-common-params)) supports the following:
|
|
300
300
|
|
|
301
|
-
<a id="
|
|
301
|
+
<a id="verification-6a5c90"></a>• [`skip_hostname_verification`](#verification-6a5c90) - Optional Bool<br>Skip verification of hostname. When True, skip verification of hostname i.e. CN/Subject Alt Name of certificate is not matched to the connecting hostname
|
|
302
302
|
|
|
303
|
-
<a id="
|
|
303
|
+
<a id="trusted-ca-8285bf"></a>• [`trusted_ca`](#trusted-ca-8285bf) - Optional Block<br>Root CA Certificate Reference. Reference to Root CA Certificate<br>See [Trusted CA](#trusted-ca-8285bf) below.
|
|
304
304
|
|
|
305
|
-
<a id="
|
|
305
|
+
<a id="url-c24aea"></a>• [`trusted_ca_url`](#url-c24aea) - Optional String<br>Inline Root CA Certificate (legacy). Inline Root CA Certificate
|
|
306
306
|
|
|
307
|
-
<a id="
|
|
307
|
+
<a id="names-e62b52"></a>• [`verify_subject_alt_names`](#names-e62b52) - Optional List<br>List of SANs for matching. 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
|
|
308
308
|
|
|
309
309
|
#### Access Info TLS Config Common Params Validation Params Trusted CA
|
|
310
310
|
|
|
311
|
-
A [`trusted_ca`](#
|
|
311
|
+
A [`trusted_ca`](#trusted-ca-8285bf) block (within [`access_info.tls_config.common_params.validation_params`](#params-952d2c)) supports the following:
|
|
312
312
|
|
|
313
|
-
<a id="
|
|
313
|
+
<a id="list-c6f3c0"></a>• [`trusted_ca_list`](#list-c6f3c0) - Optional Block<br>Root CA Certificate Reference. Reference to Root CA Certificate<br>See [Trusted CA List](#list-c6f3c0) below.
|
|
314
314
|
|
|
315
315
|
#### Access Info TLS Config Common Params Validation Params Trusted CA Trusted CA List
|
|
316
316
|
|
|
317
|
-
A [`trusted_ca_list`](#
|
|
317
|
+
A [`trusted_ca_list`](#list-c6f3c0) block (within [`access_info.tls_config.common_params.validation_params.trusted_ca`](#trusted-ca-8285bf)) supports the following:
|
|
318
318
|
|
|
319
|
-
<a id="
|
|
319
|
+
<a id="kind-a7b554"></a>• [`kind`](#kind-a7b554) - Optional String<br>Kind. 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')
|
|
320
320
|
|
|
321
|
-
<a id="
|
|
321
|
+
<a id="name-c38987"></a>• [`name`](#name-c38987) - Optional String<br>Name. 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
|
|
322
322
|
|
|
323
|
-
<a id="
|
|
323
|
+
<a id="namespace-e1a99b"></a>• [`namespace`](#namespace-e1a99b) - Optional String<br>Namespace. 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
|
|
324
324
|
|
|
325
|
-
<a id="
|
|
325
|
+
<a id="tenant-d44c66"></a>• [`tenant`](#tenant-d44c66) - Optional String<br>Tenant. 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
|
|
326
326
|
|
|
327
|
-
<a id="
|
|
327
|
+
<a id="uid-854466"></a>• [`uid`](#uid-854466) - Optional String<br>UID. 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
|
|
328
328
|
|
|
329
329
|
#### Access Info Vault Auth Info
|
|
330
330
|
|
|
331
331
|
A [`vault_auth_info`](#access-info-vault-auth-info) block (within [`access_info`](#access-info)) supports the following:
|
|
332
332
|
|
|
333
|
-
<a id="
|
|
333
|
+
<a id="auth-69347c"></a>• [`app_role_auth`](#auth-69347c) - Optional Block<br>Vault AppRole Authentication Parameters. AppRoleAuthInfoType contains parameters for AppRole authentication in Hashicorp Vault<br>See [App Role Auth](#auth-69347c) below.
|
|
334
334
|
|
|
335
335
|
<a id="access-info-vault-auth-info-token"></a>• [`token`](#access-info-vault-auth-info-token) - Optional Block<br>Secret. SecretType is used in an object to indicate a sensitive/confidential field<br>See [Token](#access-info-vault-auth-info-token) below.
|
|
336
336
|
|
|
337
337
|
#### Access Info Vault Auth Info App Role Auth
|
|
338
338
|
|
|
339
|
-
An [`app_role_auth`](#
|
|
339
|
+
An [`app_role_auth`](#auth-69347c) block (within [`access_info.vault_auth_info`](#access-info-vault-auth-info)) supports the following:
|
|
340
340
|
|
|
341
|
-
<a id="
|
|
341
|
+
<a id="role-id-fa1aef"></a>• [`role_id`](#role-id-fa1aef) - Optional String<br>Role ID. role-ID to be used for authentication
|
|
342
342
|
|
|
343
|
-
<a id="
|
|
343
|
+
<a id="secret-id-da1e5d"></a>• [`secret_id`](#secret-id-da1e5d) - Optional Block<br>Secret. SecretType is used in an object to indicate a sensitive/confidential field<br>See [Secret ID](#secret-id-da1e5d) below.
|
|
344
344
|
|
|
345
345
|
#### Access Info Vault Auth Info App Role Auth Secret ID
|
|
346
346
|
|
|
347
|
-
A [`secret_id`](#
|
|
347
|
+
A [`secret_id`](#secret-id-da1e5d) block (within [`access_info.vault_auth_info.app_role_auth`](#auth-69347c)) supports the following:
|
|
348
348
|
|
|
349
|
-
<a id="
|
|
349
|
+
<a id="info-abaf76"></a>• [`blindfold_secret_info`](#info-abaf76) - Optional Block<br>Blindfold Secret. BlindfoldSecretInfoType specifies information about the Secret managed by F5XC Secret Management<br>See [Blindfold Secret Info](#info-abaf76) below.
|
|
350
350
|
|
|
351
|
-
<a id="
|
|
351
|
+
<a id="info-47dc8c"></a>• [`clear_secret_info`](#info-47dc8c) - Optional Block<br>In-Clear Secret. ClearSecretInfoType specifies information about the Secret that is not encrypted<br>See [Clear Secret Info](#info-47dc8c) below.
|
|
352
352
|
|
|
353
353
|
#### Access Info Vault Auth Info App Role Auth Secret ID Blindfold Secret Info
|
|
354
354
|
|
|
355
|
-
A [`blindfold_secret_info`](#
|
|
355
|
+
A [`blindfold_secret_info`](#info-abaf76) block (within [`access_info.vault_auth_info.app_role_auth.secret_id`](#secret-id-da1e5d)) supports the following:
|
|
356
356
|
|
|
357
|
-
<a id="
|
|
357
|
+
<a id="provider-12a382"></a>• [`decryption_provider`](#provider-12a382) - Optional String<br>Decryption Provider. Name of the Secret Management Access object that contains information about the backend Secret Management service
|
|
358
358
|
|
|
359
|
-
<a id="
|
|
359
|
+
<a id="location-0636af"></a>• [`location`](#location-0636af) - Optional String<br>Location. 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
|
|
360
360
|
|
|
361
|
-
<a id="
|
|
361
|
+
<a id="provider-eb3f44"></a>• [`store_provider`](#provider-eb3f44) - Optional String<br>Store Provider. 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:///
|
|
362
362
|
|
|
363
363
|
#### Access Info Vault Auth Info App Role Auth Secret ID Clear Secret Info
|
|
364
364
|
|
|
365
|
-
A [`clear_secret_info`](#
|
|
365
|
+
A [`clear_secret_info`](#info-47dc8c) block (within [`access_info.vault_auth_info.app_role_auth.secret_id`](#secret-id-da1e5d)) supports the following:
|
|
366
366
|
|
|
367
|
-
<a id="
|
|
367
|
+
<a id="ref-43ea58"></a>• [`provider_ref`](#ref-43ea58) - Optional String<br>Provider. 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:///
|
|
368
368
|
|
|
369
|
-
<a id="
|
|
369
|
+
<a id="url-9760e7"></a>• [`url`](#url-9760e7) - Optional String<br>URL. 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
|
|
370
370
|
|
|
371
371
|
#### Access Info Vault Auth Info Token
|
|
372
372
|
|
|
373
373
|
A [`token`](#access-info-vault-auth-info-token) block (within [`access_info.vault_auth_info`](#access-info-vault-auth-info)) supports the following:
|
|
374
374
|
|
|
375
|
-
<a id="
|
|
375
|
+
<a id="info-8a86e5"></a>• [`blindfold_secret_info`](#info-8a86e5) - Optional Block<br>Blindfold Secret. BlindfoldSecretInfoType specifies information about the Secret managed by F5XC Secret Management<br>See [Blindfold Secret Info](#info-8a86e5) below.
|
|
376
376
|
|
|
377
|
-
<a id="
|
|
377
|
+
<a id="info-d906d4"></a>• [`clear_secret_info`](#info-d906d4) - Optional Block<br>In-Clear Secret. ClearSecretInfoType specifies information about the Secret that is not encrypted<br>See [Clear Secret Info](#info-d906d4) below.
|
|
378
378
|
|
|
379
379
|
#### Access Info Vault Auth Info Token Blindfold Secret Info
|
|
380
380
|
|
|
381
|
-
A [`blindfold_secret_info`](#
|
|
381
|
+
A [`blindfold_secret_info`](#info-8a86e5) block (within [`access_info.vault_auth_info.token`](#access-info-vault-auth-info-token)) supports the following:
|
|
382
382
|
|
|
383
|
-
<a id="
|
|
383
|
+
<a id="provider-242714"></a>• [`decryption_provider`](#provider-242714) - Optional String<br>Decryption Provider. Name of the Secret Management Access object that contains information about the backend Secret Management service
|
|
384
384
|
|
|
385
|
-
<a id="
|
|
385
|
+
<a id="location-eca803"></a>• [`location`](#location-eca803) - Optional String<br>Location. 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
|
|
386
386
|
|
|
387
|
-
<a id="
|
|
387
|
+
<a id="provider-9c6b31"></a>• [`store_provider`](#provider-9c6b31) - Optional String<br>Store Provider. 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:///
|
|
388
388
|
|
|
389
389
|
#### Access Info Vault Auth Info Token Clear Secret Info
|
|
390
390
|
|
|
391
|
-
A [`clear_secret_info`](#
|
|
391
|
+
A [`clear_secret_info`](#info-d906d4) block (within [`access_info.vault_auth_info.token`](#access-info-vault-auth-info-token)) supports the following:
|
|
392
392
|
|
|
393
|
-
<a id="
|
|
393
|
+
<a id="ref-88f453"></a>• [`provider_ref`](#ref-88f453) - Optional String<br>Provider. 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:///
|
|
394
394
|
|
|
395
|
-
<a id="
|
|
395
|
+
<a id="url-2477ab"></a>• [`url`](#url-2477ab) - Optional String<br>URL. 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
|
|
396
396
|
|
|
397
397
|
#### Timeouts
|
|
398
398
|
|
|
@@ -103,7 +103,7 @@ A [`rules`](#rule-list-rules) block (within [`rule_list`](#rule-list)) supports
|
|
|
103
103
|
|
|
104
104
|
A [`metadata`](#rule-list-rules-metadata) block (within [`rule_list.rules`](#rule-list-rules)) supports the following:
|
|
105
105
|
|
|
106
|
-
<a id="
|
|
106
|
+
<a id="spec-118a99"></a>• [`description_spec`](#spec-118a99) - Optional String<br>Description. Human readable description
|
|
107
107
|
|
|
108
108
|
<a id="rule-list-rules-metadata-name"></a>• [`name`](#rule-list-rules-metadata-name) - Optional String<br>Name. This is the name of the message. The value of name has to follow DNS-1035 format
|
|
109
109
|
|
|
@@ -115,25 +115,25 @@ A [`spec`](#rule-list-rules-spec) block (within [`rule_list.rules`](#rule-list-r
|
|
|
115
115
|
|
|
116
116
|
<a id="rule-list-rules-spec-client-name"></a>• [`client_name`](#rule-list-rules-spec-client-name) - Optional String<br>Client Name. The name of the client trying to access the secret. Name of the client will be extracted from client TLS certificate. This predicate evaluates to true if client name matches the configured name
|
|
117
117
|
|
|
118
|
-
<a id="
|
|
118
|
+
<a id="matcher-ded25d"></a>• [`client_name_matcher`](#matcher-ded25d) - Optional Block<br>Matcher. A matcher specifies multiple criteria for matching an input string. The match is considered successful if any of the criteria are satisfied. The set of supported match criteria includes a list of exact values and a list of regular expressions<br>See [Client Name Matcher](#matcher-ded25d) below.
|
|
119
119
|
|
|
120
120
|
<a id="rule-list-rules-spec-client-selector"></a>• [`client_selector`](#rule-list-rules-spec-client-selector) - Optional Block<br>Label Selector. This type can be used to establish a 'selector reference' from one object(called selector) to a set of other objects(called selectees) based on the value of expresssions. A label selector is a label query over a set of resources. An empty label selector matches all objects. A null label selector matches no objects. Label selector is immutable. expressions is a list of strings of label selection expression. Each string has ',' separated values which are 'AND' and all strings are logically 'OR'. BNF for expression string `<selector-syntax>` ::= `<requirement>` | `<requirement>` ',' `<selector-syntax>` `<requirement>` ::= [!] KEY [ `<set-based-restriction>` | `<exact-match-restriction>` ] `<set-based-restriction>` ::= '' | `<inclusion-exclusion>` `<value-set>` `<inclusion-exclusion>` ::= `<inclusion>` | `<exclusion>` `<exclusion>` ::= 'notin' `<inclusion>` ::= 'in' `<value-set>` ::= '(' `<values>` ')' `<values>` ::= VALUE | VALUE ',' `<values>` `<exact-match-restriction>` ::= ['='|'=='|'!='] VALUE<br>See [Client Selector](#rule-list-rules-spec-client-selector) below.
|
|
121
121
|
|
|
122
122
|
#### Rule List Rules Spec Client Name Matcher
|
|
123
123
|
|
|
124
|
-
A [`client_name_matcher`](#
|
|
124
|
+
A [`client_name_matcher`](#matcher-ded25d) block (within [`rule_list.rules.spec`](#rule-list-rules-spec)) supports the following:
|
|
125
125
|
|
|
126
|
-
<a id="
|
|
126
|
+
<a id="values-835b8f"></a>• [`exact_values`](#values-835b8f) - Optional List<br>Exact Values. A list of exact values to match the input against
|
|
127
127
|
|
|
128
|
-
<a id="
|
|
128
|
+
<a id="values-4b3791"></a>• [`regex_values`](#values-4b3791) - Optional List<br>Regex Values. A list of regular expressions to match the input against
|
|
129
129
|
|
|
130
|
-
<a id="
|
|
130
|
+
<a id="transformers-fd5b88"></a>• [`transformers`](#transformers-fd5b88) - Optional List Defaults to `TRANSFORMER_NONE`<br>Possible values are `LOWER_CASE`, `UPPER_CASE`, `BASE64_DECODE`, `NORMALIZE_PATH`, `REMOVE_WHITESPACE`, `URL_DECODE`, `TRIM_LEFT`, `TRIM_RIGHT`, `TRIM`<br>[Enum: LOWER_CASE|UPPER_CASE|BASE64_DECODE|NORMALIZE_PATH|REMOVE_WHITESPACE|URL_DECODE|TRIM_LEFT|TRIM_RIGHT|TRIM] Transformers. An ordered list of transformers (starting from index 0) to be applied to the path before matching
|
|
131
131
|
|
|
132
132
|
#### Rule List Rules Spec Client Selector
|
|
133
133
|
|
|
134
134
|
A [`client_selector`](#rule-list-rules-spec-client-selector) block (within [`rule_list.rules.spec`](#rule-list-rules-spec)) supports the following:
|
|
135
135
|
|
|
136
|
-
<a id="
|
|
136
|
+
<a id="expressions-248d45"></a>• [`expressions`](#expressions-248d45) - Optional List<br>Selector Expression. expressions contains the kubernetes style label expression for selections
|
|
137
137
|
|
|
138
138
|
#### Timeouts
|
|
139
139
|
|