Skip to content

Commit 9335c76

Browse files
authored
fix(docs): is_lb docs for failsafe_policy_actions (IBM-Cloud#6393)
1 parent 39eb269 commit 9335c76

File tree

6 files changed

+83
-52
lines changed

6 files changed

+83
-52
lines changed

website/docs/d/is_lb.html.markdown

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,12 @@ In addition to all argument reference list, you can access the following attribu
6868
Nested scheme for `dns`:
6969
- `instance_crn` - (String) The CRN of the DNS instance associated with the DNS zone
7070
- `zone_id` - (String) The unique identifier of the DNS zone.
71-
- `failsafe_policy_actions` - (List) The supported `failsafe_policy.action` values for this load balancer's pools. Allowable list items are: `fail`, `forward`.
71+
- `failsafe_policy_actions` - (List) The supported `failsafe_policy.action` values for this load balancer's pools. Allowable list items are: [ `bypass`, `drop`, `fail`, `forward` ].
72+
A load balancer failsafe policy action:
73+
- `bypass`: Bypasses the members and sends requests directly to their destination IPs.
74+
- `drop`: Drops requests.
75+
- `fail`: Fails requests with an HTTP 503 status code.
76+
- `forward`: Forwards requests to the target pool.
7277
- `hostname` - (String) Fully qualified domain name assigned to this load balancer.
7378
- `id` - (String) The ID of the load balancer.
7479
- `instance_groups_supported` - (Boolean) Indicates whether this load balancer supports instance groups.

website/docs/d/is_lb_pool.html.markdown

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,11 @@ In addition to all argument references listed, you can access the following attr
3636
- `created_at` - (String) The date and time that this pool was created.
3737
- `failsafe_policy` - (List)
3838
Nested schema for **failsafe_policy**:
39-
- `action` - (String) A load balancer failsafe policy action:- `forward`: Forwards requests to the `target` pool.- `fail`: Rejects requests with an HTTP `503` status code.The enumerated values for this property may[expand](https://cloud.ibm.com/apidocs/vpc#property-value-expansion) in the future. Allowable values are: `fail`, `forward`.
39+
- `action` - (String) A load balancer failsafe policy action. The enumerated values for this property may [expand](https://cloud.ibm.com/apidocs/vpc#property-value-expansion) in the future, currently allowed values are:
40+
- `bypass`: Bypasses the members and sends requests directly to their destination IPs.
41+
- `drop`: Drops requests.
42+
- `fail`: Fails requests with an HTTP 503 status code.
43+
- `forward`: Forwards requests to the target pool.
4044
- `healthy_member_threshold_count` - (Integer) The healthy member count at which the failsafe policy action will be triggered. At present, this is always `0`, but may be modifiable in the future.
4145
- `target` - (List) If `action` is `forward`, the target pool to forward to.If `action` is `fail`, this property will be absent.The targets supported by this property may[expand](https://cloud.ibm.com/apidocs/vpc#property-value-expansion) in the future.
4246
Nested schema for **target**:

website/docs/d/is_lb_pools.html.markdown

Lines changed: 52 additions & 47 deletions
Original file line numberDiff line numberDiff line change
@@ -32,51 +32,56 @@ In addition to all argument references listed, you can access the following attr
3232
- `pools` - (List) Collection of pools.
3333

3434
Nested scheme for `pools`:
35-
- `algorithm` - (String) The load balancing algorithm.
36-
- `created_at` - (String) The date and time that this pool was created.
37-
- `failsafe_policy` - (List) A load balancer failsafe policy.
38-
Nested schema for **failsafe_policy**:
39-
- `action` - (String) A load balancer failsafe policy action:- `forward`: Forwards requests to the `target` pool.- `fail`: Rejects requests with an HTTP `503` status code.The enumerated values for this property may[expand](https://cloud.ibm.com/apidocs/vpc#property-value-expansion) in the future. Allowable values are: `fail`, `forward`.
40-
- `healthy_member_threshold_count` - (Integer) The healthy member count at which the failsafe policy action will be triggered. At present, this is always `0`, but may be modifiable in the future.
41-
- `target` - (List) If `action` is `forward`, the target pool to forward to.If `action` is `fail`, this property will be absent.The targets supported by this property may[expand](https://cloud.ibm.com/apidocs/vpc#property-value-expansion) in the future.
42-
Nested schema for **target**:
43-
- `deleted` - (List) If present, this property indicates the referenced resource has been deleted, and providessome supplementary information.
44-
Nested schema for **deleted**:
45-
- `more_info` - (String) Link to documentation about deleted resources.
46-
- `href` - (String) The URL for this load balancer pool.
47-
- `id` - (String) The unique identifier for this load balancer pool.
48-
- `name` - (String) The name for this load balancer pool. The name is unique across all pools for the load balancer.
49-
- `health_monitor` - (List) The health monitor of this pool.
50-
Nested scheme for `health_monitor`:
51-
- `delay` - (Integer) The health check interval in seconds. Interval must be greater than timeout value.
52-
- `max_retries` - (Integer) The health check max retries.
53-
- `port` - (Integer) The health check port number. If specified, this overrides the ports specified in the server member resources.
54-
- `timeout` - (Integer) The health check timeout in seconds.
55-
- `type` - (String) The protocol type of this load balancer pool health monitor.The enumerated values for this property are expected to expand in the future. When processing this property, check for and log unknown values. Optionally halt processing and surface the error, or bypass the health monitor on which the unexpected property value was encountered.
56-
- `url_path` - (String) The health check URL path. Applicable only if the health monitor `type` is `http` or`https`. This value must be in the format of an [origin-form request target](https://tools.ietf.org/html/rfc7230#section-5.3.1).
57-
- `href` - (String) The pool's canonical URL.
58-
- `id` - (String) The unique identifier for this load balancer pool.
59-
- `instance_group` - (List) The instance group that is managing this pool.
60-
Nested scheme for `instance_group`:
61-
- `crn` - (String) The CRN for this instance group.
62-
- `deleted` - (List) If present, this property indicates the referenced resource has been deleted and providessome supplementary information.
63-
Nested scheme for `deleted`:
64-
- `more_info` - (String) Link to documentation about deleted resources.
65-
- `href` - (String) The URL for this instance group.
66-
- `id` - (String) The unique identifier for this instance group.
67-
- `name` - (String) The user-defined name for this instance group.
68-
- `members` - (List) The backend server members of the pool.
69-
Nested scheme for `members`:
70-
- `deleted` - (List) If present, this property indicates the referenced resource has been deleted and providessome supplementary information.
35+
36+
- `algorithm` - (String) The load balancing algorithm.
37+
- `created_at` - (String) The date and time that this pool was created.
38+
- `failsafe_policy` - (List) A load balancer failsafe policy.
39+
Nested schema for **failsafe_policy**:
40+
- `action` - (String) A load balancer failsafe policy action. The enumerated values for this property may [expand](https://cloud.ibm.com/apidocs/vpc#property-value-expansion) in the future, currently allowed values are:
41+
- `bypass`: Bypasses the members and sends requests directly to their destination IPs.
42+
- `drop`: Drops requests.
43+
- `fail`: Fails requests with an HTTP 503 status code.
44+
- `forward`: Forwards requests to the target pool.
45+
- `healthy_member_threshold_count` - (Integer) The healthy member count at which the failsafe policy action will be triggered. At present, this is always `0`, but may be modifiable in the future.
46+
- `target` - (List) If `action` is `forward`, the target pool to forward to.If `action` is `fail`, this property will be absent.The targets supported by this property may[expand](https://cloud.ibm.com/apidocs/vpc#property-value-expansion) in the future.
47+
Nested schema for **target**:
48+
- `deleted` - (List) If present, this property indicates the referenced resource has been deleted, and providessome supplementary information.
49+
Nested schema for **deleted**:
50+
- `more_info` - (String) Link to documentation about deleted resources.
51+
- `href` - (String) The URL for this load balancer pool.
52+
- `id` - (String) The unique identifier for this load balancer pool.
53+
- `name` - (String) The name for this load balancer pool. The name is unique across all pools for the load balancer.
54+
- `health_monitor` - (List) The health monitor of this pool.
55+
Nested scheme for `health_monitor`:
56+
- `delay` - (Integer) The health check interval in seconds. Interval must be greater than timeout value.
57+
- `max_retries` - (Integer) The health check max retries.
58+
- `port` - (Integer) The health check port number. If specified, this overrides the ports specified in the server member resources.
59+
- `timeout` - (Integer) The health check timeout in seconds.
60+
- `type` - (String) The protocol type of this load balancer pool health monitor.The enumerated values for this property are expected to expand in the future. When processing this property, check for and log unknown values. Optionally halt processing and surface the error, or bypass the health monitor on which the unexpected property value was encountered.
61+
- `url_path` - (String) The health check URL path. Applicable only if the health monitor `type` is `http` or`https`. This value must be in the format of an [origin-form request target](https://tools.ietf.org/html/rfc7230#section-5.3.1).
62+
- `href` - (String) The pool's canonical URL.
63+
- `id` - (String) The unique identifier for this load balancer pool.
64+
- `instance_group` - (List) The instance group that is managing this pool.
65+
Nested scheme for `instance_group`:
66+
- `crn` - (String) The CRN for this instance group.
67+
- `deleted` - (List) If present, this property indicates the referenced resource has been deleted and providessome supplementary information.
7168
Nested scheme for `deleted`:
72-
- `more_info` - (String) Link to documentation about deleted resources.
73-
- `href` - (String) The member's canonical URL.
74-
- `id` - (String) The unique identifier for this load balancer pool member.
75-
- `name` - (String) The user-defined name for this load balancer pool.
76-
- `protocol` - (String) The protocol used for this load balancer pool.The enumerated values for this property are expected to expand in the future. When processing this property, check for and log unknown values. Optionally halt processing and surface the error, or bypass the pool on which the unexpected property value was encountered.
77-
- `provisioning_status` - (String) The provisioning status of this pool.
78-
- `proxy_protocol` - (String) The PROXY protocol setting for this pool:- `v1`: Enabled with version 1 (human-readable header format)- `v2`: Enabled with version 2 (binary header format)- `disabled`: DisabledSupported by load balancers in the `application` family (otherwise always `disabled`).
79-
- `session_persistence` - (List) The session persistence of this pool.The enumerated values for this property are expected to expand in the future. Whenprocessing this property, check for and log unknown values. Optionally haltprocessing and surface the error, or bypass the pool on which the unexpectedproperty value was encountered.
80-
Nested scheme for `session_persistence`:
81-
- `cookie_name` - (String) The session persistence cookie name. Applicable only for type `app_cookie`. Names starting with `IBM` are not allowed.
82-
- `type` - (String) The session persistence type. The `http_cookie` and `app_cookie` types are applicable only to the `http` and `https` protocols.
69+
- `more_info` - (String) Link to documentation about deleted resources.
70+
- `href` - (String) The URL for this instance group.
71+
- `id` - (String) The unique identifier for this instance group.
72+
- `name` - (String) The user-defined name for this instance group.
73+
- `members` - (List) The backend server members of the pool.
74+
Nested scheme for `members`:
75+
- `deleted` - (List) If present, this property indicates the referenced resource has been deleted and providessome supplementary information.
76+
Nested scheme for `deleted`:
77+
- `more_info` - (String) Link to documentation about deleted resources.
78+
- `href` - (String) The member's canonical URL.
79+
- `id` - (String) The unique identifier for this load balancer pool member.
80+
- `name` - (String) The user-defined name for this load balancer pool.
81+
- `protocol` - (String) The protocol used for this load balancer pool.The enumerated values for this property are expected to expand in the future. When processing this property, check for and log unknown values. Optionally halt processing and surface the error, or bypass the pool on which the unexpected property value was encountered.
82+
- `provisioning_status` - (String) The provisioning status of this pool.
83+
- `proxy_protocol` - (String) The PROXY protocol setting for this pool:- `v1`: Enabled with version 1 (human-readable header format)- `v2`: Enabled with version 2 (binary header format)- `disabled`: DisabledSupported by load balancers in the `application` family (otherwise always `disabled`).
84+
- `session_persistence` - (List) The session persistence of this pool.The enumerated values for this property are expected to expand in the future. Whenprocessing this property, check for and log unknown values. Optionally haltprocessing and surface the error, or bypass the pool on which the unexpectedproperty value was encountered.
85+
Nested scheme for `session_persistence`:
86+
- `cookie_name` - (String) The session persistence cookie name. Applicable only for type `app_cookie`. Names starting with `IBM` are not allowed.
87+
- `type` - (String) The session persistence type. The `http_cookie` and `app_cookie` types are applicable only to the `http` and `https` protocols.

website/docs/d/is_lbs.html.markdown

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,13 @@ Review the attribute references that you can access after you retrieve your data
5353
Nested scheme for `dns`:
5454
- `instance_crn` - (String) The CRN of the DNS instance associated with the DNS zone
5555
- `zone_id` - (String) The unique identifier of the DNS zone.
56-
- `failsafe_policy_actions` - (List) The supported `failsafe_policy.action` values for this load balancer's pools. Allowable list items are: `fail`, `forward`.
56+
- `failsafe_policy_actions` - (List) The supported `failsafe_policy.action` values for this load balancer's pools. Allowable list items are: [ `bypass`, `drop`, `fail`, `forward` ]. A load balancer failsafe policy action:
57+
58+
- `bypass`: Bypasses the members and sends requests directly to their destination IPs.
59+
- `drop`: Drops requests.
60+
- `fail`: Fails requests with an HTTP 503 status code.
61+
- `forward`: Forwards requests to the target pool.
62+
5763
- `name` - (String) Name of the load balancer.
5864
- `subnets` - (List) The subnets this load balancer is part of.
5965

website/docs/r/is_lb.html.markdown

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -91,7 +91,13 @@ Review the argument references that you can specify for your resource.
9191
Nested scheme for `dns`:
9292
- `instance_crn` - (Required, String) The CRN of the DNS instance associated with the DNS zone
9393
- `zone_id` - (Required, String) The unique identifier of the DNS zone.
94-
- `failsafe_policy_actions` - (List) The supported `failsafe_policy.action` values for this load balancer's pools. Allowable list items are: `fail`, `forward`.
94+
- `failsafe_policy_actions` - (List) The supported `failsafe_policy.action` values for this load balancer's pools. Allowable list items are: [ `bypass`, `drop`, `fail`, `forward` ].
95+
A load balancer failsafe policy action:
96+
- `bypass`: Bypasses the members and sends requests directly to their destination IPs.
97+
- `drop`: Drops requests.
98+
- `fail`: Fails requests with an HTTP 503 status code.
99+
- `forward`: Forwards requests to the target pool.
100+
95101
- `logging`- (Optional, Bool) Enable or disable datapath logging for the load balancer. This is applicable only for application load balancer. Supported values are **true** or **false**. Default value is **false**.
96102
- `name` - (Required, String) The name of the VPC load balancer.
97103
- `profile` - (Optional, Forces new resource, String) For a Network Load Balancer, this attribute is required for network and private path load balancers. Should be set to `network-private-path` for private path load balancers and `network-fixed` for a network load balancer. For Application Load Balancer, profile is not a required attribute.

website/docs/r/is_lb_pool.html.markdown

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -175,7 +175,12 @@ Review the argument references that you can specify for your resource.
175175
- `algorithm` - (Required, String) The load-balancing algorithm. Supported values are `round_robin`, `weighted_round_robin`, or `least_connections`. Choose `least_connections` for workloads with varying response times.
176176
- `failsafe_policy` - (Optional, List) The failsafe policy defines behavior when all pool members are unhealthy. If unspecified, the default failsafe policy from the load balancer profile applies.
177177
Nested schema for **failsafe_policy**:
178-
- `action` - (Optional, String) Failsafe policy action: `forward` (routes requests to target pool) or `fail` (rejects requests with HTTP 503). The enumerated values for this property may [expand](https://cloud.ibm.com/apidocs/vpc#property-value-expansion) in the future.
178+
- `action` - (Optional, String) Failsafe policy action. The enumerated values for this property may [expand](https://cloud.ibm.com/apidocs/vpc#property-value-expansion) in the future, currently:
179+
- `bypass`: Bypasses the members and sends requests directly to their destination IPs.
180+
- `drop`: Drops requests.
181+
- `fail`: Fails requests with an HTTP 503 status code.
182+
- `forward`: Forwards requests to the target pool.
183+
179184
- `target` - (Optional, List) Target pool for `forward` action. Not applicable when action is `fail`. The targets supported by this property may [expand](https://cloud.ibm.com/apidocs/vpc#property-value-expansion) in the future.
180185
Nested schema for **target**:
181186
- `href` - (Optional, String) The URL for the target load balancer pool. Mutually exclusive with `id`. Specify "null" during update to remove an existing failsafe target pool.

0 commit comments

Comments
 (0)