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.

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

Merge most recent Magic Modules generated master #105

Merged
merged 10 commits into from
Feb 11, 2019
3 changes: 1 addition & 2 deletions docs/resources/google_cloudbuild_trigger.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,8 @@
---
title: About the Trigger resource
title: About the google_cloudbuild_trigger resource
platform: gcp
---


## Syntax
A `google_cloudbuild_trigger` is used to test a Google Trigger resource

Expand Down
3 changes: 1 addition & 2 deletions docs/resources/google_cloudbuild_triggers.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,8 @@
---
title: About the Trigger resource
title: About the google_cloudbuild_triggers resource
platform: gcp
---


## Syntax
A `google_cloudbuild_triggers` is used to test a Google Trigger resource

Expand Down
3 changes: 1 addition & 2 deletions docs/resources/google_compute_autoscaler.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,8 @@
---
title: About the Autoscaler resource
title: About the google_compute_autoscaler resource
platform: gcp
---


## Syntax
A `google_compute_autoscaler` is used to test a Google Autoscaler resource

Expand Down
3 changes: 1 addition & 2 deletions docs/resources/google_compute_autoscalers.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,8 @@
---
title: About the Autoscaler resource
title: About the google_compute_autoscalers resource
platform: gcp
---


## Syntax
A `google_compute_autoscalers` is used to test a Google Autoscaler resource

Expand Down
3 changes: 1 addition & 2 deletions docs/resources/google_compute_backend_service.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,8 @@
---
title: About the BackendService resource
title: About the google_compute_backend_service resource
platform: gcp
---


## Syntax
A `google_compute_backend_service` is used to test a Google BackendService resource

Expand Down
3 changes: 1 addition & 2 deletions docs/resources/google_compute_backend_services.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,8 @@
---
title: About the BackendService resource
title: About the google_compute_backend_services resource
platform: gcp
---


## Syntax
A `google_compute_backend_services` is used to test a Google BackendService resource

Expand Down
3 changes: 1 addition & 2 deletions docs/resources/google_compute_disk.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,8 @@
---
title: About the Disk resource
title: About the google_compute_disk resource
platform: gcp
---


## Syntax
A `google_compute_disk` is used to test a Google Disk resource

Expand Down
3 changes: 1 addition & 2 deletions docs/resources/google_compute_disks.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,8 @@
---
title: About the Disk resource
title: About the google_compute_disks resource
platform: gcp
---


## Syntax
A `google_compute_disks` is used to test a Google Disk resource

Expand Down
38 changes: 38 additions & 0 deletions docs/resources/google_compute_global_address.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
---
title: About the google_compute_global_address resource
platform: gcp
---

## Syntax
A `google_compute_global_address` is used to test a Google GlobalAddress resource

## Examples
```
describe google_compute_global_address(project: 'chef-gcp-inspec', name: 'inspec-gcp-global-address') do
it { should exist }
its('ip_version') { should eq 'IPV6' }
end

describe google_compute_global_address(project: 'chef-gcp-inspec', name: 'nonexistent') do
it { should_not exist }
end
```

## Properties
Properties that can be accessed from the `google_compute_global_address` resource:

* `address`: The static external IP address represented by this resource.

* `creation_timestamp`: Creation timestamp in RFC3339 text format.

* `description`: An optional description of this resource. Provide this property when you create the resource.

* `id`: The unique identifier for the resource. This identifier is defined by the server.

* `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.

* `ip_version`: The IP Version that will be used by this address. Valid options are IPV4 or IPV6. The default value is IPV4.

* `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.
33 changes: 33 additions & 0 deletions docs/resources/google_compute_global_addresses.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
---
title: About the google_compute_global_addresses resource
platform: gcp
---

## Syntax
A `google_compute_global_addresses` is used to test a Google GlobalAddress resource

## Examples
```
describe google_compute_global_addresses(project: 'chef-gcp-inspec', name: 'inspec-gcp-global-address') do
its('count') { should be >= 1 }
its('names') { should include 'inspec-gcp-global-address' }
its('ip_versions') { should include 'IPV6' }
end
```

## Properties
Properties that can be accessed from the `google_compute_global_addresses` resource:

See [google_compute_global_address.md](google_compute_global_address.md) for more detailed information
* `addresses`: an array of `google_compute_global_address` address
* `creation_timestamps`: an array of `google_compute_global_address` creation_timestamp
* `descriptions`: an array of `google_compute_global_address` description
* `ids`: an array of `google_compute_global_address` id
* `names`: an array of `google_compute_global_address` name
* `ip_versions`: an array of `google_compute_global_address` ip_version
* `regions`: an array of `google_compute_global_address` region
* `address_types`: an array of `google_compute_global_address` address_type

## 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.
53 changes: 53 additions & 0 deletions docs/resources/google_compute_global_forwarding_rule.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
---
title: About the google_compute_global_forwarding_rule resource
platform: gcp
---

## Syntax
A `google_compute_global_forwarding_rule` is used to test a Google GlobalForwardingRule resource

## Examples
```
describe google_compute_global_forwarding_rule(project: 'chef-gcp-inspec', name: 'inspec-gcp-global-forwarding-rule') do
it { should exist }
its('port_range') { should eq '80-80' }
its('target') { should match /\/inspec-gcp-http-proxy$/ }
end

describe google_compute_global_forwarding_rule(project: 'chef-gcp-inspec', name: 'nonexistent') do
it { should_not exist }
end
```

## Properties
Properties that can be accessed from the `google_compute_global_forwarding_rule` resource:

* `creation_timestamp`: Creation timestamp in RFC3339 text format.

* `description`: An optional description of this resource. Provide this property when you create the resource.

* `id`: The unique identifier for the resource.

* `ip_address`: The IP address that this forwarding rule is serving on behalf of. Addresses are restricted based on the forwarding rule's load balancing scheme (EXTERNAL or INTERNAL) and scope (global or regional). When the load balancing scheme is EXTERNAL, for global forwarding rules, the address must be a global IP, and for regional forwarding rules, the address must live in the same region as the forwarding rule. If this field is empty, an ephemeral IPv4 address from the same scope (global or regional) will be assigned. A regional forwarding rule supports IPv4 only. A global forwarding rule supports either IPv4 or IPv6. When the load balancing scheme is INTERNAL, this can only be an RFC 1918 IP address belonging to the network/subnet configured for the forwarding rule. By default, if this field is empty, an ephemeral internal IP address will be automatically allocated from the IP range of the subnet or network configured for this forwarding rule. An address can be specified either by a literal IP address or a URL reference to an existing Address resource. The following examples are all valid: * 100.1.2.3 * https://www.googleapis.com/compute/v1/projects/project/regions/ region/addresses/address * projects/project/regions/region/addresses/address * regions/region/addresses/address * global/addresses/address * address

* `ip_protocol`: The IP protocol to which this rule applies. Valid options are TCP, UDP, ESP, AH, SCTP or ICMP. When the load balancing scheme is INTERNAL, only TCP and UDP are valid.

* `backend_service`: A reference to a BackendService to receive the matched traffic. This is used for internal load balancing. (not used for external load balancing)

* `ip_version`: The IP Version that will be used by this forwarding rule. Valid options are IPV4 or IPV6. This can only be specified for a global forwarding rule.

* `load_balancing_scheme`: This signifies what the ForwardingRule will be used for and can only take the following values: INTERNAL, EXTERNAL The value of INTERNAL means that this will be used for Internal Network Load Balancing (TCP, UDP). The value of EXTERNAL means that this will be used for External Load Balancing (HTTP(S) LB, External TCP/UDP LB, SSL Proxy)

* `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.

* `network`: For internal load balancing, this field identifies the network that the load balanced IP should belong to for this Forwarding Rule. If this field is not specified, the default network will be used. This field is not used for external load balancing.

* `port_range`: This field is used along with the target field for TargetHttpProxy, TargetHttpsProxy, TargetSslProxy, TargetTcpProxy, TargetVpnGateway, TargetPool, TargetInstance. Applicable only when IPProtocol is TCP, UDP, or SCTP, only packets addressed to ports in the specified range will be forwarded to target. Forwarding rules with the same [IPAddress, IPProtocol] pair must have disjoint port ranges. Some types of forwarding target have constraints on the acceptable ports: * TargetHttpProxy: 80, 8080 * TargetHttpsProxy: 443 * TargetTcpProxy: 25, 43, 110, 143, 195, 443, 465, 587, 700, 993, 995, 1883, 5222 * TargetSslProxy: 25, 43, 110, 143, 195, 443, 465, 587, 700, 993, 995, 1883, 5222 * TargetVpnGateway: 500, 4500

* `ports`: This field is used along with the backend_service field for internal load balancing. When the load balancing scheme is INTERNAL, a single port or a comma separated list of ports can be configured. Only packets addressed to these ports will be forwarded to the backends configured with this forwarding rule. You may specify a maximum of up to 5 ports.

* `subnetwork`: A reference to a subnetwork. For internal load balancing, this field identifies the subnetwork that the load balanced IP should belong to for this Forwarding Rule. If the network specified is in auto subnet mode, this field is optional. However, if the network is in custom subnet mode, a subnetwork must be specified. This field is not used for external load balancing.

* `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
39 changes: 39 additions & 0 deletions docs/resources/google_compute_global_forwarding_rules.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
---
title: About the google_compute_global_forwarding_rules resource
platform: gcp
---

## Syntax
A `google_compute_global_forwarding_rules` is used to test a Google GlobalForwardingRule resource

## Examples
```
describe google_compute_global_forwarding_rules(project: 'chef-gcp-inspec') do
its('count') { should be >= 1 }
its('port_ranges') { should include '80-80' }
end
```

## Properties
Properties that can be accessed from the `google_compute_global_forwarding_rules` resource:

See [google_compute_global_forwarding_rule.md](google_compute_global_forwarding_rule.md) for more detailed information
* `creation_timestamps`: an array of `google_compute_global_forwarding_rule` creation_timestamp
* `descriptions`: an array of `google_compute_global_forwarding_rule` description
* `ids`: an array of `google_compute_global_forwarding_rule` id
* `ip_addresses`: an array of `google_compute_global_forwarding_rule` ip_address
* `ip_protocols`: an array of `google_compute_global_forwarding_rule` ip_protocol
* `backend_services`: an array of `google_compute_global_forwarding_rule` backend_service
* `ip_versions`: an array of `google_compute_global_forwarding_rule` ip_version
* `load_balancing_schemes`: an array of `google_compute_global_forwarding_rule` load_balancing_scheme
* `names`: an array of `google_compute_global_forwarding_rule` name
* `networks`: an array of `google_compute_global_forwarding_rule` network
* `port_ranges`: an array of `google_compute_global_forwarding_rule` port_range
* `ports`: an array of `google_compute_global_forwarding_rule` ports
* `subnetworks`: an array of `google_compute_global_forwarding_rule` subnetwork
* `regions`: an array of `google_compute_global_forwarding_rule` region
* `targets`: an array of `google_compute_global_forwarding_rule` target

## 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.
3 changes: 1 addition & 2 deletions docs/resources/google_compute_health_check.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,8 @@
---
title: About the HealthCheck resource
title: About the google_compute_health_check resource
platform: gcp
---


## Syntax
A `google_compute_health_check` is used to test a Google HealthCheck resource

Expand Down
3 changes: 1 addition & 2 deletions docs/resources/google_compute_health_checks.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,8 @@
---
title: About the HealthCheck resource
title: About the google_compute_health_checks resource
platform: gcp
---


## Syntax
A `google_compute_health_checks` is used to test a Google HealthCheck resource

Expand Down
3 changes: 1 addition & 2 deletions docs/resources/google_compute_http_health_check.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,8 @@
---
title: About the HttpHealthCheck resource
title: About the google_compute_http_health_check resource
platform: gcp
---


## Syntax
A `google_compute_http_health_check` is used to test a Google HttpHealthCheck resource

Expand Down
3 changes: 1 addition & 2 deletions docs/resources/google_compute_http_health_checks.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,8 @@
---
title: About the HttpHealthCheck resource
title: About the google_compute_http_health_checks resource
platform: gcp
---


## Syntax
A `google_compute_http_health_checks` is used to test a Google HttpHealthCheck resource

Expand Down
47 changes: 47 additions & 0 deletions docs/resources/google_compute_https_health_check.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
---
title: About the google_compute_https_health_check resource
platform: gcp
---

## Syntax
A `google_compute_https_health_check` is used to test a Google HttpsHealthCheck resource

## Examples
```
describe google_compute_https_health_check(project: 'chef-gcp-inspec', name: 'inspec-gcp-https-health-check') do
it { should exist }
its('timeout_sec') { should eq '15' }
its('request_path') { should eq '/https_health_check' }
its('check_interval_sec') { should eq '15' }
its('unhealthy_threshold') { should eq '3' }
end

describe google_compute_https_health_check(project: 'chef-gcp-inspec', name: 'nonexistent') do
it { should_not exist }
end
```

## Properties
Properties that can be accessed from the `google_compute_https_health_check` resource:

* `check_interval_sec`: How often (in seconds) to send a health check. The default value is 5 seconds.

* `creation_timestamp`: Creation timestamp in RFC3339 text format.

* `description`: An optional description of this resource. Provide this property when you create the resource.

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

* `host`: The value of the host header in the HTTPS health check request. If left empty (default value), the public IP on behalf of which this health check is performed will be used.

* `id`: The unique identifier for the resource. This identifier is defined by the server.

* `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.

* `port`: The TCP port number for the HTTPS health check request. The default value is 80.

* `request_path`: The request path of the HTTPS health check request. The default value is /.

* `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.
36 changes: 36 additions & 0 deletions docs/resources/google_compute_https_health_checks.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
---
title: About the google_compute_https_health_checks resource
platform: gcp
---

## Syntax
A `google_compute_https_health_checks` is used to test a Google HttpsHealthCheck resource

## Examples
```
describe google_compute_https_health_checks(project: 'chef-gcp-inspec') do
its('names') { should include 'inspec-gcp-https-health-check' }
its('timeout_secs') { should include '15' }
its('check_interval_secs') { should include '15' }
end
```

## Properties
Properties that can be accessed from the `google_compute_https_health_checks` resource:

See [google_compute_https_health_check.md](google_compute_https_health_check.md) for more detailed information
* `check_interval_secs`: an array of `google_compute_https_health_check` check_interval_sec
* `creation_timestamps`: an array of `google_compute_https_health_check` creation_timestamp
* `descriptions`: an array of `google_compute_https_health_check` description
* `healthy_thresholds`: an array of `google_compute_https_health_check` healthy_threshold
* `hosts`: an array of `google_compute_https_health_check` host
* `ids`: an array of `google_compute_https_health_check` id
* `names`: an array of `google_compute_https_health_check` name
* `ports`: an array of `google_compute_https_health_check` port
* `request_paths`: an array of `google_compute_https_health_check` request_path
* `timeout_secs`: an array of `google_compute_https_health_check` timeout_sec
* `unhealthy_thresholds`: an array of `google_compute_https_health_check` unhealthy_threshold

## 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.
3 changes: 1 addition & 2 deletions docs/resources/google_compute_instance_group_manager.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,8 @@
---
title: About the InstanceGroupManager resource
title: About the google_compute_instance_group_manager resource
platform: gcp
---


## Syntax
A `google_compute_instance_group_manager` is used to test a Google InstanceGroupManager resource

Expand Down
Loading