gcp_compute_backend_service – Creates a GCP BackendService

From Get docs
Ansible/docs/2.8/modules/gcp compute backend service module


gcp_compute_backend_service – Creates a GCP BackendService

New in version 2.6.


Synopsis

  • Creates a BackendService resource in the specified project using the data included in the request.

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 Choices/Defaults Comments

affinity_cookie_ttl_sec

-

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.

auth_kind

string / required

  • application
  • machineaccount
  • serviceaccount

The type of credential used.

backends

-

The list of backends that serve this BackendService.

balancing_mode

-

  • UTILIZATION

  • RATE
  • CONNECTION

Specifies the balancing mode for this backend.

For global HTTP(S) or TCP/SSL load balancing, the default is UTILIZATION. Valid values are UTILIZATION, RATE (for HTTP(S)) and CONNECTION (for TCP/SSL).

This cannot be used for internal load balancing.

capacity_scaler

-

Default:

"1.0"

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

Default value is 1, which means the group will serve up to 100% of its configured capacity (depending on balancingMode). A setting of 0 means the group is completely drained, offering 0% of its available Capacity. Valid range is [0.0,1.0].

This cannot be used for internal load balancing.

description

-

An optional description of this resource.

Provide this property when you create the resource.

group

-

This instance group 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.

When the BackendService has load balancing scheme INTERNAL, the instance group must be in a zone within the same region as the BackendService.

This field represents a link to a InstanceGroup resource in GCP. It can be specified in two ways. First, you can place a dictionary with key 'selfLink' and value of your resource's selfLink Alternatively, you can add `register: name-of-resource` to a gcp_compute_instance_group task and then set this group field to "Template:Name-of-resource"

max_connections

-

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 maxConnectionsPerInstance must be set.

This cannot be used for internal load balancing.

max_connections_per_instance

-

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.

This cannot be used for internal load balancing.

max_rate

-

The max requests per second (RPS) of the group.

Can be used with either RATE or UTILIZATION balancing modes, but required if RATE mode. For RATE mode, either maxRate or maxRatePerInstance must be set.

This cannot be used for internal load balancing.

max_rate_per_instance

-

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.

This cannot be used for internal load balancing.

max_utilization

-

Default:

"0.8"

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].

This cannot be used for internal load balancing.

cdn_policy

-

Cloud CDN configuration for this BackendService.

cache_key_policy

-

The CacheKeyPolicy for this CdnPolicy.

include_host

boolean

  • no
  • yes

If true requests to different hosts will be cached separately.

include_protocol

boolean

  • no
  • yes

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

include_query_string

boolean

  • no
  • yes

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.

query_string_blacklist

-

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.

query_string_whitelist

-

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.

signed_url_cache_max_age_sec

-

added in 2.8

Default:

"3600"

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.

connection_draining

-

Settings for connection draining .

draining_timeout_sec

-

Default:

"300"

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

description

-

An optional description of this resource.

enable_cdn

boolean

  • no
  • yes

If true, enable Cloud CDN for this BackendService.

When the load balancing scheme is INTERNAL, this field is not used.

health_checks

- / required

The list of URLs to the HttpHealthCheck or HttpsHealthCheck resource for health checking this BackendService. Currently at most one health check can be specified, and a health check is required.

For internal load balancing, a URL to a HealthCheck resource must be specified instead.

iap

-

added in 2.7

Settings for enabling Cloud Identity Aware Proxy.

enabled

boolean

  • no
  • yes

Enables IAP.

oauth2_client_id

- / required

OAuth2 Client ID for IAP .

oauth2_client_secret

- / required

OAuth2 Client Secret for IAP .

load_balancing_scheme

-

added in 2.7

  • INTERNAL
  • 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 be used with the other. One of `INTERNAL` or `EXTERNAL`. Defaults to `EXTERNAL`.

name

- / required

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.

port_name

-

Name of backend port. The same name should appear in the instance groups referenced by this service. Required when the load balancing scheme is EXTERNAL.

When the load balancing scheme is INTERNAL, this field is not used.

project

string

The Google Cloud Platform project to use.

protocol

-

  • HTTP
  • HTTPS
  • TCP
  • SSL

The protocol this BackendService uses to communicate with backends.

Possible values are HTTP, HTTPS, TCP, and SSL. The default is HTTP.

For internal load balancing, the possible values are TCP and UDP, and the default is TCP.

scopes

list

Array of scopes to be used.

security_policy

-

added in 2.8

The security policy associated with this backend service.

service_account_contents

string

A string representing the contents of a Service Account JSON file.

This should not be passed in as a dictionary, but a string that has the exact contents of a service account json file (valid JSON)

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.

session_affinity

-

  • NONE
  • CLIENT_IP
  • GENERATED_COOKIE
  • CLIENT_IP_PROTO
  • CLIENT_IP_PORT_PROTO

Type of session affinity to use. The default is NONE.

When the load balancing scheme is EXTERNAL, can be NONE, CLIENT_IP, or GENERATED_COOKIE.

When the load balancing scheme is INTERNAL, can be NONE, CLIENT_IP, CLIENT_IP_PROTO, or CLIENT_IP_PORT_PROTO.

When the protocol is UDP, this field is not used.

state

-

  • present

  • absent

Whether the given object should exist in GCP

timeout_sec

-

How many seconds to wait for the backend before considering it a failed request. Default is 30 seconds. Valid range is [1, 86400].


aliases: timeout_seconds



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_email using the GCP_SERVICE_ACCOUNT_EMAIL env variable.
  • For authentication, you can set service_account_contents using the GCP_SERVICE_ACCOUNT_CONTENTS 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: create a instance group
  gcp_compute_instance_group:
    name: instancegroup-backendservice
    zone: us-central1-a
    project: "{{ gcp_project }}"
    auth_kind: "{{ gcp_cred_kind }}"
    service_account_file: "{{ gcp_cred_file }}"
    state: present
  register: instancegroup

- name: create a http health check
  gcp_compute_http_health_check:
    name: httphealthcheck-backendservice
    healthy_threshold: 10
    port: 8080
    timeout_sec: 2
    unhealthy_threshold: 5
    project: "{{ gcp_project }}"
    auth_kind: "{{ gcp_cred_kind }}"
    service_account_file: "{{ gcp_cred_file }}"
    state: present
  register: healthcheck

- name: create a backend service
  gcp_compute_backend_service:
    name: test_object
    backends:
    - group: "{{ instancegroup }}"
    health_checks:
    - "{{ healthcheck.selfLink }}"
    enable_cdn: 'true'
    project: test_project
    auth_kind: serviceaccount
    service_account_file: "/tmp/auth.pem"
    state: present

Return Values

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

Key Returned Description

affinityCookieTtlSec

integer

success

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.


backends

complex

success

The list of backends that serve this BackendService.


balancingMode

string

success

Specifies the balancing mode for this backend.

For global HTTP(S) or TCP/SSL load balancing, the default is UTILIZATION. Valid values are UTILIZATION, RATE (for HTTP(S)) and CONNECTION (for TCP/SSL).

This cannot be used for internal load balancing.


capacityScaler

string

success

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

Default value is 1, which means the group will serve up to 100% of its configured capacity (depending on balancingMode). A setting of 0 means the group is completely drained, offering 0% of its available Capacity. Valid range is [0.0,1.0].

This cannot be used for internal load balancing.


description

string

success

An optional description of this resource.

Provide this property when you create the resource.


group

dictionary

success

This instance group 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.

When the BackendService has load balancing scheme INTERNAL, the instance group must be in a zone within the same region as the BackendService.


maxConnections

integer

success

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 maxConnectionsPerInstance must be set.

This cannot be used for internal load balancing.


maxConnectionsPerInstance

integer

success

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.

This cannot be used for internal load balancing.


maxRate

integer

success

The max requests per second (RPS) of the group.

Can be used with either RATE or UTILIZATION balancing modes, but required if RATE mode. For RATE mode, either maxRate or maxRatePerInstance must be set.

This cannot be used for internal load balancing.


maxRatePerInstance

string

success

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.

This cannot be used for internal load balancing.


maxUtilization

string

success

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].

This cannot be used for internal load balancing.


cdnPolicy

complex

success

Cloud CDN configuration for this BackendService.


cacheKeyPolicy

complex

success

The CacheKeyPolicy for this CdnPolicy.


includeHost

boolean

success

If true requests to different hosts will be cached separately.


includeProtocol

boolean

success

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


includeQueryString

boolean

success

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.


queryStringBlacklist

list

success

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.


queryStringWhitelist

list

success

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.


signedUrlCacheMaxAgeSec

integer

success

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.


connectionDraining

complex

success

Settings for connection draining .


drainingTimeoutSec

integer

success

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


creationTimestamp

string

success

Creation timestamp in RFC3339 text format.


description

string

success

An optional description of this resource.


enableCDN

boolean

success

If true, enable Cloud CDN for this BackendService.

When the load balancing scheme is INTERNAL, this field is not used.


fingerprint

string

success

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


healthChecks

list

success

The list of URLs to the HttpHealthCheck or HttpsHealthCheck resource for health checking this BackendService. Currently at most one health check can be specified, and a health check is required.

For internal load balancing, a URL to a HealthCheck resource must be specified instead.


iap

complex

success

Settings for enabling Cloud Identity Aware Proxy.


enabled

boolean

success

Enables IAP.


oauth2ClientId

string

success

OAuth2 Client ID for IAP .


oauth2ClientSecret

string

success

OAuth2 Client Secret for IAP .


oauth2ClientSecretSha256

string

success

OAuth2 Client Secret SHA-256 for IAP .


id

integer

success

The unique identifier for the resource.


loadBalancingScheme

string

success

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 used with the other. One of `INTERNAL` or `EXTERNAL`. Defaults to `EXTERNAL`.


name

string

success

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.


portName

string

success

Name of backend port. The same name should appear in the instance groups referenced by this service. Required when the load balancing scheme is EXTERNAL.

When the load balancing scheme is INTERNAL, this field is not used.


protocol

string

success

The protocol this BackendService uses to communicate with backends.

Possible values are HTTP, HTTPS, TCP, and SSL. The default is HTTP.

For internal load balancing, the possible values are TCP and UDP, and the default is TCP.


securityPolicy

string

success

The security policy associated with this backend service.


sessionAffinity

string

success

Type of session affinity to use. The default is NONE.

When the load balancing scheme is EXTERNAL, can be NONE, CLIENT_IP, or GENERATED_COOKIE.

When the load balancing scheme is INTERNAL, can be NONE, CLIENT_IP, CLIENT_IP_PROTO, or CLIENT_IP_PORT_PROTO.

When the protocol is UDP, this field is not used.


timeoutSec

integer

success

How many seconds to wait for the backend before considering it a failed request. Default is 30 seconds. Valid range is [1, 86400].





Status

Authors

  • Google Inc. (@googlecloudplatform)

Hint

If you notice any issues in this documentation you can edit this document to improve it.


© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.8/modules/gcp_compute_backend_service_module.html