Make docs more accurate
This commit is contained in:
parent
567c299a84
commit
0a0f532bf9
|
@ -8,17 +8,48 @@ description: |-
|
||||||
|
|
||||||
# google\_compute\_backend\_service
|
# google\_compute\_backend\_service
|
||||||
|
|
||||||
|
A Backend Service defines a group of virtual machines that will serve traffic for load balancing.
|
||||||
|
|
||||||
|
|
||||||
## Example Usage
|
## Example Usage
|
||||||
|
|
||||||
```
|
```
|
||||||
resource "google_compute_backend_service" "foobar" {
|
resource "google_compute_backend_service" "foobar" {
|
||||||
name = "blablah"
|
name = "blablah"
|
||||||
|
description = "Hello World 1234"
|
||||||
|
port_name = "http"
|
||||||
|
protocol = "HTTP"
|
||||||
|
timeout_sec = 10
|
||||||
|
|
||||||
|
backend {
|
||||||
|
group = "${google_compute_instance_group_manager.foo.instance_group}"
|
||||||
|
}
|
||||||
|
|
||||||
health_checks = ["${google_compute_http_health_check.default.self_link}"]
|
health_checks = ["${google_compute_http_health_check.default.self_link}"]
|
||||||
}
|
}
|
||||||
|
|
||||||
|
resource "google_compute_instance_group_manager" "foo" {
|
||||||
|
name = "terraform-test"
|
||||||
|
instance_template = "${google_compute_instance_template.foobar.self_link}"
|
||||||
|
base_instance_name = "foobar"
|
||||||
|
zone = "us-central1-f"
|
||||||
|
target_size = 1
|
||||||
|
}
|
||||||
|
|
||||||
|
resource "google_compute_instance_template" "foobar" {
|
||||||
|
name = "terraform-test"
|
||||||
|
machine_type = "n1-standard-1"
|
||||||
|
|
||||||
|
network_interface {
|
||||||
|
network = "default"
|
||||||
|
}
|
||||||
|
|
||||||
|
disk {
|
||||||
|
source_image = "debian-7-wheezy-v20140814"
|
||||||
|
auto_delete = true
|
||||||
|
boot = true
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
resource "google_compute_http_health_check" "default" {
|
resource "google_compute_http_health_check" "default" {
|
||||||
name = "test"
|
name = "test"
|
||||||
request_path = "/"
|
request_path = "/"
|
||||||
|
@ -35,7 +66,7 @@ The following arguments are supported:
|
||||||
* `health_checks` - (Required) Specifies a list of HTTP health check objects
|
* `health_checks` - (Required) Specifies a list of HTTP health check objects
|
||||||
for checking the health of the backend service.
|
for checking the health of the backend service.
|
||||||
* `description` - (Optional) The textual description for the backend service.
|
* `description` - (Optional) The textual description for the backend service.
|
||||||
* `backends` - (Optional) The list of backends that serve this BackendService. See *Backend* below.
|
* `backend` - (Optional) The list of backends that serve this BackendService. See *Backend* below.
|
||||||
* `port_name` - (Optional) The name of a service that has been added to
|
* `port_name` - (Optional) The name of a service that has been added to
|
||||||
an instance group in this backend. See [related docs](https://cloud.google.com/compute/docs/instance-groups/#specifying_service_endpoints)
|
an instance group in this backend. See [related docs](https://cloud.google.com/compute/docs/instance-groups/#specifying_service_endpoints)
|
||||||
for details. Defaults to http.
|
for details. Defaults to http.
|
||||||
|
@ -45,7 +76,7 @@ The following arguments are supported:
|
||||||
|
|
||||||
**Backend** supports the following attributes:
|
**Backend** supports the following attributes:
|
||||||
|
|
||||||
* `group` - (Required) The name or URI of a Compute Engine instance group that can receive traffic.
|
* `group` - (Required) The name or URI of a Compute Engine instance group (`google_compute_instance_group_manager.xyz.instance_group`) that can receive traffic.
|
||||||
* `balancing_mode` - (Optional) Defines the strategy for balancing load. Defaults to `UTILIZATION`
|
* `balancing_mode` - (Optional) Defines the strategy for balancing load. Defaults to `UTILIZATION`
|
||||||
* `capacity_scaler` - (Optional) A float in the range [0, 1.0] that scales the maximum parameters for the group (e.g., max rate). A value of 0.0 will cause no requests to be sent to the group (i.e., it adds the group in a drained state). The default is 1.0.
|
* `capacity_scaler` - (Optional) A float in the range [0, 1.0] that scales the maximum parameters for the group (e.g., max rate). A value of 0.0 will cause no requests to be sent to the group (i.e., it adds the group in a drained state). The default is 1.0.
|
||||||
* `description` - (Optional) Textual description for the backend.
|
* `description` - (Optional) Textual description for the backend.
|
||||||
|
@ -58,5 +89,4 @@ The following arguments are supported:
|
||||||
The following attributes are exported:
|
The following attributes are exported:
|
||||||
|
|
||||||
* `name` - The name of the resource.
|
* `name` - The name of the resource.
|
||||||
* `backend_service` - The IP backend_service that was allocated.
|
|
||||||
* `self_link` - The URI of the created resource.
|
* `self_link` - The URI of the created resource.
|
||||||
|
|
Loading…
Reference in New Issue