ansible-collections/google.cloud
1
0
Fork 0
mirror of https://github.com/ansible-collections/google.cloud.git synced 2025-07-25 22:30:29 -07:00
Code Issues Projects Releases Packages Wiki Activity Actions 1

Promote region* compute services to GA (#3381) (#213)

Browse source 
Signed-off-by: Modular Magician <magic-modules@google.com>
This commit is contained in:
The Magician 2020-04-29 16:31:51 -04:00 • committed by GitHub
commit 416bf30c1e
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
8 changed files with 2344 additions and 4 deletions
Download patch file Download diff file Expand all files Collapse all files

804
plugins/modules/gcp_compute_backend_service.py
View file

@ -167,6 +167,117 @@ options:
required: false required: false
default: '0.8' default: '0.8'
type: str type: str
circuit_breakers:
description:
- Settings controlling the volume of connections to a backend service. This field
is applicable only when the load_balancing_scheme is set to INTERNAL_SELF_MANAGED.
required: false
type: dict
version_added: '2.10'
suboptions:
max_requests_per_connection:
description:
- Maximum requests for a single backend connection. This parameter is respected
by both the HTTP/1.1 and HTTP/2 implementations. If not specified, there
is no limit. Setting this parameter to 1 will effectively disable keep alive.
required: false
type: int
max_connections:
description:
- The maximum number of connections to the backend cluster.
- Defaults to 1024.
required: false
default: '1024'
type: int
max_pending_requests:
description:
- The maximum number of pending requests to the backend cluster.
- Defaults to 1024.
required: false
default: '1024'
type: int
max_requests:
description:
- The maximum number of parallel requests to the backend cluster.
- Defaults to 1024.
required: false
default: '1024'
type: int
max_retries:
description:
- The maximum number of parallel retries to the backend cluster.
- Defaults to 3.
required: false
default: '3'
type: int
consistent_hash:
description:
- Consistent Hash-based load balancing can be used to provide soft session affinity
based on HTTP headers, cookies or other properties. This load balancing policy
is applicable only for HTTP connections. The affinity to a particular destination
host will be lost when one or more hosts are added/removed from the destination
service. This field specifies parameters that control consistent hashing. This
field only applies if the load_balancing_scheme is set to INTERNAL_SELF_MANAGED.
This field is only applicable when locality_lb_policy is set to MAGLEV or RING_HASH.
required: false
type: dict
version_added: '2.10'
suboptions:
http_cookie:
description:
- Hash is based on HTTP Cookie. This field describes a HTTP cookie that will
be used as the hash key for the consistent hash load balancer. If the cookie
is not present, it will be generated.
- This field is applicable if the sessionAffinity is set to HTTP_COOKIE.
required: false
type: dict
suboptions:
ttl:
description:
- Lifetime of the cookie.
required: false
type: dict
suboptions:
seconds:
description:
- Span of time at a resolution of a second.
- Must be from 0 to 315,576,000,000 inclusive.
required: true
type: int
nanos:
description:
- Span of time that's a fraction of a second at nanosecond resolution.
Durations less than one second are represented with a 0 seconds
field and a positive nanos field. Must be from 0 to 999,999,999
inclusive.
required: false
type: int
name:
description:
- Name of the cookie.
required: false
type: str
path:
description:
- Path to set for the cookie.
required: false
type: str
http_header_name:
description:
- The hash based on the value of the specified header field.
- This field is applicable if the sessionAffinity is set to HEADER_FIELD.
required: false
type: str
minimum_ring_size:
description:
- The minimum number of virtual nodes to use for the hash ring.
- Larger ring sizes result in more granular load distributions. If the number
of hosts in the load balancing pool is larger than the ring size, each host
will be assigned a single virtual node.
- Defaults to 1024.
required: false
default: '1024'
type: int
cdn_policy: cdn_policy:
description: description:
- Cloud CDN configuration for this BackendService. - Cloud CDN configuration for this BackendService.
@ -241,6 +352,13 @@ options:
required: false required: false
default: '300' default: '300'
type: int type: int
custom_request_headers:
description:
- Headers that the HTTP/S load balancer should add to proxied requests.
elements: str
required: false
type: list
version_added: '2.10'
description: description:
description: description:
- An optional description of this resource. - An optional description of this resource.
@ -293,6 +411,30 @@ options:
default: EXTERNAL default: EXTERNAL
type: str type: str
version_added: '2.7' version_added: '2.7'
locality_lb_policy:
description:
- The load balancing algorithm used within the scope of the locality.
- The possible values are - ROUND_ROBIN - This is a simple policy in which each
healthy backend is selected in round robin order.
- LEAST_REQUEST - An O(1) algorithm which selects two random healthy hosts and
picks the host which has fewer active requests.
- RING_HASH - The ring/modulo hash load balancer implements consistent hashing
to backends. The algorithm has the property that the addition/removal of a host
from a set of N hosts only affects 1/N of the requests.
- RANDOM - The load balancer selects a random healthy host.
- ORIGINAL_DESTINATION - Backend host is selected based on the client connection
metadata, i.e., connections are opened to the same address as the destination
address of the incoming connection before the connection was redirected to the
load balancer.
- MAGLEV - used as a drop in replacement for the ring hash load balancer.
- Maglev is not as stable as ring hash but has faster table lookup build times
and host selection times. For more information about Maglev, refer to https://ai.google/research/pubs/pub44824
This field is applicable only when the load_balancing_scheme is set to INTERNAL_SELF_MANAGED.
- 'Some valid choices include: "ROUND_ROBIN", "LEAST_REQUEST", "RING_HASH", "RANDOM",
"ORIGINAL_DESTINATION", "MAGLEV"'
required: false
type: str
version_added: '2.10'
name: name:
description: description:
- Name of the resource. Provided by the client when the resource is created. The - Name of the resource. Provided by the client when the resource is created. The
@ -303,6 +445,132 @@ options:
which cannot be a dash. which cannot be a dash.
required: true required: true
type: str type: str
outlier_detection:
description:
- Settings controlling eviction of unhealthy hosts from the load balancing pool.
- This field is applicable only when the load_balancing_scheme is set to INTERNAL_SELF_MANAGED.
required: false
type: dict
version_added: '2.10'
suboptions:
base_ejection_time:
description:
- The base time that a host is ejected for. The real time is equal to the
base time multiplied by the number of times the host has been ejected. Defaults
to 30000ms or 30s.
required: false
type: dict
suboptions:
seconds:
description:
- Span of time at a resolution of a second. Must be from 0 to 315,576,000,000
inclusive.
required: true
type: int
nanos:
description:
- Span of time that's a fraction of a second at nanosecond resolution.
Durations less than one second are represented with a 0 `seconds` field
and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.
required: false
type: int
consecutive_errors:
description:
- Number of errors before a host is ejected from the connection pool. When
the backend host is accessed over HTTP, a 5xx return code qualifies as an
error.
- Defaults to 5.
required: false
default: '5'
type: int
consecutive_gateway_failure:
description:
- The number of consecutive gateway failures (502, 503, 504 status or connection
errors that are mapped to one of those status codes) before a consecutive
gateway failure ejection occurs. Defaults to 5.
required: false
default: '5'
type: int
enforcing_consecutive_errors:
description:
- The percentage chance that a host will be actually ejected when an outlier
status is detected through consecutive 5xx. This setting can be used to
disable ejection or to ramp it up slowly. Defaults to 100.
required: false
default: '100'
type: int
enforcing_consecutive_gateway_failure:
description:
- The percentage chance that a host will be actually ejected when an outlier
status is detected through consecutive gateway failures. This setting can
be used to disable ejection or to ramp it up slowly. Defaults to 0.
required: false
type: int
enforcing_success_rate:
description:
- The percentage chance that a host will be actually ejected when an outlier
status is detected through success rate statistics. This setting can be
used to disable ejection or to ramp it up slowly. Defaults to 100.
required: false
default: '100'
type: int
interval:
description:
- Time interval between ejection sweep analysis. This can result in both new
ejections as well as hosts being returned to service. Defaults to 10 seconds.
required: false
type: dict
suboptions:
seconds:
description:
- Span of time at a resolution of a second. Must be from 0 to 315,576,000,000
inclusive.
required: true
type: int
nanos:
description:
- Span of time that's a fraction of a second at nanosecond resolution.
Durations less than one second are represented with a 0 `seconds` field
and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.
required: false
type: int
max_ejection_percent:
description:
- Maximum percentage of hosts in the load balancing pool for the backend service
that can be ejected. Defaults to 10%.
required: false
default: '10'
type: int
success_rate_minimum_hosts:
description:
- The number of hosts in a cluster that must have enough request volume to
detect success rate outliers. If the number of hosts is less than this setting,
outlier detection via success rate statistics is not performed for any host
in the cluster. Defaults to 5.
required: false
default: '5'
type: int
success_rate_request_volume:
description:
- The minimum number of total requests that must be collected in one interval
(as defined by the interval duration above) to include this host in success
rate based outlier detection. If the volume is lower than this setting,
outlier detection via success rate statistics is not performed for that
host. Defaults to 100.
required: false
default: '100'
type: int
success_rate_stdev_factor:
description:
- 'This factor is used to determine the ejection threshold for success rate
outlier ejection. The ejection threshold is the difference between the mean
success rate, and the product of this factor and the standard deviation
of the mean success rate: mean - (stdev * success_rate_stdev_factor). This
factor is divided by a thousand to get a double. That is, if the desired
factor is 1.9, the runtime value should be 1900. Defaults to 1900.'
required: false
default: '1900'
type: int
port_name: port_name:
description: description:
- Name of backend port. The same name should appear in the instance groups referenced - Name of backend port. The same name should appear in the instance groups referenced
@ -339,6 +607,30 @@ options:
type: int type: int
aliases: aliases:
- timeout_seconds - timeout_seconds
log_config:
description:
- This field denotes the logging options for the load balancer traffic served
by this backend service.
- If logging is enabled, logs will be exported to Stackdriver.
required: false
type: dict
version_added: '2.10'
suboptions:
enable:
description:
- Whether to enable logging for the load balancer traffic served by this backend
service.
required: false
type: bool
sample_rate:
description:
- This field can only be specified if logging is enabled for this backend
service. The value of the field must be in [0, 1]. This configures the sampling
rate of requests to the load balancer where 1.0 means all logged requests
are reported and 0.0 means no logged requests are reported.
- The default value is 1.0.
required: false
type: str
project: project:
description: description:
- The Google Cloud Platform project to use. - The Google Cloud Platform project to use.
@ -537,6 +829,109 @@ backends:
target for the group. The default is 0.8. Valid range is [0.0, 1.0]. target for the group. The default is 0.8. Valid range is [0.0, 1.0].
returned: success returned: success
type: str type: str
circuitBreakers:
description:
- Settings controlling the volume of connections to a backend service. This field
is applicable only when the load_balancing_scheme is set to INTERNAL_SELF_MANAGED.
returned: success
type: complex
contains:
maxRequestsPerConnection:
description:
- Maximum requests for a single backend connection. This parameter is respected
by both the HTTP/1.1 and HTTP/2 implementations. If not specified, there is
no limit. Setting this parameter to 1 will effectively disable keep alive.
returned: success
type: int
maxConnections:
description:
- The maximum number of connections to the backend cluster.
- Defaults to 1024.
returned: success
type: int
maxPendingRequests:
description:
- The maximum number of pending requests to the backend cluster.
- Defaults to 1024.
returned: success
type: int
maxRequests:
description:
- The maximum number of parallel requests to the backend cluster.
- Defaults to 1024.
returned: success
type: int
maxRetries:
description:
- The maximum number of parallel retries to the backend cluster.
- Defaults to 3.
returned: success
type: int
consistentHash:
description:
- Consistent Hash-based load balancing can be used to provide soft session affinity
based on HTTP headers, cookies or other properties. This load balancing policy
is applicable only for HTTP connections. The affinity to a particular destination
host will be lost when one or more hosts are added/removed from the destination
service. This field specifies parameters that control consistent hashing. This
field only applies if the load_balancing_scheme is set to INTERNAL_SELF_MANAGED.
This field is only applicable when locality_lb_policy is set to MAGLEV or RING_HASH.
returned: success
type: complex
contains:
httpCookie:
description:
- Hash is based on HTTP Cookie. This field describes a HTTP cookie that will
be used as the hash key for the consistent hash load balancer. If the cookie
is not present, it will be generated.
- This field is applicable if the sessionAffinity is set to HTTP_COOKIE.
returned: success
type: complex
contains:
ttl:
description:
- Lifetime of the cookie.
returned: success
type: complex
contains:
seconds:
description:
- Span of time at a resolution of a second.
- Must be from 0 to 315,576,000,000 inclusive.
returned: success
type: int
nanos:
description:
- Span of time that's a fraction of a second at nanosecond resolution.
Durations less than one second are represented with a 0 seconds field
and a positive nanos field. Must be from 0 to 999,999,999 inclusive.
returned: success
type: int
name:
description:
- Name of the cookie.
returned: success
type: str
path:
description:
- Path to set for the cookie.
returned: success
type: str
httpHeaderName:
description:
- The hash based on the value of the specified header field.
- This field is applicable if the sessionAffinity is set to HEADER_FIELD.
returned: success
type: str
minimumRingSize:
description:
- The minimum number of virtual nodes to use for the hash ring.
- Larger ring sizes result in more granular load distributions. If the number
of hosts in the load balancing pool is larger than the ring size, each host
will be assigned a single virtual node.
- Defaults to 1024.
returned: success
type: int
cdnPolicy: cdnPolicy:
description: description:
- Cloud CDN configuration for this BackendService. - Cloud CDN configuration for this BackendService.
@ -611,6 +1006,11 @@ creationTimestamp:
- Creation timestamp in RFC3339 text format. - Creation timestamp in RFC3339 text format.
returned: success returned: success
type: str type: str
customRequestHeaders:
description:
- Headers that the HTTP/S load balancer should add to proxied requests.
returned: success
type: list
fingerprint: fingerprint:
description: description:
- Fingerprint of this resource. A hash of the contents stored in this object. This - Fingerprint of this resource. A hash of the contents stored in this object. This
@ -674,6 +1074,27 @@ loadBalancingScheme:
used with the other. used with the other.
returned: success returned: success
type: str type: str
localityLbPolicy:
description:
- The load balancing algorithm used within the scope of the locality.
- The possible values are - ROUND_ROBIN - This is a simple policy in which each
healthy backend is selected in round robin order.
- LEAST_REQUEST - An O(1) algorithm which selects two random healthy hosts and picks
the host which has fewer active requests.
- RING_HASH - The ring/modulo hash load balancer implements consistent hashing to
backends. The algorithm has the property that the addition/removal of a host from
a set of N hosts only affects 1/N of the requests.
- RANDOM - The load balancer selects a random healthy host.
- ORIGINAL_DESTINATION - Backend host is selected based on the client connection
metadata, i.e., connections are opened to the same address as the destination
address of the incoming connection before the connection was redirected to the
load balancer.
- MAGLEV - used as a drop in replacement for the ring hash load balancer.
- Maglev is not as stable as ring hash but has faster table lookup build times and
host selection times. For more information about Maglev, refer to https://ai.google/research/pubs/pub44824
This field is applicable only when the load_balancing_scheme is set to INTERNAL_SELF_MANAGED.
returned: success
type: str
name: name:
description: description:
- Name of the resource. Provided by the client when the resource is created. The - Name of the resource. Provided by the client when the resource is created. The
@ -684,6 +1105,122 @@ name:
which cannot be a dash. which cannot be a dash.
returned: success returned: success
type: str type: str
outlierDetection:
description:
- Settings controlling eviction of unhealthy hosts from the load balancing pool.
- This field is applicable only when the load_balancing_scheme is set to INTERNAL_SELF_MANAGED.
returned: success
type: complex
contains:
baseEjectionTime:
description:
- The base time that a host is ejected for. The real time is equal to the base
time multiplied by the number of times the host has been ejected. Defaults
to 30000ms or 30s.
returned: success
type: complex
contains:
seconds:
description:
- Span of time at a resolution of a second. Must be from 0 to 315,576,000,000
inclusive.
returned: success
type: int
nanos:
description:
- Span of time that's a fraction of a second at nanosecond resolution. Durations
less than one second are represented with a 0 `seconds` field and a positive
`nanos` field. Must be from 0 to 999,999,999 inclusive.
returned: success
type: int
consecutiveErrors:
description:
- Number of errors before a host is ejected from the connection pool. When the
backend host is accessed over HTTP, a 5xx return code qualifies as an error.
- Defaults to 5.
returned: success
type: int
consecutiveGatewayFailure:
description:
- The number of consecutive gateway failures (502, 503, 504 status or connection
errors that are mapped to one of those status codes) before a consecutive
gateway failure ejection occurs. Defaults to 5.
returned: success
type: int
enforcingConsecutiveErrors:
description:
- The percentage chance that a host will be actually ejected when an outlier
status is detected through consecutive 5xx. This setting can be used to disable
ejection or to ramp it up slowly. Defaults to 100.
returned: success
type: int
enforcingConsecutiveGatewayFailure:
description:
- The percentage chance that a host will be actually ejected when an outlier
status is detected through consecutive gateway failures. This setting can
be used to disable ejection or to ramp it up slowly. Defaults to 0.
returned: success
type: int
enforcingSuccessRate:
description:
- The percentage chance that a host will be actually ejected when an outlier
status is detected through success rate statistics. This setting can be used
to disable ejection or to ramp it up slowly. Defaults to 100.
returned: success
type: int
interval:
description:
- Time interval between ejection sweep analysis. This can result in both new
ejections as well as hosts being returned to service. Defaults to 10 seconds.
returned: success
type: complex
contains:
seconds:
description:
- Span of time at a resolution of a second. Must be from 0 to 315,576,000,000
inclusive.
returned: success
type: int
nanos:
description:
- Span of time that's a fraction of a second at nanosecond resolution. Durations
less than one second are represented with a 0 `seconds` field and a positive
`nanos` field. Must be from 0 to 999,999,999 inclusive.
returned: success
type: int
maxEjectionPercent:
description:
- Maximum percentage of hosts in the load balancing pool for the backend service
that can be ejected. Defaults to 10%.
returned: success
type: int
successRateMinimumHosts:
description:
- The number of hosts in a cluster that must have enough request volume to detect
success rate outliers. If the number of hosts is less than this setting, outlier
detection via success rate statistics is not performed for any host in the
cluster. Defaults to 5.
returned: success
type: int
successRateRequestVolume:
description:
- The minimum number of total requests that must be collected in one interval
(as defined by the interval duration above) to include this host in success
rate based outlier detection. If the volume is lower than this setting, outlier
detection via success rate statistics is not performed for that host. Defaults
to 100.
returned: success
type: int
successRateStdevFactor:
description:
- 'This factor is used to determine the ejection threshold for success rate
outlier ejection. The ejection threshold is the difference between the mean
success rate, and the product of this factor and the standard deviation of
the mean success rate: mean - (stdev * success_rate_stdev_factor). This factor
is divided by a thousand to get a double. That is, if the desired factor is
1.9, the runtime value should be 1900. Defaults to 1900.'
returned: success
type: int
portName: portName:
description: description:
- Name of backend port. The same name should appear in the instance groups referenced - Name of backend port. The same name should appear in the instance groups referenced
@ -714,6 +1251,29 @@ timeoutSec:
Default is 30 seconds. Valid range is [1, 86400]. Default is 30 seconds. Valid range is [1, 86400].
returned: success returned: success
type: int type: int
logConfig:
description:
- This field denotes the logging options for the load balancer traffic served by
this backend service.
- If logging is enabled, logs will be exported to Stackdriver.
returned: success
type: complex
contains:
enable:
description:
- Whether to enable logging for the load balancer traffic served by this backend
service.
returned: success
type: bool
sampleRate:
description:
- This field can only be specified if logging is enabled for this backend service.
The value of the field must be in [0, 1]. This configures the sampling rate
of requests to the load balancer where 1.0 means all logged requests are reported
and 0.0 means no logged requests are reported.
- The default value is 1.0.
returned: success
type: str
''' '''
################################################################################ ################################################################################
@ -760,6 +1320,31 @@ def main():
max_utilization=dict(default=0.8, type='str'), max_utilization=dict(default=0.8, type='str'),
), ),
), ),
circuit_breakers=dict(
type='dict',
options=dict(
max_requests_per_connection=dict(type='int'),
max_connections=dict(default=1024, type='int'),
max_pending_requests=dict(default=1024, type='int'),
max_requests=dict(default=1024, type='int'),
max_retries=dict(default=3, type='int'),
),
),
consistent_hash=dict(
type='dict',
options=dict(
http_cookie=dict(
type='dict',
options=dict(
ttl=dict(type='dict', options=dict(seconds=dict(required=True, type='int'), nanos=dict(type='int'))),
name=dict(type='str'),
path=dict(type='str'),
),
),
http_header_name=dict(type='str'),
minimum_ring_size=dict(default=1024, type='int'),
),
),
cdn_policy=dict( cdn_policy=dict(
type='dict', type='dict',
options=dict( options=dict(
@ -777,6 +1362,7 @@ def main():
), ),
), ),
connection_draining=dict(type='dict', options=dict(draining_timeout_sec=dict(default=300, type='int'))), connection_draining=dict(type='dict', options=dict(draining_timeout_sec=dict(default=300, type='int'))),
custom_request_headers=dict(type='list', elements='str'),
description=dict(type='str'), description=dict(type='str'),
enable_cdn=dict(type='bool'), enable_cdn=dict(type='bool'),
health_checks=dict(required=True, type='list', elements='str'), health_checks=dict(required=True, type='list', elements='str'),
@ -785,12 +1371,30 @@ def main():
options=dict(enabled=dict(type='bool'), oauth2_client_id=dict(required=True, type='str'), oauth2_client_secret=dict(required=True, type='str')), options=dict(enabled=dict(type='bool'), oauth2_client_id=dict(required=True, type='str'), oauth2_client_secret=dict(required=True, type='str')),
), ),
load_balancing_scheme=dict(default='EXTERNAL', type='str'), load_balancing_scheme=dict(default='EXTERNAL', type='str'),
locality_lb_policy=dict(type='str'),
name=dict(required=True, type='str'), name=dict(required=True, type='str'),
outlier_detection=dict(
type='dict',
options=dict(
base_ejection_time=dict(type='dict', options=dict(seconds=dict(required=True, type='int'), nanos=dict(type='int'))),
consecutive_errors=dict(default=5, type='int'),
consecutive_gateway_failure=dict(default=5, type='int'),
enforcing_consecutive_errors=dict(default=100, type='int'),
enforcing_consecutive_gateway_failure=dict(default=0, type='int'),
enforcing_success_rate=dict(default=100, type='int'),
interval=dict(type='dict', options=dict(seconds=dict(required=True, type='int'), nanos=dict(type='int'))),
max_ejection_percent=dict(default=10, type='int'),
success_rate_minimum_hosts=dict(default=5, type='int'),
success_rate_request_volume=dict(default=100, type='int'),
success_rate_stdev_factor=dict(default=1900, type='int'),
),
),
port_name=dict(type='str'), port_name=dict(type='str'),
protocol=dict(type='str'), protocol=dict(type='str'),
security_policy=dict(type='str'), security_policy=dict(type='str'),
session_affinity=dict(type='str'), session_affinity=dict(type='str'),
timeout_sec=dict(type='int', aliases=['timeout_seconds']), timeout_sec=dict(type='int', aliases=['timeout_seconds']),
log_config=dict(type='dict', options=dict(enable=dict(type='bool'), sample_rate=dict(type='str'))),
) )
) )
@ -859,19 +1463,25 @@ def resource_to_request(module):
u'kind': 'compute#backendService', u'kind': 'compute#backendService',
u'affinityCookieTtlSec': module.params.get('affinity_cookie_ttl_sec'), u'affinityCookieTtlSec': module.params.get('affinity_cookie_ttl_sec'),
u'backends': BackendServiceBackendsArray(module.params.get('backends', []), module).to_request(), u'backends': BackendServiceBackendsArray(module.params.get('backends', []), module).to_request(),
u'circuitBreakers': BackendServiceCircuitbreakers(module.params.get('circuit_breakers', {}), module).to_request(),
u'consistentHash': BackendServiceConsistenthash(module.params.get('consistent_hash', {}), module).to_request(),
u'cdnPolicy': BackendServiceCdnpolicy(module.params.get('cdn_policy', {}), module).to_request(), u'cdnPolicy': BackendServiceCdnpolicy(module.params.get('cdn_policy', {}), module).to_request(),
u'connectionDraining': BackendServiceConnectiondraining(module.params.get('connection_draining', {}), module).to_request(), u'connectionDraining': BackendServiceConnectiondraining(module.params.get('connection_draining', {}), module).to_request(),
u'customRequestHeaders': module.params.get('custom_request_headers'),
u'description': module.params.get('description'), u'description': module.params.get('description'),
u'enableCDN': module.params.get('enable_cdn'), u'enableCDN': module.params.get('enable_cdn'),
u'healthChecks': module.params.get('health_checks'), u'healthChecks': module.params.get('health_checks'),
u'iap': BackendServiceIap(module.params.get('iap', {}), module).to_request(), u'iap': BackendServiceIap(module.params.get('iap', {}), module).to_request(),
u'loadBalancingScheme': module.params.get('load_balancing_scheme'), u'loadBalancingScheme': module.params.get('load_balancing_scheme'),
u'localityLbPolicy': module.params.get('locality_lb_policy'),
u'name': module.params.get('name'), u'name': module.params.get('name'),
u'outlierDetection': BackendServiceOutlierdetection(module.params.get('outlier_detection', {}), module).to_request(),
u'portName': module.params.get('port_name'), u'portName': module.params.get('port_name'),
u'protocol': module.params.get('protocol'), u'protocol': module.params.get('protocol'),
u'securityPolicy': module.params.get('security_policy'), u'securityPolicy': module.params.get('security_policy'),
u'sessionAffinity': module.params.get('session_affinity'), u'sessionAffinity': module.params.get('session_affinity'),
u'timeoutSec': module.params.get('timeout_sec'), u'timeoutSec': module.params.get('timeout_sec'),
u'logConfig': BackendServiceLogconfig(module.params.get('log_config', {}), module).to_request(),
} }
return_vals = {} return_vals = {}
for k, v in request.items(): for k, v in request.items():
@ -939,9 +1549,12 @@ def response_to_hash(module, response):
return { return {
u'affinityCookieTtlSec': response.get(u'affinityCookieTtlSec'), u'affinityCookieTtlSec': response.get(u'affinityCookieTtlSec'),
u'backends': BackendServiceBackendsArray(response.get(u'backends', []), module).from_response(), u'backends': BackendServiceBackendsArray(response.get(u'backends', []), module).from_response(),
u'circuitBreakers': BackendServiceCircuitbreakers(response.get(u'circuitBreakers', {}), module).from_response(),
u'consistentHash': BackendServiceConsistenthash(response.get(u'consistentHash', {}), module).from_response(),
u'cdnPolicy': BackendServiceCdnpolicy(response.get(u'cdnPolicy', {}), module).from_response(), u'cdnPolicy': BackendServiceCdnpolicy(response.get(u'cdnPolicy', {}), module).from_response(),
u'connectionDraining': BackendServiceConnectiondraining(response.get(u'connectionDraining', {}), module).from_response(), u'connectionDraining': BackendServiceConnectiondraining(response.get(u'connectionDraining', {}), module).from_response(),
u'creationTimestamp': response.get(u'creationTimestamp'), u'creationTimestamp': response.get(u'creationTimestamp'),
u'customRequestHeaders': response.get(u'customRequestHeaders'),
u'fingerprint': response.get(u'fingerprint'), u'fingerprint': response.get(u'fingerprint'),
u'description': response.get(u'description'), u'description': response.get(u'description'),
u'enableCDN': response.get(u'enableCDN'), u'enableCDN': response.get(u'enableCDN'),
@ -949,12 +1562,15 @@ def response_to_hash(module, response):
u'id': response.get(u'id'), u'id': response.get(u'id'),
u'iap': BackendServiceIap(response.get(u'iap', {}), module).from_response(), u'iap': BackendServiceIap(response.get(u'iap', {}), module).from_response(),
u'loadBalancingScheme': module.params.get('load_balancing_scheme'), u'loadBalancingScheme': module.params.get('load_balancing_scheme'),
u'localityLbPolicy': response.get(u'localityLbPolicy'),
u'name': module.params.get('name'), u'name': module.params.get('name'),
u'outlierDetection': BackendServiceOutlierdetection(response.get(u'outlierDetection', {}), module).from_response(),
u'portName': response.get(u'portName'), u'portName': response.get(u'portName'),
u'protocol': response.get(u'protocol'), u'protocol': response.get(u'protocol'),
u'securityPolicy': response.get(u'securityPolicy'), u'securityPolicy': response.get(u'securityPolicy'),
u'sessionAffinity': response.get(u'sessionAffinity'), u'sessionAffinity': response.get(u'sessionAffinity'),
u'timeoutSec': response.get(u'timeoutSec'), u'timeoutSec': response.get(u'timeoutSec'),
u'logConfig': BackendServiceLogconfig(response.get(u'logConfig', {}), module).from_response(),
} }
@ -1048,6 +1664,106 @@ class BackendServiceBackendsArray(object):
) )
class BackendServiceCircuitbreakers(object):
def __init__(self, request, module):
self.module = module
if request:
self.request = request
else:
self.request = {}
def to_request(self):
return remove_nones_from_dict(
{
u'maxRequestsPerConnection': self.request.get('max_requests_per_connection'),
u'maxConnections': self.request.get('max_connections'),
u'maxPendingRequests': self.request.get('max_pending_requests'),
u'maxRequests': self.request.get('max_requests'),
u'maxRetries': self.request.get('max_retries'),
}
)
def from_response(self):
return remove_nones_from_dict(
{
u'maxRequestsPerConnection': self.request.get(u'maxRequestsPerConnection'),
u'maxConnections': self.request.get(u'maxConnections'),
u'maxPendingRequests': self.request.get(u'maxPendingRequests'),
u'maxRequests': self.request.get(u'maxRequests'),
u'maxRetries': self.request.get(u'maxRetries'),
}
)
class BackendServiceConsistenthash(object):
def __init__(self, request, module):
self.module = module
if request:
self.request = request
else:
self.request = {}
def to_request(self):
return remove_nones_from_dict(
{
u'httpCookie': BackendServiceHttpcookie(self.request.get('http_cookie', {}), self.module).to_request(),
u'httpHeaderName': self.request.get('http_header_name'),
u'minimumRingSize': self.request.get('minimum_ring_size'),
}
)
def from_response(self):
return remove_nones_from_dict(
{
u'httpCookie': BackendServiceHttpcookie(self.request.get(u'httpCookie', {}), self.module).from_response(),
u'httpHeaderName': self.request.get(u'httpHeaderName'),
u'minimumRingSize': self.request.get(u'minimumRingSize'),
}
)
class BackendServiceHttpcookie(object):
def __init__(self, request, module):
self.module = module
if request:
self.request = request
else:
self.request = {}
def to_request(self):
return remove_nones_from_dict(
{
u'ttl': BackendServiceTtl(self.request.get('ttl', {}), self.module).to_request(),
u'name': self.request.get('name'),
u'path': self.request.get('path'),
}
)
def from_response(self):
return remove_nones_from_dict(
{
u'ttl': BackendServiceTtl(self.request.get(u'ttl', {}), self.module).from_response(),
u'name': self.request.get(u'name'),
u'path': self.request.get(u'path'),
}
)
class BackendServiceTtl(object):
def __init__(self, request, module):
self.module = module
if request:
self.request = request
else:
self.request = {}
def to_request(self):
return remove_nones_from_dict({u'seconds': self.request.get('seconds'), u'nanos': self.request.get('nanos')})
def from_response(self):
return remove_nones_from_dict({u'seconds': self.request.get(u'seconds'), u'nanos': self.request.get(u'nanos')})
class BackendServiceCdnpolicy(object): class BackendServiceCdnpolicy(object):
def __init__(self, request, module): def __init__(self, request, module):
self.module = module self.module = module
@ -1146,5 +1862,93 @@ class BackendServiceIap(object):
) )
class BackendServiceOutlierdetection(object):
def __init__(self, request, module):
self.module = module
if request:
self.request = request
else:
self.request = {}
def to_request(self):
return remove_nones_from_dict(
{
u'baseEjectionTime': BackendServiceBaseejectiontime(self.request.get('base_ejection_time', {}), self.module).to_request(),
u'consecutiveErrors': self.request.get('consecutive_errors'),
u'consecutiveGatewayFailure': self.request.get('consecutive_gateway_failure'),
u'enforcingConsecutiveErrors': self.request.get('enforcing_consecutive_errors'),
u'enforcingConsecutiveGatewayFailure': self.request.get('enforcing_consecutive_gateway_failure'),
u'enforcingSuccessRate': self.request.get('enforcing_success_rate'),
u'interval': BackendServiceInterval(self.request.get('interval', {}), self.module).to_request(),
u'maxEjectionPercent': self.request.get('max_ejection_percent'),
u'successRateMinimumHosts': self.request.get('success_rate_minimum_hosts'),
u'successRateRequestVolume': self.request.get('success_rate_request_volume'),
u'successRateStdevFactor': self.request.get('success_rate_stdev_factor'),
}
)
def from_response(self):
return remove_nones_from_dict(
{
u'baseEjectionTime': BackendServiceBaseejectiontime(self.request.get(u'baseEjectionTime', {}), self.module).from_response(),
u'consecutiveErrors': self.request.get(u'consecutiveErrors'),
u'consecutiveGatewayFailure': self.request.get(u'consecutiveGatewayFailure'),
u'enforcingConsecutiveErrors': self.request.get(u'enforcingConsecutiveErrors'),
u'enforcingConsecutiveGatewayFailure': self.request.get(u'enforcingConsecutiveGatewayFailure'),
u'enforcingSuccessRate': self.request.get(u'enforcingSuccessRate'),
u'interval': BackendServiceInterval(self.request.get(u'interval', {}), self.module).from_response(),
u'maxEjectionPercent': self.request.get(u'maxEjectionPercent'),
u'successRateMinimumHosts': self.request.get(u'successRateMinimumHosts'),
u'successRateRequestVolume': self.request.get(u'successRateRequestVolume'),
u'successRateStdevFactor': self.request.get(u'successRateStdevFactor'),
}
)
class BackendServiceBaseejectiontime(object):
def __init__(self, request, module):
self.module = module
if request:
self.request = request
else:
self.request = {}
def to_request(self):
return remove_nones_from_dict({u'seconds': self.request.get('seconds'), u'nanos': self.request.get('nanos')})
def from_response(self):
return remove_nones_from_dict({u'seconds': self.request.get(u'seconds'), u'nanos': self.request.get(u'nanos')})
class BackendServiceInterval(object):
def __init__(self, request, module):
self.module = module
if request:
self.request = request
else:
self.request = {}
def to_request(self):
return remove_nones_from_dict({u'seconds': self.request.get('seconds'), u'nanos': self.request.get('nanos')})
def from_response(self):
return remove_nones_from_dict({u'seconds': self.request.get(u'seconds'), u'nanos': self.request.get(u'nanos')})
class BackendServiceLogconfig(object):
def __init__(self, request, module):
self.module = module
if request:
self.request = request
else:
self.request = {}
def to_request(self):
return remove_nones_from_dict({u'enable': self.request.get('enable'), u'sampleRate': self.request.get('sample_rate')})
def from_response(self):
return remove_nones_from_dict({u'enable': self.request.get(u'enable'), u'sampleRate': self.request.get(u'sampleRate')})
if __name__ == '__main__': if __name__ == '__main__':
main() main()

275
plugins/modules/gcp_compute_backend_service_info.py
View file

@ -222,6 +222,112 @@ resources:
target for the group. The default is 0.8. Valid range is [0.0, 1.0]. target for the group. The default is 0.8. Valid range is [0.0, 1.0].
returned: success returned: success
type: str type: str
circuitBreakers:
description:
- Settings controlling the volume of connections to a backend service. This
field is applicable only when the load_balancing_scheme is set to INTERNAL_SELF_MANAGED.
returned: success
type: complex
contains:
maxRequestsPerConnection:
description:
- Maximum requests for a single backend connection. This parameter is respected
by both the HTTP/1.1 and HTTP/2 implementations. If not specified, there
is no limit. Setting this parameter to 1 will effectively disable keep
alive.
returned: success
type: int
maxConnections:
description:
- The maximum number of connections to the backend cluster.
- Defaults to 1024.
returned: success
type: int
maxPendingRequests:
description:
- The maximum number of pending requests to the backend cluster.
- Defaults to 1024.
returned: success
type: int
maxRequests:
description:
- The maximum number of parallel requests to the backend cluster.
- Defaults to 1024.
returned: success
type: int
maxRetries:
description:
- The maximum number of parallel retries to the backend cluster.
- Defaults to 3.
returned: success
type: int
consistentHash:
description:
- Consistent Hash-based load balancing can be used to provide soft session affinity
based on HTTP headers, cookies or other properties. This load balancing policy
is applicable only for HTTP connections. The affinity to a particular destination
host will be lost when one or more hosts are added/removed from the destination
service. This field specifies parameters that control consistent hashing.
This field only applies if the load_balancing_scheme is set to INTERNAL_SELF_MANAGED.
This field is only applicable when locality_lb_policy is set to MAGLEV or
RING_HASH.
returned: success
type: complex
contains:
httpCookie:
description:
- Hash is based on HTTP Cookie. This field describes a HTTP cookie that
will be used as the hash key for the consistent hash load balancer. If
the cookie is not present, it will be generated.
- This field is applicable if the sessionAffinity is set to HTTP_COOKIE.
returned: success
type: complex
contains:
ttl:
description:
- Lifetime of the cookie.
returned: success
type: complex
contains:
seconds:
description:
- Span of time at a resolution of a second.
- Must be from 0 to 315,576,000,000 inclusive.
returned: success
type: int
nanos:
description:
- Span of time that's a fraction of a second at nanosecond resolution.
Durations less than one second are represented with a 0 seconds
field and a positive nanos field. Must be from 0 to 999,999,999
inclusive.
returned: success
type: int
name:
description:
- Name of the cookie.
returned: success
type: str
path:
description:
- Path to set for the cookie.
returned: success
type: str
httpHeaderName:
description:
- The hash based on the value of the specified header field.
- This field is applicable if the sessionAffinity is set to HEADER_FIELD.
returned: success
type: str
minimumRingSize:
description:
- The minimum number of virtual nodes to use for the hash ring.
- Larger ring sizes result in more granular load distributions. If the number
of hosts in the load balancing pool is larger than the ring size, each
host will be assigned a single virtual node.
- Defaults to 1024.
returned: success
type: int
cdnPolicy: cdnPolicy:
description: description:
- Cloud CDN configuration for this BackendService. - Cloud CDN configuration for this BackendService.
@ -296,6 +402,11 @@ resources:
- Creation timestamp in RFC3339 text format. - Creation timestamp in RFC3339 text format.
returned: success returned: success
type: str type: str
customRequestHeaders:
description:
- Headers that the HTTP/S load balancer should add to proxied requests.
returned: success
type: list
fingerprint: fingerprint:
description: description:
- Fingerprint of this resource. A hash of the contents stored in this object. - Fingerprint of this resource. A hash of the contents stored in this object.
@ -359,6 +470,27 @@ resources:
be used with the other. be used with the other.
returned: success returned: success
type: str type: str
localityLbPolicy:
description:
- The load balancing algorithm used within the scope of the locality.
- The possible values are - ROUND_ROBIN - This is a simple policy in which each
healthy backend is selected in round robin order.
- LEAST_REQUEST - An O(1) algorithm which selects two random healthy hosts and
picks the host which has fewer active requests.
- RING_HASH - The ring/modulo hash load balancer implements consistent hashing
to backends. The algorithm has the property that the addition/removal of a
host from a set of N hosts only affects 1/N of the requests.
- RANDOM - The load balancer selects a random healthy host.
- ORIGINAL_DESTINATION - Backend host is selected based on the client connection
metadata, i.e., connections are opened to the same address as the destination
address of the incoming connection before the connection was redirected to
the load balancer.
- MAGLEV - used as a drop in replacement for the ring hash load balancer.
- Maglev is not as stable as ring hash but has faster table lookup build times
and host selection times. For more information about Maglev, refer to https://ai.google/research/pubs/pub44824
This field is applicable only when the load_balancing_scheme is set to INTERNAL_SELF_MANAGED.
returned: success
type: str
name: name:
description: description:
- Name of the resource. Provided by the client when the resource is created. - Name of the resource. Provided by the client when the resource is created.
@ -369,6 +501,126 @@ resources:
which cannot be a dash. which cannot be a dash.
returned: success returned: success
type: str type: str
outlierDetection:
description:
- Settings controlling eviction of unhealthy hosts from the load balancing pool.
- This field is applicable only when the load_balancing_scheme is set to INTERNAL_SELF_MANAGED.
returned: success
type: complex
contains:
baseEjectionTime:
description:
- The base time that a host is ejected for. The real time is equal to the
base time multiplied by the number of times the host has been ejected.
Defaults to 30000ms or 30s.
returned: success
type: complex
contains:
seconds:
description:
- Span of time at a resolution of a second. Must be from 0 to 315,576,000,000
inclusive.
returned: success
type: int
nanos:
description:
- Span of time that's a fraction of a second at nanosecond resolution.
Durations less than one second are represented with a 0 `seconds`
field and a positive `nanos` field. Must be from 0 to 999,999,999
inclusive.
returned: success
type: int
consecutiveErrors:
description:
- Number of errors before a host is ejected from the connection pool. When
the backend host is accessed over HTTP, a 5xx return code qualifies as
an error.
- Defaults to 5.
returned: success
type: int
consecutiveGatewayFailure:
description:
- The number of consecutive gateway failures (502, 503, 504 status or connection
errors that are mapped to one of those status codes) before a consecutive
gateway failure ejection occurs. Defaults to 5.
returned: success
type: int
enforcingConsecutiveErrors:
description:
- The percentage chance that a host will be actually ejected when an outlier
status is detected through consecutive 5xx. This setting can be used to
disable ejection or to ramp it up slowly. Defaults to 100.
returned: success
type: int
enforcingConsecutiveGatewayFailure:
description:
- The percentage chance that a host will be actually ejected when an outlier
status is detected through consecutive gateway failures. This setting
can be used to disable ejection or to ramp it up slowly. Defaults to 0.
returned: success
type: int
enforcingSuccessRate:
description:
- The percentage chance that a host will be actually ejected when an outlier
status is detected through success rate statistics. This setting can be
used to disable ejection or to ramp it up slowly. Defaults to 100.
returned: success
type: int
interval:
description:
- Time interval between ejection sweep analysis. This can result in both
new ejections as well as hosts being returned to service. Defaults to
10 seconds.
returned: success
type: complex
contains:
seconds:
description:
- Span of time at a resolution of a second. Must be from 0 to 315,576,000,000
inclusive.
returned: success
type: int
nanos:
description:
- Span of time that's a fraction of a second at nanosecond resolution.
Durations less than one second are represented with a 0 `seconds`
field and a positive `nanos` field. Must be from 0 to 999,999,999
inclusive.
returned: success
type: int
maxEjectionPercent:
description:
- Maximum percentage of hosts in the load balancing pool for the backend
service that can be ejected. Defaults to 10%.
returned: success
type: int
successRateMinimumHosts:
description:
- The number of hosts in a cluster that must have enough request volume
to detect success rate outliers. If the number of hosts is less than this
setting, outlier detection via success rate statistics is not performed
for any host in the cluster. Defaults to 5.
returned: success
type: int
successRateRequestVolume:
description:
- The minimum number of total requests that must be collected in one interval
(as defined by the interval duration above) to include this host in success
rate based outlier detection. If the volume is lower than this setting,
outlier detection via success rate statistics is not performed for that
host. Defaults to 100.
returned: success
type: int
successRateStdevFactor:
description:
- 'This factor is used to determine the ejection threshold for success rate
outlier ejection. The ejection threshold is the difference between the
mean success rate, and the product of this factor and the standard deviation
of the mean success rate: mean - (stdev * success_rate_stdev_factor).
This factor is divided by a thousand to get a double. That is, if the
desired factor is 1.9, the runtime value should be 1900. Defaults to 1900.'
returned: success
type: int
portName: portName:
description: description:
- Name of backend port. The same name should appear in the instance groups referenced - Name of backend port. The same name should appear in the instance groups referenced
@ -399,6 +651,29 @@ resources:
Default is 30 seconds. Valid range is [1, 86400]. Default is 30 seconds. Valid range is [1, 86400].
returned: success returned: success
type: int type: int
logConfig:
description:
- This field denotes the logging options for the load balancer traffic served
by this backend service.
- If logging is enabled, logs will be exported to Stackdriver.
returned: success
type: complex
contains:
enable:
description:
- Whether to enable logging for the load balancer traffic served by this
backend service.
returned: success
type: bool
sampleRate:
description:
- This field can only be specified if logging is enabled for this backend
service. The value of the field must be in [0, 1]. This configures the
sampling rate of requests to the load balancer where 1.0 means all logged
requests are reported and 0.0 means no logged requests are reported.
- The default value is 1.0.
returned: success
type: str
''' '''
################################################################################ ################################################################################

935
plugins/modules/gcp_compute_region_backend_service.py
View file

File diff suppressed because it is too large Load diff

326
plugins/modules/gcp_compute_region_backend_service_info.py
View file

@ -118,6 +118,15 @@ resources:
returned: always returned: always
type: complex type: complex
contains: contains:
affinityCookieTtlSec:
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: backends:
description: description:
- The set of backends that serve this RegionBackendService. - The set of backends that serve this RegionBackendService.
@ -146,6 +155,12 @@ resources:
- Provide this property when you create the resource. - Provide this property when you create the resource.
returned: success returned: success
type: str type: str
failover:
description:
- This field designates whether this is a failover backend. More than one
failover backend can be configured for a given RegionBackendService.
returned: success
type: bool
group: group:
description: description:
- The fully-qualified URL of an Instance Group or Network Endpoint Group - The fully-qualified URL of an Instance Group or Network Endpoint Group
@ -224,6 +239,113 @@ resources:
- Cannot be set for INTERNAL backend services. - Cannot be set for INTERNAL backend services.
returned: success returned: success
type: str type: str
circuitBreakers:
description:
- Settings controlling the volume of connections to a backend service. This
field is applicable only when the `load_balancing_scheme` is set to INTERNAL_MANAGED
and the `protocol` is set to HTTP, HTTPS, or HTTP2.
returned: success
type: complex
contains:
maxRequestsPerConnection:
description:
- Maximum requests for a single backend connection. This parameter is respected
by both the HTTP/1.1 and HTTP/2 implementations. If not specified, there
is no limit. Setting this parameter to 1 will effectively disable keep
alive.
returned: success
type: int
maxConnections:
description:
- The maximum number of connections to the backend cluster.
- Defaults to 1024.
returned: success
type: int
maxPendingRequests:
description:
- The maximum number of pending requests to the backend cluster.
- Defaults to 1024.
returned: success
type: int
maxRequests:
description:
- The maximum number of parallel requests to the backend cluster.
- Defaults to 1024.
returned: success
type: int
maxRetries:
description:
- The maximum number of parallel retries to the backend cluster.
- Defaults to 3.
returned: success
type: int
consistentHash:
description:
- Consistent Hash-based load balancing can be used to provide soft session affinity
based on HTTP headers, cookies or other properties. This load balancing policy
is applicable only for HTTP connections. The affinity to a particular destination
host will be lost when one or more hosts are added/removed from the destination
service. This field specifies parameters that control consistent hashing.
- This field only applies when all of the following are true - * `load_balancing_scheme`
is set to INTERNAL_MANAGED * `protocol` is set to HTTP, HTTPS, or HTTP2 *
`locality_lb_policy` is set to MAGLEV or RING_HASH .
returned: success
type: complex
contains:
httpCookie:
description:
- Hash is based on HTTP Cookie. This field describes a HTTP cookie that
will be used as the hash key for the consistent hash load balancer. If
the cookie is not present, it will be generated.
- This field is applicable if the sessionAffinity is set to HTTP_COOKIE.
returned: success
type: complex
contains:
ttl:
description:
- Lifetime of the cookie.
returned: success
type: complex
contains:
seconds:
description:
- Span of time at a resolution of a second.
- Must be from 0 to 315,576,000,000 inclusive.
returned: success
type: int
nanos:
description:
- Span of time that's a fraction of a second at nanosecond resolution.
Durations less than one second are represented with a 0 seconds
field and a positive nanos field. Must be from 0 to 999,999,999
inclusive.
returned: success
type: int
name:
description:
- Name of the cookie.
returned: success
type: str
path:
description:
- Path to set for the cookie.
returned: success
type: str
httpHeaderName:
description:
- The hash based on the value of the specified header field.
- This field is applicable if the sessionAffinity is set to HEADER_FIELD.
returned: success
type: str
minimumRingSize:
description:
- The minimum number of virtual nodes to use for the hash ring.
- Larger ring sizes result in more granular load distributions. If the number
of hosts in the load balancing pool is larger than the ring size, each
host will be assigned a single virtual node.
- Defaults to 1024.
returned: success
type: int
connectionDraining: connectionDraining:
description: description:
- Settings for connection draining . - Settings for connection draining .
@ -246,6 +368,44 @@ resources:
- An optional description of this resource. - An optional description of this resource.
returned: success returned: success
type: str type: str
failoverPolicy:
description:
- Policy for failovers.
returned: success
type: complex
contains:
disableConnectionDrainOnFailover:
description:
- 'On failover or failback, this field indicates whether connection drain
will be honored. Setting this to true has the following effect: connections
to the old active pool are not drained. Connections to the new active
pool use the timeout of 10 min (currently fixed). Setting to false has
the following effect: both old and new connections will have a drain timeout
of 10 min.'
- This can be set to true only if the protocol is TCP.
- The default is false.
returned: success
type: bool
dropTrafficIfUnhealthy:
description:
- This option is used only when no healthy VMs are detected in the primary
and backup instance groups. When set to true, traffic is dropped. When
set to false, new connections are sent across all VMs in the primary group.
- The default is false.
returned: success
type: bool
failoverRatio:
description:
- The value of the field must be in [0, 1]. If the ratio of the healthy
VMs in the primary backend is at or below this number, traffic arriving
at the load-balanced IP will be directed to the failover backend.
- In case where 'failoverRatio' is not set or all the VMs in the backup
backend are unhealthy, the traffic will be directed back to the primary
backend in the "force" mode, where traffic will be spread to the healthy
VMs with the best effort, or to all VMs when no VM is healthy.
- This field is only used with l4 load balancing.
returned: success
type: str
fingerprint: fingerprint:
description: description:
- Fingerprint of this resource. A hash of the contents stored in this object. - Fingerprint of this resource. A hash of the contents stored in this object.
@ -271,6 +431,28 @@ resources:
be used with the other(s). be used with the other(s).
returned: success returned: success
type: str type: str
localityLbPolicy:
description:
- The load balancing algorithm used within the scope of the locality.
- The possible values are - ROUND_ROBIN - This is a simple policy in which each
healthy backend is selected in round robin order.
- LEAST_REQUEST - An O(1) algorithm which selects two random healthy hosts and
picks the host which has fewer active requests.
- RING_HASH - The ring/modulo hash load balancer implements consistent hashing
to backends. The algorithm has the property that the addition/removal of a
host from a set of N hosts only affects 1/N of the requests.
- RANDOM - The load balancer selects a random healthy host.
- ORIGINAL_DESTINATION - Backend host is selected based on the client connection
metadata, i.e., connections are opened to the same address as the destination
address of the incoming connection before the connection was redirected to
the load balancer.
- MAGLEV - used as a drop in replacement for the ring hash load balancer.
- Maglev is not as stable as ring hash but has faster table lookup build times
and host selection times. For more information about Maglev, refer to https://ai.google/research/pubs/pub44824
This field is applicable only when the `load_balancing_scheme` is set to INTERNAL_MANAGED
and the `protocol` is set to HTTP, HTTPS, or HTTP2.
returned: success
type: str
name: name:
description: description:
- Name of the resource. Provided by the client when the resource is created. - Name of the resource. Provided by the client when the resource is created.
@ -281,6 +463,127 @@ resources:
which cannot be a dash. which cannot be a dash.
returned: success returned: success
type: str type: str
outlierDetection:
description:
- Settings controlling eviction of unhealthy hosts from the load balancing pool.
- This field is applicable only when the `load_balancing_scheme` is set to INTERNAL_MANAGED
and the `protocol` is set to HTTP, HTTPS, or HTTP2.
returned: success
type: complex
contains:
baseEjectionTime:
description:
- The base time that a host is ejected for. The real time is equal to the
base time multiplied by the number of times the host has been ejected.
Defaults to 30000ms or 30s.
returned: success
type: complex
contains:
seconds:
description:
- Span of time at a resolution of a second. Must be from 0 to 315,576,000,000
inclusive.
returned: success
type: int
nanos:
description:
- Span of time that's a fraction of a second at nanosecond resolution.
Durations less than one second are represented with a 0 `seconds`
field and a positive `nanos` field. Must be from 0 to 999,999,999
inclusive.
returned: success
type: int
consecutiveErrors:
description:
- Number of errors before a host is ejected from the connection pool. When
the backend host is accessed over HTTP, a 5xx return code qualifies as
an error.
- Defaults to 5.
returned: success
type: int
consecutiveGatewayFailure:
description:
- The number of consecutive gateway failures (502, 503, 504 status or connection
errors that are mapped to one of those status codes) before a consecutive
gateway failure ejection occurs. Defaults to 5.
returned: success
type: int
enforcingConsecutiveErrors:
description:
- The percentage chance that a host will be actually ejected when an outlier
status is detected through consecutive 5xx. This setting can be used to
disable ejection or to ramp it up slowly. Defaults to 100.
returned: success
type: int
enforcingConsecutiveGatewayFailure:
description:
- The percentage chance that a host will be actually ejected when an outlier
status is detected through consecutive gateway failures. This setting
can be used to disable ejection or to ramp it up slowly. Defaults to 0.
returned: success
type: int
enforcingSuccessRate:
description:
- The percentage chance that a host will be actually ejected when an outlier
status is detected through success rate statistics. This setting can be
used to disable ejection or to ramp it up slowly. Defaults to 100.
returned: success
type: int
interval:
description:
- Time interval between ejection sweep analysis. This can result in both
new ejections as well as hosts being returned to service. Defaults to
10 seconds.
returned: success
type: complex
contains:
seconds:
description:
- Span of time at a resolution of a second. Must be from 0 to 315,576,000,000
inclusive.
returned: success
type: int
nanos:
description:
- Span of time that's a fraction of a second at nanosecond resolution.
Durations less than one second are represented with a 0 `seconds`
field and a positive `nanos` field. Must be from 0 to 999,999,999
inclusive.
returned: success
type: int
maxEjectionPercent:
description:
- Maximum percentage of hosts in the load balancing pool for the backend
service that can be ejected. Defaults to 10%.
returned: success
type: int
successRateMinimumHosts:
description:
- The number of hosts in a cluster that must have enough request volume
to detect success rate outliers. If the number of hosts is less than this
setting, outlier detection via success rate statistics is not performed
for any host in the cluster. Defaults to 5.
returned: success
type: int
successRateRequestVolume:
description:
- The minimum number of total requests that must be collected in one interval
(as defined by the interval duration above) to include this host in success
rate based outlier detection. If the volume is lower than this setting,
outlier detection via success rate statistics is not performed for that
host. Defaults to 100.
returned: success
type: int
successRateStdevFactor:
description:
- 'This factor is used to determine the ejection threshold for success rate
outlier ejection. The ejection threshold is the difference between the
mean success rate, and the product of this factor and the standard deviation
of the mean success rate: mean - (stdev * success_rate_stdev_factor).
This factor is divided by a thousand to get a double. That is, if the
desired factor is 1.9, the runtime value should be 1900. Defaults to 1900.'
returned: success
type: int
protocol: protocol:
description: description:
- The protocol this RegionBackendService uses to communicate with backends. - The protocol this RegionBackendService uses to communicate with backends.
@ -300,6 +603,29 @@ resources:
Default is 30 seconds. Valid range is [1, 86400]. Default is 30 seconds. Valid range is [1, 86400].
returned: success returned: success
type: int type: int
logConfig:
description:
- This field denotes the logging options for the load balancer traffic served
by this backend service.
- If logging is enabled, logs will be exported to Stackdriver.
returned: success
type: complex
contains:
enable:
description:
- Whether to enable logging for the load balancer traffic served by this
backend service.
returned: success
type: bool
sampleRate:
description:
- This field can only be specified if logging is enabled for this backend
service. The value of the field must be in [0, 1]. This configures the
sampling rate of requests to the load balancer where 1.0 means all logged
requests are reported and 0.0 means no logged requests are reported.
- The default value is 1.0.
returned: success
type: str
network: network:
description: description:
- The URL of the network to which this backend service belongs. - The URL of the network to which this backend service belongs.

2
plugins/modules/gcp_compute_region_disk.py
View file

@ -202,7 +202,7 @@ options:
- This only alters the User Agent string for any API requests. - This only alters the User Agent string for any API requests.
type: str type: str
notes: notes:
- 'API Reference: U(https://cloud.google.com/compute/docs/reference/rest/beta/regionDisks)' - 'API Reference: U(https://cloud.google.com/compute/docs/reference/rest/v1/regionDisks)'
- 'Adding or Resizing Regional Persistent Disks: U(https://cloud.google.com/compute/docs/disks/regional-persistent-disk)' - 'Adding or Resizing Regional Persistent Disks: U(https://cloud.google.com/compute/docs/disks/regional-persistent-disk)'
- for authentication, you can set service_account_file using the C(gcp_service_account_file) - for authentication, you can set service_account_file using the C(gcp_service_account_file)
env variable. env variable.

2
plugins/modules/gcp_compute_region_health_check.py
View file

@ -442,7 +442,7 @@ options:
- This only alters the User Agent string for any API requests. - This only alters the User Agent string for any API requests.
type: str type: str
notes: notes:
- 'API Reference: U(https://cloud.google.com/compute/docs/reference/rest/beta/regionHealthChecks)' - 'API Reference: U(https://cloud.google.com/compute/docs/reference/rest/v1/regionHealthChecks)'
- 'Official Documentation: U(https://cloud.google.com/load-balancing/docs/health-checks)' - 'Official Documentation: U(https://cloud.google.com/load-balancing/docs/health-checks)'
- for authentication, you can set service_account_file using the C(gcp_service_account_file) - for authentication, you can set service_account_file using the C(gcp_service_account_file)
env variable. env variable.

2
plugins/modules/gcp_compute_region_target_http_proxy.py
View file

@ -118,7 +118,7 @@ options:
- This only alters the User Agent string for any API requests. - This only alters the User Agent string for any API requests.
type: str type: str
notes: notes:
- 'API Reference: U(https://cloud.google.com/compute/docs/reference/rest/beta/regionTargetHttpProxies)' - 'API Reference: U(https://cloud.google.com/compute/docs/reference/rest/v1/regionTargetHttpProxies)'
- 'Official Documentation: U(https://cloud.google.com/compute/docs/load-balancing/http/target-proxies)' - 'Official Documentation: U(https://cloud.google.com/compute/docs/load-balancing/http/target-proxies)'
- for authentication, you can set service_account_file using the C(gcp_service_account_file) - for authentication, you can set service_account_file using the C(gcp_service_account_file)
env variable. env variable.

2
plugins/modules/gcp_compute_region_target_https_proxy.py
View file

@ -126,7 +126,7 @@ options:
- This only alters the User Agent string for any API requests. - This only alters the User Agent string for any API requests.
type: str type: str
notes: notes:
- 'API Reference: U(https://cloud.google.com/compute/docs/reference/rest/beta/regionTargetHttpsProxies)' - 'API Reference: U(https://cloud.google.com/compute/docs/reference/rest/v1/regionTargetHttpsProxies)'
- 'Official Documentation: U(https://cloud.google.com/compute/docs/load-balancing/http/target-proxies)' - 'Official Documentation: U(https://cloud.google.com/compute/docs/load-balancing/http/target-proxies)'
- for authentication, you can set service_account_file using the C(gcp_service_account_file) - for authentication, you can set service_account_file using the C(gcp_service_account_file)
env variable. env variable.