2015-08-20 19:53:23 +00:00
|
|
|
---
|
2019-04-02 21:32:09 +00:00
|
|
|
# ----------------------------------------------------------------------------
|
|
|
|
#
|
|
|
|
# *** AUTO GENERATED CODE *** AUTO GENERATED CODE ***
|
|
|
|
#
|
|
|
|
# ----------------------------------------------------------------------------
|
|
|
|
#
|
|
|
|
# This file is automatically generated by Magic Modules and manual
|
|
|
|
# changes will be clobbered when the file is regenerated.
|
|
|
|
#
|
|
|
|
# Please read more about how to change this file in
|
|
|
|
# .github/CONTRIBUTING.md.
|
|
|
|
#
|
|
|
|
# ----------------------------------------------------------------------------
|
2015-08-20 19:53:23 +00:00
|
|
|
layout: "google"
|
|
|
|
page_title: "Google: google_compute_backend_service"
|
2015-10-23 14:10:41 +00:00
|
|
|
sidebar_current: "docs-google-compute-backend-service"
|
2015-08-20 19:53:23 +00:00
|
|
|
description: |-
|
2019-04-30 21:36:44 +00:00
|
|
|
A Backend Service defines a group of virtual machines that will serve
|
|
|
|
traffic for load balancing.
|
2015-08-20 19:53:23 +00:00
|
|
|
---
|
|
|
|
|
|
|
|
# google\_compute\_backend\_service
|
|
|
|
|
2019-04-30 21:36:44 +00:00
|
|
|
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. For internal load balancing, use
|
|
|
|
a regional backend service instead.
|
2015-08-20 19:53:23 +00:00
|
|
|
|
2017-05-09 10:10:14 +00:00
|
|
|
|
2019-04-30 21:36:44 +00:00
|
|
|
To get more information about BackendService, see:
|
|
|
|
|
|
|
|
* [API documentation](https://cloud.google.com/compute/docs/reference/v1/backendServices)
|
|
|
|
* How-to Guides
|
|
|
|
* [Official Documentation](https://cloud.google.com/compute/docs/load-balancing/http/backend-service)
|
2015-08-20 19:53:23 +00:00
|
|
|
|
2019-04-02 21:32:09 +00:00
|
|
|
<div class = "oics-button" style="float: right; margin: 0 0 -15px">
|
|
|
|
<a href="https://console.cloud.google.com/cloudshell/open?cloudshell_git_repo=https%3A%2F%2Fgithub.com%2Fterraform-google-modules%2Fdocs-examples.git&cloudshell_working_dir=backend_service_basic&cloudshell_image=gcr.io%2Fgraphite-cloud-shell-images%2Fterraform%3Alatest&open_in_editor=main.tf&cloudshell_print=.%2Fmotd&cloudshell_tutorial=.%2Ftutorial.md" target="_blank">
|
|
|
|
<img alt="Open in Cloud Shell" src="//gstatic.com/cloudssh/images/open-btn.svg" style="max-height: 44px; margin: 32px auto; max-width: 100%;">
|
|
|
|
</a>
|
|
|
|
</div>
|
|
|
|
## Example Usage - Backend Service Basic
|
2016-04-10 21:34:15 +00:00
|
|
|
|
|
|
|
|
2019-04-02 21:32:09 +00:00
|
|
|
```hcl
|
|
|
|
resource "google_compute_backend_service" "default" {
|
|
|
|
name = "backend-service"
|
|
|
|
health_checks = ["${google_compute_http_health_check.default.self_link}"]
|
2015-09-08 10:57:51 +00:00
|
|
|
}
|
|
|
|
|
2015-08-20 19:53:23 +00:00
|
|
|
resource "google_compute_http_health_check" "default" {
|
2019-04-02 21:32:09 +00:00
|
|
|
name = "health-check"
|
2016-04-10 21:34:15 +00:00
|
|
|
request_path = "/"
|
|
|
|
check_interval_sec = 1
|
|
|
|
timeout_sec = 1
|
2015-08-20 19:53:23 +00:00
|
|
|
}
|
|
|
|
```
|
|
|
|
|
|
|
|
## Argument Reference
|
|
|
|
|
|
|
|
The following arguments are supported:
|
|
|
|
|
2016-04-10 21:34:15 +00:00
|
|
|
|
2019-04-02 21:32:09 +00:00
|
|
|
* `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.
|
2016-04-10 21:34:15 +00:00
|
|
|
|
2019-04-02 21:32:09 +00:00
|
|
|
* `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.
|
2016-04-10 21:34:15 +00:00
|
|
|
|
|
|
|
|
2019-04-02 21:32:09 +00:00
|
|
|
- - -
|
2018-03-22 16:53:24 +00:00
|
|
|
|
2016-11-27 19:12:56 +00:00
|
|
|
|
2019-04-02 21:32:09 +00:00
|
|
|
* `affinity_cookie_ttl_sec` -
|
|
|
|
(Optional)
|
|
|
|
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.
|
|
|
|
|
|
|
|
* `backend` -
|
|
|
|
(Optional)
|
|
|
|
The list of backends that serve this BackendService. Structure is documented below.
|
|
|
|
|
|
|
|
* `cdn_policy` -
|
|
|
|
(Optional)
|
|
|
|
Cloud CDN configuration for this BackendService. Structure is documented below.
|
|
|
|
|
|
|
|
* `connection_draining_timeout_sec` -
|
|
|
|
(Optional)
|
|
|
|
Time for which instance will be drained (not accept new
|
|
|
|
connections, but still work to finish started).
|
|
|
|
|
|
|
|
* `description` -
|
|
|
|
(Optional)
|
|
|
|
An optional description of this resource.
|
|
|
|
|
|
|
|
* `enable_cdn` -
|
|
|
|
(Optional)
|
|
|
|
If true, enable Cloud CDN for this BackendService.
|
|
|
|
|
|
|
|
* `iap` -
|
|
|
|
(Optional)
|
|
|
|
Settings for enabling Cloud Identity Aware Proxy Structure is documented below.
|
|
|
|
|
2019-04-04 20:50:31 +00:00
|
|
|
* `load_balancing_scheme` -
|
|
|
|
(Optional)
|
|
|
|
Indicates whether the backend service will be used with internal or
|
|
|
|
external load balancing. A backend service created for one type of
|
2019-04-30 21:36:44 +00:00
|
|
|
load balancing cannot be used with the other. Must be `EXTERNAL` for
|
|
|
|
a global backend service. Defaults to `EXTERNAL`.
|
2019-04-04 20:50:31 +00:00
|
|
|
|
2019-04-02 21:32:09 +00:00
|
|
|
* `port_name` -
|
|
|
|
(Optional)
|
|
|
|
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` -
|
|
|
|
(Optional)
|
|
|
|
The protocol this BackendService uses to communicate with backends.
|
|
|
|
Possible values are HTTP, HTTPS, TCP, and SSL. The default is HTTP.
|
|
|
|
|
|
|
|
* `security_policy` -
|
|
|
|
(Optional)
|
|
|
|
The security policy associated with this backend service.
|
|
|
|
|
|
|
|
* `session_affinity` -
|
|
|
|
(Optional)
|
|
|
|
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.
|
|
|
|
|
|
|
|
* `timeout_sec` -
|
|
|
|
(Optional)
|
|
|
|
How many seconds to wait for the backend before considering it a
|
|
|
|
failed request. Default is 30 seconds. Valid range is [1, 86400].
|
|
|
|
* `project` - (Optional) The ID of the project in which the resource belongs.
|
|
|
|
If it is not provided, the provider project is used.
|
2018-12-22 00:54:17 +00:00
|
|
|
|
2017-06-14 21:13:52 +00:00
|
|
|
|
2017-06-07 22:17:49 +00:00
|
|
|
The `backend` block supports:
|
2015-08-20 19:53:23 +00:00
|
|
|
|
2019-04-02 21:32:09 +00:00
|
|
|
* `balancing_mode` -
|
|
|
|
(Optional)
|
|
|
|
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).
|
|
|
|
|
|
|
|
* `capacity_scaler` -
|
|
|
|
(Optional)
|
|
|
|
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` -
|
|
|
|
(Optional)
|
|
|
|
An optional description of this resource.
|
|
|
|
Provide this property when you create the resource.
|
|
|
|
|
|
|
|
* `group` -
|
|
|
|
(Optional)
|
2019-04-22 18:11:24 +00:00
|
|
|
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.
|
2019-04-02 21:32:09 +00:00
|
|
|
|
|
|
|
* `max_connections` -
|
|
|
|
(Optional)
|
|
|
|
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.
|
|
|
|
|
|
|
|
* `max_connections_per_instance` -
|
|
|
|
(Optional)
|
|
|
|
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` -
|
|
|
|
(Optional)
|
|
|
|
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.
|
|
|
|
|
|
|
|
* `max_rate_per_instance` -
|
|
|
|
(Optional)
|
|
|
|
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` -
|
|
|
|
(Optional)
|
|
|
|
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].
|
2015-08-20 19:53:23 +00:00
|
|
|
|
2018-03-16 17:50:32 +00:00
|
|
|
The `cdn_policy` block supports:
|
|
|
|
|
2019-04-02 21:32:09 +00:00
|
|
|
* `cache_key_policy` -
|
|
|
|
(Optional)
|
|
|
|
The CacheKeyPolicy for this CdnPolicy. Structure is documented below.
|
|
|
|
|
2019-04-04 20:50:31 +00:00
|
|
|
* `signed_url_cache_max_age_sec` -
|
|
|
|
(Optional)
|
|
|
|
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.
|
|
|
|
|
2018-03-16 17:50:32 +00:00
|
|
|
|
|
|
|
The `cache_key_policy` block supports:
|
|
|
|
|
2019-04-02 21:32:09 +00:00
|
|
|
* `include_host` -
|
|
|
|
(Optional)
|
|
|
|
If true requests to different hosts will be cached separately.
|
|
|
|
|
|
|
|
* `include_protocol` -
|
|
|
|
(Optional)
|
|
|
|
If true, http and https requests will be cached separately.
|
|
|
|
|
|
|
|
* `include_query_string` -
|
|
|
|
(Optional)
|
|
|
|
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` -
|
|
|
|
(Optional)
|
|
|
|
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` -
|
|
|
|
(Optional)
|
|
|
|
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.
|
2018-03-16 17:50:32 +00:00
|
|
|
|
2019-04-02 21:32:09 +00:00
|
|
|
The `iap` block supports:
|
2018-03-16 17:50:32 +00:00
|
|
|
|
2019-04-02 21:32:09 +00:00
|
|
|
* `oauth2_client_id` -
|
|
|
|
(Required)
|
|
|
|
OAuth2 Client ID for IAP
|
2018-03-16 17:50:32 +00:00
|
|
|
|
2019-04-02 21:32:09 +00:00
|
|
|
* `oauth2_client_secret` -
|
|
|
|
(Required)
|
|
|
|
OAuth2 Client Secret for IAP
|
2018-03-16 17:50:32 +00:00
|
|
|
|
2019-04-02 21:32:09 +00:00
|
|
|
* `oauth2_client_secret_sha256` -
|
|
|
|
OAuth2 Client Secret SHA-256 for IAP
|
2018-03-16 17:50:32 +00:00
|
|
|
|
2019-04-02 21:32:09 +00:00
|
|
|
## Attributes Reference
|
2017-12-11 17:43:27 +00:00
|
|
|
|
2019-04-02 21:32:09 +00:00
|
|
|
In addition to the arguments listed above, the following computed attributes are exported:
|
2017-12-11 17:43:27 +00:00
|
|
|
|
|
|
|
|
2019-04-02 21:32:09 +00:00
|
|
|
* `creation_timestamp` -
|
|
|
|
Creation timestamp in RFC3339 text format.
|
2015-08-20 19:53:23 +00:00
|
|
|
|
2019-04-02 21:32:09 +00:00
|
|
|
* `fingerprint` -
|
|
|
|
Fingerprint of this resource. A hash of the contents stored in this
|
|
|
|
object. This field is used in optimistic locking.
|
|
|
|
* `self_link` - The URI of the created resource.
|
2016-04-10 21:34:15 +00:00
|
|
|
|
2019-02-01 18:57:45 +00:00
|
|
|
|
2019-04-02 21:32:09 +00:00
|
|
|
## Timeouts
|
2015-08-20 19:53:23 +00:00
|
|
|
|
2019-04-02 21:32:09 +00:00
|
|
|
This resource provides the following
|
|
|
|
[Timeouts](/docs/configuration/resources.html#timeouts) configuration options:
|
|
|
|
|
|
|
|
- `create` - Default is 4 minutes.
|
|
|
|
- `update` - Default is 4 minutes.
|
|
|
|
- `delete` - Default is 4 minutes.
|
2017-06-14 21:13:52 +00:00
|
|
|
|
|
|
|
## Import
|
|
|
|
|
2019-04-02 21:32:09 +00:00
|
|
|
BackendService can be imported using any of these accepted formats:
|
2017-06-14 21:13:52 +00:00
|
|
|
|
|
|
|
```
|
2019-04-02 21:32:09 +00:00
|
|
|
$ terraform import google_compute_backend_service.default projects/{{project}}/global/backendServices/{{name}}
|
|
|
|
$ terraform import google_compute_backend_service.default {{project}}/{{name}}
|
|
|
|
$ terraform import google_compute_backend_service.default {{name}}
|
2017-06-14 21:13:52 +00:00
|
|
|
```
|
2019-04-02 21:32:09 +00:00
|
|
|
|
|
|
|
-> If you're importing a resource with beta features, make sure to include `-provider=google-beta`
|
|
|
|
as an argument so that Terraform uses the correct provider to import your resource.
|