mirror of
https://github.com/ansible-collections/google.cloud.git
synced 2025-04-27 05:11:24 -07:00
Better documentation for how a resourceref works (#96)
<!-- This change is generated by MagicModules. --> /cc @rambleraptor
This commit is contained in:
parent
6aa571c1b8
commit
e87c2e837c
31 changed files with 1669 additions and 1213 deletions
|
@ -81,8 +81,81 @@ options:
|
|||
completely drained, offering 0% of its available Capacity. Valid range is
|
||||
[0.0,1.0].
|
||||
required: false
|
||||
default: '1.0'
|
||||
description:
|
||||
suboptions:
|
||||
balancing_mode:
|
||||
description:
|
||||
- Specifies the balancing mode for this backend.
|
||||
- For global HTTP(S) or TCP/SSL load balancing, the default is UTILIZATION. Valid
|
||||
values are UTILIZATION, RATE (for HTTP(S)) and CONNECTION (for TCP/SSL).
|
||||
- This cannot be used for internal load balancing.
|
||||
required: false
|
||||
choices: ['UTILIZATION', 'RATE', 'CONNECTION']
|
||||
capacity_scaler:
|
||||
description:
|
||||
- A multiplier applied to the group's maximum servicing capacity (based on UTILIZATION,
|
||||
RATE or CONNECTION).
|
||||
- Default value is 1, which means the group will serve up to 100% of its configured
|
||||
capacity (depending on balancingMode). A setting of 0 means the group is completely
|
||||
drained, offering 0% of its available Capacity. Valid range is [0.0,1.0].
|
||||
- This cannot be used for internal load balancing.
|
||||
required: false
|
||||
description:
|
||||
description:
|
||||
- An optional description of this resource.
|
||||
- Provide this property when you create the resource.
|
||||
required: false
|
||||
group:
|
||||
description:
|
||||
- This instance group defines the list of instances that serve traffic. Member virtual
|
||||
machine instances from each instance group must live in the same zone as the instance
|
||||
group itself.
|
||||
- No two backends in a backend service are allowed to use same Instance Group resource.
|
||||
- When the BackendService has load balancing scheme INTERNAL, the instance group must
|
||||
be in a zone within the same region as the BackendService.
|
||||
- 'This field represents a link to a InstanceGroup resource in GCP. It can be specified
|
||||
in two ways. You can add `register: name-of-resource` to a gcp_compute_instance_group
|
||||
task and then set this group field to "{{ name-of-resource }}" Alternatively, you
|
||||
can set this group to a dictionary with the selfLink key where the value is the
|
||||
selfLink of your InstanceGroup.'
|
||||
required: false
|
||||
max_connections:
|
||||
description:
|
||||
- The max number of simultaneous connections for the group. Can be used with either
|
||||
CONNECTION or UTILIZATION balancing modes.
|
||||
- For CONNECTION mode, either maxConnections or maxConnectionsPerInstance must be
|
||||
set.
|
||||
- This cannot be used for internal load balancing.
|
||||
required: false
|
||||
max_connections_per_instance:
|
||||
description:
|
||||
- The max number of simultaneous connections that a single backend instance can handle.
|
||||
This is used to calculate the capacity of the group. Can be used in either CONNECTION
|
||||
or UTILIZATION balancing modes.
|
||||
- For CONNECTION mode, either maxConnections or maxConnectionsPerInstance must be
|
||||
set.
|
||||
- This cannot be used for internal load balancing.
|
||||
required: false
|
||||
max_rate:
|
||||
description:
|
||||
- The max requests per second (RPS) of the group.
|
||||
- Can be used with either RATE or UTILIZATION balancing modes, but required if RATE
|
||||
mode. For RATE mode, either maxRate or maxRatePerInstance must be set.
|
||||
- This cannot be used for internal load balancing.
|
||||
required: false
|
||||
max_rate_per_instance:
|
||||
description:
|
||||
- The max requests per second (RPS) that a single backend instance can handle. This
|
||||
is used to calculate the capacity of the group. Can be used in either balancing
|
||||
mode. For RATE mode, either maxRate or maxRatePerInstance must be set.
|
||||
- This cannot be used for internal load balancing.
|
||||
required: false
|
||||
max_utilization:
|
||||
description:
|
||||
- Used when balancingMode is UTILIZATION. This ratio defines the CPU utilization target
|
||||
for the group. The default is 0.8. Valid range is [0.0, 1.0].
|
||||
- This cannot be used for internal load balancing.
|
||||
required: false
|
||||
cdn_policy:
|
||||
description:
|
||||
- An optional description of this resource.
|
||||
- Provide this property when you create the resource.
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue