google.cloud.gcp_compute_region_backend_service_info – Gather info for GCP RegionBackendService

Note

This plugin is part of the google.cloud collection (version 1.0.2).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install google.cloud.

To use it in a playbook, specify: google.cloud.gcp_compute_region_backend_service_info.

Synopsis

  • Gather info for GCP RegionBackendService

Requirements

The below requirements are needed on the host that executes this module.

  • python >= 2.6

  • requests >= 2.18.4

  • google-auth >= 1.3.0

Parameters

Parameter

Comments

auth_kind

string / required

The type of credential used.

Choices:

  • application

  • machineaccount

  • serviceaccount

env_type

string

Specifies which Ansible environment you’re running this module within.

This should not be set unless you know what you’re doing.

This only alters the User Agent string for any API requests.

filters

list / elements=string

A list of filter value pairs. Available filters are listed here https://cloud.google.com/sdk/gcloud/reference/topic/filters.

Each additional filter in the list will act be added as an AND condition (filter1 and filter2) .

project

string

The Google Cloud Platform project to use.

region

string / required

A reference to the region where the regional backend service resides.

scopes

list / elements=string

Array of scopes to be used

service_account_contents

jsonarg

The contents of a Service Account JSON file, either in a dictionary or as a JSON string that represents it.

service_account_email

string

An optional service account email address if machineaccount is selected and the user does not wish to use the default email.

service_account_file

path

The path of a Service Account JSON file if serviceaccount is selected as type.

Notes

Note

  • for authentication, you can set service_account_file using the gcp_service_account_file env variable.

  • for authentication, you can set service_account_contents using the GCP_SERVICE_ACCOUNT_CONTENTS env variable.

  • For authentication, you can set service_account_email using the GCP_SERVICE_ACCOUNT_EMAIL env variable.

  • For authentication, you can set auth_kind using the GCP_AUTH_KIND env variable.

  • For authentication, you can set scopes using the GCP_SCOPES env variable.

  • Environment variables values will only be used if the playbook values are not set.

  • The service_account_email and service_account_file options are mutually exclusive.

Examples

- name: get info on a region backend service
  gcp_compute_region_backend_service_info:
    region: us-central1
    filters:
    - name = test_object
    project: test_project
    auth_kind: serviceaccount
    service_account_file: "/tmp/auth.pem"

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key

Description

resources

complex

List of resources

Returned: always

affinityCookieTtlSec

integer

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

backends

complex

The set of backends that serve this RegionBackendService.

Returned: success

balancingMode

string

Specifies the balancing mode for this backend.

Returned: success

capacityScaler

string

A multiplier applied to the group’s maximum servicing capacity (based on UTILIZATION, RATE or CONNECTION).

~>**NOTE**: This field cannot be set for INTERNAL region backend services (default loadBalancingScheme), but is required for non-INTERNAL backend service. The total capacity_scaler for all backends must be non-zero.

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

description

string

An optional description of this resource.

Provide this property when you create the resource.

Returned: success

failover

boolean

This field designates whether this is a failover backend. More than one failover backend can be configured for a given RegionBackendService.

Returned: success

group

string

The fully-qualified URL of an Instance Group or Network Endpoint Group resource. In case of instance group this defines the list of instances that serve traffic. Member virtual machine instances from each instance group must live in the same zone as the instance group itself. No two backends in a backend service are allowed to use same Instance Group resource.

For Network Endpoint Groups this defines list of endpoints. All endpoints 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

maxConnections

integer

The max number of simultaneous connections for the group. Can be used with either CONNECTION or UTILIZATION balancing modes.

Cannot be set for INTERNAL backend services.

For CONNECTION mode, either maxConnections or one of maxConnectionsPerInstance or maxConnectionsPerEndpoint, as appropriate for group type, must be set.

Returned: success

maxConnectionsPerEndpoint

integer

The max number of simultaneous connections that a single backend network endpoint can handle. Cannot be set for INTERNAL backend services.

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

maxConnectionsPerInstance

integer

The max number of simultaneous connections that a single backend instance can handle. Cannot be set for INTERNAL backend services.

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

maxRate

integer

The max requests per second (RPS) of the group. Cannot be set for INTERNAL backend services.

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

maxRatePerEndpoint

string

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. Cannot be set for INTERNAL backend services.

Returned: success

maxRatePerInstance

string

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. Cannot be set for INTERNAL backend services.

Returned: success

maxUtilization

string

Used when balancingMode is UTILIZATION. This ratio defines the CPU utilization target for the group. Valid range is [0.0, 1.0].

Cannot be set for INTERNAL backend services.

Returned: success

cdnPolicy

complex

Cloud CDN configuration for this BackendService.

Returned: success

cacheKeyPolicy

complex

The CacheKeyPolicy for this CdnPolicy.

Returned: success

includeHost

boolean

If true requests to different hosts will be cached separately.

Returned: success

includeProtocol

boolean

If true, http and https requests will be cached separately.

Returned: success

includeQueryString

boolean

If true, include query string parameters in the cache key according to query_string_whitelist and query_string_blacklist. If neither is set, the entire query string will be included.

If false, the query string will be excluded from the cache key entirely.

Returned: success

queryStringBlacklist

list / elements=string

Names of query string parameters to exclude in cache keys.

All other parameters will be included. Either specify query_string_whitelist or query_string_blacklist, not both.

‘&’ and ‘=’ will be percent encoded and not treated as delimiters.

Returned: success

queryStringWhitelist

list / elements=string

Names of query string parameters to include in cache keys.

All other parameters will be excluded. Either specify query_string_whitelist or query_string_blacklist, not both.

‘&’ and ‘=’ will be percent encoded and not treated as delimiters.

Returned: success

signedUrlCacheMaxAgeSec

integer

Maximum number of seconds the response to a signed URL request will be considered fresh, defaults to 1hr (3600s). After this time period, the response will be revalidated before being served.

When serving responses to signed URL requests, Cloud CDN will internally behave as though all responses from this backend had a “Cache-Control: public, max-age=[TTL]” header, regardless of any existing Cache-Control header. The actual headers served in responses will not be altered.

Returned: success

circuitBreakers

complex

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

maxConnections

integer

The maximum number of connections to the backend cluster.

Defaults to 1024.

Returned: success

maxPendingRequests

integer

The maximum number of pending requests to the backend cluster.

Defaults to 1024.

Returned: success

maxRequests

integer

The maximum number of parallel requests to the backend cluster.

Defaults to 1024.

Returned: success

maxRequestsPerConnection

integer

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

maxRetries

integer

The maximum number of parallel retries to the backend cluster.

Defaults to 3.

Returned: success

connectionDraining

complex

Settings for connection draining .

Returned: success

drainingTimeoutSec

integer

Time for which instance will be drained (not accept new connections, but still work to finish started).

Returned: success

consistentHash

complex

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

httpCookie

complex

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

name

string

Name of the cookie.

Returned: success

path

string

Path to set for the cookie.

Returned: success

ttl

complex

Lifetime of the cookie.

Returned: success

nanos

integer

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

seconds

integer

Span of time at a resolution of a second.

Must be from 0 to 315,576,000,000 inclusive.

Returned: success

httpHeaderName

string

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

minimumRingSize

integer

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

creationTimestamp

string

Creation timestamp in RFC3339 text format.

Returned: success

description

string

An optional description of this resource.

Returned: success

enableCDN

boolean

If true, enable Cloud CDN for this RegionBackendService.

Returned: success

failoverPolicy

complex

Policy for failovers.

Returned: success

disableConnectionDrainOnFailover

boolean

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

dropTrafficIfUnhealthy

boolean

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

failoverRatio

string

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

fingerprint

string

Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking.

Returned: success

healthChecks

list / elements=string

The set of URLs to HealthCheck resources for health checking this RegionBackendService. Currently at most one health check can be specified. A health check must be specified unless the backend service uses an internet or serverless NEG as a backend.

Returned: success

id

integer

The unique identifier for the resource.

Returned: success

loadBalancingScheme

string

Indicates what kind of load balancing this regional backend service will be used for. A backend service created for one type of load balancing cannot be used with the other(s).

Returned: success

localityLbPolicy

string

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

logConfig

complex

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

enable

boolean

Whether to enable logging for the load balancer traffic served by this backend service.

Returned: success

sampleRate

string

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

name

string

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

network

dictionary

The URL of the network to which this backend service belongs.

This field can only be specified when the load balancing scheme is set to INTERNAL.

Returned: success

outlierDetection

complex

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

baseEjectionTime

complex

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

nanos

integer

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

seconds

integer

Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive.

Returned: success

consecutiveErrors

integer

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

consecutiveGatewayFailure

integer

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

enforcingConsecutiveErrors

integer

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

enforcingConsecutiveGatewayFailure

integer

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

enforcingSuccessRate

integer

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

interval

complex

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

nanos

integer

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

seconds

integer

Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive.

Returned: success

maxEjectionPercent

integer

Maximum percentage of hosts in the load balancing pool for the backend service that can be ejected. Defaults to 10%.

Returned: success

successRateMinimumHosts

integer

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

successRateRequestVolume

integer

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

successRateStdevFactor

integer

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

portName

string

A named port on a backend instance group representing the port for communication to the backend VMs in that group. Required when the loadBalancingScheme is EXTERNAL, INTERNAL_MANAGED, or INTERNAL_SELF_MANAGED and the backends are instance groups. The named port must be defined on each backend instance group. This parameter has no meaning if the backends are NEGs. API sets a default of “http” if not given.

Must be omitted when the loadBalancingScheme is INTERNAL (Internal TCP/UDP Load Balancing).

Returned: success

protocol

string

The protocol this RegionBackendService uses to communicate with backends.

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

region

string

A reference to the region where the regional backend service resides.

Returned: success

sessionAffinity

string

Type of session affinity to use. The default is NONE. Session affinity is not applicable if the protocol is UDP.

Returned: success

timeoutSec

integer

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

Authors

  • Google Inc. (@googlecloudplatform)