Add L7 ILB fields to RegionBackendService (#38)

Signed-off-by: Modular Magician <magic-modules@google.com>
This commit is contained in:
The Magician 2019-11-05 13:51:03 -08:00 committed by Ty Larrabee
parent 66474a3916
commit 1430a27759
7 changed files with 529 additions and 238 deletions

View file

@ -102,8 +102,7 @@ options:
- For Network Endpoint Groups this defines list of endpoints. All endpoints - For Network Endpoint Groups this defines list of endpoints. All endpoints
of Network Endpoint Group must be hosted on instances located in the same of Network Endpoint Group must be hosted on instances located in the same
zone as the Network Endpoint Group. zone as the Network Endpoint Group.
- Backend service can not contain mix of Instance Group and Network Endpoint - Backend services cannot mix Instance Group and Network Endpoint Group backends.
Group backends.
- Note that you must specify an Instance Group or Network Endpoint Group resource - Note that you must specify an Instance Group or Network Endpoint Group resource
using the fully-qualified URL, rather than a partial URL. using the fully-qualified URL, rather than a partial URL.
required: false required: false
@ -475,8 +474,7 @@ backends:
- For Network Endpoint Groups this defines list of endpoints. All endpoints - For Network Endpoint Groups this defines list of endpoints. All endpoints
of Network Endpoint Group must be hosted on instances located in the same of Network Endpoint Group must be hosted on instances located in the same
zone as the Network Endpoint Group. zone as the Network Endpoint Group.
- Backend service can not contain mix of Instance Group and Network Endpoint - Backend services cannot mix Instance Group and Network Endpoint Group backends.
Group backends.
- Note that you must specify an Instance Group or Network Endpoint Group resource - Note that you must specify an Instance Group or Network Endpoint Group resource
using the fully-qualified URL, rather than a partial URL. using the fully-qualified URL, rather than a partial URL.
returned: success returned: success

View file

@ -160,8 +160,8 @@ resources:
- For Network Endpoint Groups this defines list of endpoints. All endpoints - For Network Endpoint Groups this defines list of endpoints. All endpoints
of Network Endpoint Group must be hosted on instances located in the same of Network Endpoint Group must be hosted on instances located in the same
zone as the Network Endpoint Group. zone as the Network Endpoint Group.
- Backend service can not contain mix of Instance Group and Network Endpoint - Backend services cannot mix Instance Group and Network Endpoint Group
Group backends. backends.
- Note that you must specify an Instance Group or Network Endpoint Group - Note that you must specify an Instance Group or Network Endpoint Group
resource using the fully-qualified URL, rather than a partial URL. resource using the fully-qualified URL, rather than a partial URL.
returned: success returned: success

View file

@ -106,12 +106,14 @@ options:
type: str type: str
load_balancing_scheme: load_balancing_scheme:
description: description:
- 'This signifies what the ForwardingRule will be used for and can only take the - This signifies what the ForwardingRule will be used for and can be EXTERNAL,
following values: INTERNAL, EXTERNAL The value of INTERNAL means that this will INTERNAL, or INTERNAL_MANAGED. EXTERNAL is used for Classic Cloud VPN gateways,
be used for Internal Network Load Balancing (TCP, UDP). The value of EXTERNAL protocol forwarding to VMs from an external IP address, and HTTP(S), SSL Proxy,
means that this will be used for External Load Balancing (HTTP(S) LB, External TCP Proxy, and Network TCP/UDP load balancers.
TCP/UDP LB, SSL Proxy) .' - INTERNAL is used for protocol forwarding to VMs from an internal IP address,
- 'Some valid choices include: "INTERNAL", "EXTERNAL"' and internal TCP/UDP load balancers.
- INTERNAL_MANAGED is used for internal HTTP(S) load balancers.
- 'Some valid choices include: "EXTERNAL", "INTERNAL", "INTERNAL_MANAGED"'
required: false required: false
type: str type: str
name: name:
@ -372,11 +374,13 @@ ipVersion:
type: str type: str
loadBalancingScheme: loadBalancingScheme:
description: description:
- 'This signifies what the ForwardingRule will be used for and can only take the - This signifies what the ForwardingRule will be used for and can be EXTERNAL, INTERNAL,
following values: INTERNAL, EXTERNAL The value of INTERNAL means that this will or INTERNAL_MANAGED. EXTERNAL is used for Classic Cloud VPN gateways, protocol
be used for Internal Network Load Balancing (TCP, UDP). The value of EXTERNAL forwarding to VMs from an external IP address, and HTTP(S), SSL Proxy, TCP Proxy,
means that this will be used for External Load Balancing (HTTP(S) LB, External and Network TCP/UDP load balancers.
TCP/UDP LB, SSL Proxy) .' - INTERNAL is used for protocol forwarding to VMs from an internal IP address, and
internal TCP/UDP load balancers.
- INTERNAL_MANAGED is used for internal HTTP(S) load balancers.
returned: success returned: success
type: str type: str
name: name:

View file

@ -178,11 +178,13 @@ resources:
type: str type: str
loadBalancingScheme: loadBalancingScheme:
description: description:
- 'This signifies what the ForwardingRule will be used for and can only take - This signifies what the ForwardingRule will be used for and can be EXTERNAL,
the following values: INTERNAL, EXTERNAL The value of INTERNAL means that INTERNAL, or INTERNAL_MANAGED. EXTERNAL is used for Classic Cloud VPN gateways,
this will be used for Internal Network Load Balancing (TCP, UDP). The value protocol forwarding to VMs from an external IP address, and HTTP(S), SSL Proxy,
of EXTERNAL means that this will be used for External Load Balancing (HTTP(S) TCP Proxy, and Network TCP/UDP load balancers.
LB, External TCP/UDP LB, SSL Proxy) .' - INTERNAL is used for protocol forwarding to VMs from an internal IP address,
and internal TCP/UDP load balancers.
- INTERNAL_MANAGED is used for internal HTTP(S) load balancers.
returned: success returned: success
type: str type: str
name: name:

View file

@ -103,7 +103,7 @@ options:
Global HTTP(S) LB. The value of EXTERNAL means that this will be used for External Global HTTP(S) LB. The value of EXTERNAL means that this will be used for External
Global Load Balancing (HTTP(S) LB, External TCP/UDP LB, SSL Proxy) NOTE: Currently Global Load Balancing (HTTP(S) LB, External TCP/UDP LB, SSL Proxy) NOTE: Currently
global forwarding rules cannot be used for INTERNAL load balancing.' global forwarding rules cannot be used for INTERNAL load balancing.'
- 'Some valid choices include: "INTERNAL_SELF_MANAGED", "EXTERNAL"' - 'Some valid choices include: "EXTERNAL", "INTERNAL_SELF_MANAGED"'
required: false required: false
default: EXTERNAL default: EXTERNAL
type: str type: str

View file

@ -33,8 +33,6 @@ module: gcp_compute_region_backend_service
description: description:
- A Region Backend Service defines a regionally-scoped group of virtual machines that - A Region Backend Service defines a regionally-scoped group of virtual machines that
will serve traffic for load balancing. will serve traffic for load balancing.
- Region backend services can only be used when using internal load balancing.
- For external load balancing, use a global backend service instead.
short_description: Creates a GCP RegionBackendService short_description: Creates a GCP RegionBackendService
version_added: '2.10' version_added: '2.10'
author: Google Inc. (@googlecloudplatform) author: Google Inc. (@googlecloudplatform)
@ -51,28 +49,27 @@ options:
- absent - absent
default: present default: present
type: str type: str
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.
required: true
type: str
health_checks:
description:
- The list of HealthChecks for checking the health of the backend service.
- Currently at most one health check can be specified, and a health check is required.
required: true
type: list
backends: backends:
description: description:
- The list of backends that serve this RegionBackendService. - The set of backends that serve this RegionBackendService.
required: false required: false
type: list type: list
suboptions: suboptions:
balancing_mode:
description:
- Specifies the balancing mode for this backend. Defaults to CONNECTION.
- 'Some valid choices include: "UTILIZATION", "RATE", "CONNECTION"'
required: false
default: CONNECTION
type: str
capacity_scaler:
description:
- A multiplier applied to the group's maximum servicing capacity (based on
UTILIZATION, RATE or CONNECTION).
- A setting of 0 means the group is completely drained, offering 0% of its
available Capacity. Valid range is [0.0,1.0].
required: false
type: str
description: description:
description: description:
- An optional description of this resource. - An optional description of this resource.
@ -81,46 +78,76 @@ options:
type: str type: str
group: group:
description: description:
- The fully-qualified URL of an Instance Group. This defines the list of instances - The fully-qualified URL of an Instance Group or Network Endpoint Group resource.
that serve traffic. Member virtual machine instances from each instance In case of instance group this defines the list of instances that serve
group must live in the same zone as the instance group itself. No two backends traffic. Member virtual machine instances from each instance group must
in a backend service are allowed to use same Instance Group resource. live in the same zone as the instance group itself. No two backends in a
- Note that you must specify an Instance Group resource using the fully-qualified backend service are allowed to use same Instance Group resource.
URL, rather than a partial URL. - For Network Endpoint Groups this defines list of endpoints. All endpoints
- The instance group must be within the same region as the BackendService. of Network Endpoint Group must be hosted on instances located in the same
zone as the Network Endpoint Group.
- Backend services cannot mix Instance Group and Network Endpoint Group backends.
- When the `load_balancing_scheme` is INTERNAL, only instance groups are supported.
- Note that you must specify an Instance Group or Network Endpoint Group resource
using the fully-qualified URL, rather than a partial URL.
required: true
type: str
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 one of maxConnectionsPerInstance
or maxConnectionsPerEndpoint, as appropriate for group type, must be set.
required: false
type: int
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.
required: false
type: int
max_connections_per_endpoint:
description:
- The max number of simultaneous connections that a single backend network
endpoint 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 maxConnectionsPerEndpoint
must be set.
required: false
type: int
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. Either maxRate or one of maxRatePerInstance or maxRatePerEndpoint,
as appropriate for group type, must be set.
required: false
type: int
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.
required: false
type: str
max_rate_per_endpoint:
description:
- The max requests per second (RPS) that a single backend network endpoint
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 maxRatePerEndpoint
must be set.
required: false
type: str
max_utilization:
description:
- Used when balancingMode is UTILIZATION. This ratio defines the CPU utilization
target for the group. Valid range is [0.0, 1.0].
required: false required: false
type: str type: str
description:
description:
- An optional description of this resource.
required: false
type: str
protocol:
description:
- The protocol this BackendService uses to communicate with backends.
- The possible values are TCP and UDP, and the default is TCP.
- 'Some valid choices include: "HTTP", "HTTPS", "HTTP2", "SSL", "TCP", "UDP"'
required: false
type: str
session_affinity:
description:
- Type of session affinity to use. The default is NONE.
- Can be NONE, CLIENT_IP, CLIENT_IP_PROTO, or CLIENT_IP_PORT_PROTO.
- When the protocol is UDP, this field is not used.
- 'Some valid choices include: "NONE", "CLIENT_IP", "CLIENT_IP_PROTO", "CLIENT_IP_PORT_PROTO"'
required: false
type: str
region:
description:
- The region where the regional backend service resides.
required: false
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].
required: false
type: int
connection_draining: connection_draining:
description: description:
- Settings for connection draining . - Settings for connection draining .
@ -132,15 +159,67 @@ options:
- Time for which instance will be drained (not accept new connections, but - Time for which instance will be drained (not accept new connections, but
still work to finish started). still work to finish started).
required: false required: false
default: '300'
type: int type: int
description:
description:
- An optional description of this resource.
required: false
type: str
health_checks:
description:
- The set of URLs to HealthCheck resources for health checking this RegionBackendService.
Currently at most one health check can be specified, and a health check is required.
required: true
type: list
load_balancing_scheme: load_balancing_scheme:
description: description:
- This signifies what the ForwardingRule will be used for and can only be INTERNAL - Indicates what kind of load balancing this regional backend service will be
for RegionBackendServices . used for. A backend service created for one type of load balancing cannot be
- 'Some valid choices include: "INTERNAL"' used with the other(s). Must be `INTERNAL` or `INTERNAL_MANAGED`. Defaults to
`INTERNAL`.
- 'Some valid choices include: "INTERNAL", "INTERNAL_MANAGED"'
required: false required: false
default: INTERNAL default: INTERNAL
type: str type: str
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.
required: true
type: str
protocol:
description:
- The protocol this RegionBackendService uses to communicate with backends.
- 'Possible values are HTTP, HTTPS, HTTP2, SSL, TCP, and UDP. The default is HTTP.
**NOTE**: HTTP2 is only valid for beta HTTP/2 load balancer types and may result
in errors if used with the GA API.'
- 'Some valid choices include: "HTTP", "HTTPS", "HTTP2", "SSL", "TCP", "UDP"'
required: false
type: str
session_affinity:
description:
- Type of session affinity to use. The default is NONE. Session affinity is not
applicable if the protocol is UDP.
- 'Some valid choices include: "NONE", "CLIENT_IP", "CLIENT_IP_PORT_PROTO", "CLIENT_IP_PROTO",
"GENERATED_COOKIE", "HEADER_FIELD", "HTTP_COOKIE"'
required: false
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].
required: false
type: int
region:
description:
- A reference to the region where the regional backend service resides.
required: true
type: str
project: project:
description: description:
- The Google Cloud Platform project to use. - The Google Cloud Platform project to use.
@ -224,28 +303,25 @@ EXAMPLES = '''
''' '''
RETURN = ''' RETURN = '''
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
healthChecks:
description:
- The list of HealthChecks for checking the health of the backend service.
- Currently at most one health check can be specified, and a health check is required.
returned: success
type: list
backends: backends:
description: description:
- The list of backends that serve this RegionBackendService. - The set of backends that serve this RegionBackendService.
returned: success returned: success
type: complex type: complex
contains: contains:
balancingMode:
description:
- Specifies the balancing mode for this backend. Defaults to CONNECTION.
returned: success
type: str
capacityScaler:
description:
- A multiplier applied to the group's maximum servicing capacity (based on UTILIZATION,
RATE or CONNECTION).
- A setting of 0 means the group is completely drained, offering 0% of its available
Capacity. Valid range is [0.0,1.0].
returned: success
type: str
description: description:
description: description:
- An optional description of this resource. - An optional description of this resource.
@ -254,50 +330,76 @@ backends:
type: str type: str
group: group:
description: description:
- The fully-qualified URL of an Instance Group. This defines the list of instances - The fully-qualified URL of an Instance Group or Network Endpoint Group resource.
that serve traffic. Member virtual machine instances from each instance group In case of instance group this defines the list of instances that serve traffic.
must live in the same zone as the instance group itself. No two backends in Member virtual machine instances from each instance group must live in the
a backend service are allowed to use same Instance Group resource. same zone as the instance group itself. No two backends in a backend service
- Note that you must specify an Instance Group resource using the fully-qualified are allowed to use same Instance Group resource.
URL, rather than a partial URL. - For Network Endpoint Groups this defines list of endpoints. All endpoints
- The instance group must be within the same region as the BackendService. of Network Endpoint Group must be hosted on instances located in the same
zone as the Network Endpoint Group.
- Backend services cannot mix Instance Group and Network Endpoint Group backends.
- When the `load_balancing_scheme` is INTERNAL, only instance groups are supported.
- Note that you must specify an Instance Group or Network Endpoint Group resource
using the fully-qualified URL, rather than a partial URL.
returned: success
type: str
maxConnections:
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 one of maxConnectionsPerInstance
or maxConnectionsPerEndpoint, as appropriate for group type, must be set.
returned: success
type: int
maxConnectionsPerInstance:
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.
returned: success
type: int
maxConnectionsPerEndpoint:
description:
- The max number of simultaneous connections that a single backend network endpoint
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 maxConnectionsPerEndpoint must
be set.
returned: success
type: int
maxRate:
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. Either maxRate or one of maxRatePerInstance or maxRatePerEndpoint,
as appropriate for group type, must be set.
returned: success
type: int
maxRatePerInstance:
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.
returned: success
type: str
maxRatePerEndpoint:
description:
- The max requests per second (RPS) that a single backend network endpoint 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 maxRatePerEndpoint
must be set.
returned: success
type: str
maxUtilization:
description:
- Used when balancingMode is UTILIZATION. This ratio defines the CPU utilization
target for the group. Valid range is [0.0, 1.0].
returned: success returned: success
type: str type: str
description:
description:
- An optional description of this resource.
returned: success
type: str
fingerprint:
description:
- Fingerprint of this resource. A hash of the contents stored in this object. This
field is used in optimistic locking.
returned: success
type: str
protocol:
description:
- The protocol this BackendService uses to communicate with backends.
- The possible values are TCP and UDP, and the default is TCP.
returned: success
type: str
sessionAffinity:
description:
- Type of session affinity to use. The default is NONE.
- 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
region:
description:
- The region where the regional backend service resides.
returned: success
type: str
timeoutSec:
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
connectionDraining: connectionDraining:
description: description:
- Settings for connection draining . - Settings for connection draining .
@ -310,10 +412,73 @@ connectionDraining:
work to finish started). work to finish started).
returned: success returned: success
type: int type: int
creationTimestamp:
description:
- Creation timestamp in RFC3339 text format.
returned: success
type: str
description:
description:
- An optional description of this resource.
returned: success
type: str
fingerprint:
description:
- Fingerprint of this resource. A hash of the contents stored in this object. This
field is used in optimistic locking.
returned: success
type: str
healthChecks:
description:
- The set of URLs to HealthCheck resources for health checking this RegionBackendService.
Currently at most one health check can be specified, and a health check is required.
returned: success
type: list
id:
description:
- The unique identifier for the resource.
returned: success
type: int
loadBalancingScheme: loadBalancingScheme:
description: description:
- This signifies what the ForwardingRule will be used for and can only be INTERNAL - Indicates what kind of load balancing this regional backend service will be used
for RegionBackendServices . for. A backend service created for one type of load balancing cannot be used with
the other(s). Must be `INTERNAL` or `INTERNAL_MANAGED`. Defaults to `INTERNAL`.
returned: success
type: str
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
protocol:
description:
- The protocol this RegionBackendService uses to communicate with backends.
- 'Possible values are HTTP, HTTPS, HTTP2, SSL, TCP, and UDP. The default is HTTP.
**NOTE**: HTTP2 is only valid for beta HTTP/2 load balancer types and may result
in errors if used with the GA API.'
returned: success
type: str
sessionAffinity:
description:
- Type of session affinity to use. The default is NONE. Session affinity is not
applicable if the protocol is UDP.
returned: success
type: str
timeoutSec:
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
region:
description:
- A reference to the region where the regional backend service resides.
returned: success returned: success
type: str type: str
''' '''
@ -331,7 +496,6 @@ from ansible_collections.google.cloud.plugins.module_utils.gcp_utils import (
replace_resource_dict, replace_resource_dict,
) )
import json import json
import re
import time import time
################################################################################ ################################################################################
@ -345,16 +509,32 @@ def main():
module = GcpModule( module = GcpModule(
argument_spec=dict( argument_spec=dict(
state=dict(default='present', choices=['present', 'absent'], type='str'), state=dict(default='present', choices=['present', 'absent'], type='str'),
name=dict(required=True, type='str'), backends=dict(
health_checks=dict(required=True, type='list', elements='str'), type='list',
backends=dict(type='list', elements='dict', options=dict(description=dict(type='str'), group=dict(type='str'))), elements='dict',
options=dict(
balancing_mode=dict(default='CONNECTION', type='str'),
capacity_scaler=dict(type='str'),
description=dict(type='str'),
group=dict(required=True, type='str'),
max_connections=dict(type='int'),
max_connections_per_instance=dict(type='int'),
max_connections_per_endpoint=dict(type='int'),
max_rate=dict(type='int'),
max_rate_per_instance=dict(type='str'),
max_rate_per_endpoint=dict(type='str'),
max_utilization=dict(type='str'),
),
),
connection_draining=dict(type='dict', options=dict(draining_timeout_sec=dict(default=300, type='int'))),
description=dict(type='str'), description=dict(type='str'),
health_checks=dict(required=True, type='list', elements='str'),
load_balancing_scheme=dict(default='INTERNAL', type='str'),
name=dict(required=True, type='str'),
protocol=dict(type='str'), protocol=dict(type='str'),
session_affinity=dict(type='str'), session_affinity=dict(type='str'),
region=dict(type='str'),
timeout_sec=dict(type='int'), timeout_sec=dict(type='int'),
connection_draining=dict(type='dict', options=dict(draining_timeout_sec=dict(type='int'))), region=dict(required=True, type='str'),
load_balancing_scheme=dict(default='INTERNAL', type='str'),
) )
) )
@ -407,16 +587,15 @@ def delete(module, link, kind):
def resource_to_request(module): def resource_to_request(module):
request = { request = {
u'kind': 'compute#backendService', u'kind': 'compute#backendService',
u'name': module.params.get('name'),
u'healthChecks': module.params.get('health_checks'),
u'backends': RegionBackendServiceBackendsArray(module.params.get('backends', []), module).to_request(), u'backends': RegionBackendServiceBackendsArray(module.params.get('backends', []), module).to_request(),
u'connectionDraining': RegionBackendServiceConnectiondraining(module.params.get('connection_draining', {}), module).to_request(),
u'description': module.params.get('description'), u'description': module.params.get('description'),
u'healthChecks': module.params.get('health_checks'),
u'loadBalancingScheme': module.params.get('load_balancing_scheme'),
u'name': module.params.get('name'),
u'protocol': module.params.get('protocol'), u'protocol': module.params.get('protocol'),
u'sessionAffinity': module.params.get('session_affinity'), u'sessionAffinity': module.params.get('session_affinity'),
u'region': region_selflink(module.params.get('region'), module.params),
u'timeoutSec': module.params.get('timeout_sec'), u'timeoutSec': module.params.get('timeout_sec'),
u'connectionDraining': RegionBackendServiceConnectiondraining(module.params.get('connection_draining', {}), module).to_request(),
u'loadBalancingScheme': module.params.get('load_balancing_scheme'),
} }
return_vals = {} return_vals = {}
for k, v in request.items(): for k, v in request.items():
@ -482,29 +661,21 @@ def is_different(module, response):
# This is for doing comparisons with Ansible's current parameters. # This is for doing comparisons with Ansible's current parameters.
def response_to_hash(module, response): def response_to_hash(module, response):
return { return {
u'name': module.params.get('name'),
u'healthChecks': response.get(u'healthChecks'),
u'backends': RegionBackendServiceBackendsArray(response.get(u'backends', []), module).from_response(), u'backends': RegionBackendServiceBackendsArray(response.get(u'backends', []), module).from_response(),
u'connectionDraining': RegionBackendServiceConnectiondraining(response.get(u'connectionDraining', {}), module).from_response(),
u'creationTimestamp': response.get(u'creationTimestamp'),
u'description': response.get(u'description'), u'description': response.get(u'description'),
u'fingerprint': response.get(u'fingerprint'), u'fingerprint': response.get(u'fingerprint'),
u'healthChecks': response.get(u'healthChecks'),
u'id': response.get(u'id'),
u'loadBalancingScheme': module.params.get('load_balancing_scheme'),
u'name': module.params.get('name'),
u'protocol': response.get(u'protocol'), u'protocol': response.get(u'protocol'),
u'sessionAffinity': response.get(u'sessionAffinity'), u'sessionAffinity': response.get(u'sessionAffinity'),
u'region': region_selflink(module.params.get('region'), module.params),
u'timeoutSec': response.get(u'timeoutSec'), u'timeoutSec': response.get(u'timeoutSec'),
u'connectionDraining': RegionBackendServiceConnectiondraining(response.get(u'connectionDraining', {}), module).from_response(),
u'loadBalancingScheme': response.get(u'loadBalancingScheme'),
} }
def region_selflink(name, params):
if name is None:
return
url = r"https://www.googleapis.com/compute/v1/projects/.*/regions/.*"
if not re.match(url, name):
name = "https://www.googleapis.com/compute/v1/projects/{project}/regions/%s".format(**params) % name
return name
def async_op_url(module, extra_data=None): def async_op_url(module, extra_data=None):
if extra_data is None: if extra_data is None:
extra_data = {} extra_data = {}
@ -561,10 +732,38 @@ class RegionBackendServiceBackendsArray(object):
return items return items
def _request_for_item(self, item): def _request_for_item(self, item):
return remove_nones_from_dict({u'description': item.get('description'), u'group': item.get('group')}) return remove_nones_from_dict(
{
u'balancingMode': item.get('balancing_mode'),
u'capacityScaler': item.get('capacity_scaler'),
u'description': item.get('description'),
u'group': item.get('group'),
u'maxConnections': item.get('max_connections'),
u'maxConnectionsPerInstance': item.get('max_connections_per_instance'),
u'maxConnectionsPerEndpoint': item.get('max_connections_per_endpoint'),
u'maxRate': item.get('max_rate'),
u'maxRatePerInstance': item.get('max_rate_per_instance'),
u'maxRatePerEndpoint': item.get('max_rate_per_endpoint'),
u'maxUtilization': item.get('max_utilization'),
}
)
def _response_from_item(self, item): def _response_from_item(self, item):
return remove_nones_from_dict({u'description': item.get(u'description'), u'group': item.get(u'group')}) return remove_nones_from_dict(
{
u'balancingMode': item.get(u'balancingMode'),
u'capacityScaler': item.get(u'capacityScaler'),
u'description': item.get(u'description'),
u'group': item.get(u'group'),
u'maxConnections': item.get(u'maxConnections'),
u'maxConnectionsPerInstance': item.get(u'maxConnectionsPerInstance'),
u'maxConnectionsPerEndpoint': item.get(u'maxConnectionsPerEndpoint'),
u'maxRate': item.get(u'maxRate'),
u'maxRatePerInstance': item.get(u'maxRatePerInstance'),
u'maxRatePerEndpoint': item.get(u'maxRatePerEndpoint'),
u'maxUtilization': item.get(u'maxUtilization'),
}
)
class RegionBackendServiceConnectiondraining(object): class RegionBackendServiceConnectiondraining(object):

View file

@ -48,8 +48,8 @@ options:
type: list type: list
region: region:
description: description:
- The region where the regional backend service resides. - A reference to the region where the regional backend service resides.
required: false required: true
type: str type: str
project: project:
description: description:
@ -118,29 +118,25 @@ resources:
returned: always returned: always
type: complex type: complex
contains: contains:
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
healthChecks:
description:
- The list of HealthChecks for checking the health of the backend service.
- Currently at most one health check can be specified, and a health check is
required.
returned: success
type: list
backends: backends:
description: description:
- The list of backends that serve this RegionBackendService. - The set of backends that serve this RegionBackendService.
returned: success returned: success
type: complex type: complex
contains: contains:
balancingMode:
description:
- Specifies the balancing mode for this backend. Defaults to CONNECTION.
returned: success
type: str
capacityScaler:
description:
- A multiplier applied to the group's maximum servicing capacity (based
on UTILIZATION, RATE or CONNECTION).
- A setting of 0 means the group is completely drained, offering 0% of its
available Capacity. Valid range is [0.0,1.0].
returned: success
type: str
description: description:
description: description:
- An optional description of this resource. - An optional description of this resource.
@ -149,51 +145,78 @@ resources:
type: str type: str
group: group:
description: description:
- The fully-qualified URL of an Instance Group. This defines the list of - The fully-qualified URL of an Instance Group or Network Endpoint Group
instances that serve traffic. Member virtual machine instances from each resource. In case of instance group this defines the list of instances
instance group must live in the same zone as the instance group itself. that serve traffic. Member virtual machine instances from each instance
No two backends in a backend service are allowed to use same Instance group must live in the same zone as the instance group itself. No two
Group resource. backends in a backend service are allowed to use same Instance Group resource.
- Note that you must specify an Instance Group resource using the fully-qualified - For Network Endpoint Groups this defines list of endpoints. All endpoints
URL, rather than a partial URL. of Network Endpoint Group must be hosted on instances located in the same
- The instance group must be within the same region as the BackendService. zone as the Network Endpoint Group.
- Backend services cannot mix Instance Group and Network Endpoint Group
backends.
- When the `load_balancing_scheme` is INTERNAL, only instance groups are
supported.
- Note that you must specify an Instance Group or Network Endpoint Group
resource using the fully-qualified URL, rather than a partial URL.
returned: success
type: str
maxConnections:
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 one of maxConnectionsPerInstance
or maxConnectionsPerEndpoint, as appropriate for group type, must be set.
returned: success
type: int
maxConnectionsPerInstance:
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.
returned: success
type: int
maxConnectionsPerEndpoint:
description:
- The max number of simultaneous connections that a single backend network
endpoint 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 maxConnectionsPerEndpoint
must be set.
returned: success
type: int
maxRate:
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. Either maxRate or one of maxRatePerInstance or maxRatePerEndpoint,
as appropriate for group type, must be set.
returned: success
type: int
maxRatePerInstance:
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.
returned: success
type: str
maxRatePerEndpoint:
description:
- The max requests per second (RPS) that a single backend network endpoint
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 maxRatePerEndpoint
must be set.
returned: success
type: str
maxUtilization:
description:
- Used when balancingMode is UTILIZATION. This ratio defines the CPU utilization
target for the group. Valid range is [0.0, 1.0].
returned: success returned: success
type: str type: str
description:
description:
- An optional description of this resource.
returned: success
type: str
fingerprint:
description:
- Fingerprint of this resource. A hash of the contents stored in this object.
This field is used in optimistic locking.
returned: success
type: str
protocol:
description:
- The protocol this BackendService uses to communicate with backends.
- The possible values are TCP and UDP, and the default is TCP.
returned: success
type: str
sessionAffinity:
description:
- Type of session affinity to use. The default is NONE.
- 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
region:
description:
- The region where the regional backend service resides.
returned: success
type: str
timeoutSec:
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
connectionDraining: connectionDraining:
description: description:
- Settings for connection draining . - Settings for connection draining .
@ -206,10 +229,75 @@ resources:
still work to finish started). still work to finish started).
returned: success returned: success
type: int type: int
creationTimestamp:
description:
- Creation timestamp in RFC3339 text format.
returned: success
type: str
description:
description:
- An optional description of this resource.
returned: success
type: str
fingerprint:
description:
- Fingerprint of this resource. A hash of the contents stored in this object.
This field is used in optimistic locking.
returned: success
type: str
healthChecks:
description:
- The set of URLs to HealthCheck resources for health checking this RegionBackendService.
Currently at most one health check can be specified, and a health check is
required.
returned: success
type: list
id:
description:
- The unique identifier for the resource.
returned: success
type: int
loadBalancingScheme: loadBalancingScheme:
description: description:
- This signifies what the ForwardingRule will be used for and can only be INTERNAL - Indicates what kind of load balancing this regional backend service will be
for RegionBackendServices . used for. A backend service created for one type of load balancing cannot
be used with the other(s). Must be `INTERNAL` or `INTERNAL_MANAGED`. Defaults
to `INTERNAL`.
returned: success
type: str
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
protocol:
description:
- The protocol this RegionBackendService uses to communicate with backends.
- 'Possible values are HTTP, HTTPS, HTTP2, SSL, TCP, and UDP. The default is
HTTP. **NOTE**: HTTP2 is only valid for beta HTTP/2 load balancer types and
may result in errors if used with the GA API.'
returned: success
type: str
sessionAffinity:
description:
- Type of session affinity to use. The default is NONE. Session affinity is
not applicable if the protocol is UDP.
returned: success
type: str
timeoutSec:
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
region:
description:
- A reference to the region where the regional backend service resides.
returned: success returned: success
type: str type: str
''' '''
@ -226,7 +314,7 @@ import json
def main(): def main():
module = GcpModule(argument_spec=dict(filters=dict(type='list', elements='str'), region=dict(type='str'))) module = GcpModule(argument_spec=dict(filters=dict(type='list', elements='str'), region=dict(required=True, type='str')))
if not module.params['scopes']: if not module.params['scopes']:
module.params['scopes'] = ['https://www.googleapis.com/auth/compute'] module.params['scopes'] = ['https://www.googleapis.com/auth/compute']