Update the documentation.
Document the acceptable inputs everywhere that uses the function.
This commit is contained in:
parent
72bfc435ad
commit
ec93fb5ebb
|
@ -37,9 +37,11 @@ The following arguments are supported:
|
||||||
encoded in [RFC 4648 base64](https://tools.ietf.org/html/rfc4648#section-4)
|
encoded in [RFC 4648 base64](https://tools.ietf.org/html/rfc4648#section-4)
|
||||||
to encrypt this disk.
|
to encrypt this disk.
|
||||||
|
|
||||||
* `image` - (Optional) The image from which to initialize this disk. Either the
|
* `image` - (Optional) The image from which to initialize this disk. This can be
|
||||||
full URL, a contraction of the form "project/name", or just a name (in which
|
one of: the image self_link, projects/{project}/global/images/{image},
|
||||||
case the current project is used).
|
projects/{project}/global/images/family/{family}, global/images/{image},
|
||||||
|
global/images/family/{family}, family/{family}, {project}/{family},
|
||||||
|
{project}/{image}, {family}, or {image}.
|
||||||
|
|
||||||
* `project` - (Optional) The project in which the resource belongs. If it
|
* `project` - (Optional) The project in which the resource belongs. If it
|
||||||
is not provided, the provider project is used.
|
is not provided, the provider project is used.
|
||||||
|
|
|
@ -117,12 +117,11 @@ the type is "local-ssd", in which case scratch must be true).
|
||||||
* `disk` - The name of the existing disk (such as those managed by
|
* `disk` - The name of the existing disk (such as those managed by
|
||||||
`google_compute_disk`) to attach.
|
`google_compute_disk`) to attach.
|
||||||
|
|
||||||
* `image` - The image from which to initialize this
|
* `image` - The image from which to initialize this disk. This can be
|
||||||
disk. Either the full URL, a contraction of the form "project/name", the
|
one of: the image self_link, projects/{project}/global/images/{image},
|
||||||
name of a Google-supported
|
projects/{project}/global/images/family/{family}, global/images/{image},
|
||||||
[image family](https://cloud.google.com/compute/docs/images#image_families),
|
global/images/family/{family}, family/{family}, {project}/{family},
|
||||||
or simple the name of an image or image family (in which case the current
|
{project}/{image}, {family}, or {image}.
|
||||||
project is used).
|
|
||||||
|
|
||||||
* `auto_delete` - (Optional) Whether or not the disk should be auto-deleted.
|
* `auto_delete` - (Optional) Whether or not the disk should be auto-deleted.
|
||||||
This defaults to true. Leave true for local SSDs.
|
This defaults to true. Leave true for local SSDs.
|
||||||
|
|
|
@ -176,8 +176,12 @@ The `disk` block supports:
|
||||||
* `disk_name` - (Optional) Name of the disk. When not provided, this defaults
|
* `disk_name` - (Optional) Name of the disk. When not provided, this defaults
|
||||||
to the name of the instance.
|
to the name of the instance.
|
||||||
|
|
||||||
* `source_image` - (Required if source not set) The name of the image to base
|
* `source_image` - (Required if source not set) The image from which to
|
||||||
this disk off of. Accepts same arguments as a [google_compute_instance image](https://www.terraform.io/docs/providers/google/r/compute_instance.html#image).
|
initialize this disk. This can be one of: the image self_link,
|
||||||
|
projects/{project}/global/images/{image},
|
||||||
|
projects/{project}/global/images/family/{family}, global/images/{image},
|
||||||
|
global/images/family/{family}, family/{family}, {project}/{family},
|
||||||
|
{project}/{image}, {family}, or {image}.
|
||||||
|
|
||||||
* `interface` - (Optional) Specifies the disk interface to use for attaching
|
* `interface` - (Optional) Specifies the disk interface to use for attaching
|
||||||
this disk.
|
this disk.
|
||||||
|
|
Loading…
Reference in New Issue