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

Commit

Permalink
Inspec beta flag on resources
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 Stuart Paterson committed Apr 6, 2020
1 parent 00a5331 commit 91e5ff7
Show file tree
Hide file tree
Showing 263 changed files with 2,377 additions and 314 deletions.
18 changes: 18 additions & 0 deletions docs/resources/google_cloudbuild_trigger.md
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,24 @@ Properties that can be accessed from the `google_cloudbuild_trigger` resource:

* `commit_sha`: Explicit commit SHA to build. Exactly one of a branch name, tag, or commit SHA must be provided.

* `github`: (Beta only) Describes the configuration of a trigger that creates a build whenever a GitHub event is received.

* `owner`: Owner of the repository. For example: The owner for https://github.com/googlecloudplatform/cloud-builders is "googlecloudplatform".

* `name`: Name of the repository. For example: The name for https://github.com/googlecloudplatform/cloud-builders is "cloud-builders".

* `pull_request`: filter to match changes in pull requests. Specify only one of pullRequest or push.

* `branch`: Regex of branches to match.

* `comment_control`: Whether to block builds on a "/gcbrun" comment from a repository owner or collaborator.

* `push`: filter to match changes in refs, like branches or tags. Specify only one of pullRequest or push.

* `branch`: Regex of branches to match. Specify only one of branch or tag.

* `tag`: Regex of tags to match. Specify only one of branch or tag.

* `build`: Contents of the build template. Either a filename or build template must be provided.

* `tags`: Tags for annotation of a Build. These are not docker tags.
Expand Down
1 change: 1 addition & 0 deletions docs/resources/google_cloudbuild_triggers.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,7 @@ See [google_cloudbuild_trigger.md](google_cloudbuild_trigger.md) for more detail
* `ignored_files`: an array of `google_cloudbuild_trigger` ignored_files
* `included_files`: an array of `google_cloudbuild_trigger` included_files
* `trigger_templates`: an array of `google_cloudbuild_trigger` trigger_template
* `githubs`: (Beta only) an array of `google_cloudbuild_trigger` github
* `builds`: an array of `google_cloudbuild_trigger` build

## Filter Criteria
Expand Down
8 changes: 8 additions & 0 deletions docs/resources/google_compute_address.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,10 @@ platform: gcp
## Syntax
A `google_compute_address` is used to test a Google Address resource


## Beta Resource
This resource has beta fields available. To retrieve these fields, include `beta: true` in the constructor for the resource

## Examples
```
describe google_compute_address(project: 'chef-gcp-inspec', location: 'europe-west2', name: 'inspec-gcp-global-address') do
Expand Down Expand Up @@ -69,6 +73,10 @@ Properties that can be accessed from the `google_compute_address` resource:

* `users`: The URLs of the resources that are using this address.

* `labels`: (Beta only) Labels to apply to this address. A list of key->value pairs.

* `label_fingerprint`: (Beta only) The fingerprint used for optimistic locking of this resource. Used internally during updates.

* `status`: The status of the address, which can be one of RESERVING, RESERVED, or IN_USE. An address that is RESERVING is currently in the process of being reserved. A RESERVED address is currently reserved and available to use. An IN_USE address is currently being used by another resource and is not available.

* `region`: URL of the region where the regional address resides. This field is not applicable to global addresses.
Expand Down
6 changes: 6 additions & 0 deletions docs/resources/google_compute_addresses.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,10 @@ platform: gcp
## Syntax
A `google_compute_addresses` is used to test a Google Address resource


## Beta Resource
This resource has beta fields available. To retrieve these fields, include `beta: true` in the constructor for the resource

## Examples
```
describe google_compute_addresses(project: 'chef-gcp-inspec', location: 'europe-west2') do
Expand All @@ -28,6 +32,8 @@ See [google_compute_address.md](google_compute_address.md) for more detailed inf
* `network_tiers`: an array of `google_compute_address` network_tier
* `subnetworks`: an array of `google_compute_address` subnetwork
* `users`: an array of `google_compute_address` users
* `labels`: (Beta only) an array of `google_compute_address` labels
* `label_fingerprints`: (Beta only) an array of `google_compute_address` label_fingerprint
* `statuses`: an array of `google_compute_address` status
* `regions`: an array of `google_compute_address` region

Expand Down
8 changes: 8 additions & 0 deletions docs/resources/google_compute_autoscaler.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,10 @@ platform: gcp
## Syntax
A `google_compute_autoscaler` is used to test a Google Autoscaler resource


## Beta Resource
This resource has beta fields available. To retrieve these fields, include `beta: true` in the constructor for the resource

## Examples
```
describe google_compute_autoscaler(project: 'chef-gcp-inspec', zone: 'zone', name: 'inspec-gcp-autoscaler') do
Expand Down Expand Up @@ -51,10 +55,14 @@ Properties that can be accessed from the `google_compute_autoscaler` resource:

* `metric`: The identifier (type) of the Stackdriver Monitoring metric. The metric cannot have negative values. The metric must have a value type of INT64 or DOUBLE.

* `single_instance_assignment`: (Beta only) If scaling is based on a per-group metric value that represents the total amount of work to be done or resource usage, set this value to an amount assigned for a single instance of the scaled group. The autoscaler will keep the number of instances proportional to the value of this metric, the metric itself should not change value due to group resizing. For example, a good metric to use with the target is `pubsub.googleapis.com/subscription/num_undelivered_messages` or a custom metric exporting the total number of requests coming to your instances. A bad example would be a metric exporting an average or median latency, since this value can't include a chunk assignable to a single instance, it could be better used with utilization_target instead.

* `utilization_target`: The target value of the metric that autoscaler should maintain. This must be a positive value. A utilization metric scales number of virtual machines handling requests to increase or decrease proportionally to the metric. For example, a good metric to use as a utilizationTarget is www.googleapis.com/compute/instance/network/received_bytes_count. The autoscaler will work to keep this value constant for each of the instances.

* `utilization_target_type`: Defines how target utilization value is expressed for a Stackdriver Monitoring metric. Either GAUGE, DELTA_PER_SECOND, or DELTA_PER_MINUTE.

* `filter`: (Beta only) A filter string to be used as the filter string for a Stackdriver Monitoring TimeSeries.list API call. This filter is used to select a specific TimeSeries for the purpose of autoscaling and to determine whether the metric is exporting per-instance or per-group data. You can only use the AND operator for joining selectors. You can only use direct equality comparison operator (=) without any functions for each selector. You can specify the metric in both the filter string and in the metric field. However, if specified in both places, the metric must be identical. The monitored resource type determines what kind of values are expected for the metric. If it is a gce_instance, the autoscaler expects the metric to include a separate TimeSeries for each instance in a group. In such a case, you cannot filter on resource labels. If the resource type is any other value, the autoscaler expects this metric to contain values that apply to the entire autoscaled instance group and resource label filtering can be performed to point autoscaler at the correct TimeSeries to scale upon. This is called a per-group metric for the purpose of autoscaling. If not specified, the type defaults to gce_instance. You should provide a filter that is selective enough to pick just one TimeSeries for the autoscaled group or for each of the instances (if you are using gce_instance resource type). If multiple TimeSeries are returned upon the query execution, the autoscaler will sum their respective values to obtain its scaling value.

* `load_balancing_utilization`: Configuration parameters of autoscaling based on a load balancer.

* `utilization_target`: Fraction of backend capacity utilization (set in HTTP(s) load balancing configuration) that autoscaler should maintain. Must be a positive float value. If not defined, the default is 0.8.
Expand Down
4 changes: 4 additions & 0 deletions docs/resources/google_compute_autoscalers.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,10 @@ platform: gcp
## Syntax
A `google_compute_autoscalers` is used to test a Google Autoscaler resource


## Beta Resource
This resource has beta fields available. To retrieve these fields, include `beta: true` in the constructor for the resource

## Examples
```
autoscalers = google_compute_autoscalers(project: 'chef-gcp-inspec', zone: 'zone')
Expand Down
4 changes: 4 additions & 0 deletions docs/resources/google_compute_backend_bucket.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,10 @@ platform: gcp
## Syntax
A `google_compute_backend_bucket` is used to test a Google BackendBucket resource


## Beta Resource
This resource has beta fields available. To retrieve these fields, include `beta: true` in the constructor for the resource

## Examples
```
describe google_compute_backend_bucket(project: 'chef-gcp-inspec', name: 'inspec-gcp-backend-bucket') do
Expand Down
4 changes: 4 additions & 0 deletions docs/resources/google_compute_backend_buckets.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,10 @@ platform: gcp
## Syntax
A `google_compute_backend_buckets` is used to test a Google BackendBucket resource


## Beta Resource
This resource has beta fields available. To retrieve these fields, include `beta: true` in the constructor for the resource

## Examples
```
describe google_compute_backend_buckets(project: 'chef-gcp-inspec', name: 'inspec-gcp-backend-bucket') do
Expand Down
Loading

0 comments on commit 91e5ff7

Please sign in to comment.