@robinmordasiewicz/f5xc-terraform-mcp 3.5.0 → 3.6.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +283 -104
- package/dist/docs/data-sources/bgp.md +2 -2
- package/dist/docs/data-sources/discovery.md +2 -2
- package/dist/docs/data-sources/fast_acl.md +2 -2
- package/dist/docs/data-sources/fast_acl_rule.md +2 -2
- package/dist/docs/data-sources/irule.md +2 -2
- package/dist/docs/data-sources/log_receiver.md +2 -2
- package/dist/docs/data-sources/network_policy.md +2 -2
- package/dist/docs/data-sources/route.md +2 -2
- package/dist/docs/data-sources/site.md +2 -2
- package/dist/docs/resources/address_allocator.md +7 -7
- package/dist/docs/resources/advertise_policy.md +57 -57
- package/dist/docs/resources/alert_policy.md +40 -40
- package/dist/docs/resources/alert_receiver.md +57 -57
- package/dist/docs/resources/api_crawler.md +13 -13
- package/dist/docs/resources/api_definition.md +11 -11
- package/dist/docs/resources/api_discovery.md +4 -4
- package/dist/docs/resources/api_testing.md +27 -27
- package/dist/docs/resources/apm.md +40 -40
- package/dist/docs/resources/app_api_group.md +20 -20
- package/dist/docs/resources/app_firewall.md +50 -50
- package/dist/docs/resources/app_setting.md +19 -19
- package/dist/docs/resources/app_type.md +7 -7
- package/dist/docs/resources/authentication.md +29 -29
- package/dist/docs/resources/aws_tgw_site.md +140 -140
- package/dist/docs/resources/aws_vpc_site.md +174 -174
- package/dist/docs/resources/azure_vnet_site.md +245 -245
- package/dist/docs/resources/bgp.md +37 -205
- package/dist/docs/resources/bgp_asn_set.md +1 -1
- package/dist/docs/resources/bgp_routing_policy.md +19 -19
- package/dist/docs/resources/bot_defense_app_infrastructure.md +12 -12
- package/dist/docs/resources/cdn_cache_rule.md +5 -5
- package/dist/docs/resources/cdn_loadbalancer.md +418 -418
- package/dist/docs/resources/certificate.md +1 -1
- package/dist/docs/resources/certificate_chain.md +1 -1
- package/dist/docs/resources/cloud_connect.md +28 -28
- package/dist/docs/resources/cloud_credentials.md +35 -35
- package/dist/docs/resources/cloud_elastic_ip.md +8 -8
- package/dist/docs/resources/cloud_link.md +36 -36
- package/dist/docs/resources/cluster.md +86 -86
- package/dist/docs/resources/cminstance.md +22 -22
- package/dist/docs/resources/code_base_integration.md +24 -24
- package/dist/docs/resources/container_registry.md +13 -13
- package/dist/docs/resources/crl.md +1 -1
- package/dist/docs/resources/data_type.md +16 -16
- package/dist/docs/resources/dc_cluster_group.md +4 -4
- package/dist/docs/resources/discovery.md +8 -259
- package/dist/docs/resources/dns_compliance_checks.md +1 -1
- package/dist/docs/resources/dns_domain.md +3 -3
- package/dist/docs/resources/endpoint.md +44 -44
- package/dist/docs/resources/enhanced_firewall_policy.md +51 -51
- package/dist/docs/resources/external_connector.md +42 -42
- package/dist/docs/resources/fast_acl.md +60 -166
- package/dist/docs/resources/fast_acl_rule.md +28 -28
- package/dist/docs/resources/filter_set.md +10 -10
- package/dist/docs/resources/fleet.md +160 -160
- package/dist/docs/resources/forward_proxy_policy.md +82 -82
- package/dist/docs/resources/forwarding_class.md +14 -14
- package/dist/docs/resources/gcp_vpc_site.md +152 -152
- package/dist/docs/resources/global_log_receiver.md +238 -238
- package/dist/docs/resources/healthcheck.md +17 -17
- package/dist/docs/resources/http_loadbalancer.md +1003 -1003
- package/dist/docs/resources/irule.md +5 -7
- package/dist/docs/resources/log_receiver.md +825 -44
- package/dist/docs/resources/malicious_user_mitigation.md +10 -10
- package/dist/docs/resources/nat_policy.md +86 -86
- package/dist/docs/resources/network_connector.md +31 -31
- package/dist/docs/resources/network_firewall.md +22 -22
- package/dist/docs/resources/network_interface.md +77 -77
- package/dist/docs/resources/network_policy.md +38 -217
- package/dist/docs/resources/network_policy_rule.md +21 -21
- package/dist/docs/resources/network_policy_view.md +65 -65
- package/dist/docs/resources/nfv_service.md +76 -76
- package/dist/docs/resources/nginx_service_discovery.md +10 -10
- package/dist/docs/resources/origin_pool.md +166 -166
- package/dist/docs/resources/policer.md +4 -4
- package/dist/docs/resources/policy_based_routing.md +28 -28
- package/dist/docs/resources/protocol_inspection.md +12 -12
- package/dist/docs/resources/protocol_policer.md +14 -14
- package/dist/docs/resources/proxy.md +111 -111
- package/dist/docs/resources/rate_limiter.md +15 -15
- package/dist/docs/resources/rate_limiter_policy.md +56 -56
- package/dist/docs/resources/route.md +183 -183
- package/dist/docs/resources/secret_management_access.md +68 -68
- package/dist/docs/resources/securemesh_site.md +1619 -258
- package/dist/docs/resources/segment.md +4 -4
- package/dist/docs/resources/sensitive_data_policy.md +9 -9
- package/dist/docs/resources/service_policy.md +175 -175
- package/dist/docs/resources/service_policy_rule.md +142 -142
- package/dist/docs/resources/site.md +381 -303
- package/dist/docs/resources/site_mesh_group.md +18 -18
- package/dist/docs/resources/subnet.md +17 -17
- package/dist/docs/resources/tcp_loadbalancer.md +130 -130
- package/dist/docs/resources/tenant_configuration.md +10 -10
- package/dist/docs/resources/trusted_ca_list.md +1 -1
- package/dist/docs/resources/tunnel.md +36 -36
- package/dist/docs/resources/udp_loadbalancer.md +59 -59
- package/dist/docs/resources/usb_policy.md +6 -6
- package/dist/docs/resources/user_identification.md +16 -16
- package/dist/docs/resources/virtual_host.md +225 -225
- package/dist/docs/resources/virtual_network.md +14 -14
- package/dist/docs/resources/virtual_site.md +3 -3
- package/dist/docs/resources/voltstack_site.md +141 -141
- package/dist/docs/resources/waf_exclusion_policy.md +17 -17
- package/dist/docs/resources/workload.md +327 -327
- package/dist/docs/resources/workload_flavor.md +3 -3
- package/dist/metadata/resource-metadata.json +1484 -942
- package/dist/types.d.ts +11 -0
- package/dist/types.d.ts.map +1 -1
- package/dist/types.js.map +1 -1
- package/package.json +1 -1
|
@@ -57,11 +57,11 @@ resource "f5xc_rate_limiter" "example" {
|
|
|
57
57
|
|
|
58
58
|
### Spec Argument Reference
|
|
59
59
|
|
|
60
|
-
<a id="limits"></a>• [`limits`](#limits) - Optional Block<br>
|
|
60
|
+
<a id="limits"></a>• [`limits`](#limits) - Optional Block<br>List of RateLimitValues that specifies the total number of allowed requests for each specified period<br>See [Limits](#limits) below for details.
|
|
61
61
|
|
|
62
62
|
<a id="timeouts"></a>• [`timeouts`](#timeouts) - Optional Block<br>See [Timeouts](#timeouts) below for details.
|
|
63
63
|
|
|
64
|
-
<a id="user-identification"></a>• [`user_identification`](#user-identification) - Optional Block<br>
|
|
64
|
+
<a id="user-identification"></a>• [`user_identification`](#user-identification) - Optional Block<br>Reference to user_identification object. The rules in the user_identification object are evaluated to determine the user identifier to be rate limited<br>See [User Identification](#user-identification) below for details.
|
|
65
65
|
|
|
66
66
|
### Attributes Reference
|
|
67
67
|
|
|
@@ -75,21 +75,21 @@ In addition to all arguments above, the following attributes are exported:
|
|
|
75
75
|
|
|
76
76
|
A [`limits`](#limits) block supports the following:
|
|
77
77
|
|
|
78
|
-
<a id="limits-action-block"></a>• [`action_block`](#limits-action-block) - Optional Block<br>
|
|
78
|
+
<a id="limits-action-block"></a>• [`action_block`](#limits-action-block) - Optional Block<br>Action where a user is blocked from making further requests after exceeding rate limit threshold<br>See [Action Block](#limits-action-block) below.
|
|
79
79
|
|
|
80
|
-
<a id="limits-burst-multiplier"></a>• [`burst_multiplier`](#limits-burst-multiplier) - Optional Number<br>
|
|
80
|
+
<a id="limits-burst-multiplier"></a>• [`burst_multiplier`](#limits-burst-multiplier) - Optional Number<br>The maximum burst of requests to accommodate, expressed as a multiple of the rate
|
|
81
81
|
|
|
82
|
-
<a id="limits-disabled"></a>• [`disabled`](#limits-disabled) - Optional Block<br>
|
|
82
|
+
<a id="limits-disabled"></a>• [`disabled`](#limits-disabled) - Optional Block<br>Can be used for messages where no values are needed
|
|
83
83
|
|
|
84
|
-
<a id="limits-leaky-bucket"></a>• [`leaky_bucket`](#limits-leaky-bucket) - Optional Block<br>Leaky
|
|
84
|
+
<a id="limits-leaky-bucket"></a>• [`leaky_bucket`](#limits-leaky-bucket) - Optional Block<br>Leaky-Bucket is the default rate limiter algorithm for F5
|
|
85
85
|
|
|
86
|
-
<a id="limits-period-multiplier"></a>• [`period_multiplier`](#limits-period-multiplier) - Optional Number<br>
|
|
86
|
+
<a id="limits-period-multiplier"></a>• [`period_multiplier`](#limits-period-multiplier) - Optional Number<br>Setting, combined with Per Period units, provides a duration
|
|
87
87
|
|
|
88
|
-
<a id="limits-token-bucket"></a>• [`token_bucket`](#limits-token-bucket) - Optional Block<br>Token
|
|
88
|
+
<a id="limits-token-bucket"></a>• [`token_bucket`](#limits-token-bucket) - Optional Block<br>Token-Bucket is a rate limiter algorithm that is stricter with enforcing limits
|
|
89
89
|
|
|
90
|
-
<a id="limits-total-number"></a>• [`total_number`](#limits-total-number) - Optional Number<br>
|
|
90
|
+
<a id="limits-total-number"></a>• [`total_number`](#limits-total-number) - Optional Number<br>The total number of allowed requests per rate-limiting period
|
|
91
91
|
|
|
92
|
-
<a id="limits-unit"></a>• [`unit`](#limits-unit) - Optional String Defaults to `SECOND`<br>Possible values are `SECOND`, `MINUTE`, `HOUR`<br>[Enum: SECOND|MINUTE|HOUR]
|
|
92
|
+
<a id="limits-unit"></a>• [`unit`](#limits-unit) - Optional String Defaults to `SECOND`<br>Possible values are `SECOND`, `MINUTE`, `HOUR`<br>[Enum: SECOND|MINUTE|HOUR] Unit for the period per which the rate limit is applied. - SECOND: Second Rate limit period unit is seconds - MINUTE: Minute Rate limit period unit is minutes - HOUR: Hour Rate limit period unit is hours - DAY: Day Rate limit period unit is days
|
|
93
93
|
|
|
94
94
|
#### Limits Action Block
|
|
95
95
|
|
|
@@ -135,15 +135,15 @@ A [`timeouts`](#timeouts) block supports the following:
|
|
|
135
135
|
|
|
136
136
|
An [`user_identification`](#user-identification) block supports the following:
|
|
137
137
|
|
|
138
|
-
<a id="user-identification-kind"></a>• [`kind`](#user-identification-kind) - Optional String<br>
|
|
138
|
+
<a id="user-identification-kind"></a>• [`kind`](#user-identification-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')
|
|
139
139
|
|
|
140
|
-
<a id="user-identification-name"></a>• [`name`](#user-identification-name) - Optional String<br>
|
|
140
|
+
<a id="user-identification-name"></a>• [`name`](#user-identification-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
|
|
141
141
|
|
|
142
|
-
<a id="user-identification-namespace"></a>• [`namespace`](#user-identification-namespace) - Optional String<br>
|
|
142
|
+
<a id="user-identification-namespace"></a>• [`namespace`](#user-identification-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
|
|
143
143
|
|
|
144
|
-
<a id="user-identification-tenant"></a>• [`tenant`](#user-identification-tenant) - Optional String<br>
|
|
144
|
+
<a id="user-identification-tenant"></a>• [`tenant`](#user-identification-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
|
|
145
145
|
|
|
146
|
-
<a id="user-identification-uid"></a>• [`uid`](#user-identification-uid) - Optional String<br>
|
|
146
|
+
<a id="user-identification-uid"></a>• [`uid`](#user-identification-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
|
|
147
147
|
|
|
148
148
|
---
|
|
149
149
|
|
|
@@ -36,7 +36,7 @@ resource "f5xc_rate_limiter_policy" "example" {
|
|
|
36
36
|
any_server {
|
|
37
37
|
# Configure any_server settings
|
|
38
38
|
}
|
|
39
|
-
#
|
|
39
|
+
# List of RateLimiterRules that are evaluated sequentially ...
|
|
40
40
|
rules {
|
|
41
41
|
# Configure rules settings
|
|
42
42
|
}
|
|
@@ -63,12 +63,12 @@ resource "f5xc_rate_limiter_policy" "example" {
|
|
|
63
63
|
### Spec Argument Reference
|
|
64
64
|
|
|
65
65
|
-> **One of the following:**
|
|
66
|
-
• <a id="any-server"></a>[`any_server`](#any-server) - Optional Block<br>
|
|
67
|
-
<br><br>• <a id="server-name"></a>[`server_name`](#server-name) - Optional String<br>
|
|
68
|
-
<br><br>• <a id="server-name-matcher"></a>[`server_name_matcher`](#server-name-matcher) - Optional Block<br>Matcher
|
|
69
|
-
<br><br>• <a id="server-selector"></a>[`server_selector`](#server-selector) - Optional Block<br>
|
|
66
|
+
• <a id="any-server"></a>[`any_server`](#any-server) - Optional Block<br>Can be used for messages where no values are needed
|
|
67
|
+
<br><br>• <a id="server-name"></a>[`server_name`](#server-name) - Optional String<br>The expected name of the server. The actual names for the server are extracted from the HTTP Host header and the name of the virtual_host for the request
|
|
68
|
+
<br><br>• <a id="server-name-matcher"></a>[`server_name_matcher`](#server-name-matcher) - Optional Block<br>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 [Server Name Matcher](#server-name-matcher) below for details.
|
|
69
|
+
<br><br>• <a id="server-selector"></a>[`server_selector`](#server-selector) - Optional Block<br>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<br>See [Server Selector](#server-selector) below for details.
|
|
70
70
|
|
|
71
|
-
<a id="rules"></a>• [`rules`](#rules) - Optional Block<br>
|
|
71
|
+
<a id="rules"></a>• [`rules`](#rules) - Optional Block<br>List of RateLimiterRules that are evaluated sequentially till a matching rule is identified<br>See [Rules](#rules) below for details.
|
|
72
72
|
|
|
73
73
|
<a id="timeouts"></a>• [`timeouts`](#timeouts) - Optional Block<br>See [Timeouts](#timeouts) below for details.
|
|
74
74
|
|
|
@@ -84,7 +84,7 @@ In addition to all arguments above, the following attributes are exported:
|
|
|
84
84
|
|
|
85
85
|
A [`rules`](#rules) block supports the following:
|
|
86
86
|
|
|
87
|
-
<a id="rules-metadata"></a>• [`metadata`](#rules-metadata) - Optional Block<br>
|
|
87
|
+
<a id="rules-metadata"></a>• [`metadata`](#rules-metadata) - Optional Block<br>MessageMetaType is metadata (common attributes) of a message that only certain messages have. This information is propagated to the metadata of a child object that gets created from the containing message during view processing. The information in this type can be specified by user during create<br>See [Metadata](#rules-metadata) below.
|
|
88
88
|
|
|
89
89
|
<a id="rules-spec"></a>• [`spec`](#rules-spec) - Optional Block<br>Rate Limiter Rule Specification. Shape of Rate Limiter Rule<br>See [Spec](#rules-spec) below.
|
|
90
90
|
|
|
@@ -94,67 +94,67 @@ A [`metadata`](#rules-metadata) block (within [`rules`](#rules)) supports the fo
|
|
|
94
94
|
|
|
95
95
|
<a id="rules-metadata-description-spec"></a>• [`description_spec`](#rules-metadata-description-spec) - Optional String<br>Description. Human readable description
|
|
96
96
|
|
|
97
|
-
<a id="rules-metadata-name"></a>• [`name`](#rules-metadata-name) - Optional String<br>Name
|
|
97
|
+
<a id="rules-metadata-name"></a>• [`name`](#rules-metadata-name) - Optional String<br>Name of the message. The value of name has to follow DNS-1035 format
|
|
98
98
|
|
|
99
99
|
#### Rules Spec
|
|
100
100
|
|
|
101
101
|
A [`spec`](#rules-spec) block (within [`rules`](#rules)) supports the following:
|
|
102
102
|
|
|
103
|
-
<a id="rules-spec-any-asn"></a>• [`any_asn`](#rules-spec-any-asn) - Optional Block<br>
|
|
103
|
+
<a id="rules-spec-any-asn"></a>• [`any_asn`](#rules-spec-any-asn) - Optional Block<br>Can be used for messages where no values are needed
|
|
104
104
|
|
|
105
|
-
<a id="rules-spec-any-country"></a>• [`any_country`](#rules-spec-any-country) - Optional Block<br>
|
|
105
|
+
<a id="rules-spec-any-country"></a>• [`any_country`](#rules-spec-any-country) - Optional Block<br>Can be used for messages where no values are needed
|
|
106
106
|
|
|
107
|
-
<a id="rules-spec-any-ip"></a>• [`any_ip`](#rules-spec-any-ip) - Optional Block<br>
|
|
107
|
+
<a id="rules-spec-any-ip"></a>• [`any_ip`](#rules-spec-any-ip) - Optional Block<br>Can be used for messages where no values are needed
|
|
108
108
|
|
|
109
|
-
<a id="rules-spec-apply-rate-limiter"></a>• [`apply_rate_limiter`](#rules-spec-apply-rate-limiter) - Optional Block<br>
|
|
109
|
+
<a id="rules-spec-apply-rate-limiter"></a>• [`apply_rate_limiter`](#rules-spec-apply-rate-limiter) - Optional Block<br>Can be used for messages where no values are needed
|
|
110
110
|
|
|
111
|
-
<a id="rules-spec-asn-list"></a>• [`asn_list`](#rules-spec-asn-list) - Optional Block<br>
|
|
111
|
+
<a id="rules-spec-asn-list"></a>• [`asn_list`](#rules-spec-asn-list) - Optional Block<br>Unordered set of RFC 6793 defined 4-byte AS numbers that can be used to create allow or deny lists for use in network policy or service policy. It can be used to create the allow list only for DNS Load Balancer<br>See [Asn List](#rules-spec-asn-list) below.
|
|
112
112
|
|
|
113
|
-
<a id="rules-spec-asn-matcher"></a>• [`asn_matcher`](#rules-spec-asn-matcher) - Optional Block<br>
|
|
113
|
+
<a id="rules-spec-asn-matcher"></a>• [`asn_matcher`](#rules-spec-asn-matcher) - Optional Block<br>Match any AS number contained in the list of bgp_asn_sets<br>See [Asn Matcher](#rules-spec-asn-matcher) below.
|
|
114
114
|
|
|
115
|
-
<a id="rules-spec-bypass-rate-limiter"></a>• [`bypass_rate_limiter`](#rules-spec-bypass-rate-limiter) - Optional Block<br>
|
|
115
|
+
<a id="rules-spec-bypass-rate-limiter"></a>• [`bypass_rate_limiter`](#rules-spec-bypass-rate-limiter) - Optional Block<br>Can be used for messages where no values are needed
|
|
116
116
|
|
|
117
117
|
<a id="rules-spec-country-list"></a>• [`country_list`](#rules-spec-country-list) - Optional Block<br>Country Codes List. List of Country Codes to match against<br>See [Country List](#rules-spec-country-list) below.
|
|
118
118
|
|
|
119
|
-
<a id="rules-spec-custom-rate-limiter"></a>• [`custom_rate_limiter`](#rules-spec-custom-rate-limiter) - Optional Block<br>
|
|
119
|
+
<a id="rules-spec-custom-rate-limiter"></a>• [`custom_rate_limiter`](#rules-spec-custom-rate-limiter) - Optional Block<br>Type establishes a direct reference from one object(the referrer) to another(the referred). Such a reference is in form of tenant/namespace/name<br>See [Custom Rate Limiter](#rules-spec-custom-rate-limiter) below.
|
|
120
120
|
|
|
121
|
-
<a id="rules-spec-domain-matcher"></a>• [`domain_matcher`](#rules-spec-domain-matcher) - Optional Block<br>Matcher
|
|
121
|
+
<a id="rules-spec-domain-matcher"></a>• [`domain_matcher`](#rules-spec-domain-matcher) - Optional Block<br>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 [Domain Matcher](#rules-spec-domain-matcher) below.
|
|
122
122
|
|
|
123
|
-
<a id="rules-spec-headers"></a>• [`headers`](#rules-spec-headers) - Optional Block<br>
|
|
123
|
+
<a id="rules-spec-headers"></a>• [`headers`](#rules-spec-headers) - Optional Block<br>List of predicates for various HTTP headers that need to match. The criteria for matching each HTTP header are described in individual HeaderMatcherType instances. The actual HTTP header values are extracted from the request API as a list of strings for each HTTP header type<br>See [Headers](#rules-spec-headers) below.
|
|
124
124
|
|
|
125
|
-
<a id="rules-spec-http-method"></a>• [`http_method`](#rules-spec-http-method) - Optional Block<br>HTTP
|
|
125
|
+
<a id="rules-spec-http-method"></a>• [`http_method`](#rules-spec-http-method) - Optional Block<br>HTTP method matcher specifies a list of methods to match an input HTTP method. The match is considered successful if the input method is a member of the list. The result of the match based on the method list is inverted if invert_matcher is true<br>See [HTTP Method](#rules-spec-http-method) below.
|
|
126
126
|
|
|
127
|
-
<a id="rules-spec-ip-matcher"></a>• [`ip_matcher`](#rules-spec-ip-matcher) - Optional Block<br>
|
|
127
|
+
<a id="rules-spec-ip-matcher"></a>• [`ip_matcher`](#rules-spec-ip-matcher) - Optional Block<br>Match any IP prefix contained in the list of ip_prefix_sets. The result of the match is inverted if invert_matcher is true<br>See [IP Matcher](#rules-spec-ip-matcher) below.
|
|
128
128
|
|
|
129
|
-
<a id="rules-spec-ip-prefix-list"></a>• [`ip_prefix_list`](#rules-spec-ip-prefix-list) - Optional Block<br>
|
|
129
|
+
<a id="rules-spec-ip-prefix-list"></a>• [`ip_prefix_list`](#rules-spec-ip-prefix-list) - Optional Block<br>List of IP Prefix strings to match against<br>See [IP Prefix List](#rules-spec-ip-prefix-list) below.
|
|
130
130
|
|
|
131
|
-
<a id="rules-spec-path"></a>• [`path`](#rules-spec-path) - Optional Block<br>Path
|
|
131
|
+
<a id="rules-spec-path"></a>• [`path`](#rules-spec-path) - Optional Block<br>Path matcher specifies multiple criteria for matching an HTTP path string. The match is considered successful if any of the criteria are satisfied. The set of supported match criteria includes a list of path prefixes, a list of exact path values and a list of regular expressions<br>See [Path](#rules-spec-path) below.
|
|
132
132
|
|
|
133
133
|
#### Rules Spec Asn List
|
|
134
134
|
|
|
135
135
|
An [`asn_list`](#rules-spec-asn-list) block (within [`rules.spec`](#rules-spec)) supports the following:
|
|
136
136
|
|
|
137
|
-
<a id="rules-spec-asn-list-as-numbers"></a>• [`as_numbers`](#rules-spec-asn-list-as-numbers) - Optional List<br>
|
|
137
|
+
<a id="rules-spec-asn-list-as-numbers"></a>• [`as_numbers`](#rules-spec-asn-list-as-numbers) - Optional List<br>Unordered set of RFC 6793 defined 4-byte AS numbers that can be used to create allow or deny lists for use in network policy or service policy. It can be used to create the allow list only for DNS Load Balancer
|
|
138
138
|
|
|
139
139
|
#### Rules Spec Asn Matcher
|
|
140
140
|
|
|
141
141
|
An [`asn_matcher`](#rules-spec-asn-matcher) block (within [`rules.spec`](#rules-spec)) supports the following:
|
|
142
142
|
|
|
143
|
-
<a id="rules-spec-asn-matcher-asn-sets"></a>• [`asn_sets`](#rules-spec-asn-matcher-asn-sets) - Optional Block<br>
|
|
143
|
+
<a id="rules-spec-asn-matcher-asn-sets"></a>• [`asn_sets`](#rules-spec-asn-matcher-asn-sets) - Optional Block<br>List of references to bgp_asn_set objects<br>See [Asn Sets](#rules-spec-asn-matcher-asn-sets) below.
|
|
144
144
|
|
|
145
145
|
#### Rules Spec Asn Matcher Asn Sets
|
|
146
146
|
|
|
147
147
|
An [`asn_sets`](#rules-spec-asn-matcher-asn-sets) block (within [`rules.spec.asn_matcher`](#rules-spec-asn-matcher)) supports the following:
|
|
148
148
|
|
|
149
|
-
<a id="rules-spec-asn-matcher-asn-sets-kind"></a>• [`kind`](#rules-spec-asn-matcher-asn-sets-kind) - Optional String<br>
|
|
149
|
+
<a id="rules-spec-asn-matcher-asn-sets-kind"></a>• [`kind`](#rules-spec-asn-matcher-asn-sets-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')
|
|
150
150
|
|
|
151
|
-
<a id="rules-spec-asn-matcher-asn-sets-name"></a>• [`name`](#rules-spec-asn-matcher-asn-sets-name) - Optional String<br>
|
|
151
|
+
<a id="rules-spec-asn-matcher-asn-sets-name"></a>• [`name`](#rules-spec-asn-matcher-asn-sets-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
|
|
152
152
|
|
|
153
|
-
<a id="namespace-3ce633"></a>• [`namespace`](#namespace-3ce633) - Optional String<br>
|
|
153
|
+
<a id="namespace-3ce633"></a>• [`namespace`](#namespace-3ce633) - 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
|
|
154
154
|
|
|
155
|
-
<a id="rules-spec-asn-matcher-asn-sets-tenant"></a>• [`tenant`](#rules-spec-asn-matcher-asn-sets-tenant) - Optional String<br>
|
|
155
|
+
<a id="rules-spec-asn-matcher-asn-sets-tenant"></a>• [`tenant`](#rules-spec-asn-matcher-asn-sets-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
|
|
156
156
|
|
|
157
|
-
<a id="rules-spec-asn-matcher-asn-sets-uid"></a>• [`uid`](#rules-spec-asn-matcher-asn-sets-uid) - Optional String<br>
|
|
157
|
+
<a id="rules-spec-asn-matcher-asn-sets-uid"></a>• [`uid`](#rules-spec-asn-matcher-asn-sets-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
|
|
158
158
|
|
|
159
159
|
#### Rules Spec Country List
|
|
160
160
|
|
|
@@ -168,43 +168,43 @@ A [`country_list`](#rules-spec-country-list) block (within [`rules.spec`](#rules
|
|
|
168
168
|
|
|
169
169
|
A [`custom_rate_limiter`](#rules-spec-custom-rate-limiter) block (within [`rules.spec`](#rules-spec)) supports the following:
|
|
170
170
|
|
|
171
|
-
<a id="rules-spec-custom-rate-limiter-name"></a>• [`name`](#rules-spec-custom-rate-limiter-name) - Optional String<br>
|
|
171
|
+
<a id="rules-spec-custom-rate-limiter-name"></a>• [`name`](#rules-spec-custom-rate-limiter-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
|
|
172
172
|
|
|
173
|
-
<a id="namespace-339376"></a>• [`namespace`](#namespace-339376) - Optional String<br>
|
|
173
|
+
<a id="namespace-339376"></a>• [`namespace`](#namespace-339376) - 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
|
|
174
174
|
|
|
175
|
-
<a id="rules-spec-custom-rate-limiter-tenant"></a>• [`tenant`](#rules-spec-custom-rate-limiter-tenant) - Optional String<br>
|
|
175
|
+
<a id="rules-spec-custom-rate-limiter-tenant"></a>• [`tenant`](#rules-spec-custom-rate-limiter-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
|
|
176
176
|
|
|
177
177
|
#### Rules Spec Domain Matcher
|
|
178
178
|
|
|
179
179
|
A [`domain_matcher`](#rules-spec-domain-matcher) block (within [`rules.spec`](#rules-spec)) supports the following:
|
|
180
180
|
|
|
181
|
-
<a id="rules-spec-domain-matcher-exact-values"></a>• [`exact_values`](#rules-spec-domain-matcher-exact-values) - Optional List<br>
|
|
181
|
+
<a id="rules-spec-domain-matcher-exact-values"></a>• [`exact_values`](#rules-spec-domain-matcher-exact-values) - Optional List<br>List of exact values to match the input against
|
|
182
182
|
|
|
183
|
-
<a id="rules-spec-domain-matcher-regex-values"></a>• [`regex_values`](#rules-spec-domain-matcher-regex-values) - Optional List<br>
|
|
183
|
+
<a id="rules-spec-domain-matcher-regex-values"></a>• [`regex_values`](#rules-spec-domain-matcher-regex-values) - Optional List<br>List of regular expressions to match the input against
|
|
184
184
|
|
|
185
185
|
#### Rules Spec Headers
|
|
186
186
|
|
|
187
187
|
A [`headers`](#rules-spec-headers) block (within [`rules.spec`](#rules-spec)) supports the following:
|
|
188
188
|
|
|
189
|
-
<a id="rules-spec-headers-check-not-present"></a>• [`check_not_present`](#rules-spec-headers-check-not-present) - Optional Block<br>
|
|
189
|
+
<a id="rules-spec-headers-check-not-present"></a>• [`check_not_present`](#rules-spec-headers-check-not-present) - Optional Block<br>Can be used for messages where no values are needed
|
|
190
190
|
|
|
191
|
-
<a id="rules-spec-headers-check-present"></a>• [`check_present`](#rules-spec-headers-check-present) - Optional Block<br>
|
|
191
|
+
<a id="rules-spec-headers-check-present"></a>• [`check_present`](#rules-spec-headers-check-present) - Optional Block<br>Can be used for messages where no values are needed
|
|
192
192
|
|
|
193
193
|
<a id="rules-spec-headers-invert-matcher"></a>• [`invert_matcher`](#rules-spec-headers-invert-matcher) - Optional Bool<br>Invert Header Matcher. Invert the match result
|
|
194
194
|
|
|
195
|
-
<a id="rules-spec-headers-item"></a>• [`item`](#rules-spec-headers-item) - Optional Block<br>Matcher
|
|
195
|
+
<a id="rules-spec-headers-item"></a>• [`item`](#rules-spec-headers-item) - Optional Block<br>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 [Item](#rules-spec-headers-item) below.
|
|
196
196
|
|
|
197
|
-
<a id="rules-spec-headers-name"></a>• [`name`](#rules-spec-headers-name) - Optional String<br>
|
|
197
|
+
<a id="rules-spec-headers-name"></a>• [`name`](#rules-spec-headers-name) - Optional String<br>Case-insensitive HTTP header name
|
|
198
198
|
|
|
199
199
|
#### Rules Spec Headers Item
|
|
200
200
|
|
|
201
201
|
An [`item`](#rules-spec-headers-item) block (within [`rules.spec.headers`](#rules-spec-headers)) supports the following:
|
|
202
202
|
|
|
203
|
-
<a id="rules-spec-headers-item-exact-values"></a>• [`exact_values`](#rules-spec-headers-item-exact-values) - Optional List<br>
|
|
203
|
+
<a id="rules-spec-headers-item-exact-values"></a>• [`exact_values`](#rules-spec-headers-item-exact-values) - Optional List<br>List of exact values to match the input against
|
|
204
204
|
|
|
205
|
-
<a id="rules-spec-headers-item-regex-values"></a>• [`regex_values`](#rules-spec-headers-item-regex-values) - Optional List<br>
|
|
205
|
+
<a id="rules-spec-headers-item-regex-values"></a>• [`regex_values`](#rules-spec-headers-item-regex-values) - Optional List<br>List of regular expressions to match the input against
|
|
206
206
|
|
|
207
|
-
<a id="rules-spec-headers-item-transformers"></a>• [`transformers`](#rules-spec-headers-item-transformers) - Optional List Defaults to `TRANSFORMER_NONE`<br>See [Transformers](#common-transformers)<br>
|
|
207
|
+
<a id="rules-spec-headers-item-transformers"></a>• [`transformers`](#rules-spec-headers-item-transformers) - Optional List Defaults to `TRANSFORMER_NONE`<br>See [Transformers](#common-transformers)<br> Ordered list of transformers (starting from index 0) to be applied to the path before matching
|
|
208
208
|
|
|
209
209
|
#### Rules Spec HTTP Method
|
|
210
210
|
|
|
@@ -212,7 +212,7 @@ A [`http_method`](#rules-spec-http-method) block (within [`rules.spec`](#rules-s
|
|
|
212
212
|
|
|
213
213
|
<a id="rules-spec-http-method-invert-matcher"></a>• [`invert_matcher`](#rules-spec-http-method-invert-matcher) - Optional Bool<br>Invert Method Matcher. Invert the match result
|
|
214
214
|
|
|
215
|
-
<a id="rules-spec-http-method-methods"></a>• [`methods`](#rules-spec-http-method-methods) - Optional List Defaults to `ANY`<br>See [HTTP Methods](#common-http-methods)<br>
|
|
215
|
+
<a id="rules-spec-http-method-methods"></a>• [`methods`](#rules-spec-http-method-methods) - Optional List Defaults to `ANY`<br>See [HTTP Methods](#common-http-methods)<br> List of methods values to match against
|
|
216
216
|
|
|
217
217
|
#### Rules Spec IP Matcher
|
|
218
218
|
|
|
@@ -220,21 +220,21 @@ An [`ip_matcher`](#rules-spec-ip-matcher) block (within [`rules.spec`](#rules-sp
|
|
|
220
220
|
|
|
221
221
|
<a id="rules-spec-ip-matcher-invert-matcher"></a>• [`invert_matcher`](#rules-spec-ip-matcher-invert-matcher) - Optional Bool<br>Invert IP Matcher. Invert the match result
|
|
222
222
|
|
|
223
|
-
<a id="rules-spec-ip-matcher-prefix-sets"></a>• [`prefix_sets`](#rules-spec-ip-matcher-prefix-sets) - Optional Block<br>
|
|
223
|
+
<a id="rules-spec-ip-matcher-prefix-sets"></a>• [`prefix_sets`](#rules-spec-ip-matcher-prefix-sets) - Optional Block<br>List of references to ip_prefix_set objects<br>See [Prefix Sets](#rules-spec-ip-matcher-prefix-sets) below.
|
|
224
224
|
|
|
225
225
|
#### Rules Spec IP Matcher Prefix Sets
|
|
226
226
|
|
|
227
227
|
A [`prefix_sets`](#rules-spec-ip-matcher-prefix-sets) block (within [`rules.spec.ip_matcher`](#rules-spec-ip-matcher)) supports the following:
|
|
228
228
|
|
|
229
|
-
<a id="rules-spec-ip-matcher-prefix-sets-kind"></a>• [`kind`](#rules-spec-ip-matcher-prefix-sets-kind) - Optional String<br>
|
|
229
|
+
<a id="rules-spec-ip-matcher-prefix-sets-kind"></a>• [`kind`](#rules-spec-ip-matcher-prefix-sets-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')
|
|
230
230
|
|
|
231
|
-
<a id="rules-spec-ip-matcher-prefix-sets-name"></a>• [`name`](#rules-spec-ip-matcher-prefix-sets-name) - Optional String<br>
|
|
231
|
+
<a id="rules-spec-ip-matcher-prefix-sets-name"></a>• [`name`](#rules-spec-ip-matcher-prefix-sets-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
|
|
232
232
|
|
|
233
|
-
<a id="namespace-5d9a15"></a>• [`namespace`](#namespace-5d9a15) - Optional String<br>
|
|
233
|
+
<a id="namespace-5d9a15"></a>• [`namespace`](#namespace-5d9a15) - 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
|
|
234
234
|
|
|
235
|
-
<a id="tenant-68e36f"></a>• [`tenant`](#tenant-68e36f) - Optional String<br>
|
|
235
|
+
<a id="tenant-68e36f"></a>• [`tenant`](#tenant-68e36f) - 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
|
|
236
236
|
|
|
237
|
-
<a id="rules-spec-ip-matcher-prefix-sets-uid"></a>• [`uid`](#rules-spec-ip-matcher-prefix-sets-uid) - Optional String<br>
|
|
237
|
+
<a id="rules-spec-ip-matcher-prefix-sets-uid"></a>• [`uid`](#rules-spec-ip-matcher-prefix-sets-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
|
|
238
238
|
|
|
239
239
|
#### Rules Spec IP Prefix List
|
|
240
240
|
|
|
@@ -248,31 +248,31 @@ An [`ip_prefix_list`](#rules-spec-ip-prefix-list) block (within [`rules.spec`](#
|
|
|
248
248
|
|
|
249
249
|
A [`path`](#rules-spec-path) block (within [`rules.spec`](#rules-spec)) supports the following:
|
|
250
250
|
|
|
251
|
-
<a id="rules-spec-path-exact-values"></a>• [`exact_values`](#rules-spec-path-exact-values) - Optional List<br>
|
|
251
|
+
<a id="rules-spec-path-exact-values"></a>• [`exact_values`](#rules-spec-path-exact-values) - Optional List<br>List of exact path values to match the input HTTP path against
|
|
252
252
|
|
|
253
253
|
<a id="rules-spec-path-invert-matcher"></a>• [`invert_matcher`](#rules-spec-path-invert-matcher) - Optional Bool<br>Invert Path Matcher. Invert the match result
|
|
254
254
|
|
|
255
|
-
<a id="rules-spec-path-prefix-values"></a>• [`prefix_values`](#rules-spec-path-prefix-values) - Optional List<br>
|
|
255
|
+
<a id="rules-spec-path-prefix-values"></a>• [`prefix_values`](#rules-spec-path-prefix-values) - Optional List<br>List of path prefix values to match the input HTTP path against
|
|
256
256
|
|
|
257
|
-
<a id="rules-spec-path-regex-values"></a>• [`regex_values`](#rules-spec-path-regex-values) - Optional List<br>
|
|
257
|
+
<a id="rules-spec-path-regex-values"></a>• [`regex_values`](#rules-spec-path-regex-values) - Optional List<br>List of regular expressions to match the input HTTP path against
|
|
258
258
|
|
|
259
|
-
<a id="rules-spec-path-suffix-values"></a>• [`suffix_values`](#rules-spec-path-suffix-values) - Optional List<br>
|
|
259
|
+
<a id="rules-spec-path-suffix-values"></a>• [`suffix_values`](#rules-spec-path-suffix-values) - Optional List<br>List of path suffix values to match the input HTTP path against
|
|
260
260
|
|
|
261
|
-
<a id="rules-spec-path-transformers"></a>• [`transformers`](#rules-spec-path-transformers) - Optional List Defaults to `TRANSFORMER_NONE`<br>See [Transformers](#common-transformers)<br>
|
|
261
|
+
<a id="rules-spec-path-transformers"></a>• [`transformers`](#rules-spec-path-transformers) - Optional List Defaults to `TRANSFORMER_NONE`<br>See [Transformers](#common-transformers)<br> Ordered list of transformers (starting from index 0) to be applied to the path before matching
|
|
262
262
|
|
|
263
263
|
#### Server Name Matcher
|
|
264
264
|
|
|
265
265
|
A [`server_name_matcher`](#server-name-matcher) block supports the following:
|
|
266
266
|
|
|
267
|
-
<a id="server-name-matcher-exact-values"></a>• [`exact_values`](#server-name-matcher-exact-values) - Optional List<br>
|
|
267
|
+
<a id="server-name-matcher-exact-values"></a>• [`exact_values`](#server-name-matcher-exact-values) - Optional List<br>List of exact values to match the input against
|
|
268
268
|
|
|
269
|
-
<a id="server-name-matcher-regex-values"></a>• [`regex_values`](#server-name-matcher-regex-values) - Optional List<br>
|
|
269
|
+
<a id="server-name-matcher-regex-values"></a>• [`regex_values`](#server-name-matcher-regex-values) - Optional List<br>List of regular expressions to match the input against
|
|
270
270
|
|
|
271
271
|
#### Server Selector
|
|
272
272
|
|
|
273
273
|
A [`server_selector`](#server-selector) block supports the following:
|
|
274
274
|
|
|
275
|
-
<a id="server-selector-expressions"></a>• [`expressions`](#server-selector-expressions) - Optional List<br>
|
|
275
|
+
<a id="server-selector-expressions"></a>• [`expressions`](#server-selector-expressions) - Optional List<br>Expressions contains the Kubernetes style label expression for selections
|
|
276
276
|
|
|
277
277
|
#### Timeouts
|
|
278
278
|
|