Bug fixes for gcp_compute_backend_service_facts (#44291)
This commit is contained in:
Alex Stephen
Ryan Brown
parent
b56639447f
commit
2fe1f3deb4
1 changed files with 224 additions and 219 deletions
|
|
@ -61,228 +61,233 @@ EXAMPLES = '''
|
||||||
'''
|
'''
|
||||||
|
|
||||||
RETURN = '''
|
RETURN = '''
|
||||||
affinity_cookie_ttl_sec:
|
items:
|
||||||
description:
|
description: List of items
|
||||||
- Lifetime of cookies in seconds if session_affinity is GENERATED_COOKIE. If set to
|
returned: always
|
||||||
0, the cookie is non-persistent and lasts only until the end of the browser session
|
type: complex
|
||||||
(or equivalent). The maximum allowed value for TTL is one day.
|
contains:
|
||||||
- When the load balancing scheme is INTERNAL, this field is not used.
|
affinity_cookie_ttl_sec:
|
||||||
returned: success
|
|
||||||
type: int
|
|
||||||
backends:
|
|
||||||
description:
|
|
||||||
- The list of backends that serve this BackendService.
|
|
||||||
returned: success
|
|
||||||
type: complex
|
|
||||||
contains:
|
|
||||||
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.
|
|
||||||
returned: success
|
|
||||||
type: str
|
|
||||||
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.
|
|
||||||
returned: success
|
|
||||||
type: str
|
|
||||||
description:
|
description:
|
||||||
|
- Lifetime of cookies in seconds if session_affinity is GENERATED_COOKIE. If set to
|
||||||
|
0, the cookie is non-persistent and lasts only until the end of the browser session
|
||||||
|
(or equivalent). The maximum allowed value for TTL is one day.
|
||||||
|
- When the load balancing scheme is INTERNAL, this field is not used.
|
||||||
|
returned: success
|
||||||
|
type: int
|
||||||
|
backends:
|
||||||
|
description:
|
||||||
|
- The list of backends that serve this BackendService.
|
||||||
|
returned: success
|
||||||
|
type: complex
|
||||||
|
contains:
|
||||||
|
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.
|
||||||
|
returned: success
|
||||||
|
type: str
|
||||||
|
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.
|
||||||
|
returned: success
|
||||||
|
type: str
|
||||||
description:
|
description:
|
||||||
- An optional description of this resource.
|
description:
|
||||||
- Provide this property when you create the resource.
|
- An optional description of this resource.
|
||||||
returned: success
|
- Provide this property when you create the resource.
|
||||||
type: str
|
returned: success
|
||||||
group:
|
type: str
|
||||||
description:
|
group:
|
||||||
- This instance group defines the list of instances that serve traffic. Member virtual
|
description:
|
||||||
machine instances from each instance group must live in the same zone as the instance
|
- This instance group defines the list of instances that serve traffic. Member virtual
|
||||||
group itself.
|
machine instances from each instance group must live in the same zone as the instance
|
||||||
- No two backends in a backend service are allowed to use same Instance Group resource.
|
group itself.
|
||||||
- When the BackendService has load balancing scheme INTERNAL, the instance group must
|
- No two backends in a backend service are allowed to use same Instance Group resource.
|
||||||
be in a zone within the same region as the BackendService.
|
- When the BackendService has load balancing scheme INTERNAL, the instance group must
|
||||||
returned: success
|
be in a zone within the same region as the BackendService.
|
||||||
type: dict
|
returned: success
|
||||||
max_connections:
|
type: dict
|
||||||
description:
|
max_connections:
|
||||||
- The max number of simultaneous connections for the group. Can be used with either
|
description:
|
||||||
CONNECTION or UTILIZATION balancing modes.
|
- The max number of simultaneous connections for the group. Can be used with either
|
||||||
- For CONNECTION mode, either maxConnections or maxConnectionsPerInstance must be
|
CONNECTION or UTILIZATION balancing modes.
|
||||||
set.
|
- For CONNECTION mode, either maxConnections or maxConnectionsPerInstance must be
|
||||||
- This cannot be used for internal load balancing.
|
set.
|
||||||
returned: success
|
- This cannot be used for internal load balancing.
|
||||||
type: int
|
returned: success
|
||||||
max_connections_per_instance:
|
type: int
|
||||||
description:
|
max_connections_per_instance:
|
||||||
- The max number of simultaneous connections that a single backend instance can handle.
|
description:
|
||||||
This is used to calculate the capacity of the group. Can be used in either CONNECTION
|
- The max number of simultaneous connections that a single backend instance can handle.
|
||||||
or UTILIZATION balancing modes.
|
This is used to calculate the capacity of the group. Can be used in either CONNECTION
|
||||||
- For CONNECTION mode, either maxConnections or maxConnectionsPerInstance must be
|
or UTILIZATION balancing modes.
|
||||||
set.
|
- For CONNECTION mode, either maxConnections or maxConnectionsPerInstance must be
|
||||||
- This cannot be used for internal load balancing.
|
set.
|
||||||
returned: success
|
- This cannot be used for internal load balancing.
|
||||||
type: int
|
returned: success
|
||||||
max_rate:
|
type: int
|
||||||
description:
|
max_rate:
|
||||||
- The max requests per second (RPS) of the group.
|
description:
|
||||||
- Can be used with either RATE or UTILIZATION balancing modes, but required if RATE
|
- The max requests per second (RPS) of the group.
|
||||||
mode. For RATE mode, either maxRate or maxRatePerInstance must be set.
|
- Can be used with either RATE or UTILIZATION balancing modes, but required if RATE
|
||||||
- This cannot be used for internal load balancing.
|
mode. For RATE mode, either maxRate or maxRatePerInstance must be set.
|
||||||
returned: success
|
- This cannot be used for internal load balancing.
|
||||||
type: int
|
returned: success
|
||||||
max_rate_per_instance:
|
type: int
|
||||||
description:
|
max_rate_per_instance:
|
||||||
- The max requests per second (RPS) that a single backend instance can handle. This
|
description:
|
||||||
is used to calculate the capacity of the group. Can be used in either balancing
|
- The max requests per second (RPS) that a single backend instance can handle. This
|
||||||
mode. For RATE mode, either maxRate or maxRatePerInstance must be set.
|
is used to calculate the capacity of the group. Can be used in either balancing
|
||||||
- This cannot be used for internal load balancing.
|
mode. For RATE mode, either maxRate or maxRatePerInstance must be set.
|
||||||
returned: success
|
- This cannot be used for internal load balancing.
|
||||||
type: str
|
returned: success
|
||||||
max_utilization:
|
type: str
|
||||||
description:
|
max_utilization:
|
||||||
- Used when balancingMode is UTILIZATION. This ratio defines the CPU utilization target
|
description:
|
||||||
for the group. The default is 0.8. Valid range is [0.0, 1.0].
|
- Used when balancingMode is UTILIZATION. This ratio defines the CPU utilization target
|
||||||
- This cannot be used for internal load balancing.
|
for the group. The default is 0.8. Valid range is [0.0, 1.0].
|
||||||
returned: success
|
- This cannot be used for internal load balancing.
|
||||||
type: str
|
returned: success
|
||||||
cdn_policy:
|
type: str
|
||||||
|
cdn_policy:
|
||||||
|
description:
|
||||||
|
- Cloud CDN configuration for this BackendService.
|
||||||
|
returned: success
|
||||||
|
type: complex
|
||||||
|
contains:
|
||||||
|
cache_key_policy:
|
||||||
|
description:
|
||||||
|
- The CacheKeyPolicy for this CdnPolicy.
|
||||||
|
returned: success
|
||||||
|
type: complex
|
||||||
|
contains:
|
||||||
|
include_host:
|
||||||
|
description:
|
||||||
|
- If true requests to different hosts will be cached separately.
|
||||||
|
returned: success
|
||||||
|
type: bool
|
||||||
|
include_protocol:
|
||||||
|
description:
|
||||||
|
- If true, http and https requests will be cached separately.
|
||||||
|
returned: success
|
||||||
|
type: bool
|
||||||
|
include_query_string:
|
||||||
|
description:
|
||||||
|
- If true, include query string parameters in the cache key according to query_string_whitelist
|
||||||
|
and query_string_blacklist. If neither is set, the entire query string will be included.
|
||||||
|
- If false, the query string will be excluded from the cache key entirely.
|
||||||
|
returned: success
|
||||||
|
type: bool
|
||||||
|
query_string_blacklist:
|
||||||
|
description:
|
||||||
|
- Names of query string parameters to exclude in cache keys.
|
||||||
|
- All other parameters will be included. Either specify query_string_whitelist or
|
||||||
|
query_string_blacklist, not both.
|
||||||
|
- "'&' and '=' will be percent encoded and not treated as delimiters."
|
||||||
|
returned: success
|
||||||
|
type: list
|
||||||
|
query_string_whitelist:
|
||||||
|
description:
|
||||||
|
- Names of query string parameters to include in cache keys.
|
||||||
|
- All other parameters will be excluded. Either specify query_string_whitelist or
|
||||||
|
query_string_blacklist, not both.
|
||||||
|
- "'&' and '=' will be percent encoded and not treated as delimiters."
|
||||||
|
returned: success
|
||||||
|
type: list
|
||||||
|
connection_draining:
|
||||||
|
description:
|
||||||
|
- Settings for connection draining.
|
||||||
|
returned: success
|
||||||
|
type: complex
|
||||||
|
contains:
|
||||||
|
draining_timeout_sec:
|
||||||
|
description:
|
||||||
|
- Time for which instance will be drained (not accept new connections, but still work
|
||||||
|
to finish started).
|
||||||
|
returned: success
|
||||||
|
type: int
|
||||||
|
creation_timestamp:
|
||||||
|
description:
|
||||||
|
- Creation timestamp in RFC3339 text format.
|
||||||
|
returned: success
|
||||||
|
type: str
|
||||||
description:
|
description:
|
||||||
- Cloud CDN configuration for this BackendService.
|
description:
|
||||||
returned: success
|
- An optional description of this resource.
|
||||||
type: complex
|
returned: success
|
||||||
contains:
|
type: str
|
||||||
cache_key_policy:
|
enable_cdn:
|
||||||
description:
|
description:
|
||||||
- The CacheKeyPolicy for this CdnPolicy.
|
- If true, enable Cloud CDN for this BackendService.
|
||||||
returned: success
|
- When the load balancing scheme is INTERNAL, this field is not used.
|
||||||
type: complex
|
returned: success
|
||||||
contains:
|
type: bool
|
||||||
include_host:
|
health_checks:
|
||||||
description:
|
description:
|
||||||
- If true requests to different hosts will be cached separately.
|
- The list of URLs to the HttpHealthCheck or HttpsHealthCheck resource for health
|
||||||
returned: success
|
checking this BackendService. Currently at most one health check can be specified,
|
||||||
type: bool
|
and a health check is required.
|
||||||
include_protocol:
|
- For internal load balancing, a URL to a HealthCheck resource must be specified instead.
|
||||||
description:
|
returned: success
|
||||||
- If true, http and https requests will be cached separately.
|
type: list
|
||||||
returned: success
|
id:
|
||||||
type: bool
|
description:
|
||||||
include_query_string:
|
- The unique identifier for the resource.
|
||||||
description:
|
returned: success
|
||||||
- If true, include query string parameters in the cache key according to query_string_whitelist
|
type: int
|
||||||
and query_string_blacklist. If neither is set, the entire query string will be included.
|
name:
|
||||||
- If false, the query string will be excluded from the cache key entirely.
|
description:
|
||||||
returned: success
|
- Name of the resource. Provided by the client when the resource is created. The name
|
||||||
type: bool
|
must be 1-63 characters long, and comply with RFC1035. Specifically, the name must
|
||||||
query_string_blacklist:
|
be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?`
|
||||||
description:
|
which means the first character must be a lowercase letter, and all following characters
|
||||||
- Names of query string parameters to exclude in cache keys.
|
must be a dash, lowercase letter, or digit, except the last character, which cannot
|
||||||
- All other parameters will be included. Either specify query_string_whitelist or
|
be a dash.
|
||||||
query_string_blacklist, not both.
|
returned: success
|
||||||
- "'&' and '=' will be percent encoded and not treated as delimiters."
|
type: str
|
||||||
returned: success
|
port_name:
|
||||||
type: list
|
description:
|
||||||
query_string_whitelist:
|
- Name of backend port. The same name should appear in the instance groups referenced
|
||||||
description:
|
by this service. Required when the load balancing scheme is EXTERNAL.
|
||||||
- Names of query string parameters to include in cache keys.
|
- When the load balancing scheme is INTERNAL, this field is not used.
|
||||||
- All other parameters will be excluded. Either specify query_string_whitelist or
|
returned: success
|
||||||
query_string_blacklist, not both.
|
type: str
|
||||||
- "'&' and '=' will be percent encoded and not treated as delimiters."
|
protocol:
|
||||||
returned: success
|
description:
|
||||||
type: list
|
- The protocol this BackendService uses to communicate with backends.
|
||||||
connection_draining:
|
- Possible values are HTTP, HTTPS, TCP, and SSL. The default is HTTP.
|
||||||
description:
|
- For internal load balancing, the possible values are TCP and UDP, and the default
|
||||||
- Settings for connection draining.
|
is TCP.
|
||||||
returned: success
|
returned: success
|
||||||
type: complex
|
type: str
|
||||||
contains:
|
region:
|
||||||
draining_timeout_sec:
|
description:
|
||||||
description:
|
- The region where the regional backend service resides.
|
||||||
- Time for which instance will be drained (not accept new connections, but still work
|
- This field is not applicable to global backend services.
|
||||||
to finish started).
|
returned: success
|
||||||
returned: success
|
type: str
|
||||||
type: int
|
session_affinity:
|
||||||
creation_timestamp:
|
description:
|
||||||
description:
|
- Type of session affinity to use. The default is NONE.
|
||||||
- Creation timestamp in RFC3339 text format.
|
- When the load balancing scheme is EXTERNAL, can be NONE, CLIENT_IP, or GENERATED_COOKIE.
|
||||||
returned: success
|
- When the load balancing scheme is INTERNAL, can be NONE, CLIENT_IP, CLIENT_IP_PROTO,
|
||||||
type: str
|
or CLIENT_IP_PORT_PROTO.
|
||||||
description:
|
- When the protocol is UDP, this field is not used.
|
||||||
description:
|
returned: success
|
||||||
- An optional description of this resource.
|
type: str
|
||||||
returned: success
|
timeout_sec:
|
||||||
type: str
|
description:
|
||||||
enable_cdn:
|
- How many seconds to wait for the backend before considering it a failed request.
|
||||||
description:
|
Default is 30 seconds. Valid range is [1, 86400].
|
||||||
- If true, enable Cloud CDN for this BackendService.
|
returned: success
|
||||||
- When the load balancing scheme is INTERNAL, this field is not used.
|
type: int
|
||||||
returned: success
|
|
||||||
type: bool
|
|
||||||
health_checks:
|
|
||||||
description:
|
|
||||||
- The list of URLs to the HttpHealthCheck or HttpsHealthCheck resource for health
|
|
||||||
checking this BackendService. Currently at most one health check can be specified,
|
|
||||||
and a health check is required.
|
|
||||||
- For internal load balancing, a URL to a HealthCheck resource must be specified instead.
|
|
||||||
returned: success
|
|
||||||
type: list
|
|
||||||
id:
|
|
||||||
description:
|
|
||||||
- The unique identifier for the resource.
|
|
||||||
returned: success
|
|
||||||
type: int
|
|
||||||
name:
|
|
||||||
description:
|
|
||||||
- Name of the resource. Provided by the client when the resource is created. The name
|
|
||||||
must be 1-63 characters long, and comply with RFC1035. Specifically, the name must
|
|
||||||
be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?`
|
|
||||||
which means the first character must be a lowercase letter, and all following characters
|
|
||||||
must be a dash, lowercase letter, or digit, except the last character, which cannot
|
|
||||||
be a dash.
|
|
||||||
returned: success
|
|
||||||
type: str
|
|
||||||
port_name:
|
|
||||||
description:
|
|
||||||
- Name of backend port. The same name should appear in the instance groups referenced
|
|
||||||
by this service. Required when the load balancing scheme is EXTERNAL.
|
|
||||||
- When the load balancing scheme is INTERNAL, this field is not used.
|
|
||||||
returned: success
|
|
||||||
type: str
|
|
||||||
protocol:
|
|
||||||
description:
|
|
||||||
- The protocol this BackendService uses to communicate with backends.
|
|
||||||
- Possible values are HTTP, HTTPS, TCP, and SSL. The default is HTTP.
|
|
||||||
- For internal load balancing, the possible values are TCP and UDP, and the default
|
|
||||||
is TCP.
|
|
||||||
returned: success
|
|
||||||
type: str
|
|
||||||
region:
|
|
||||||
description:
|
|
||||||
- The region where the regional backend service resides.
|
|
||||||
- This field is not applicable to global backend services.
|
|
||||||
returned: success
|
|
||||||
type: str
|
|
||||||
session_affinity:
|
|
||||||
description:
|
|
||||||
- Type of session affinity to use. The default is NONE.
|
|
||||||
- When the load balancing scheme is EXTERNAL, can be NONE, CLIENT_IP, or GENERATED_COOKIE.
|
|
||||||
- When the load balancing scheme is INTERNAL, can be NONE, CLIENT_IP, CLIENT_IP_PROTO,
|
|
||||||
or CLIENT_IP_PORT_PROTO.
|
|
||||||
- When the protocol is UDP, this field is not used.
|
|
||||||
returned: success
|
|
||||||
type: str
|
|
||||||
timeout_sec:
|
|
||||||
description:
|
|
||||||
- How many seconds to wait for the backend before considering it a failed request.
|
|
||||||
Default is 30 seconds. Valid range is [1, 86400].
|
|
||||||
returned: success
|
|
||||||
type: int
|
|
||||||
'''
|
'''
|
||||||
|
|
||||||
################################################################################
|
################################################################################
|
||||||
|
|
|
||||||
Loading…
Reference in a new issue