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

Commit 7958203

Browse files
authored
Merge pull request #181 from modular-magician/master
Add dataproc_cluster resource, doc fixes
2 parents 4c4aebc + 555aecf commit 7958203

File tree

184 files changed

+4155
-111
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

184 files changed

+4155
-111
lines changed

Gemfile

+2-1
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,12 @@
11
source 'https://rubygems.org'
22

33
gem 'bundle'
4+
gem 'faraday', '>= 0.16.2'
45
gem 'google-api-client'
56
gem 'google-cloud'
67
gem 'googleauth'
78
gem 'inifile'
8-
gem 'inspec-bin'
9+
gem 'inspec-bin', '4.16.0'
910
gem 'rubocop'
1011

1112
group :development do

docs/resources/google_appengine_standard_app_version.md

+2
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,7 @@ end
1919
## Properties
2020
Properties that can be accessed from the `google_appengine_standard_app_version` resource:
2121

22+
2223
* `name`: Full path to the Version resource in the API. Example, "v1".
2324

2425
* `version_id`: Relative name of the version within the service. For example, `v1`. Version names can contain only lowercase letters, numbers, or hyphens. Reserved names,"default", "latest", and any name with the prefix "ah-".
@@ -27,6 +28,7 @@ Properties that can be accessed from the `google_appengine_standard_app_version`
2728

2829
* `threadsafe`: Whether multiple requests can be dispatched to this version at once.
2930

31+
* `instance_class`: Instance class that is used to run this version. Valid values are AutomaticScaling F1, F2, F4, F4_1G (Only AutomaticScaling is supported at the moment)
3032

3133

3234
## GCP Permissions

docs/resources/google_appengine_standard_app_versions.md

+1
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,7 @@ See [google_appengine_standard_app_version.md](google_appengine_standard_app_ver
2222
* `version_ids`: an array of `google_appengine_standard_app_version` version_id
2323
* `runtimes`: an array of `google_appengine_standard_app_version` runtime
2424
* `threadsaves`: an array of `google_appengine_standard_app_version` threadsafe
25+
* `instance_classes`: an array of `google_appengine_standard_app_version` instance_class
2526

2627
## Filter Criteria
2728
This resource supports all of the above properties as filter criteria, which can be used

docs/resources/google_bigquery_dataset.md

+10
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,7 @@ end
3535
## Properties
3636
Properties that can be accessed from the `google_bigquery_dataset` resource:
3737

38+
3839
* `access`: An array of objects that define dataset access for one or more entities.
3940

4041
* `domain`: A domain to grant access to. Any users signed in with the domain specified will be granted the specified access
@@ -49,6 +50,12 @@ Properties that can be accessed from the `google_bigquery_dataset` resource:
4950

5051
* `view`: A view from a different dataset to grant access to. Queries executed against that view will have read access to tables in this dataset. The role field is not required when this field is set. If that view is updated by any user, access to the view needs to be granted again via an update operation.
5152

53+
* `dataset_id`: The ID of the dataset containing this table.
54+
55+
* `project_id`: The ID of the project containing this table.
56+
57+
* `table_id`: The ID of the table. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.
58+
5259
* `creation_time`: The time when this dataset was created, in milliseconds since the epoch.
5360

5461
* `dataset_reference`: A reference that identifies the dataset.
@@ -75,6 +82,9 @@ Properties that can be accessed from the `google_bigquery_dataset` resource:
7582

7683
* `location`: The geographic location where the dataset should reside. See [official docs](https://cloud.google.com/bigquery/docs/dataset-locations). There are two types of locations, regional or multi-regional. A regional location is a specific geographic place, such as Tokyo, and a multi-regional location is a large geographic area, such as the United States, that contains at least two geographic places. Possible regional values include: `asia-east1`, `asia-northeast1`, `asia-southeast1`, `australia-southeast1`, `europe-north1`, `europe-west2` and `us-east4`. Possible multi-regional values: `EU` and `US`. The default value is multi-regional location `US`. Changing this forces a new resource to be created.
7784

85+
* `default_encryption_configuration`: The default encryption key for all tables in the dataset. Once this property is set, all newly-created partitioned tables in the dataset will have encryption key set to this value, unless table creation request (or query) overrides the key.
86+
87+
* `kms_key_name`: Describes the Cloud KMS encryption key that will be used to protect destination BigQuery table. The BigQuery Service Account associated with your project requires access to this encryption key.
7888

7989

8090
## GCP Permissions

docs/resources/google_bigquery_datasets.md

+1
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,7 @@ See [google_bigquery_dataset.md](google_bigquery_dataset.md) for more detailed i
2626
* `ids`: an array of `google_bigquery_dataset` id
2727
* `labels`: an array of `google_bigquery_dataset` labels
2828
* `locations`: an array of `google_bigquery_dataset` location
29+
* `default_encryption_configurations`: an array of `google_bigquery_dataset` default_encryption_configuration
2930

3031
## Filter Criteria
3132
This resource supports all of the above properties as filter criteria, which can be used

docs/resources/google_bigquery_table.md

+67-1
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,7 @@ end
2424
## Properties
2525
Properties that can be accessed from the `google_bigquery_table` resource:
2626

27+
2728
* `table_reference`: Reference describing the ID of this table
2829

2930
* `dataset_id`: The ID of the dataset containing this table
@@ -66,6 +67,10 @@ Properties that can be accessed from the `google_bigquery_table` resource:
6667

6768
* `user_defined_function_resources`: Describes user-defined function resources used in the query.
6869

70+
* `inline_code`: An inline resource that contains code for a user-defined function (UDF). Providing a inline code resource is equivalent to providing a URI for a file containing the same code.
71+
72+
* `resource_uri`: A code resource to load from a Google Cloud Storage URI (gs://bucket/path).
73+
6974
* `time_partitioning`: If specified, configures time-based partitioning for this table.
7075

7176
* `expiration_ms`: Number of milliseconds for which to keep the storage for a partition.
@@ -86,6 +91,16 @@ Properties that can be accessed from the `google_bigquery_table` resource:
8691

8792
* `fields`: Describes the fields in a table.
8893

94+
* `description`: The field description. The maximum length is 1,024 characters.
95+
96+
* `fields`: Describes the nested schema fields if the type property is set to RECORD.
97+
98+
* `mode`: The field mode
99+
100+
* `name`: The field name
101+
102+
* `type`: The field data type
103+
89104
* `encryption_configuration`: Custom encryption configuration
90105

91106
* `kms_key_name`: Describes the Cloud KMS encryption key that will be used to protect destination BigQuery table. The BigQuery Service Account associated with your project requires access to this encryption key.
@@ -108,14 +123,65 @@ Properties that can be accessed from the `google_bigquery_table` resource:
108123

109124
* `schema`: The schema for the data. Schema is required for CSV and JSON formats
110125

126+
* `fields`: Describes the fields in a table.
127+
128+
* `description`: The field description
129+
130+
* `fields`: Describes the nested schema fields if the type property is set to RECORD
131+
132+
* `mode`: Field mode.
133+
134+
* `name`: Field name
135+
136+
* `type`: Field data type
137+
111138
* `google_sheets_options`: Additional options if sourceFormat is set to GOOGLE_SHEETS.
112139

140+
* `skip_leading_rows`: The number of rows at the top of a Google Sheet that BigQuery will skip when reading the data.
141+
113142
* `csv_options`: Additional properties to set if sourceFormat is set to CSV.
114143

144+
* `allow_jagged_rows`: Indicates if BigQuery should accept rows that are missing trailing optional columns
145+
146+
* `allow_quoted_newlines`: Indicates if BigQuery should allow quoted data sections that contain newline characters in a CSV file
147+
148+
* `encoding`: The character encoding of the data
149+
150+
* `field_delimiter`: The separator for fields in a CSV file
151+
152+
* `quote`: The value that is used to quote data sections in a CSV file
153+
154+
* `skip_leading_rows`: The number of rows at the top of a CSV file that BigQuery will skip when reading the data.
155+
115156
* `bigtable_options`: Additional options if sourceFormat is set to BIGTABLE.
116157

117-
* `dataset`: Name of the dataset
158+
* `ignore_unspecified_column_families`: If field is true, then the column families that are not specified in columnFamilies list are not exposed in the table schema
159+
160+
* `read_rowkey_as_string`: If field is true, then the rowkey column families will be read and converted to string.
161+
162+
* `column_families`: List of column families to expose in the table schema along with their types.
163+
164+
* `columns`: Lists of columns that should be exposed as individual fields as opposed to a list of (column name, value) pairs.
165+
166+
* `encoding`: The encoding of the values when the type is not STRING
167+
168+
* `field_name`: If the qualifier is not a valid BigQuery field identifier, a valid identifier must be provided as the column field name and is used as field name in queries.
118169

170+
* `only_read_latest`: If this is set, only the latest version of value in this column are exposed
171+
172+
* `qualifier_string`: Qualifier of the column
173+
174+
* `type`: The type to convert the value in cells of this column
175+
176+
* `encoding`: The encoding of the values when the type is not STRING
177+
178+
* `family_id`: Identifier of the column family.
179+
180+
* `only_read_latest`: If this is set only the latest version of value are exposed for all columns in this column family
181+
182+
* `type`: The type to convert the value in cells of this column family
183+
184+
* `dataset`: Name of the dataset
119185

120186

121187
## GCP Permissions

docs/resources/google_cloudbuild_trigger.md

+26
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,7 @@ end
2525
## Properties
2626
Properties that can be accessed from the `google_cloudbuild_trigger` resource:
2727

28+
2829
* `id`: The unique identifier for the trigger.
2930

3031
* `description`: Human-readable description of the trigger.
@@ -63,6 +64,31 @@ Properties that can be accessed from the `google_cloudbuild_trigger` resource:
6364

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

67+
* `name`: The name of the container image that will run this particular build step. If the image is available in the host's Docker daemon's cache, it will be run directly. If not, the host will attempt to pull the image first, using the builder service account's credentials if necessary. The Docker daemon's cache will already have the latest versions of all of the officially supported build steps (https://github.com/GoogleCloudPlatform/cloud-builders). The Docker daemon will also have cached many of the layers for some popular images, like "ubuntu", "debian", but they will be refreshed at the time you attempt to use them. If you built an image in a previous build step, it will be stored in the host's Docker daemon's cache and is available to use as the name for a later build step.
68+
69+
* `args`: A list of arguments that will be presented to the step when it is started. If the image used to run the step's container has an entrypoint, the args are used as arguments to that entrypoint. If the image does not define an entrypoint, the first element in args is used as the entrypoint, and the remainder will be used as arguments.
70+
71+
* `env`: A list of environment variable definitions to be used when running a step. The elements are of the form "KEY=VALUE" for the environment variable "KEY" being given the value "VALUE".
72+
73+
* `id`: Unique identifier for this build step, used in `wait_for` to reference this build step as a dependency.
74+
75+
* `entrypoint`: Entrypoint to be used instead of the build step image's default entrypoint. If unset, the image's default entrypoint is used
76+
77+
* `dir`: Working directory to use when running this step's container. If this value is a relative path, it is relative to the build's working directory. If this value is absolute, it may be outside the build's working directory, in which case the contents of the path may not be persisted across build step executions, unless a `volume` for that path is specified. If the build specifies a `RepoSource` with `dir` and a step with a `dir`, which specifies an absolute path, the `RepoSource` `dir` is ignored for the step's execution.
78+
79+
* `secret_env`: A list of environment variables which are encrypted using a Cloud Key Management Service crypto key. These values must be specified in the build's `Secret`.
80+
81+
* `timeout`: Time limit for executing this build step. If not defined, the step has no time limit and will be allowed to continue to run until either it completes or the build itself times out.
82+
83+
* `timing`: Output only. Stores timing information for executing this build step.
84+
85+
* `volumes`: List of volumes to mount into the build step. Each volume is created as an empty volume prior to execution of the build step. Upon completion of the build, volumes and their contents are discarded. Using a named volume in only one step is not valid as it is indicative of a build request with an incorrect configuration.
86+
87+
* `name`: Name of the volume to mount. Volume names must be unique per build step and must be valid names for Docker volumes. Each named volume must be used by at least two build steps.
88+
89+
* `path`: Path at which to mount the volume. Paths must be absolute and cannot conflict with other volume paths on the same build step or with certain reserved volume paths.
90+
91+
* `wait_for`: The ID(s) of the step(s) that this build step depends on. This build step will not start until all the build steps in `wait_for` have completed successfully. If `wait_for` is empty, this build step will start when all previous build steps in the `Build.Steps` list have completed successfully.
6692

6793

6894
## GCP Permissions

docs/resources/google_cloudfunctions_cloud_function.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,7 @@ end
2525
## Properties
2626
Properties that can be accessed from the `google_cloudfunctions_cloud_function` resource:
2727

28+
2829
* `name`: A user-defined name of the function. Function names must be unique globally and match pattern `projects/*/locations/*/functions/*`.
2930

3031
* `description`: User-provided description of a function.
@@ -74,7 +75,6 @@ Properties that can be accessed from the `google_cloudfunctions_cloud_function`
7475
* `location`: The location of this cloud function.
7576

7677

77-
7878
## GCP Permissions
7979

8080
Ensure the [Cloud Functions API](https://console.cloud.google.com/apis/library/cloudfunctions.googleapis.com/) is enabled for the current project.

docs/resources/google_compute_autoscaler.md

+11-1
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,7 @@ end
2626
## Properties
2727
Properties that can be accessed from the `google_compute_autoscaler` resource:
2828

29+
2930
* `id`: Unique identifier for the resource.
3031

3132
* `creation_timestamp`: Creation timestamp in RFC3339 text format.
@@ -44,16 +45,25 @@ Properties that can be accessed from the `google_compute_autoscaler` resource:
4445

4546
* `cpu_utilization`: Defines the CPU utilization policy that allows the autoscaler to scale based on the average CPU utilization of a managed instance group.
4647

48+
* `utilization_target`: The target CPU utilization that the autoscaler should maintain. Must be a float value in the range (0, 1]. If not specified, the default is 0.6. If the CPU level is below the target utilization, the autoscaler scales down the number of instances until it reaches the minimum number of instances you specified or until the average CPU of your instances reaches the target utilization. If the average CPU is above the target utilization, the autoscaler scales up until it reaches the maximum number of instances you specified or until the average utilization reaches the target utilization.
49+
4750
* `custom_metric_utilizations`: Defines the CPU utilization policy that allows the autoscaler to scale based on the average CPU utilization of a managed instance group.
4851

52+
* `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.
53+
54+
* `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.
55+
56+
* `utilization_target_type`: Defines how target utilization value is expressed for a Stackdriver Monitoring metric. Either GAUGE, DELTA_PER_SECOND, or DELTA_PER_MINUTE.
57+
4958
* `load_balancing_utilization`: Configuration parameters of autoscaling based on a load balancer.
5059

60+
* `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.
61+
5162
* `target`: URL of the managed instance group that this autoscaler will scale.
5263

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

5566

56-
5767
## GCP Permissions
5868

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

docs/resources/google_compute_backend_bucket.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,7 @@ end
2323
## Properties
2424
Properties that can be accessed from the `google_compute_backend_bucket` resource:
2525

26+
2627
* `bucket_name`: Cloud Storage bucket name.
2728

2829
* `cdn_policy`: Cloud CDN configuration for this Backend Bucket.
@@ -40,7 +41,6 @@ Properties that can be accessed from the `google_compute_backend_bucket` resourc
4041
* `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.
4142

4243

43-
4444
## GCP Permissions
4545

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

0 commit comments

Comments
 (0)