gcp_compute_backend_service – Creates a GCP BackendService

New in version 2.6.

Synopsis

  • A Backend Service defines a group of virtual machines that will serve traffic for load balancing. This resource is a global backend service, appropriate for external load balancing or self-managed internal load balancing.
  • For managed internal load balancing, use a regional backend service instead.
  • Currently self-managed internal load balancing is only available in beta.

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
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.
auth_kind
string / required
    Choices:
  • application
  • machineaccount
  • serviceaccount
The type of credential used.
backends
list
The set of backends that serve this BackendService.
balancing_mode
string
Default:
"UTILIZATION"
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).
Some valid choices include: "UTILIZATION", "RATE", "CONNECTION"
capacity_scaler
string
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].
description
string
An optional description of this resource.
Provide this property when you create the resource.
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 service can not contain mix of Instance Group and Network Endpoint Group backends.
Note that you must specify an Instance Group or Network Endpoint Group resource using the fully-qualified URL, rather than a partial URL.
max_connections
integer
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.
max_connections_per_endpoint
integer
added in 2.9
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.
max_connections_per_instance
integer
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.
max_rate
integer
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 one of maxRatePerInstance or maxRatePerEndpoint, as appropriate for group type, must be set.
max_rate_per_endpoint
string
added in 2.9
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.
max_rate_per_instance
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.
max_utilization
string
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].
cdn_policy
dictionary
Cloud CDN configuration for this BackendService.
cache_key_policy
dictionary
The CacheKeyPolicy for this CdnPolicy.
include_host
boolean
    Choices:
  • no
  • yes
If true requests to different hosts will be cached separately.
include_protocol
boolean
    Choices:
  • no
  • yes
If true, http and https requests will be cached separately.
include_query_string
boolean
    Choices:
  • 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
list
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
list
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
integer
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
dictionary
Settings for connection draining .
draining_timeout_sec
integer
Default:
"300"
Time for which instance will be drained (not accept new connections, but still work to finish started).
description
string
An optional description of this resource.
enable_cdn
boolean
    Choices:
  • no
  • yes
If true, enable Cloud CDN for this BackendService.
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.
health_checks
list / required
The set 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
dictionary
added in 2.7
Settings for enabling Cloud Identity Aware Proxy.
enabled
boolean
    Choices:
  • no
  • yes
Enables IAP.
oauth2_client_id
string / required
OAuth2 Client ID for IAP .
oauth2_client_secret
string / required
OAuth2 Client Secret for IAP .
load_balancing_scheme
string
added in 2.7
Default:
"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. Must be `EXTERNAL` or `INTERNAL_SELF_MANAGED` for a global backend service. Defaults to `EXTERNAL`.
Some valid choices include: "EXTERNAL", "INTERNAL_SELF_MANAGED"
name
string / 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
string
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.
project
string
The Google Cloud Platform project to use.
protocol
string
The protocol this BackendService uses to communicate with backends.
Possible values are HTTP, HTTPS, HTTP2, TCP, and SSL. 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", "TCP", "SSL"
scopes
list
Array of scopes to be used.
security_policy
string
added in 2.8
The security policy associated with this backend service.
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.
session_affinity
string
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 protocol is UDP, this field is not used.
Some valid choices include: "NONE", "CLIENT_IP", "GENERATED_COOKIE"
state
string
    Choices:
  • present ←
  • absent
Whether the given object should exist in GCP
timeout_sec
integer
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

  • API Reference: https://cloud.google.com/compute/docs/reference/v1/backendServices
  • Official Documentation: https://cloud.google.com/compute/docs/load-balancing/http/backend-service
  • for authentication, you can set service_account_file using the c(gcp_service_account_file) env variable.
  • for authentication, you can set service_account_contents using the c(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: 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.selfLink }}"
    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 set 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).

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

  description
string
success
An optional description of this resource.
Provide this property when you create the resource.

  group
string
success
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 service can not contain mix of Instance Group and Network Endpoint Group backends.
Note that you must specify an Instance Group or Network Endpoint Group resource using the fully-qualified URL, rather than a partial URL.

  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 one of maxConnectionsPerInstance or maxConnectionsPerEndpoint, as appropriate for group type, must be set.

  maxConnectionsPerEndpoint
integer
success
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.

  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.

  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 one of maxRatePerInstance or maxRatePerEndpoint, as appropriate for group type, must be set.

  maxRatePerEndpoint
string
success
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.

  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.

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

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.

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 set 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. Must be `EXTERNAL` or `INTERNAL_SELF_MANAGED` for a global backend service. 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.

protocol
string
success
The protocol this BackendService uses to communicate with backends.
Possible values are HTTP, HTTPS, HTTP2, TCP, and SSL. 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.

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