github.com/turtlemonvh/terraform@v0.6.9-0.20151204001754-8e40b6b855e8/website/source/docs/providers/google/r/compute_backend_service.html.markdown (about)

     1  ---
     2  layout: "google"
     3  page_title: "Google: google_compute_backend_service"
     4  sidebar_current: "docs-google-compute-backend-service"
     5  description: |-
     6    Creates a Backend Service resource for Google Compute Engine.
     7  ---
     8  
     9  # google\_compute\_backend\_service
    10  
    11  A Backend Service defines a group of virtual machines that will serve traffic for load balancing.
    12  
    13  ## Example Usage
    14  
    15  ```
    16  resource "google_compute_backend_service" "foobar" {
    17      name = "blablah"
    18      description = "Hello World 1234"
    19      port_name = "http"
    20      protocol = "HTTP"
    21      timeout_sec = 10
    22      region = "us-central1"
    23  
    24      backend {
    25          group = "${google_compute_instance_group_manager.foo.instance_group}"
    26      }
    27  
    28      health_checks = ["${google_compute_http_health_check.default.self_link}"]
    29  }
    30  
    31  resource "google_compute_instance_group_manager" "foo" {
    32      name = "terraform-test"
    33      instance_template = "${google_compute_instance_template.foobar.self_link}"
    34      base_instance_name = "foobar"
    35      zone = "us-central1-f"
    36      target_size = 1
    37  }
    38  
    39  resource "google_compute_instance_template" "foobar" {
    40      name = "terraform-test"
    41      machine_type = "n1-standard-1"
    42  
    43      network_interface {
    44          network = "default"
    45      }
    46  
    47      disk {
    48          source_image = "debian-7-wheezy-v20140814"
    49          auto_delete = true
    50          boot = true
    51      }
    52  }
    53  
    54  resource "google_compute_http_health_check" "default" {
    55      name = "test"
    56      request_path = "/"
    57      check_interval_sec = 1
    58      timeout_sec = 1
    59  }
    60  ```
    61  
    62  ## Argument Reference
    63  
    64  The following arguments are supported:
    65  
    66  * `name` - (Required) The name of the backend service.
    67  * `health_checks` - (Required) Specifies a list of HTTP health check objects
    68      for checking the health of the backend service.
    69  * `description` - (Optional) The textual description for the backend service.
    70  * `backend` - (Optional) The list of backends that serve this BackendService. See *Backend* below.
    71  * `region` - (Optional) The region the service sits in. If not specified, the project region is used.
    72  * `port_name` - (Optional) The name of a service that has been added to
    73  	an instance group in this backend. See [related docs](https://cloud.google.com/compute/docs/instance-groups/#specifying_service_endpoints)
    74      for details. Defaults to http.
    75  * `protocol` - (Optional) The protocol for incoming requests. Defaults to `HTTP`.
    76  * `timeout_sec` - (Optional) The number of secs to wait for a backend to respond
    77  	to a request before considering the request failed. Defaults to `30`.
    78  
    79  **Backend** supports the following attributes:
    80  
    81  * `group` - (Required) The name or URI of a Compute Engine instance group (`google_compute_instance_group_manager.xyz.instance_group`) that can receive traffic.
    82  * `balancing_mode` - (Optional) Defines the strategy for balancing load. Defaults to `UTILIZATION`
    83  * `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.
    84  * `description` - (Optional) Textual description for the backend.
    85  * `max_rate` - (Optional) Maximum requests per second (RPS) that the group can handle.
    86  * `max_rate_per_instance` - (Optional) The maximum per-instance requests per second (RPS).
    87  * `max_utilization` - (Optional) The target CPU utilization for the group as a float in the range [0.0, 1.0]. This flag can only be provided when the balancing mode is `UTILIZATION`. Defaults to `0.8`.
    88  
    89  ## Attributes Reference
    90  
    91  The following attributes are exported:
    92  
    93  * `name` - The name of the resource.
    94  * `self_link` - The URI of the created resource.