github.com/minamijoyo/terraform@v0.7.8-0.20161029001309-18b3736ba44b/website/source/docs/providers/google/r/compute_instance.html.markdown (about)

     1  ---
     2  layout: "google"
     3  page_title: "Google: google_compute_instance"
     4  sidebar_current: "docs-google-compute-instance"
     5  description: |-
     6    Manages a VM instance resource within GCE.
     7  ---
     8  
     9  # google\_compute\_instance
    10  
    11  Manages a VM instance resource within GCE. For more information see
    12  [the official documentation](https://cloud.google.com/compute/docs/instances)
    13  and
    14  [API](https://cloud.google.com/compute/docs/reference/latest/instances).
    15  
    16  
    17  ## Example Usage
    18  
    19  ```js
    20  resource "google_compute_instance" "default" {
    21    name         = "test"
    22    machine_type = "n1-standard-1"
    23    zone         = "us-central1-a"
    24  
    25    tags = ["foo", "bar"]
    26  
    27    disk {
    28      image = "debian-cloud/debian-8"
    29    }
    30  
    31    // Local SSD disk
    32    disk {
    33      type    = "local-ssd"
    34      scratch = true
    35    }
    36  
    37    network_interface {
    38      network = "default"
    39      access_config {
    40        // Ephemeral IP
    41      }
    42    }
    43  
    44    metadata {
    45      foo = "bar"
    46    }
    47  
    48    metadata_startup_script = "echo hi > /test.txt"
    49  
    50    service_account {
    51      scopes = ["userinfo-email", "compute-ro", "storage-ro"]
    52    }
    53  }
    54  ```
    55  
    56  ## Argument Reference
    57  
    58  The following arguments are supported:
    59  
    60  * `disk` - (Required) Disks to attach to the instance. This can be specified
    61      multiple times for multiple disks. Structure is documented below.
    62  
    63  * `machine_type` - (Required) The machine type to create. To create a custom
    64      machine type, value should be set as specified
    65      [here](https://cloud.google.com/compute/docs/reference/latest/instances#machineType)
    66  
    67  * `name` - (Required) A unique name for the resource, required by GCE.
    68      Changing this forces a new resource to be created.
    69  
    70  * `zone` - (Required) The zone that the machine should be created in.
    71  
    72  - - -
    73  
    74  * `can_ip_forward` - (Optional) Whether to allow sending and receiving of
    75      packets with non-matching source or destination IPs.
    76      This defaults to false.
    77  
    78  * `description` - (Optional) A brief description of this resource.
    79  
    80  * `metadata` - (Optional) Metadata key/value pairs to make available from
    81      within the instance.
    82  
    83  * `metadata_startup_script` - (Optional) An alternative to using the
    84      startup-script metadata key, except this one forces the instance to be
    85      recreated (thus re-running the script) if it is changed. This replaces the
    86      startup-script metadata key on the created instance and thus the two
    87      mechanisms are not allowed to be used simultaneously.
    88  
    89  * `network_interface` - (Required) Networks to attach to the instance. This can
    90      be specified multiple times for multiple networks, but GCE is currently
    91      limited to just 1. Structure is documented below.
    92  
    93  * `network` - (DEPRECATED, Required) Networks to attach to the instance. This
    94      can be specified multiple times for multiple networks. Structure is
    95      documented below.
    96  
    97  * `project` - (Optional) The project in which the resource belongs. If it
    98      is not provided, the provider project is used.
    99  
   100  * `scheduling` - (Optional) The scheduling strategy to use. More details about
   101      this configuration option are detailed below.
   102  
   103  * `service_account` - (Optional) Service account to attach to the instance.
   104      Structure is documented below.
   105  
   106  * `tags` - (Optional) Tags to attach to the instance.
   107  
   108  The `disk` block supports: (Note that either disk or image is required, unless
   109  the type is "local-ssd", in which case scratch must be true).
   110  
   111  * `disk` - The name of the existing disk (such as those managed by
   112      `google_compute_disk`) to attach.
   113  
   114  * `image` - The image from which to initialize this
   115      disk. Either the full URL, a contraction of the form "project/name", an
   116      [image family](https://cloud.google.com/compute/docs/images#image_families),
   117      or just a name (in which case the current project is used).
   118  
   119  * `auto_delete` - (Optional) Whether or not the disk should be auto-deleted.
   120      This defaults to true. Leave true for local SSDs.
   121  
   122  * `type` - (Optional) The GCE disk type, e.g. pd-standard, pd-ssd, or local-ssd.
   123  
   124  * `scratch` - (Optional) Whether the disk is a scratch disk as opposed to a
   125      persistent disk (required for local-ssd).
   126  
   127  * `size` - (Optional) The size of the image in gigabytes. If not specified, it
   128      will inherit the size of its base image. Do not specify for local SSDs as
   129      their size is fixed.
   130  
   131  * `device_name` - (Optional) Name with which attached disk will be accessible
   132      under `/dev/disk/by-id/`
   133  
   134  The `network_interface` block supports:
   135  
   136  * `network` - (Optional) The name or self_link of the network to attach this interface to.
   137      Either `network` or `subnetwork` must be provided.
   138  
   139  *  `subnetwork` - (Optional) the name of the subnetwork to attach this interface
   140      to. The subnetwork must exist in the same region this instance will be
   141      created in. Either `network` or `subnetwork` must be provided.
   142  
   143  * `address` - (Optional) The private IP address to assign to the instance. If
   144      empty, the address will be automatically assigned.
   145  
   146  * `access_config` - (Optional) Access configurations, i.e. IPs via which this
   147      instance can be accessed via the Internet. Omit to ensure that the instance
   148      is not accessible from the Internet (this means that ssh provisioners will
   149      not work unless you are running Terraform can send traffic to the instance's
   150      network (e.g. via tunnel or because it is running on another cloud instance
   151      on that network). This block can be repeated multiple times. Structure
   152      documented below.
   153  
   154  The `access_config` block supports:
   155  
   156  * `nat_ip` - (Optional) The IP address that will be 1:1 mapped to the instance's
   157      network ip. If not given, one will be generated.
   158  
   159  The `service_account` block supports:
   160  
   161  * `email` - (Optional) The service account e-mail address. If not given, the
   162      default Google Compute Engine service account is used.
   163  
   164  * `scopes` - (Required) A list of service scopes. Both OAuth2 URLs and gcloud
   165      short names are supported.
   166  
   167  (DEPRECATED) The `network` block supports:
   168  
   169  * `source` - (Required) The name of the network to attach this interface to.
   170  
   171  * `address` - (Optional) The IP address of a reserved IP address to assign
   172      to this interface.
   173  
   174  The `scheduling` block supports:
   175  
   176  * `preemptible` - (Optional) Is the instance preemptible.
   177  
   178  * `on_host_maintenance` - (Optional) Describes maintenance behavior for the
   179      instance. Can be MIGRATE or TERMINATE, for more info, read
   180      [here](https://cloud.google.com/compute/docs/instances/setting-instance-scheduling-options)
   181  
   182  * `automatic_restart` - (Optional) Specifies if the instance should be
   183      restarted if it was terminated by Compute Engine (not a user).
   184  
   185  ## Attributes Reference
   186  
   187  In addition to the arguments listed above, the following computed attributes are
   188  exported:
   189  
   190  * `metadata_fingerprint` - The unique fingerprint of the metadata.
   191  
   192  * `self_link` - The URI of the created resource.
   193  
   194  * `tags_fingerprint` - The unique fingerprint of the tags.
   195  
   196  * `network_interface.0.address` - The internal ip address of the instance, either manually or dynamically assigned.
   197  
   198  * `network_interface.0.access_config.0.assigned_nat_ip` - If the instance has an access config, either the given external ip (in the `nat_ip` field) or the ephemeral (generated) ip (if you didn't provide one).