Skip to content

load balancer doc fix #426

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
keerthi-gp wants to merge 1 commit into
base: master
Choose a base branch
from
Open

load balancer doc fix #426

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 16 additions & 16 deletions website/docs/d/is_lb_pool_members.html.markdown
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,20 +33,20 @@ In addition to all argument references listed, you can access the following attr
- `id` - The unique identifier of the LoadBalancerPoolMemberCollection.
- `members` - (List) Collection of members.
Nested scheme for `members`:
- `created_at` - (String) The date and time that this member was created.
- `health` - (String) Health of the server member in the pool.
- `href` - (String) The member's canonical URL.
- `id` - (String) The unique identifier for this load balancer pool member.
- `port` - (Integer) The port number of the application running in the server member.
- `provisioning_status` - (String) The provisioning status of this member.
- `target` - (List) The pool member target. Load balancers in the `network` family support virtual serverinstances. Load balancers in the `application` family support IP addresses.
Nested scheme for `target`:
- `address` - (String) The IP address.This property may add support for IPv6 addresses in the future. When processing a value in this property, verify that the address is in an expected format. If it is not, log an error. Optionally halt processing and surface the error, or bypass the resource on which the unexpected IP address format was encountered.
- `crn` - (String) The CRN for this virtual server instance.
- `deleted` - (List) If present, this property indicates the referenced resource has been deleted and providessome supplementary information.
Nested scheme for `deleted`:
- `more_info` - (String) Link to documentation about deleted resources.
- `href` - (String) The URL for this virtual server instance.
- `id` - (String) The unique identifier for this virtual server instance.
- `name` - (String) The user-defined name for this virtual server instance (and default system hostname).
- `created_at` - (String) The date and time that this member was created.
- `health` - (String) Health of the server member in the pool.
- `href` - (String) The member's canonical URL.
- `id` - (String) The unique identifier for this load balancer pool member.
- `port` - (Integer) The port number of the application running in the server member.
- `provisioning_status` - (String) The provisioning status of this member.
- `target` - (List) The pool member target. Load balancers in the `network` family support virtual serverinstances. Load balancers in the `application` family support IP addresses.
Nested scheme for `target`:
- `address` - (String) The IP address.This property may add support for IPv6 addresses in the future. When processing a value in this property, verify that the address is in an expected format. If it is not, log an error. Optionally halt processing and surface the error, or bypass the resource on which the unexpected IP address format was encountered.
- `crn` - (String) The CRN for this virtual server instance.
- `deleted` - (List) If present, this property indicates the referenced resource has been deleted and providessome supplementary information.
Nested scheme for `deleted`:
- `more_info` - (String) Link to documentation about deleted resources.
- `href` - (String) The URL for this virtual server instance.
- `id` - (String) The unique identifier for this virtual server instance.
- `name` - (String) The user-defined name for this virtual server instance (and default system hostname).
- `weight` - (Integer) Weight of the server member. Applicable only if the pool algorithm is`weighted_round_robin`.
96 changes: 48 additions & 48 deletions website/docs/d/is_lb_pools.html.markdown
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,51 +32,51 @@ In addition to all argument references listed, you can access the following attr
- `pools` - (List) Collection of pools.

Nested scheme for `pools`:
- `algorithm` - (String) The load balancing algorithm.
- `created_at` - (String) The date and time that this pool was created.
- `failsafe_policy` - (List) A load balancer failsafe policy.
Nested schema for **failsafe_policy**:
- `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`.
- `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.
- `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.
Nested schema for **target**:
- `deleted` - (List) If present, this property indicates the referenced resource has been deleted, and providessome supplementary information.
Nested schema for **deleted**:
- `more_info` - (String) Link to documentation about deleted resources.
- `href` - (String) The URL for this load balancer pool.
- `id` - (String) The unique identifier for this load balancer pool.
- `name` - (String) The name for this load balancer pool. The name is unique across all pools for the load balancer.
- `health_monitor` - (List) The health monitor of this pool.
Nested scheme for `health_monitor`:
- `delay` - (Integer) The health check interval in seconds. Interval must be greater than timeout value.
- `max_retries` - (Integer) The health check max retries.
- `port` - (Integer) The health check port number. If specified, this overrides the ports specified in the server member resources.
- `timeout` - (Integer) The health check timeout in seconds.
- `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.
- `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).
- `href` - (String) The pool's canonical URL.
- `id` - (String) The unique identifier for this load balancer pool.
- `instance_group` - (List) The instance group that is managing this pool.
Nested scheme for `instance_group`:
- `crn` - (String) The CRN for this instance group.
- `deleted` - (List) If present, this property indicates the referenced resource has been deleted and providessome supplementary information.
Nested scheme for `deleted`:
- `more_info` - (String) Link to documentation about deleted resources.
- `href` - (String) The URL for this instance group.
- `id` - (String) The unique identifier for this instance group.
- `name` - (String) The user-defined name for this instance group.
- `members` - (List) The backend server members of the pool.
Nested scheme for `members`:
- `deleted` - (List) If present, this property indicates the referenced resource has been deleted and providessome supplementary information.
Nested scheme for `deleted`:
- `more_info` - (String) Link to documentation about deleted resources.
- `href` - (String) The member's canonical URL.
- `id` - (String) The unique identifier for this load balancer pool member.
- `name` - (String) The user-defined name for this load balancer pool.
- `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.
- `provisioning_status` - (String) The provisioning status of this pool.
- `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`).
- `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.
Nested scheme for `session_persistence`:
- `cookie_name` - (String) The session persistence cookie name. Applicable only for type `app_cookie`. Names starting with `IBM` are not allowed.
- `type` - (String) The session persistence type. The `http_cookie` and `app_cookie` types are applicable only to the `http` and `https` protocols.
- `algorithm` - (String) The load balancing algorithm.
- `created_at` - (String) The date and time that this pool was created.
- `failsafe_policy` - (List) A load balancer failsafe policy.
Nested schema for **failsafe_policy**:
- `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`.
- `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.
- `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.
Nested schema for **target**:
- `deleted` - (List) If present, this property indicates the referenced resource has been deleted, and providessome supplementary information.
Nested schema for **deleted**:
- `more_info` - (String) Link to documentation about deleted resources.
- `href` - (String) The URL for this load balancer pool.
- `id` - (String) The unique identifier for this load balancer pool.
- `name` - (String) The name for this load balancer pool. The name is unique across all pools for the load balancer.
- `health_monitor` - (List) The health monitor of this pool.
Nested scheme for `health_monitor`:
- `delay` - (Integer) The health check interval in seconds. Interval must be greater than timeout value.
- `max_retries` - (Integer) The health check max retries.
- `port` - (Integer) The health check port number. If specified, this overrides the ports specified in the server member resources.
- `timeout` - (Integer) The health check timeout in seconds.
- `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.
- `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).
- `href` - (String) The pool's canonical URL.
- `id` - (String) The unique identifier for this load balancer pool.
- `instance_group` - (List) The instance group that is managing this pool.
Nested scheme for `instance_group`:
- `crn` - (String) The CRN for this instance group.
- `deleted` - (List) If present, this property indicates the referenced resource has been deleted and providessome supplementary information.
Nested scheme for `deleted`:
- `more_info` - (String) Link to documentation about deleted resources.
- `href` - (String) The URL for this instance group.
- `id` - (String) The unique identifier for this instance group.
- `name` - (String) The user-defined name for this instance group.
- `members` - (List) The backend server members of the pool.
Nested scheme for `members`:
- `deleted` - (List) If present, this property indicates the referenced resource has been deleted and providessome supplementary information.
Nested scheme for `deleted`:
- `more_info` - (String) Link to documentation about deleted resources.
- `href` - (String) The member's canonical URL.
- `id` - (String) The unique identifier for this load balancer pool member.
- `name` - (String) The user-defined name for this load balancer pool.
- `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.
- `provisioning_status` - (String) The provisioning status of this pool.
- `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`).
- `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.
Nested scheme for `session_persistence`:
- `cookie_name` - (String) The session persistence cookie name. Applicable only for type `app_cookie`. Names starting with `IBM` are not allowed.
- `type` - (String) The session persistence type. The `http_cookie` and `app_cookie` types are applicable only to the `http` and `https` protocols.
Loading