ansible-collections/google.cloud
1
0
Fork 0
mirror of https://github.com/ansible-collections/google.cloud.git synced 2025-04-09 04:10:27 -07:00
Code Issues Projects Releases Packages Wiki Activity Actions 1

Update BackendService docs to reflect being GLB only (#237)

Browse source 
Signed-off-by: Modular Magician <magic-modules@google.com>
This commit is contained in:
The Magician 2019-04-30 14:36:32 -07:00 • committed by Alex Stephen
parent c301d3b4ae
commit 4e2574414e
2 changed files with 12 additions and 65 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

56
plugins/modules/gcp_compute_backend_service.py
View file

@ -31,8 +31,9 @@ DOCUMENTATION = '''
--- ---
module: gcp_compute_backend_service module: gcp_compute_backend_service
description: description:
- Creates a BackendService resource in the specified project using the data included - A Backend Service defines a group of virtual machines that will serve traffic for
in the request. load balancing. This resource is a global backend service, appropriate for external
load balancing. For internal load balancing, use a regional backend service instead.
short_description: Creates a GCP BackendService short_description: Creates a GCP BackendService
version_added: 2.6 version_added: 2.6
author: Google Inc. (@googlecloudplatform) author: Google Inc. (@googlecloudplatform)
@ -65,7 +66,6 @@ options:
- Specifies the balancing mode for this backend. - Specifies the balancing mode for this backend.
- For global HTTP(S) or TCP/SSL load balancing, the default is UTILIZATION. - For global HTTP(S) or TCP/SSL load balancing, the default is UTILIZATION.
Valid values are UTILIZATION, RATE (for HTTP(S)) and CONNECTION (for TCP/SSL). Valid values are UTILIZATION, RATE (for HTTP(S)) and CONNECTION (for TCP/SSL).
- This cannot be used for internal load balancing.
required: false required: false
default: UTILIZATION default: UTILIZATION
choices: choices:
@ -80,7 +80,6 @@ options:
capacity (depending on balancingMode). A setting of 0 means the group is capacity (depending on balancingMode). A setting of 0 means the group is
completely drained, offering 0% of its available Capacity. Valid range is completely drained, offering 0% of its available Capacity. Valid range is
[0.0,1.0]. [0.0,1.0].
- This cannot be used for internal load balancing.
required: false required: false
default: '1.0' default: '1.0'
description: description:
@ -102,9 +101,6 @@ options:
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.
- When the BackendService has load balancing scheme INTERNAL, the instance
group must be within the same region as the BackendService. Network Endpoint
Groups are not supported for INTERNAL load balancing scheme.
required: false required: false
max_connections: max_connections:
description: description:
@ -112,7 +108,6 @@ options:
either CONNECTION or UTILIZATION balancing modes. either CONNECTION or UTILIZATION balancing modes.
- For CONNECTION mode, either maxConnections or maxConnectionsPerInstance - For CONNECTION mode, either maxConnections or maxConnectionsPerInstance
must be set. must be set.
- This cannot be used for internal load balancing.
required: false required: false
max_connections_per_instance: max_connections_per_instance:
description: description:
@ -121,7 +116,6 @@ options:
used in either CONNECTION or UTILIZATION balancing modes. used in either CONNECTION or UTILIZATION balancing modes.
- For CONNECTION mode, either maxConnections or maxConnectionsPerInstance - For CONNECTION mode, either maxConnections or maxConnectionsPerInstance
must be set. must be set.
- This cannot be used for internal load balancing.
required: false required: false
max_rate: max_rate:
description: description:
@ -129,7 +123,6 @@ options:
- Can be used with either RATE or UTILIZATION balancing modes, but required - Can be used with either RATE or UTILIZATION balancing modes, but required
if RATE mode. For RATE mode, either maxRate or maxRatePerInstance must be if RATE mode. For RATE mode, either maxRate or maxRatePerInstance must be
set. set.
- This cannot be used for internal load balancing.
required: false required: false
max_rate_per_instance: max_rate_per_instance:
description: description:
@ -137,13 +130,11 @@ options:
This is used to calculate the capacity of the group. Can be used in either 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 balancing mode. For RATE mode, either maxRate or maxRatePerInstance must
be set. be set.
- This cannot be used for internal load balancing.
required: false required: false
max_utilization: max_utilization:
description: description:
- Used when balancingMode is UTILIZATION. This ratio defines the CPU utilization - Used when balancingMode is UTILIZATION. This ratio defines the CPU utilization
target for the group. The default is 0.8. Valid range is [0.0, 1.0]. target for the group. The default is 0.8. Valid range is [0.0, 1.0].
- This cannot be used for internal load balancing.
required: false required: false
default: '0.8' default: '0.8'
cdn_policy: cdn_policy:
@ -218,7 +209,6 @@ options:
enable_cdn: enable_cdn:
description: description:
- If true, enable Cloud CDN for this BackendService. - If true, enable Cloud CDN for this BackendService.
- When the load balancing scheme is INTERNAL, this field is not used.
required: false required: false
type: bool type: bool
health_checks: health_checks:
@ -226,8 +216,6 @@ options:
- The list of URLs to the HttpHealthCheck or HttpsHealthCheck resource for health - The list of URLs to the HttpHealthCheck or HttpsHealthCheck resource for health
checking this BackendService. Currently at most one health check can be specified, checking this BackendService. Currently at most one health check can be specified,
and a health check is required. and a health check is required.
- For internal load balancing, a URL to a HealthCheck resource must be specified
instead.
required: true required: true
iap: iap:
description: description:
@ -252,12 +240,12 @@ options:
description: description:
- Indicates whether the backend service will be used with internal or external - Indicates whether the backend service will be used with internal or external
load balancing. A backend service created for one type of load balancing cannot load balancing. A backend service created for one type of load balancing cannot
be used with the other. One of `INTERNAL` or `EXTERNAL`. Defaults to `EXTERNAL`. be used with the other. Must be `EXTERNAL` for a global backend service. Defaults
to `EXTERNAL`.
required: false required: false
default: EXTERNAL default: EXTERNAL
version_added: 2.7 version_added: 2.7
choices: choices:
- INTERNAL
- EXTERNAL - EXTERNAL
name: name:
description: description:
@ -272,14 +260,11 @@ options:
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
by this service. Required when the load balancing scheme is EXTERNAL. by this service. Required when the load balancing scheme is EXTERNAL.
- When the load balancing scheme is INTERNAL, this field is not used.
required: false required: false
protocol: protocol:
description: description:
- The protocol this BackendService uses to communicate with backends. - The protocol this BackendService uses to communicate with backends.
- Possible values are HTTP, HTTPS, TCP, and SSL. The default is HTTP. - Possible values are HTTP, HTTPS, TCP, and SSL. The default is HTTP.
- For internal load balancing, the possible values are TCP and UDP, and the default
is TCP.
required: false required: false
choices: choices:
- HTTP - HTTP
@ -295,16 +280,12 @@ options:
description: description:
- Type of session affinity to use. The default is NONE. - Type of session affinity to use. The default is NONE.
- When the load balancing scheme is EXTERNAL, can be NONE, CLIENT_IP, or GENERATED_COOKIE. - When the load balancing scheme is EXTERNAL, can be NONE, CLIENT_IP, or GENERATED_COOKIE.
- When the load balancing scheme is INTERNAL, can be NONE, CLIENT_IP, CLIENT_IP_PROTO,
or CLIENT_IP_PORT_PROTO.
- When the protocol is UDP, this field is not used. - When the protocol is UDP, this field is not used.
required: false required: false
choices: choices:
- NONE - NONE
- CLIENT_IP - CLIENT_IP
- GENERATED_COOKIE - GENERATED_COOKIE
- CLIENT_IP_PROTO
- CLIENT_IP_PORT_PROTO
timeout_sec: timeout_sec:
description: description:
- How many seconds to wait for the backend before considering it a failed request. - How many seconds to wait for the backend before considering it a failed request.
@ -376,7 +357,6 @@ backends:
- Specifies the balancing mode for this backend. - Specifies the balancing mode for this backend.
- For global HTTP(S) or TCP/SSL load balancing, the default is UTILIZATION. - For global HTTP(S) or TCP/SSL load balancing, the default is UTILIZATION.
Valid values are UTILIZATION, RATE (for HTTP(S)) and CONNECTION (for TCP/SSL). Valid values are UTILIZATION, RATE (for HTTP(S)) and CONNECTION (for TCP/SSL).
- This cannot be used for internal load balancing.
returned: success returned: success
type: str type: str
capacityScaler: capacityScaler:
@ -386,7 +366,6 @@ backends:
- Default value is 1, which means the group will serve up to 100% of its configured - Default value is 1, which means the group will serve up to 100% of its configured
capacity (depending on balancingMode). A setting of 0 means the group is completely capacity (depending on balancingMode). A setting of 0 means the group is completely
drained, offering 0% of its available Capacity. Valid range is [0.0,1.0]. drained, offering 0% of its available Capacity. Valid range is [0.0,1.0].
- This cannot be used for internal load balancing.
returned: success returned: success
type: str type: str
description: description:
@ -409,9 +388,6 @@ backends:
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.
- When the BackendService has load balancing scheme INTERNAL, the instance group
must be within the same region as the BackendService. Network Endpoint Groups
are not supported for INTERNAL load balancing scheme.
returned: success returned: success
type: str type: str
maxConnections: maxConnections:
@ -420,7 +396,6 @@ backends:
either CONNECTION or UTILIZATION balancing modes. either CONNECTION or UTILIZATION balancing modes.
- For CONNECTION mode, either maxConnections or maxConnectionsPerInstance must - For CONNECTION mode, either maxConnections or maxConnectionsPerInstance must
be set. be set.
- This cannot be used for internal load balancing.
returned: success returned: success
type: int type: int
maxConnectionsPerInstance: maxConnectionsPerInstance:
@ -430,7 +405,6 @@ backends:
in either CONNECTION or UTILIZATION balancing modes. in either CONNECTION or UTILIZATION balancing modes.
- For CONNECTION mode, either maxConnections or maxConnectionsPerInstance must - For CONNECTION mode, either maxConnections or maxConnectionsPerInstance must
be set. be set.
- This cannot be used for internal load balancing.
returned: success returned: success
type: int type: int
maxRate: maxRate:
@ -439,7 +413,6 @@ backends:
- Can be used with either RATE or UTILIZATION balancing modes, but required - Can be used with either RATE or UTILIZATION balancing modes, but required
if RATE mode. For RATE mode, either maxRate or maxRatePerInstance must be if RATE mode. For RATE mode, either maxRate or maxRatePerInstance must be
set. set.
- This cannot be used for internal load balancing.
returned: success returned: success
type: int type: int
maxRatePerInstance: maxRatePerInstance:
@ -448,14 +421,12 @@ backends:
This is used to calculate the capacity of the group. Can be used in either 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 balancing mode. For RATE mode, either maxRate or maxRatePerInstance must be
set. set.
- This cannot be used for internal load balancing.
returned: success returned: success
type: str type: str
maxUtilization: maxUtilization:
description: description:
- Used when balancingMode is UTILIZATION. This ratio defines the CPU utilization - Used when balancingMode is UTILIZATION. This ratio defines the CPU utilization
target for the group. The default is 0.8. Valid range is [0.0, 1.0]. target for the group. The default is 0.8. Valid range is [0.0, 1.0].
- This cannot be used for internal load balancing.
returned: success returned: success
type: str type: str
cdnPolicy: cdnPolicy:
@ -546,7 +517,6 @@ description:
enableCDN: enableCDN:
description: description:
- If true, enable Cloud CDN for this BackendService. - If true, enable Cloud CDN for this BackendService.
- When the load balancing scheme is INTERNAL, this field is not used.
returned: success returned: success
type: bool type: bool
healthChecks: healthChecks:
@ -554,8 +524,6 @@ healthChecks:
- The list of URLs to the HttpHealthCheck or HttpsHealthCheck resource for health - The list of URLs to the HttpHealthCheck or HttpsHealthCheck resource for health
checking this BackendService. Currently at most one health check can be specified, checking this BackendService. Currently at most one health check can be specified,
and a health check is required. and a health check is required.
- For internal load balancing, a URL to a HealthCheck resource must be specified
instead.
returned: success returned: success
type: list type: list
id: id:
@ -593,7 +561,8 @@ loadBalancingScheme:
description: description:
- Indicates whether the backend service will be used with internal or external load - Indicates whether the backend service will be used with internal or external load
balancing. A backend service created for one type of load balancing cannot be balancing. A backend service created for one type of load balancing cannot be
used with the other. One of `INTERNAL` or `EXTERNAL`. Defaults to `EXTERNAL`. used with the other. Must be `EXTERNAL` for a global backend service. Defaults
to `EXTERNAL`.
returned: success returned: success
type: str type: str
name: name:
@ -610,15 +579,12 @@ 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
by this service. Required when the load balancing scheme is EXTERNAL. by this service. Required when the load balancing scheme is EXTERNAL.
- When the load balancing scheme is INTERNAL, this field is not used.
returned: success returned: success
type: str type: str
protocol: protocol:
description: description:
- The protocol this BackendService uses to communicate with backends. - The protocol this BackendService uses to communicate with backends.
- Possible values are HTTP, HTTPS, TCP, and SSL. The default is HTTP. - Possible values are HTTP, HTTPS, TCP, and SSL. The default is HTTP.
- For internal load balancing, the possible values are TCP and UDP, and the default
is TCP.
returned: success returned: success
type: str type: str
securityPolicy: securityPolicy:
@ -630,8 +596,6 @@ sessionAffinity:
description: description:
- Type of session affinity to use. The default is NONE. - Type of session affinity to use. The default is NONE.
- When the load balancing scheme is EXTERNAL, can be NONE, CLIENT_IP, or GENERATED_COOKIE. - When the load balancing scheme is EXTERNAL, can be NONE, CLIENT_IP, or GENERATED_COOKIE.
- When the load balancing scheme is INTERNAL, can be NONE, CLIENT_IP, CLIENT_IP_PROTO,
or CLIENT_IP_PORT_PROTO.
- When the protocol is UDP, this field is not used. - When the protocol is UDP, this field is not used.
returned: success returned: success
type: str type: str
@ -702,12 +666,12 @@ def main():
type='dict', type='dict',
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', choices=['INTERNAL', 'EXTERNAL']), load_balancing_scheme=dict(default='EXTERNAL', type='str', choices=['EXTERNAL']),
name=dict(required=True, type='str'), name=dict(required=True, type='str'),
port_name=dict(type='str'), port_name=dict(type='str'),
protocol=dict(type='str', choices=['HTTP', 'HTTPS', 'TCP', 'SSL']), protocol=dict(type='str', choices=['HTTP', 'HTTPS', 'TCP', 'SSL']),
security_policy=dict(type='str'), security_policy=dict(type='str'),
session_affinity=dict(type='str', choices=['NONE', 'CLIENT_IP', 'GENERATED_COOKIE', 'CLIENT_IP_PROTO', 'CLIENT_IP_PORT_PROTO']), session_affinity=dict(type='str', choices=['NONE', 'CLIENT_IP', 'GENERATED_COOKIE']),
timeout_sec=dict(type='int', aliases=['timeout_seconds']), timeout_sec=dict(type='int', aliases=['timeout_seconds']),
) )
) )
@ -866,7 +830,7 @@ def response_to_hash(module, response):
u'healthChecks': response.get(u'healthChecks'), u'healthChecks': response.get(u'healthChecks'),
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': response.get(u'loadBalancingScheme'), u'loadBalancingScheme': module.params.get('load_balancing_scheme'),
u'name': module.params.get('name'), u'name': module.params.get('name'),
u'portName': response.get(u'portName'), u'portName': response.get(u'portName'),
u'protocol': response.get(u'protocol'), u'protocol': response.get(u'protocol'),

21
plugins/modules/gcp_compute_backend_service_facts.py
View file

@ -85,7 +85,6 @@ resources:
- Specifies the balancing mode for this backend. - Specifies the balancing mode for this backend.
- For global HTTP(S) or TCP/SSL load balancing, the default is UTILIZATION. - For global HTTP(S) or TCP/SSL load balancing, the default is UTILIZATION.
Valid values are UTILIZATION, RATE (for HTTP(S)) and CONNECTION (for TCP/SSL). Valid values are UTILIZATION, RATE (for HTTP(S)) and CONNECTION (for TCP/SSL).
- This cannot be used for internal load balancing.
returned: success returned: success
type: str type: str
capacityScaler: capacityScaler:
@ -96,7 +95,6 @@ resources:
configured capacity (depending on balancingMode). A setting of 0 means configured capacity (depending on balancingMode). A setting of 0 means
the group is completely drained, offering 0% of its available Capacity. the group is completely drained, offering 0% of its available Capacity.
Valid range is [0.0,1.0]. Valid range is [0.0,1.0].
- This cannot be used for internal load balancing.
returned: success returned: success
type: str type: str
description: description:
@ -119,9 +117,6 @@ resources:
Group backends. Group 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.
- When the BackendService has load balancing scheme INTERNAL, the instance
group must be within the same region as the BackendService. Network Endpoint
Groups are not supported for INTERNAL load balancing scheme.
returned: success returned: success
type: str type: str
maxConnections: maxConnections:
@ -130,7 +125,6 @@ resources:
with either CONNECTION or UTILIZATION balancing modes. with either CONNECTION or UTILIZATION balancing modes.
- For CONNECTION mode, either maxConnections or maxConnectionsPerInstance - For CONNECTION mode, either maxConnections or maxConnectionsPerInstance
must be set. must be set.
- This cannot be used for internal load balancing.
returned: success returned: success
type: int type: int
maxConnectionsPerInstance: maxConnectionsPerInstance:
@ -140,7 +134,6 @@ resources:
used in either CONNECTION or UTILIZATION balancing modes. used in either CONNECTION or UTILIZATION balancing modes.
- For CONNECTION mode, either maxConnections or maxConnectionsPerInstance - For CONNECTION mode, either maxConnections or maxConnectionsPerInstance
must be set. must be set.
- This cannot be used for internal load balancing.
returned: success returned: success
type: int type: int
maxRate: maxRate:
@ -149,7 +142,6 @@ resources:
- Can be used with either RATE or UTILIZATION balancing modes, but required - Can be used with either RATE or UTILIZATION balancing modes, but required
if RATE mode. For RATE mode, either maxRate or maxRatePerInstance must if RATE mode. For RATE mode, either maxRate or maxRatePerInstance must
be set. be set.
- This cannot be used for internal load balancing.
returned: success returned: success
type: int type: int
maxRatePerInstance: maxRatePerInstance:
@ -158,14 +150,12 @@ resources:
This is used to calculate the capacity of the group. Can be used in either 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 balancing mode. For RATE mode, either maxRate or maxRatePerInstance must
be set. be set.
- This cannot be used for internal load balancing.
returned: success returned: success
type: str type: str
maxUtilization: maxUtilization:
description: description:
- Used when balancingMode is UTILIZATION. This ratio defines the CPU utilization - Used when balancingMode is UTILIZATION. This ratio defines the CPU utilization
target for the group. The default is 0.8. Valid range is [0.0, 1.0]. target for the group. The default is 0.8. Valid range is [0.0, 1.0].
- This cannot be used for internal load balancing.
returned: success returned: success
type: str type: str
cdnPolicy: cdnPolicy:
@ -256,7 +246,6 @@ resources:
enableCDN: enableCDN:
description: description:
- If true, enable Cloud CDN for this BackendService. - If true, enable Cloud CDN for this BackendService.
- When the load balancing scheme is INTERNAL, this field is not used.
returned: success returned: success
type: bool type: bool
healthChecks: healthChecks:
@ -264,8 +253,6 @@ resources:
- The list of URLs to the HttpHealthCheck or HttpsHealthCheck resource for health - The list of URLs to the HttpHealthCheck or HttpsHealthCheck resource for health
checking this BackendService. Currently at most one health check can be specified, checking this BackendService. Currently at most one health check can be specified,
and a health check is required. and a health check is required.
- For internal load balancing, a URL to a HealthCheck resource must be specified
instead.
returned: success returned: success
type: list type: list
id: id:
@ -303,7 +290,8 @@ resources:
description: description:
- Indicates whether the backend service will be used with internal or external - Indicates whether the backend service will be used with internal or external
load balancing. A backend service created for one type of load balancing cannot load balancing. A backend service created for one type of load balancing cannot
be used with the other. One of `INTERNAL` or `EXTERNAL`. Defaults to `EXTERNAL`. be used with the other. Must be `EXTERNAL` for a global backend service. Defaults
to `EXTERNAL`.
returned: success returned: success
type: str type: str
name: name:
@ -320,15 +308,12 @@ resources:
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
by this service. Required when the load balancing scheme is EXTERNAL. by this service. Required when the load balancing scheme is EXTERNAL.
- When the load balancing scheme is INTERNAL, this field is not used.
returned: success returned: success
type: str type: str
protocol: protocol:
description: description:
- The protocol this BackendService uses to communicate with backends. - The protocol this BackendService uses to communicate with backends.
- Possible values are HTTP, HTTPS, TCP, and SSL. The default is HTTP. - Possible values are HTTP, HTTPS, TCP, and SSL. The default is HTTP.
- For internal load balancing, the possible values are TCP and UDP, and the
default is TCP.
returned: success returned: success
type: str type: str
securityPolicy: securityPolicy:
@ -340,8 +325,6 @@ resources:
description: description:
- Type of session affinity to use. The default is NONE. - Type of session affinity to use. The default is NONE.
- When the load balancing scheme is EXTERNAL, can be NONE, CLIENT_IP, or GENERATED_COOKIE. - When the load balancing scheme is EXTERNAL, can be NONE, CLIENT_IP, or GENERATED_COOKIE.
- When the load balancing scheme is INTERNAL, can be NONE, CLIENT_IP, CLIENT_IP_PROTO,
or CLIENT_IP_PORT_PROTO.
- When the protocol is UDP, this field is not used. - When the protocol is UDP, this field is not used.
returned: success returned: success
type: str type: str