Skip to content
This repository has been archived by the owner on Nov 14, 2024. It is now read-only.

Commit

Permalink
Add notes on API requirements to markdown docs for InSpec generated r…
Browse files Browse the repository at this point in the history
Signed-off-by: Modular Magician <magic-modules@google.com>
  • Loading branch information
slevenick authored and modular-magician committed Feb 28, 2019
1 parent e591cf4 commit bce4ef4
Show file tree
Hide file tree
Showing 56 changed files with 280 additions and 0 deletions.
6 changes: 6 additions & 0 deletions docs/resources/google_bigquery_dataset.md
Original file line number Diff line number Diff line change
Expand Up @@ -71,3 +71,9 @@ Properties that can be accessed from the `google_bigquery_dataset` resource:
* `last_modified_time`: The date when this dataset or any of its tables was last modified, in milliseconds since the epoch.

* `location`: The geographic location where the dataset should reside. Possible values include EU and US. The default value is US.



## GCP Permissions

Ensure the [BigQuery API](https://console.cloud.google.com/apis/library/bigquery-json.googleapis.com/) is enabled for the current project.
4 changes: 4 additions & 0 deletions docs/resources/google_bigquery_datasets.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,3 +28,7 @@ See [google_bigquery_dataset.md](google_bigquery_dataset.md) for more detailed i
## Filter Criteria
This resource supports all of the above properties as filter criteria, which can be used
with `where` as a block or a method.

## GCP Permissions

Ensure the [BigQuery API](https://console.cloud.google.com/apis/library/bigquery-json.googleapis.com/) is enabled for the current project.
6 changes: 6 additions & 0 deletions docs/resources/google_bigquery_table.md
Original file line number Diff line number Diff line change
Expand Up @@ -109,3 +109,9 @@ Properties that can be accessed from the `google_bigquery_table` resource:
* `bigtableOptions`: Additional options if sourceFormat is set to BIGTABLE.

* `dataset`: Name of the dataset



## GCP Permissions

Ensure the [BigQuery API](https://console.cloud.google.com/apis/library/bigquery-json.googleapis.com/) is enabled for the current project.
4 changes: 4 additions & 0 deletions docs/resources/google_bigquery_tables.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,3 +45,7 @@ See [google_bigquery_table.md](google_bigquery_table.md) for more detailed infor
## Filter Criteria
This resource supports all of the above properties as filter criteria, which can be used
with `where` as a block or a method.

## GCP Permissions

Ensure the [BigQuery API](https://console.cloud.google.com/apis/library/bigquery-json.googleapis.com/) is enabled for the current project.
6 changes: 6 additions & 0 deletions docs/resources/google_cloudbuild_trigger.md
Original file line number Diff line number Diff line change
Expand Up @@ -62,3 +62,9 @@ Properties that can be accessed from the `google_cloudbuild_trigger` resource:
* `images`: A list of images to be pushed upon the successful completion of all build steps. The images are pushed using the builder service account's credentials. The digests of the pushed images will be stored in the Build resource's results field. If any of the images fail to be pushed, the build status is marked FAILURE.

* `steps`: The operations to be performed on the workspace.



## GCP Permissions

Ensure the [Cloud Build API](https://console.cloud.google.com/apis/library/cloudbuild.googleapis.com/) is enabled for the current project.
4 changes: 4 additions & 0 deletions docs/resources/google_cloudbuild_triggers.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,3 +40,7 @@ See [google_cloudbuild_trigger.md](google_cloudbuild_trigger.md) for more detail
## Filter Criteria
This resource supports all of the above properties as filter criteria, which can be used
with `where` as a block or a method.

## GCP Permissions

Ensure the [Cloud Build API](https://console.cloud.google.com/apis/library/cloudbuild.googleapis.com/) is enabled for the current project.
6 changes: 6 additions & 0 deletions docs/resources/google_compute_autoscaler.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,3 +51,9 @@ Properties that can be accessed from the `google_compute_autoscaler` resource:
* `target`: URL of the managed instance group that this autoscaler will scale.

* `zone`: URL of the zone where the instance group resides.



## GCP Permissions

Ensure the [Compute Engine API](https://console.cloud.google.com/apis/library/compute.googleapis.com/) is enabled for the current project.
4 changes: 4 additions & 0 deletions docs/resources/google_compute_autoscalers.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,3 +36,7 @@ See [google_compute_autoscaler.md](google_compute_autoscaler.md) for more detail
## Filter Criteria
This resource supports all of the above properties as filter criteria, which can be used
with `where` as a block or a method.

## GCP Permissions

Ensure the [Compute Engine API](https://console.cloud.google.com/apis/library/compute.googleapis.com/) is enabled for the current project.
6 changes: 6 additions & 0 deletions docs/resources/google_compute_backend_service.md
Original file line number Diff line number Diff line change
Expand Up @@ -88,3 +88,9 @@ Properties that can be accessed from the `google_compute_backend_service` resour
* `session_affinity`: Type of session affinity to use. The default is NONE. When the load balancing scheme is EXTERNAL, can be NONE, CLIENT_IP, or GENERATED_COOKIE. When the load balancing scheme is INTERNAL, can be NONE, CLIENT_IP, CLIENT_IP_PROTO, or CLIENT_IP_PORT_PROTO. When the protocol is UDP, this field is not used.

* `timeout_sec`: How many seconds to wait for the backend before considering it a failed request. Default is 30 seconds. Valid range is [1, 86400].



## GCP Permissions

Ensure the [Compute Engine API](https://console.cloud.google.com/apis/library/compute.googleapis.com/) is enabled for the current project.
4 changes: 4 additions & 0 deletions docs/resources/google_compute_backend_services.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,3 +42,7 @@ See [google_compute_backend_service.md](google_compute_backend_service.md) for m
## Filter Criteria
This resource supports all of the above properties as filter criteria, which can be used
with `where` as a block or a method.

## GCP Permissions

Ensure the [Compute Engine API](https://console.cloud.google.com/apis/library/compute.googleapis.com/) is enabled for the current project.
6 changes: 6 additions & 0 deletions docs/resources/google_compute_disk.md
Original file line number Diff line number Diff line change
Expand Up @@ -91,3 +91,9 @@ Properties that can be accessed from the `google_compute_disk` resource:
* `sha256`: The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.

* `source_snapshot_id`: The unique ID of the snapshot used to create this disk. This value identifies the exact snapshot that was used to create this persistent disk. For example, if you created the persistent disk from a snapshot that was later deleted and recreated under the same name, the source snapshot ID would identify the exact version of the snapshot that was used.



## GCP Permissions

Ensure the [Compute Engine API](https://console.cloud.google.com/apis/library/compute.googleapis.com/) is enabled for the current project.
4 changes: 4 additions & 0 deletions docs/resources/google_compute_disks.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,3 +44,7 @@ See [google_compute_disk.md](google_compute_disk.md) for more detailed informati
## Filter Criteria
This resource supports all of the above properties as filter criteria, which can be used
with `where` as a block or a method.

## GCP Permissions

Ensure the [Compute Engine API](https://console.cloud.google.com/apis/library/compute.googleapis.com/) is enabled for the current project.
6 changes: 6 additions & 0 deletions docs/resources/google_compute_global_address.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,3 +36,9 @@ Properties that can be accessed from the `google_compute_global_address` resourc
* `region`: A reference to the region where the regional address resides.

* `address_type`: The type of the address to reserve, default is EXTERNAL. * EXTERNAL indicates public/external single IP address. * INTERNAL indicates internal IP ranges belonging to some network.



## GCP Permissions

Ensure the [Compute Engine API](https://console.cloud.google.com/apis/library/compute.googleapis.com/) is enabled for the current project.
4 changes: 4 additions & 0 deletions docs/resources/google_compute_global_addresses.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,3 +31,7 @@ See [google_compute_global_address.md](google_compute_global_address.md) for mor
## Filter Criteria
This resource supports all of the above properties as filter criteria, which can be used
with `where` as a block or a method.

## GCP Permissions

Ensure the [Compute Engine API](https://console.cloud.google.com/apis/library/compute.googleapis.com/) is enabled for the current project.
6 changes: 6 additions & 0 deletions docs/resources/google_compute_global_forwarding_rule.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,3 +51,9 @@ Properties that can be accessed from the `google_compute_global_forwarding_rule`
* `region`: A reference to the region where the regional forwarding rule resides. This field is not applicable to global forwarding rules.

* `target`: This target must be a global load balancing resource. The forwarded traffic must be of a type appropriate to the target object. Valid types: HTTP_PROXY, HTTPS_PROXY, SSL_PROXY, TCP_PROXY



## GCP Permissions

Ensure the [Compute Engine API](https://console.cloud.google.com/apis/library/compute.googleapis.com/) is enabled for the current project.
4 changes: 4 additions & 0 deletions docs/resources/google_compute_global_forwarding_rules.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,3 +37,7 @@ See [google_compute_global_forwarding_rule.md](google_compute_global_forwarding_
## Filter Criteria
This resource supports all of the above properties as filter criteria, which can be used
with `where` as a block or a method.

## GCP Permissions

Ensure the [Compute Engine API](https://console.cloud.google.com/apis/library/compute.googleapis.com/) is enabled for the current project.
6 changes: 6 additions & 0 deletions docs/resources/google_compute_health_check.md
Original file line number Diff line number Diff line change
Expand Up @@ -91,3 +91,9 @@ Properties that can be accessed from the `google_compute_health_check` resource:
* `portName`: Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.

* `proxyHeader`: Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.



## GCP Permissions

Ensure the [Compute Engine API](https://console.cloud.google.com/apis/library/compute.googleapis.com/) is enabled for the current project.
4 changes: 4 additions & 0 deletions docs/resources/google_compute_health_checks.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,3 +35,7 @@ See [google_compute_health_check.md](google_compute_health_check.md) for more de
## Filter Criteria
This resource supports all of the above properties as filter criteria, which can be used
with `where` as a block or a method.

## GCP Permissions

Ensure the [Compute Engine API](https://console.cloud.google.com/apis/library/compute.googleapis.com/) is enabled for the current project.
6 changes: 6 additions & 0 deletions docs/resources/google_compute_http_health_check.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,3 +44,9 @@ Properties that can be accessed from the `google_compute_http_health_check` reso
* `timeout_sec`: How long (in seconds) to wait before claiming failure. The default value is 5 seconds. It is invalid for timeoutSec to have greater value than checkIntervalSec.

* `unhealthy_threshold`: A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2.



## GCP Permissions

Ensure the [Compute Engine API](https://console.cloud.google.com/apis/library/compute.googleapis.com/) is enabled for the current project.
4 changes: 4 additions & 0 deletions docs/resources/google_compute_http_health_checks.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,3 +34,7 @@ See [google_compute_http_health_check.md](google_compute_http_health_check.md) f
## Filter Criteria
This resource supports all of the above properties as filter criteria, which can be used
with `where` as a block or a method.

## GCP Permissions

Ensure the [Compute Engine API](https://console.cloud.google.com/apis/library/compute.googleapis.com/) is enabled for the current project.
6 changes: 6 additions & 0 deletions docs/resources/google_compute_https_health_check.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,3 +45,9 @@ Properties that can be accessed from the `google_compute_https_health_check` res
* `timeout_sec`: How long (in seconds) to wait before claiming failure. The default value is 5 seconds. It is invalid for timeoutSec to have greater value than checkIntervalSec.

* `unhealthy_threshold`: A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2.



## GCP Permissions

Ensure the [Compute Engine API](https://console.cloud.google.com/apis/library/compute.googleapis.com/) is enabled for the current project.
4 changes: 4 additions & 0 deletions docs/resources/google_compute_https_health_checks.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,3 +34,7 @@ See [google_compute_https_health_check.md](google_compute_https_health_check.md)
## Filter Criteria
This resource supports all of the above properties as filter criteria, which can be used
with `where` as a block or a method.

## GCP Permissions

Ensure the [Compute Engine API](https://console.cloud.google.com/apis/library/compute.googleapis.com/) is enabled for the current project.
6 changes: 6 additions & 0 deletions docs/resources/google_compute_instance_group_manager.md
Original file line number Diff line number Diff line change
Expand Up @@ -71,3 +71,9 @@ Properties that can be accessed from the `google_compute_instance_group_manager`
* `target_size`: The target number of running instances for this managed instance group. Deleting or abandoning instances reduces this number. Resizing the group changes this number.

* `zone`: The zone the managed instance group resides.



## GCP Permissions

Ensure the [Compute Engine API](https://console.cloud.google.com/apis/library/compute.googleapis.com/) is enabled for the current project.
4 changes: 4 additions & 0 deletions docs/resources/google_compute_instance_group_managers.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,3 +34,7 @@ See [google_compute_instance_group_manager.md](google_compute_instance_group_man
## Filter Criteria
This resource supports all of the above properties as filter criteria, which can be used
with `where` as a block or a method.

## GCP Permissions

Ensure the [Compute Engine API](https://console.cloud.google.com/apis/library/compute.googleapis.com/) is enabled for the current project.
6 changes: 6 additions & 0 deletions docs/resources/google_compute_instance_template.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,3 +60,9 @@ Properties that can be accessed from the `google_compute_instance_template` reso
* `serviceAccounts`: A list of service accounts, with their specified scopes, authorized for this instance. Only one service account per VM instance is supported.

* `tags`: A list of tags to apply to this instance. Tags are used to identify valid sources or targets for network firewalls and are specified by the client during instance creation. The tags can be later modified by the setTags method. Each tag within the list must comply with RFC1035.



## GCP Permissions

Ensure the [Compute Engine API](https://console.cloud.google.com/apis/library/compute.googleapis.com/) is enabled for the current project.
4 changes: 4 additions & 0 deletions docs/resources/google_compute_instance_templates.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,3 +26,7 @@ See [google_compute_instance_template.md](google_compute_instance_template.md) f
## Filter Criteria
This resource supports all of the above properties as filter criteria, which can be used
with `where` as a block or a method.

## GCP Permissions

Ensure the [Compute Engine API](https://console.cloud.google.com/apis/library/compute.googleapis.com/) is enabled for the current project.
6 changes: 6 additions & 0 deletions docs/resources/google_compute_route.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,3 +45,9 @@ Properties that can be accessed from the `google_compute_route` resource:
* `next_hop_vpn_tunnel`: URL to a VpnTunnel that should handle matching packets.

* `next_hop_network`: URL to a Network that should handle matching packets.



## GCP Permissions

Ensure the [Compute Engine API](https://console.cloud.google.com/apis/library/compute.googleapis.com/) is enabled for the current project.
6 changes: 6 additions & 0 deletions docs/resources/google_compute_router.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,3 +48,9 @@ Properties that can be accessed from the `google_compute_router` resource:
* `advertisedIpRanges`: User-specified list of individual IP ranges to advertise in custom mode. This field can only be populated if advertiseMode is CUSTOM and is advertised to all peers of the router. These IP ranges will be advertised in addition to any specified groups. Leave this field blank to advertise no custom IP ranges.

* `region`: Region where the router resides.



## GCP Permissions

Ensure the [Compute Engine API](https://console.cloud.google.com/apis/library/compute.googleapis.com/) is enabled for the current project.
4 changes: 4 additions & 0 deletions docs/resources/google_compute_routers.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,3 +28,7 @@ See [google_compute_router.md](google_compute_router.md) for more detailed infor
## Filter Criteria
This resource supports all of the above properties as filter criteria, which can be used
with `where` as a block or a method.

## GCP Permissions

Ensure the [Compute Engine API](https://console.cloud.google.com/apis/library/compute.googleapis.com/) is enabled for the current project.
4 changes: 4 additions & 0 deletions docs/resources/google_compute_routes.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,3 +35,7 @@ See [google_compute_route.md](google_compute_route.md) for more detailed informa
## Filter Criteria
This resource supports all of the above properties as filter criteria, which can be used
with `where` as a block or a method.

## GCP Permissions

Ensure the [Compute Engine API](https://console.cloud.google.com/apis/library/compute.googleapis.com/) is enabled for the current project.
6 changes: 6 additions & 0 deletions docs/resources/google_compute_snapshot.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,3 +57,9 @@ Properties that can be accessed from the `google_compute_snapshot` resource:
* `rawKey`: Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.

* `kmsKeyName`: The name of the encryption key that is stored in Google Cloud KMS.



## GCP Permissions

Ensure the [Compute Engine API](https://console.cloud.google.com/apis/library/compute.googleapis.com/) is enabled for the current project.
4 changes: 4 additions & 0 deletions docs/resources/google_compute_snapshots.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,3 +43,7 @@ See [google_compute_snapshot.md](google_compute_snapshot.md) for more detailed i
## Filter Criteria
This resource supports all of the above properties as filter criteria, which can be used
with `where` as a block or a method.

## GCP Permissions

Ensure the [Compute Engine API](https://console.cloud.google.com/apis/library/compute.googleapis.com/) is enabled for the current project.
6 changes: 6 additions & 0 deletions docs/resources/google_compute_ssl_certificate.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,3 +50,9 @@ Properties that can be accessed from the `google_compute_ssl_certificate` resour
* `name`: Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.

* `private_key`: The write-only private key in PEM format.



## GCP Permissions

Ensure the [Compute Engine API](https://console.cloud.google.com/apis/library/compute.googleapis.com/) is enabled for the current project.
4 changes: 4 additions & 0 deletions docs/resources/google_compute_ssl_certificates.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,3 +47,7 @@ See [google_compute_ssl_certificate.md](google_compute_ssl_certificate.md) for m
## Filter Criteria
This resource supports all of the above properties as filter criteria, which can be used
with `where` as a block or a method.

## GCP Permissions

Ensure the [Compute Engine API](https://console.cloud.google.com/apis/library/compute.googleapis.com/) is enabled for the current project.
4 changes: 4 additions & 0 deletions docs/resources/google_compute_ssl_policies.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,3 +40,7 @@ See [google_compute_ssl_policy.md](google_compute_ssl_policy.md) for more detail
## Filter Criteria
This resource supports all of the above properties as filter criteria, which can be used
with `where` as a block or a method.

## GCP Permissions

Ensure the [Compute Engine API](https://console.cloud.google.com/apis/library/compute.googleapis.com/) is enabled for the current project.
6 changes: 6 additions & 0 deletions docs/resources/google_compute_ssl_policy.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,3 +47,9 @@ Properties that can be accessed from the `google_compute_ssl_policy` resource:
* `code`: A warning code, if applicable.

* `message`: A human-readable description of the warning code.



## GCP Permissions

Ensure the [Compute Engine API](https://console.cloud.google.com/apis/library/compute.googleapis.com/) is enabled for the current project.
4 changes: 4 additions & 0 deletions docs/resources/google_compute_target_http_proxies.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,3 +27,7 @@ See [google_compute_target_http_proxy.md](google_compute_target_http_proxy.md) f
## Filter Criteria
This resource supports all of the above properties as filter criteria, which can be used
with `where` as a block or a method.

## GCP Permissions

Ensure the [Compute Engine API](https://console.cloud.google.com/apis/library/compute.googleapis.com/) is enabled for the current project.
6 changes: 6 additions & 0 deletions docs/resources/google_compute_target_http_proxy.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,3 +31,9 @@ Properties that can be accessed from the `google_compute_target_http_proxy` reso
* `name`: Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.

* `url_map`: A reference to the UrlMap resource that defines the mapping from URL to the BackendService.



## GCP Permissions

Ensure the [Compute Engine API](https://console.cloud.google.com/apis/library/compute.googleapis.com/) is enabled for the current project.
4 changes: 4 additions & 0 deletions docs/resources/google_compute_target_https_proxies.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,3 +30,7 @@ See [google_compute_target_https_proxy.md](google_compute_target_https_proxy.md)
## Filter Criteria
This resource supports all of the above properties as filter criteria, which can be used
with `where` as a block or a method.

## GCP Permissions

Ensure the [Compute Engine API](https://console.cloud.google.com/apis/library/compute.googleapis.com/) is enabled for the current project.
6 changes: 6 additions & 0 deletions docs/resources/google_compute_target_https_proxy.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,3 +37,9 @@ Properties that can be accessed from the `google_compute_target_https_proxy` res
* `ssl_policy`: A reference to the SslPolicy resource that will be associated with the TargetHttpsProxy resource. If not set, the TargetHttpsProxy resource will not have any SSL policy configured.

* `url_map`: A reference to the UrlMap resource that defines the mapping from URL to the BackendService.



## GCP Permissions

Ensure the [Compute Engine API](https://console.cloud.google.com/apis/library/compute.googleapis.com/) is enabled for the current project.
Loading

0 comments on commit bce4ef4

Please sign in to comment.