Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Align manually generated documentation with #5192 #5279

Merged
merged 2 commits into from
Oct 15, 2021
Merged

Align manually generated documentation with #5192 #5279

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ccf9119
Align manually generated documentation with #5192
juliocc Oct 5, 2021
44b946d
Fix broken documentation links
juliocc Oct 15, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 8 additions & 8 deletions ...rd_party/terraform/website/docs/d/cloud_identity_group_membership.html.markdown
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,29 +29,29 @@ data "google_cloud_identity_group_memberships" "members" {

In addition to the arguments listed above, the following attributes are exported:

* `memberships` - The list of memberships under the given group. Structure is documented below.
* `memberships` - The list of memberships under the given group. Structure is [documented below](#nested_memberships).

The `memberships` block contains:
<a name="nested_memberships"></a>The `memberships` block contains:

* `name` -
The resource name of the Membership, of the form groups/{group_id}/memberships/{membership_id}.

* `roles` - The MembershipRoles that apply to the Membership. Structure is documented below.
* `roles` - The MembershipRoles that apply to the Membership. Structure is [documented below](#nested_roles).

* `member_key` -
(Optional)
EntityKey of the member. Structure is documented below.
EntityKey of the member. Structure is [documented below](#nested_member_key).

* `preferred_member_key` -
(Optional)
EntityKey of the member. Structure is documented below.
EntityKey of the member. Structure is [documented below](#nested_preferred_member_key).

The `roles` block supports:
<a name="nested_roles"></a>The `roles` block supports:

* `name` - The name of the MembershipRole. One of OWNER, MANAGER, MEMBER.


The `member_key` block supports:
<a name="nested_member_key"></a>The `member_key` block supports:

* `id` - The ID of the entity. For Google-managed entities, the id is the email address of an existing
group or user. For external-identity-mapped entities, the id is a string conforming
Expand All @@ -62,7 +62,7 @@ The `member_key` block supports:
such as a Google user or a Google Group.
If populated, the EntityKey represents an external-identity-mapped group.

The `preferred_member_key` block supports:
<a name="nested_preferred_member_key"></a>The `preferred_member_key` block supports:

* `id` - The ID of the entity. For Google-managed entities, the id is the email address of an existing
group or user. For external-identity-mapped entities, the id is a string conforming
Expand Down
8 changes: 4 additions & 4 deletions mmv1/third_party/terraform/website/docs/d/cloud_identity_groups.html.markdown
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,15 +29,15 @@ data "google_cloud_identity_groups" "groups" {

In addition to the arguments listed above, the following attributes are exported:

* `groups` - The list of groups under the provided customer or namespace. Structure is documented below.
* `groups` - The list of groups under the provided customer or namespace. Structure is [documented below](#nested_groups).

The `groups` block contains:
<a name="nested_groups"></a>The `groups` block contains:

* `name` -
Resource name of the Group in the format: groups/{group_id}, where `group_id` is the unique ID assigned to the Group.

* `group_key` -
EntityKey of the Group. Structure is documented below.
EntityKey of the Group. Structure is [documented below](#nested_group_key).

* `display_name` -
The display name of the Group.
Expand All @@ -49,7 +49,7 @@ The `groups` block contains:
Contains 'cloudidentity.googleapis.com/groups.discussion_forum': '' if the Group is a Google Group or
'system/groups/external': '' if the Group is an external-identity-mapped group.

The `group_key` block supports:
<a name="nested_group_key"></a>The `group_key` block supports:

* `id` -
The ID of the entity.
Expand Down
12 changes: 6 additions & 6 deletions mmv1/third_party/terraform/website/docs/d/cloudfunctions_function.html.markdown
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,31 +49,31 @@ exported:
* `runtime` - The runtime in which the function is running.
* `entry_point` - Name of a JavaScript function that will be executed when the Google Cloud Function is triggered.
* `trigger_http` - If function is triggered by HTTP, this boolean is set.
* `event_trigger` - A source that fires events in response to a condition in another service. Structure is documented below.
* `event_trigger` - A source that fires events in response to a condition in another service. Structure is [documented below](#nested_event_trigger).
* `https_trigger_url` - If function is triggered by HTTP, trigger URL is set here.
* `ingress_settings` - Controls what traffic can reach the function.
* `labels` - A map of labels applied to this function.
* `service_account_email` - The service account email to be assumed by the cloud function.
* `vpc_connector` - The VPC Network Connector that this cloud function can connect to.
* `vpc_connector_egress_settings` - The egress settings for the connector, controlling what traffic is diverted through it.
* `max_instances` - The limit on the maximum number of function instances that may coexist at a given time.
* `source_repository` - The URL of the Cloud Source Repository that the function is deployed from. Structure is documented below.
* `source_repository` - The URL of the Cloud Source Repository that the function is deployed from. Structure is [documented below](#nested_source_repository).

The `event_trigger` block contains:
<a name="nested_event_trigger"></a>The `event_trigger` block contains:

* `event_type` - The type of event to observe. For example: `"google.storage.object.finalize"`.
See the documentation on [calling Cloud Functions](https://cloud.google.com/functions/docs/calling/)
for a full reference of accepted triggers.

* `resource` - The name of the resource whose events are being observed, for example, `"myBucket"`

* `failure_policy` - Policy for failed executions. Structure is documented below.
* `failure_policy` - Policy for failed executions. Structure is [documented below](#nested_failure_policy).

The `failure_policy` block supports:
<a name="nested_failure_policy"></a>The `failure_policy` block contains:

* `retry` - Whether the function should be retried on failure.


The `source_repository` block contains:
<a name="nested_source_repository"></a>The `source_repository` block contains:

* `url` - The URL pointing to the hosted repository where the function is defined.
48 changes: 24 additions & 24 deletions mmv1/third_party/terraform/website/docs/d/compute_instance.html.markdown
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,33 +44,33 @@ The following arguments are supported:

## Attributes Reference

* `boot_disk` - The boot disk for the instance. Structure is documented below.
* `boot_disk` - The boot disk for the instance. Structure is [documented below](#nested_boot_disk).

* `machine_type` - The machine type to create.

* `network_interface` - The networks attached to the instance. Structure is documented below.
* `network_interface` - The networks attached to the instance. Structure is [documented below](#nested_network_interface).

* `attached_disk` - List of disks attached to the instance. Structure is documented below.
* `attached_disk` - List of disks attached to the instance. Structure is [documented below](#nested_attached_disk).

* `can_ip_forward` - Whether sending and receiving of packets with non-matching source or destination IPs is allowed.

* `description` - A brief description of the resource.

* `deletion_protection` - Whether deletion protection is enabled on this instance.

* `guest_accelerator` - List of the type and count of accelerator cards attached to the instance. Structure is documented below.
* `guest_accelerator` - List of the type and count of accelerator cards attached to the instance. Structure is [documented below](#nested_guest_accelerator).

* `labels` - A set of key/value label pairs assigned to the instance.

* `metadata` - Metadata key/value pairs made available within the instance.

* `min_cpu_platform` - The minimum CPU platform specified for the VM instance.

* `scheduling` - The scheduling strategy being used by the instance.
* `scheduling` - The scheduling strategy being used by the instance. Structure is [documented below](#nested_scheduling)

* `scratch_disk` - The scratch disks attached to the instance. Structure is documented below.
* `scratch_disk` - The scratch disks attached to the instance. Structure is [documented below](#nested_scratch_disk).

* `service_account` - The service account to attach to the instance. Structure is documented below.
* `service_account` - The service account to attach to the instance. Structure is [documented below](#nested_service_account).

* `tags` - The list of tags attached to the instance.

Expand All @@ -86,15 +86,15 @@ The following arguments are supported:

* `cpu_platform` - The CPU platform used by this instance.

* `shielded_instance_config` - The shielded vm config being used by the instance. Structure is documented below.
* `shielded_instance_config` - The shielded vm config being used by the instance. Structure is [documented below](#nested_shielded_instance_config).

* `enable_display` -- Whether the instance has virtual displays enabled.

* `network_interface.0.network_ip` - The internal ip address of the instance, either manually or dynamically assigned.

* `network_interface.0.access_config.0.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).

* `network_performance_config` - The network performance configuration setting for the instance, if set. Structure is documented below.
* `network_performance_config` - The network performance configuration setting for the instance, if set. Structure is [documented below](#nested_network_performance_config).

* `attached_disk.0.disk_encryption_key_sha256` - The [RFC 4648 base64](https://tools.ietf.org/html/rfc4648#section-4)
encoded SHA-256 hash of the [customer-supplied encryption key]
Expand All @@ -110,31 +110,31 @@ The following arguments are supported:

---

The `boot_disk` block supports:
<a name="nested_boot_disk"></a>The `boot_disk` block supports:

* `auto_delete` - Whether the disk will be auto-deleted when the instance is deleted.

* `device_name` - Name with which attached disk will be accessible under `/dev/disk/by-id/`

* `initialize_params` - Parameters with which a disk was created alongside the instance.
Structure is documented below.
Structure is [documented below](#nested_initialize_params).

* `source` - The name or self_link of an existing disk (such as those managed by
`google_compute_disk`) that was attached to the instance.

The `initialize_params` block supports:
<a name="nested_initialize_params"></a>The `initialize_params` block supports:

* `size` - The size of the image in gigabytes.

* `type` - The GCE disk type. One of `pd-standard` or `pd-ssd`.

* `image` - The image from which this disk was initialised.

The `scratch_disk` block supports:
<a name="nested_scratch_disk"></a>The `scratch_disk` block supports:

* `interface` - The disk interface used for attaching this disk. One of `SCSI` or `NVME`.

The `attached_disk` block supports:
<a name="nested_attached_disk"></a>The `attached_disk` block supports:

* `source` - The name or self_link of the disk attached to this instance.

Expand All @@ -143,7 +143,7 @@ The `attached_disk` block supports:

* `mode` - Read/write mode for the disk. One of `"READ_ONLY"` or `"READ_WRITE"`.

The `network_interface` block supports:
<a name="nested_network_interface"></a>The `network_interface` block supports:

* `network` - The name or self_link of the network attached to this interface.

Expand All @@ -154,11 +154,11 @@ The `network_interface` block supports:
* `network_ip` - The private IP address assigned to the instance.

* `access_config` - Access configurations, i.e. IPs via which this
instance can be accessed via the Internet. Structure documented below.
instance can be accessed via the Internet. Structure [documented below](#nested_access_config).

* `alias_ip_range` - An array of alias IP ranges for this network interface. Structure documented below.
* `alias_ip_range` - An array of alias IP ranges for this network interface. Structure [documented below](#nested_alias_ip_range).

The `access_config` block supports:
<a name="nested_access_config"></a>The `access_config` block supports:

* `nat_ip` - The IP address that is be 1:1 mapped to the instance's
network ip.
Expand All @@ -167,21 +167,21 @@ The `access_config` block supports:

* `network_tier` - The [networking tier][network-tier] used for configuring this instance. One of `PREMIUM` or `STANDARD`.

The `alias_ip_range` block supports:
<a name="nested_alias_ip_range"></a>The `alias_ip_range` block supports:

* `ip_cidr_range` - The IP CIDR range represented by this alias IP range.

* `subnetwork_range_name` - The subnetwork secondary range name specifying
the secondary range from which to allocate the IP CIDR range for this alias IP
range.

The `service_account` block supports:
<a name="nested_service_account"></a>The `service_account` block supports:

* `email` - The service account e-mail address.

* `scopes` - A list of service scopes.

The `scheduling` block supports:
<a name="nested_scheduling"></a>The `scheduling` block supports:

* `preemptible` - Whether the instance is preemptible.

Expand All @@ -192,22 +192,22 @@ The `scheduling` block supports:
* `automatic_restart` - Specifies if the instance should be
restarted if it was terminated by Compute Engine (not a user).

The `guest_accelerator` block supports:
<a name="nested_guest_accelerator"></a>The `guest_accelerator` block supports:

* `type` - The accelerator type resource exposed to this instance. E.g. `nvidia-tesla-k80`.

* `count` - The number of the guest accelerator cards exposed to this instance.

[network-tier]: https://cloud.google.com/network-tiers/docs/overview

The `shielded_instance_config` block supports:
<a name="nested_shielded_instance_config"></a>The `shielded_instance_config` block supports:

* `enable_secure_boot` -- Whether secure boot is enabled for the instance.

* `enable_vtpm` -- Whether the instance uses vTPM.

* `enable_integrity_monitoring` -- Whether integrity monitoring is enabled for the instance.

The `network_performance_config` block supports:
<a name="nested_network_performance_config"></a>The `network_performance_config` block supports:

* `total_egress_bandwidth_tier` - The egress bandwidth tier for the instance.
Loading