GoogleCloudPlatform/puppet-google-compute

Name: puppet-google-compute

Owner: Google Cloud Platform

Description: null

Created: 2017-06-16 23:19:29.0

Updated: 2018-05-22 19:45:57.0

Pushed: 2018-05-22 19:45:56.0

Homepage: null

Size: 1742

Language: Ruby

GitHub Committers

UserMost Recent Commit# Commits

Other Committers

UserEmailMost Recent Commit# Commits

README

Google Compute Engine Puppet Module

Puppet Forge

Table of Contents
  1. [Module Description - What the module does and why it is useful](

    module-description)

  2. Setup - The basics of getting started with Google Compute Engine
  3. Usage - Configuration options and additional functionality
  4. [Reference - An under-the-hood peek at what the module is doing and how](

    reference)

  5. Limitations - OS compatibility, etc.
  6. Development - Guide for contributing to the module
Module Description

This Puppet module manages the resource of Google Compute Engine. You can manage its resources using standard Puppet DSL and the module will, under the hood, ensure the state described will be reflected in the Google Cloud Platform resources.

Setup

To install this module on your Puppet Master (or Puppet Client/Agent), use the Puppet module installer:

puppet module install google-gcompute

Optionally you can install support to all Google Cloud Platform products at once by installing our “bundle” google-cloud module:

puppet module install google-cloud
Usage
Credentials

All Google Cloud Platform modules use an unified authentication mechanism, provided by the google-gauth module. Don't worry, it is automatically installed when you install this module.

h_credential { 'mycred':
th     => $cred_path, # e.g. '/home/nelsonjr/my_account.json'
ovider => serviceaccount,
opes   => [
'https://www.googleapis.com/auth/compute',

Please refer to the google-gauth module for further requirements, i.e. required gems.

Examples
gcompute_address 
pute_region { 'some-region':
me       => 'us-west1',
oject    => 'google.com:graphite-playground',
edential => 'mycred',


pute_address { 'test1':
sure     => present,
gion     => 'some-region',
oject    => 'google.com:graphite-playground',
edential => 'mycred',
gcompute_backend_bucket 
pute_backend_bucket { 'be-bucket-connection':
sure      => present,
cket_name => 'backend-bucket-test',
scription => 'A BackendBucket to connect LNB w/ Storage Bucket',
able_cdn  => true,
oject     => 'google.com:graphite-playground',
edential  => 'mycred',
gcompute_backend_service 
ckend Service requires various other services to be setup beforehand. Please
ke sure they are defined as well:
- gcompute_instance_group { ... }
- Health check
pute_backend_service { 'my-app-backend':
sure        => present,
ckends      => [
{ group => 'my-puppet-masters' },

able_cdn    => true,
alth_checks => [
gcompute_health_check_ref('another-hc', 'google.com:graphite-playground'),

oject       => 'google.com:graphite-playground',
edential    => 'mycred',
gcompute_disk_type 
pute_disk_type { 'pd-standard':
fault_disk_size_gb => 500,
precated_deleted   => undef, # undef = not deprecated
ne                 => 'us-central1-a',
oject              => 'google.com:graphite-playground',
edential           => 'mycred',
gcompute_disk 
pute_disk { 'data-disk-1':
sure              => present,
ze_gb             => 50,
sk_encryption_key => {
raw_key => 'SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=',

ne                => 'us-central1-a',
oject             => 'google.com:graphite-playground',
edential          => 'mycred',
gcompute_firewall 
pute_firewall { 'test-fw-allow-ssh':
sure      => present,
lowed     => [
{
  ip_protocol => 'tcp',
  ports       => [
    '22',
  ],
},

rget_tags => [
'test-ssh-server',
'staging-ssh-server',

urce_tags => [
'test-ssh-clients',

oject     => 'google.com:graphite-playground',
edential  => 'mycred',
gcompute_forwarding_rule 
pute_forwarding_rule { 'test1':
sure      => present,
_address  => gcompute_address_ref(
'some-address',
'us-west1', 'google.com:graphite-playground'

_protocol => 'TCP',
rt_range  => '80',
rget      => 'target-pool',
gion      => 'some-region',
oject     => 'google.com:graphite-playground',
edential  => 'mycred',
gcompute_global_address 
pute_global_address { 'my-app-lb-address':
sure     => present,
oject    => 'google.com:graphite-playground',
edential => 'mycred',
gcompute_global_forwarding_rule 
pute_global_forwarding_rule { 'test1':
sure      => present,
_address  => gcompute_global_address_ref(
'my-app-lb-address',
'google.com:graphite-playground'

_protocol => 'TCP',
rt_range  => '80',
rget      => gcompute_target_http_proxy_ref(
'my-http-proxy',
'google.com:graphite-playground'

oject     => 'google.com:graphite-playground',
edential  => 'mycred',
gcompute_http_health_check 
pute_http_health_check { 'my-app-http-hc':
sure              => present,
althy_threshold   => 10,
rt                => 8080,
meout_sec         => 2,
healthy_threshold => 5,
oject             => 'google.com:graphite-playground',
edential          => 'mycred',
gcompute_https_health_check 
pute_https_health_check { 'my-app-https-hc':
sure              => present,
althy_threshold   => 10,
rt                => 8080,
meout_sec         => 2,
healthy_threshold => 5,
oject             => 'google.com:graphite-playground',
edential          => 'mycred',
gcompute_health_check 
pute_health_check { 'my-app-tcp-hc':
sure              => present,
pe                => 'TCP',
p_health_check    => {
port_name => 'service-health',
request   => 'ping',
response  => 'pong',

althy_threshold   => 10,
meout_sec         => 2,
healthy_threshold => 5,
oject             => 'google.com:graphite-playground',
edential          => 'mycred',
gcompute_instance_template 
wer Tips:
1) Remember to define the resources needed to allocate the VM:
   a) gcompute_disk_type (to be used in 'diskType' property)
   b) gcompute_machine_type (to be used in 'machine_type' property)
   c) gcompute_network (to be used in 'network_interfaces' property)
   d) gcompute_subnetwork (to be used in the 'subnetwork' property)
   e) gcompute_disk (to be used in the 'sourceDisk' property)
2) Don't forget to define a source_image for the OS of the boot disk
   a) You can use the provided gcompute_image_family function to specify the
      latest version of an operating system of a given family
      e.g. Ubuntu 16.04
pute_instance_template { 'instance-template':
sure     => present,
operties => {
machine_type       => 'n1-standard-1',
disks              => [
  {
    # Tip: Auto delete will prevent disks from being left behind on
    # deletion.
    auto_delete       => true,
    boot              => true,
    initialize_params => {
      source_image =>
        gcompute_image_family('ubuntu-1604-lts', 'ubuntu-os-cloud'),
    }
  }
],
metadata           => {
  'startup-script-url'   => 'gs://graphite-playground/bootstrap.sh',
  'cost-center'          => '12345',
},
network_interfaces => [
  {
    access_configs => {
      name => 'test-config',
      type => 'ONE_TO_ONE_NAT',
    },
    network        => 'mynetwork-test',
  }
]

oject    => 'google.com:graphite-playground',
edential => 'mycred',
gcompute_license 
pute_license { 'test-license':
oject    => 'google.com:graphite-playground',
edential => 'mycred',
gcompute_image 
p: Be sure to include a valid gcompute_disk object
pute_image { 'test-image':
sure      => present,
urce_disk => 'data-disk-1',
oject     => 'google.com:graphite-playground',
edential  => 'mycred'
gcompute_instance 
wer Tips:
1) Remember to define the resources needed to allocate the VM:
   a) gcompute_disk_type (to be used in 'diskType' property)
   b) gcompute_machine_type (to be used in 'machine_type' property)
   c) gcompute_network (to be used in 'network_interfaces' property)
   d) gcompute_subnetwork (to be used in the 'subnetwork' property)
   e) gcompute_disk (to be used in the 'sourceDisk' property)
   f) gcompute_address (to be used in 'access_configs', if your machine
      needs external ingress access)
2) Don't forget to define a source_image for the OS of the boot disk
   a) You can use the provided gcompute_image_family function to specify the
      latest version of an operating system of a given family
      e.g. Ubuntu 16.04
pute_instance { 'instance-test':
sure             => present,
chine_type       => 'n1-standard-1',
sks              => [
{
  auto_delete => true,
  boot        => true,
  source      => 'instance-test-os-1'
}

tadata           => {
startup-script-url   => 'gs://graphite-playground/bootstrap.sh',
cost-center          => '12345',

twork_interfaces => [
{
  network        => 'default',
  access_configs => [
    {
      name   => 'External NAT',
      nat_ip => 'instance-test-ip',
      type   => 'ONE_TO_ONE_NAT',
    },
  ],
}

ne               => 'us-central1-a',
oject            => 'google.com:graphite-playground',
edential         => 'mycred',
gcompute_instance_group 
stance group requires a network, so define them in your manifest:
- gcompute_network { 'my-network': ensure => present }
pute_instance_group { 'my-puppet-masters':
sure      => present,
med_ports => [
{
  name => 'puppet',
  port => 8140,
},

twork     => 'my-network',
ne        => 'us-central1-a',
oject     => 'google.com:graphite-playground',
edential  => 'mycred',
gcompute_instance_group_manager 
pute_instance_group_manager { 'test1':
sure             => present,
se_instance_name => 'test1-child',
stance_template  => 'instance-template',
rget_size        => 3,
ne               => 'us-west1-a',
oject            => 'google.com:graphite-playground',
edential         => 'mycred',
gcompute_machine_type 
pute_machine_type { 'n1-standard-1':
ne       => 'us-central1-a',
oject    => 'google.com:graphite-playground',
edential => 'mycred',
gcompute_network 
tomatically allocated network
pute_network { "mynetwork-${network_id}":
to_create_subnetworks => true,
oject                 => 'google.com:graphite-playground',
edential              => 'mycred',


nually allocated network
pute_network { "mynetwork-${network_id}":
to_create_subnetworks => false,
oject                 => 'google.com:graphite-playground',
edential              => 'mycred',


gacy network
pute_network { "mynetwork-${network_id}":
On a legacy network you cannot specify the auto_create_subnetworks
parameter.
| auto_create_subnetworks => false,
v4_range   => '192.168.0.0/16',
teway_ipv4 => '192.168.0.1',
oject      => 'google.com:graphite-playground',
edential   => 'mycred',


nverting automatic to custom network
pute_network { "mynetwork-${network_id}":
to_create_subnetworks => false,
oject                 => 'google.com:graphite-playground',
edential              => 'mycred',
gcompute_region 
pute_region { 'us-west1':
oject    => 'google.com:graphite-playground',
edential => 'mycred',
gcompute_route 
ute requires a network, so define them in your manifest:
- gcompute_network { 'my-network': ensure => presnet }
pute_route { 'corp-route':
sure           => present,
st_range       => '192.168.6.0/24',
xt_hop_gateway => 'global/gateways/default-internet-gateway',
twork          => 'my-network',
gs             => ['backends', 'databases'],
oject          => 'google.com:graphite-playground',
edential       => 'mycred',
gcompute_snapshot 
pute_snapshot { 'data-disk-snapshot-1':
sure                     => present,
apshot_encryption_key    => {
raw_key => 'VGhpcyBpcyBhbiBlbmNyeXB0ZWQgc25hcHNob3QhISE=',

urce_disk_encryption_key => {
raw_key => 'SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=',

urce                     => 'data-disk-1',
ne                       => 'us-central1-a',
oject                    => 'google.com:graphite-playground',
edential                 => 'mycred',
gcompute_ssl_certificate 
*****
RNING: This manifest is for example purposes only. It is *not* advisable to
ve the key embedded like this because if you check this file into source
ntrol you are publishing the private key to whomever can access the source
de. Instead you should protect the key, and for example, use the file()
nction to read it from disk without writing it verbatim to the manifest:

ompute_ssl_certificate { ...
...
private_key => file('/path/to/my/private/key.pem'),
...

*****

pute_ssl_certificate { 'sample-certificate':
sure      => present,
scription => 'A certificate for test purposes only.',
oject     => 'google.com:graphite-playground',
edential  => 'mycred',
rtificate => '-----BEGIN CERTIFICATE-----
qjCCAk+gAwIBAgIJAIuJ+0352Kq4MAoGCCqGSM49BAMCMIGwMQswCQYDVQQG
UzETMBEGA1UECAwKV2FzaGluZ3RvbjERMA8GA1UEBwwIS2lya2xhbmQxFTAT
BAoMDEdvb2dsZSwgSW5jLjEeMBwGA1UECwwVR29vZ2xlIENsb3VkIFBsYXRm
MR8wHQYDVQQDDBZ3d3cubXktc2VjdXJlLXNpdGUuY29tMSEwHwYJKoZIhvcN
FhJuZWxzb25hQGdvb2dsZS5jb20wHhcNMTcwNjI4MDQ1NjI2WhcNMjcwNjI2
NjI2WjCBsDELMAkGA1UEBhMCVVMxEzARBgNVBAgMCldhc2hpbmd0b24xETAP
BAcMCEtpcmtsYW5kMRUwEwYDVQQKDAxHb29nbGUsIEluYy4xHjAcBgNVBAsM
b2dsZSBDbG91ZCBQbGF0Zm9ybTEfMB0GA1UEAwwWd3d3Lm15LXNlY3VyZS1z
LmNvbTEhMB8GCSqGSIb3DQEJARYSbmVsc29uYUBnb29nbGUuY29tMFkwEwYH
zj0CAQYIKoZIzj0DAQcDQgAEHGzpcRJ4XzfBJCCPMQeXQpTXwlblimODQCuQ
zTv0dXyB750fOGN02HtkpBOZzzvUARTR10JQoSe2/5PIwaNQME4wHQYDVR0O
FKIQC3A2SDpxcdfn0YLKineDNq/BMB8GA1UdIwQYMBaAFKIQC3A2SDpxcdfn
ineDNq/BMAwGA1UdEwQFMAMBAf8wCgYIKoZIzj0EAwIDSQAwRgIhALs4vy+O
qgA4fSW/oKw6UJxp+M6a+nGMX+UJR3YgAiEAvvl39QRVAiv84hdoCuyON0lJ
hIPGq2ULqXKK8BY=
-END CERTIFICATE-----',
ivate_key => '-----BEGIN EC PRIVATE KEY-----
AQEEIObtRo8tkUqoMjeHhsOh2ouPpXCgBcP+EDxZCB/tws15oAoGCCqGSM49
oUQDQgAEHGzpcRJ4XzfBJCCPMQeXQpTXwlblimODQCuQ4mzkzTv0dXyB750f
2HtkpBOZzzvUARTR10JQoSe2/5PIwQ==
-END EC PRIVATE KEY-----',
gcompute_subnetwork 
bnetwork requires a network and a region, so define them in your manifest:
- gcompute_network { 'my-network': ensure => present, ... }
- gcompute_region { 'some-region': ... }
pute_subnetwork { 'servers':
sure        => present,
_cidr_range => '172.16.0.0/16',
twork       => 'mynetwork-subnetwork',
gion        => 'some-region',
oject       => 'google.com:graphite-playground',
edential    => 'mycred',
gcompute_target_http_proxy 
pute_target_http_proxy { 'my-http-proxy':
sure     => present,
l_map    => 'my-url-map',
oject    => 'google.com:graphite-playground',
edential => 'mycred',
gcompute_target_https_proxy 
pute_target_https_proxy { 'my-https-proxy':
sure           => present,
l_certificates => [
'sample-certificate',

l_map          => 'my-url-map',
oject          => 'google.com:graphite-playground',
edential       => 'mycred',
gcompute_target_pool 
pute_region { 'some-region':
me       => 'us-west1',
oject    => 'google.com:graphite-playground',
edential => 'mycred',


pute_target_pool { 'test1':
sure     => present,
gion     => 'some-region',
oject    => 'google.com:graphite-playground',
edential => 'mycred',
gcompute_target_ssl_proxy 
pute_target_ssl_proxy { 'my-ssl-proxy':
sure           => present,
oxy_header     => 'PROXY_V1',
rvice          => 'my-ssl-backend',
l_certificates => [
'sample-certificate',

oject          => 'google.com:graphite-playground',
edential       => 'mycred',
gcompute_target_tcp_proxy 
pute_target_tcp_proxy { 'my-tcp-proxy':
sure       => present,
oxy_header => 'PROXY_V1',
rvice      => 'my-tcp-backend',
oject      => 'google.com:graphite-playground',
edential   => 'mycred',
gcompute_url_map 
pute_url_map { 'my-url-map':
sure          => present,
fault_service => 'my-app-backend',
oject         => 'google.com:graphite-playground',
edential      => 'mycred',
gcompute_zone 
pute_zone { 'us-central1-a':
oject    => 'google.com:graphite-playground',
edential => 'mycred',
Classes
Public classes
About output only properties

Some fields are output-only. It means you cannot set them because they are provided by the Google Cloud Platform. Yet they are still useful to ensure the value the API is assigning (or has assigned in the past) is still the value you expect.

For example in a DNS the name servers are assigned by the Google Cloud DNS service. Checking these values once created is useful to make sure your upstream and/or root DNS masters are in sync. Or if you decide to use the object ID, e.g. the VM unique ID, for billing purposes. If the VM gets deleted and recreated it will have a different ID, despite the name being the same. If that detail is important to you you can verify that the ID of the object did not change by asserting it in the manifest.

Parameters
gcompute_address

Represents an Address resource.

Each virtual machine instance has an ephemeral internal IP address and, optionally, an external IP address. To communicate between instances on the same network, you can use an instance's internal IP address. To communicate with the Internet and instances outside of the same network, you must specify the instance's external IP address.

Internal IP addresses are ephemeral and only belong to an instance for the lifetime of the instance; if the instance is deleted and recreated, the instance is assigned a new internal IP address, either by Compute Engine or by you. External IP addresses can be either ephemeral or static.

Example 
pute_region { 'some-region':
me       => 'us-west1',
oject    => 'google.com:graphite-playground',
edential => 'mycred',


pute_address { 'test1':
sure     => present,
gion     => 'some-region',
oject    => 'google.com:graphite-playground',
edential => 'mycred',
Reference 
pute_address { 'id-of-resource':
dress            => string,
eation_timestamp => time,
scription        => string,
                 => integer,
me               => string,
gion             => reference to gcompute_region,
ers              => [
string,
...

oject            => string,
edential         => reference to gauth_credential,
address

The static external IP address represented by this resource. Only IPv4 is supported.

description

An optional description of this resource.

name

Name of the resource. 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? 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.

region

Required. URL of the region where the regional address resides. This field is not applicable to global addresses.

Output-only properties gcompute_backend_bucket

Backend buckets allow you to use Google Cloud Storage buckets with HTTP(S) load balancing.

An HTTP(S) load balancer can direct traffic to specified URLs to a backend bucket rather than a backend service. It can send requests for static content to a Cloud Storage bucket and requests for dynamic content a virtual machine instance.

Example 
pute_backend_bucket { 'be-bucket-connection':
sure      => present,
cket_name => 'backend-bucket-test',
scription => 'A BackendBucket to connect LNB w/ Storage Bucket',
able_cdn  => true,
oject     => 'google.com:graphite-playground',
edential  => 'mycred',
Reference 
pute_backend_bucket { 'id-of-resource':
cket_name        => string,
eation_timestamp => time,
scription        => string,
able_cdn         => boolean,
                 => integer,
me               => string,
oject            => string,
edential         => reference to gauth_credential,
bucket_name

Required. Cloud Storage bucket name.

description

An optional textual description of the resource; provided by the client when the resource is created.

enable_cdn

If true, enable Cloud CDN for this BackendBucket.

name

Required. 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.

Output-only properties gcompute_backend_service

Creates a BackendService resource in the specified project using the data included in the request.

Example 
ckend Service requires various other services to be setup beforehand. Please
ke sure they are defined as well:
- gcompute_instance_group { ... }
- Health check
pute_backend_service { 'my-app-backend':
sure        => present,
ckends      => [
{ group => 'my-puppet-masters' },

able_cdn    => true,
alth_checks => [
gcompute_health_check_ref('another-hc', 'google.com:graphite-playground'),

oject       => 'google.com:graphite-playground',
edential    => 'mycred',
Reference 
pute_backend_service { 'id-of-resource':
finity_cookie_ttl_sec => integer,
ckends                => [
{
  balancing_mode               => 'UTILIZATION', 'RATE' or 'CONNECTION',
  capacity_scaler              => double,
  description                  => string,
  group                        => reference to gcompute_instance_group,
  max_connections              => integer,
  max_connections_per_instance => integer,
  max_rate                     => integer,
  max_rate_per_instance        => double,
  max_utilization              => double,
},
...

n_policy              => {
cache_key_policy => {
  include_host           => boolean,
  include_protocol       => boolean,
  include_query_string   => boolean,
  query_string_blacklist => [
    string,
    ...
  ],
  query_string_whitelist => [
    string,
    ...
  ],
},

nnection_draining     => {
draining_timeout_sec => integer,

eation_timestamp      => time,
scription             => string,
able_cdn              => boolean,
alth_checks           => [
string,
...

                      => integer,
me                    => string,
rt_name               => string,
otocol                => 'HTTP', 'HTTPS', 'TCP' or 'SSL',
gion                  => reference to gcompute_region,
ssion_affinity        => 'NONE', 'CLIENT_IP', 'GENERATED_COOKIE', 'CLIENT_IP_PROTO' or 'CLIENT_IP_PORT_PROTO',
meout_sec             => integer,
oject                 => string,
edential              => reference to gauth_credential,
affinity_cookie_ttl_sec

Lifetime of cookies in seconds if session_affinity is GENERATED_COOKIE. If set to 0, the cookie is non-persistent and lasts only until the end of the browser session (or equivalent). The maximum allowed value for TTL is one day. When the load balancing scheme is INTERNAL, this field is not used.

backends

The list of backends that serve this BackendService.

backends[]/balancing_mode

Specifies the balancing mode for this backend. For global HTTP(S) or TCP/SSL load balancing, the default is UTILIZATION. Valid values are UTILIZATION, RATE (for HTTP(S)) and CONNECTION (for TCP/SSL). This cannot be used for internal load balancing.

backends[]/capacity_scaler

A multiplier applied to the group's maximum servicing capacity (based on UTILIZATION, RATE or CONNECTION). Default value is 1, which means the group will serve up to 100% of its configured capacity (depending on balancingMode). A setting of 0 means the group is completely drained, offering 0% of its available Capacity. Valid range is [0.0,1.0]. This cannot be used for internal load balancing.

backends[]/description

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

backends[]/group

This instance group defines the list of instances that serve traffic. Member virtual machine instances from each instance group must live in the same zone as the instance group itself. No two backends in a backend service are allowed to use same Instance Group resource. When the BackendService has load balancing scheme INTERNAL, the instance group must be in a zone within the same region as the BackendService.

backends[]/max_connections

The max number of simultaneous connections for the group. Can be used with either CONNECTION or UTILIZATION balancing modes. For CONNECTION mode, either maxConnections or maxConnectionsPerInstance must be set. This cannot be used for internal load balancing.

backends[]/max_connections_per_instance

The max number of simultaneous connections that a single backend instance can handle. This is used to calculate the capacity of the group. Can be used in either CONNECTION or UTILIZATION balancing modes. For CONNECTION mode, either maxConnections or maxConnectionsPerInstance must be set. This cannot be used for internal load balancing.

backends[]/max_rate

The max requests per second (RPS) of the group. Can be used with either RATE or UTILIZATION balancing modes, but required if RATE mode. For RATE mode, either maxRate or maxRatePerInstance must be set. This cannot be used for internal load balancing.

backends[]/max_rate_per_instance

The max requests per second (RPS) that a single backend instance can handle. This is used to calculate the capacity of the group. Can be used in either balancing mode. For RATE mode, either maxRate or maxRatePerInstance must be set. This cannot be used for internal load balancing.

backends[]/max_utilization

Used when balancingMode is UTILIZATION. This ratio defines the CPU utilization target for the group. The default is 0.8. Valid range is [0.0, 1.0]. This cannot be used for internal load balancing.

cdn_policy

Cloud CDN configuration for this BackendService.

cdn_policy/cache_key_policy

The CacheKeyPolicy for this CdnPolicy.

cdn_policy/cache_key_policy/include_host

If true requests to different hosts will be cached separately.

cdn_policy/cache_key_policy/include_protocol

If true, http and https requests will be cached separately.

cdn_policy/cache_key_policy/include_query_string

If true, include query string parameters in the cache key according to query_string_whitelist and query_string_blacklist. If neither is set, the entire query string will be included. If false, the query string will be excluded from the cache key entirely.

cdn_policy/cache_key_policy/query_string_blacklist

Names of query string parameters to exclude in cache keys. All other parameters will be included. Either specify query_string_whitelist or query_string_blacklist, not both. '&' and '=' will be percent encoded and not treated as delimiters.

cdn_policy/cache_key_policy/query_string_whitelist

Names of query string parameters to include in cache keys. All other parameters will be excluded. Either specify query_string_whitelist or query_string_blacklist, not both. '&' and '=' will be percent encoded and not treated as delimiters.

connection_draining

Settings for connection draining

connection_draining/draining_timeout_sec

Time for which instance will be drained (not accept new connections, but still work to finish started).

description

An optional description of this resource.

enable_cdn

If true, enable Cloud CDN for this BackendService. When the load balancing scheme is INTERNAL, this field is not used.

health_checks

The list of URLs to the HttpHealthCheck or HttpsHealthCheck resource for health checking this BackendService. Currently at most one health check can be specified, and a health check is required. For internal load balancing, a URL to a HealthCheck resource must be specified instead.

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_name

Name of backend port. The same name should appear in the instance groups referenced by this service. Required when the load balancing scheme is EXTERNAL. When the load balancing scheme is INTERNAL, this field is not used.

protocol

The protocol this BackendService uses to communicate with backends. Possible values are HTTP, HTTPS, TCP, and SSL. The default is HTTP. For internal load balancing, the possible values are TCP and UDP, and the default is TCP.

region

The region where the regional backend service resides. This field is not applicable to global backend services.

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].

Output-only properties gcompute_disk_type

Represents a DiskType resource. A DiskType resource represents the type of disk to use, such as a pd-ssd or pd-standard. To reference a disk type, use the disk type's full or partial URL.

Example 
pute_disk_type { 'pd-standard':
fault_disk_size_gb => 500,
precated_deleted   => undef, # undef = not deprecated
ne                 => 'us-central1-a',
oject              => 'google.com:graphite-playground',
edential           => 'mycred',
Reference 
pute_disk_type { 'id-of-resource':
eation_timestamp   => time,
fault_disk_size_gb => integer,
precated           => {
deleted     => time,
deprecated  => time,
obsolete    => time,
replacement => string,
state       => 'DEPRECATED', 'OBSOLETE' or 'DELETED',

scription          => string,
                   => integer,
me                 => string,
lid_disk_size      => string,
ne                 => reference to gcompute_zone,
oject              => string,
edential           => reference to gauth_credential,
name

Name of the resource.

zone

Required. A reference to the zone where the disk type resides.

Output-only properties deprecated/deleted

Output only. An optional RFC3339 timestamp on or after which the deprecation state of this resource will be changed to DELETED.

deprecated/deprecated

Output only. An optional RFC3339 timestamp on or after which the deprecation state of this resource will be changed to DEPRECATED.

deprecated/obsolete

Output only. An optional RFC3339 timestamp on or after which the deprecation state of this resource will be changed to OBSOLETE.

deprecated/replacement

Output only. The URL of the suggested replacement for a deprecated resource. The suggested replacement resource must be the same kind of resource as the deprecated resource.

deprecated/state

Output only. The deprecation state of this resource. This can be DEPRECATED, OBSOLETE, or DELETED. Operations which create a new resource using a DEPRECATED resource will return successfully, but with a warning indicating the deprecated resource and recommending its replacement. Operations which use OBSOLETE or DELETED resources will be rejected and result in an error.

gcompute_disk

Persistent disks are durable storage devices that function similarly to the physical disks in a desktop or a server. Compute Engine manages the hardware behind these devices to ensure data redundancy and optimize performance for you. Persistent disks are available as either standard hard disk drives (HDD) or solid-state drives (SSD).

Persistent disks are located independently from your virtual machine instances, so you can detach or move persistent disks to keep your data even after you delete your instances. Persistent disk performance scales automatically with size, so you can resize your existing persistent disks or add more persistent disks to an instance to meet your performance and storage space requirements.

Add a persistent disk to your instance when you need reliable and affordable storage with consistent performance characteristics.

Example 
pute_disk { 'data-disk-1':
sure              => present,
ze_gb             => 50,
sk_encryption_key => {
raw_key => 'SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=',

ne                => 'us-central1-a',
oject             => 'google.com:graphite-playground',
edential          => 'mycred',
Reference 
pute_disk { 'id-of-resource':
eation_timestamp             => time,
scription                    => string,
sk_encryption_key            => {
raw_key => string,
sha256  => string,

                             => integer,
bels                         => namevalues,
st_attach_timestamp          => time,
st_detach_timestamp          => time,
censes                       => [
string,
...

me                           => string,
ze_gb                        => integer,
urce_image                   => string,
urce_image_encryption_key    => {
raw_key => string,
sha256  => string,

urce_image_id                => string,
urce_snapshot                => string,
urce_snapshot_encryption_key => {
raw_key => string,
sha256  => string,

urce_snapshot_id             => string,
pe                           => string,
ers                          => [
string,
...

ne                           => reference to gcompute_zone,
oject                        => string,
edential                     => reference to gauth_credential,
description

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

labels

Labels to apply to this disk. A list of key->value pairs.

licenses

Any applicable publicly visible licenses.

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.

size_gb

Size of the persistent disk, specified in GB. You can specify this field when creating a persistent disk using the sourceImage or sourceSnapshot parameter, or specify it alone to create an empty persistent disk. If you specify this field along with sourceImage or sourceSnapshot, the value of sizeGb must not be less than the size of the sourceImage or the size of the snapshot.

source_image

The source image used to create this disk. If the source image is deleted, this field will not be set. To create a disk with one of the public operating system images, specify the image by its family name. For example, specify family/debian-8 to use the latest Debian 8 image: projects/debian-cloud/global/images/family/debian-8 Alternatively, use a specific version of a public operating system image: projects/debian-cloud/global/images/debian-8-jessie-vYYYYMMDD To create a disk with a private image that you created, specify the image name in the following format: global/images/my-private-image You can also specify a private image by its image family, which returns the latest version of the image in that family. Replace the image name with family/family-name: global/images/family/my-private-family

type

URL of the disk type resource describing which disk type to use to create the disk. Provide this when creating the disk.

zone

Required. A reference to the zone where the disk resides.

disk_encryption_key

Encrypts the disk using a customer-supplied encryption key. After you encrypt a disk with a customer-supplied key, you must provide the same key if you use the disk later (e.g. to create a disk snapshot or an image, or to attach the disk to a virtual machine). Customer-supplied encryption keys do not protect access to metadata of the disk. If you do not provide an encryption key when creating the disk, then the disk will be encrypted using an automatically generated key and you do not need to provide a key to use the disk later.

disk_encryption_key/raw_key

Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.

disk_encryption_key/sha256

Output only. The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.

source_image_encryption_key

The customer-supplied encryption key of the source image. Required if the source image is protected by a customer-supplied encryption key.

source_image_encryption_key/raw_key

Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.

source_image_encryption_key/sha256

Output only. The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.

source_snapshot

The source snapshot used to create this disk. You can provide this as a partial or full URL to the resource. For example, the following are valid values:

source_snapshot_encryption_key

The customer-supplied encryption key of the source snapshot. Required if the source snapshot is protected by a customer-supplied encryption key.

source_snapshot_encryption_key/raw_key

Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.

source_snapshot_encryption_key/sha256

Output only. The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.

Output-only properties gcompute_firewall

Each network has its own firewall controlling access to and from the instances.

All traffic to instances, even from other instances, is blocked by the firewall unless firewall rules are created to allow it.

The default network has automatically created firewall rules that are shown in default firewall rules. No manually created network has automatically created firewall rules except for a default “allow” rule for outgoing traffic and a default “deny” for incoming traffic. For all networks except the default network, you must create any firewall rules you need.

Example 
pute_firewall { 'test-fw-allow-ssh':
sure      => present,
lowed     => [
{
  ip_protocol => 'tcp',
  ports       => [
    '22',
  ],
},

rget_tags => [
'test-ssh-server',
'staging-ssh-server',

urce_tags => [
'test-ssh-clients',

oject     => 'google.com:graphite-playground',
edential  => 'mycred',
Reference 
pute_firewall { 'id-of-resource':
lowed            => [
{
  ip_protocol => string,
  ports       => [
    string,
    ...
  ],
},
...

eation_timestamp => time,
scription        => string,
                 => integer,
me               => string,
twork            => string,
urce_ranges      => [
string,
...

urce_tags        => [
string,
...

rget_tags        => [
string,
...

oject            => string,
edential         => reference to gauth_credential,
allowed

The list of ALLOW rules specified by this firewall. Each rule specifies a protocol and port-range tuple that describes a permitted connection.

allowed[]/ip_protocol

Required. The IP protocol to which this rule applies. The protocol type is required when creating a firewall rule. This value can either be one of the following well known protocol strings (tcp, udp, icmp, esp, ah, sctp), or the IP protocol number.

allowed[]/ports

An optional list of ports to which this rule applies. This field is only applicable for UDP or TCP protocol. Each entry must be either an integer or a range. If not specified, this rule applies to connections through any port. Example inputs include: [“22”], [“80”,“443”], and [“12345-12349”].

description

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

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

URL of the network resource for this firewall rule. If not specified when creating a firewall rule, the default network is used: global/networks/default If you choose to specify this property, you can specify the network as a full or partial URL. For example, the following are all valid URLs: https://www.googleapis.com/compute/v1/projects/myproject/global/ networks/my-network projects/myproject/global/networks/my-network global/networks/default

source_ranges

If source ranges are specified, the firewall will apply only to traffic that has source IP address in these ranges. These ranges must be expressed in CIDR format. One or both of sourceRanges and sourceTags may be set. If both properties are set, the firewall will apply to traffic that has source IP address within sourceRanges OR the source IP that belongs to a tag listed in the sourceTags property. The connection does not need to match both properties for the firewall to apply. Only IPv4 is supported.

source_tags

If source tags are specified, the firewall will apply only to traffic with source IP that belongs to a tag listed in source tags. Source tags cannot be used to control traffic to an instance's external IP address. Because tags are associated with an instance, not an IP address. One or both of sourceRanges and sourceTags may be set. If both properties are set, the firewall will apply to traffic that has source IP address within sourceRanges OR the source IP that belongs to a tag listed in the sourceTags property. The connection does not need to match both properties for the firewall to apply.

target_tags

A list of instance tags indicating sets of instances located in the network that may make network connections as specified in allowed[]. If no targetTags are specified, the firewall rule applies to all instances on the specified network.

Output-only properties gcompute_forwarding_rule

A ForwardingRule resource. A ForwardingRule resource specifies which pool of target virtual machines to forward a packet to if it matches the given [IPAddress, IPProtocol, portRange] tuple.

Example 
pute_forwarding_rule { 'test1':
sure      => present,
_address  => gcompute_address_ref(
'some-address',
'us-west1', 'google.com:graphite-playground'

_protocol => 'TCP',
rt_range  => '80',
rget      => 'target-pool',
gion      => 'some-region',
oject     => 'google.com:graphite-playground',
edential  => 'mycred',
Reference 
pute_forwarding_rule { 'id-of-resource':
ckend_service       => reference to gcompute_backend_service,
eation_timestamp    => time,
scription           => string,
                    => integer,
_address            => string,
_protocol           => 'TCP', 'UDP', 'ESP', 'AH', 'SCTP' or 'ICMP',
_version            => 'IPV4' or 'IPV6',
ad_balancing_scheme => 'INTERNAL' or 'EXTERNAL',
me                  => string,
twork               => reference to gcompute_network,
rt_range            => string,
rts                 => [
string,
...

gion                => reference to gcompute_region,
bnetwork            => reference to gcompute_subnetwork,
rget                => reference to gcompute_target_pool,
oject               => string,
edential            => reference to gauth_credential,
description

An optional description of this resource. Provide this property when you create 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:

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

Required. 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? 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:

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.

target

A reference to a TargetPool resource to receive the matched traffic. For regional forwarding rules, this target must live in the same region as the forwarding rule. For global forwarding rules, this target must be a global load balancing resource. The forwarded traffic must be of a type appropriate to the target object. This field is not used for internal load balancing.

region

Required. A reference to the region where the regional forwarding rule resides. This field is not applicable to global forwarding rules.

Output-only properties gcompute_global_address

Represents a Global Address resource. Global addresses are used for HTTP(S) load balancing.

Example 
pute_global_address { 'my-app-lb-address':
sure     => present,
oject    => 'google.com:graphite-playground',
edential => 'mycred',
Reference 
pute_global_address { 'id-of-resource':
dress            => string,
eation_timestamp => time,
scription        => string,
                 => integer,
_version         => 'IPV4' or 'IPV6',
me               => string,
gion             => reference to gcompute_region,
oject            => string,
edential         => reference to gauth_credential,
description

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

name

Required. 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.

Output-only properties gcompute_global_forwarding_rule

Represents a GlobalForwardingRule resource. Global forwarding rules are used to forward traffic to the correct load balancer for HTTP load balancing. Global forwarding rules can only be used for HTTP load balancing.

For more information, see https://cloud.google.com/compute/docs/load-balancing/http/

Example 
pute_global_forwarding_rule { 'test1':
sure      => present,
_address  => gcompute_global_address_ref(
'my-app-lb-address',
'google.com:graphite-playground'

_protocol => 'TCP',
rt_range  => '80',
rget      => gcompute_target_http_proxy_ref(
'my-http-proxy',
'google.com:graphite-playground'

oject     => 'google.com:graphite-playground',
edential  => 'mycred',
Reference 
pute_global_forwarding_rule { 'id-of-resource':
ckend_service       => reference to gcompute_backend_service,
eation_timestamp    => time,
scription           => string,
                    => integer,
_address            => string,
_protocol           => 'TCP', 'UDP', 'ESP', 'AH', 'SCTP' or 'ICMP',
_version            => 'IPV4' or 'IPV6',
ad_balancing_scheme => 'INTERNAL' or 'EXTERNAL',
me                  => string,
twork               => reference to gcompute_network,
rt_range            => string,
rts                 => [
string,
...

gion                => reference to gcompute_region,
bnetwork            => reference to gcompute_subnetwork,
rget                => string,
oject               => string,
edential            => reference to gauth_credential,
description

An optional description of this resource. Provide this property when you create 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:

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

Required. 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? 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:

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.

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

Output-only properties gcompute_http_health_check

An HttpHealthCheck resource. This resource defines a template for how individual VMs should be checked for health, via HTTP.

Example 
pute_http_health_check { 'my-app-http-hc':
sure              => present,
althy_threshold   => 10,
rt                => 8080,
meout_sec         => 2,
healthy_threshold => 5,
oject             => 'google.com:graphite-playground',
edential          => 'mycred',
Reference 
pute_http_health_check { 'id-of-resource':
eck_interval_sec  => integer,
eation_timestamp  => time,
scription         => string,
althy_threshold   => integer,
st                => string,
                  => integer,
me                => string,
rt                => integer,
quest_path        => string,
meout_sec         => integer,
healthy_threshold => integer,
oject             => string,
edential          => reference to gauth_credential,
check_interval_sec

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

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 HTTP health check request. If left empty (default value), the public IP on behalf of which this health check is performed will be used.

name

Required. 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 HTTP health check request. The default value is 80.

request_path

The request path of the HTTP 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.

Output-only properties gcompute_https_health_check

An HttpsHealthCheck resource. This resource defines a template for how individual VMs should be checked for health, via HTTPS.

Example 
pute_https_health_check { 'my-app-https-hc':
sure              => present,
althy_threshold   => 10,
rt                => 8080,
meout_sec         => 2,
healthy_threshold => 5,
oject             => 'google.com:graphite-playground',
edential          => 'mycred',
Reference 
pute_https_health_check { 'id-of-resource':
eck_interval_sec  => integer,
eation_timestamp  => time,
scription         => string,
althy_threshold   => integer,
st                => string,
                  => integer,
me                => string,
rt                => integer,
quest_path        => string,
meout_sec         => integer,
healthy_threshold => integer,
oject             => string,
edential          => reference to gauth_credential,
check_interval_sec

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

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.

name

Required. 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.

Output-only properties gcompute_health_check

An HealthCheck resource. This resource defines a template for how individual virtual machines should be checked for health, via one of the supported protocols.

Example 
pute_health_check { 'my-app-tcp-hc':
sure              => present,
pe                => 'TCP',
p_health_check    => {
port_name => 'service-health',
request   => 'ping',
response  => 'pong',

althy_threshold   => 10,
meout_sec         => 2,
healthy_threshold => 5,
oject             => 'google.com:graphite-playground',
edential          => 'mycred',
Reference 
pute_health_check { 'id-of-resource':
eck_interval_sec  => integer,
eation_timestamp  => time,
scription         => string,
althy_threshold   => integer,
tp_health_check   => {
host         => string,
port         => integer,
port_name    => string,
proxy_header => 'NONE' or 'PROXY_V1',
request_path => string,

tps_health_check  => {
host         => string,
port         => integer,
port_name    => string,
proxy_header => 'NONE' or 'PROXY_V1',
request_path => string,

                  => integer,
me                => string,
l_health_check    => {
port         => integer,
port_name    => string,
proxy_header => 'NONE' or 'PROXY_V1',
request      => string,
response     => string,

p_health_check    => {
port         => integer,
port_name    => string,
proxy_header => 'NONE' or 'PROXY_V1',
request      => string,
response     => string,

meout_sec         => integer,
pe                => 'TCP', 'SSL' or 'HTTP',
healthy_threshold => integer,
oject             => string,
edential          => reference to gauth_credential,
check_interval_sec

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

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.

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.

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.

type

Specifies the type of the healthCheck, either TCP, SSL, HTTP or HTTPS. If not specified, the default is TCP. Exactly one of the protocol-specific health check field must be specified, which must match type field.

http_health_check

A nested object resource

http_health_check/host

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

http_health_check/request_path

The request path of the HTTP health check request. The default value is /.

http_health_check/port

The TCP port number for the HTTP health check request. The default value is 80.

http_health_check/port_name

Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.

http_health_check/proxy_header

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

https_health_check

A nested object resource

https_health_check/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.

https_health_check/request_path

The request path of the HTTPS health check request. The default value is /.

https_health_check/port

The TCP port number for the HTTPS health check request. The default value is 443.

https_health_check/port_name

Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.

https_health_check/proxy_header

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

tcp_health_check

A nested object resource

tcp_health_check/request

The application data to send once the TCP connection has been established (default value is empty). If both request and response are empty, the connection establishment alone will indicate health. The request data can only be ASCII.

tcp_health_check/response

The bytes to match against the beginning of the response data. If left empty (the default value), any response will indicate health. The response data can only be ASCII.

tcp_health_check/port

The TCP port number for the TCP health check request. The default value is 443.

tcp_health_check/port_name

Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.

tcp_health_check/proxy_header

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

ssl_health_check

A nested object resource

ssl_health_check/request

The application data to send once the SSL connection has been established (default value is empty). If both request and response are empty, the connection establishment alone will indicate health. The request data can only be ASCII.

ssl_health_check/response

The bytes to match against the beginning of the response data. If left empty (the default value), any response will indicate health. The response data can only be ASCII.

ssl_health_check/port

The TCP port number for the SSL health check request. The default value is 443.

ssl_health_check/port_name

Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.

ssl_health_check/proxy_header

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

Output-only properties gcompute_instance_template

Defines an Instance Template resource that provides configuration settings for your virtual machine instances. Instance templates are not tied to the lifetime of an instance and can be used and reused as to deploy virtual machines. You can also use different templates to create different virtual machine configurations. Instance templates are required when you create a managed instance group.

Tip: Disks should be set to autoDelete=true so that leftover disks are not left behind on machine deletion.

Example 
wer Tips:
1) Remember to define the resources needed to allocate the VM:
   a) gcompute_disk_type (to be used in 'diskType' property)
   b) gcompute_machine_type (to be used in 'machine_type' property)
   c) gcompute_network (to be used in 'network_interfaces' property)
   d) gcompute_subnetwork (to be used in the 'subnetwork' property)
   e) gcompute_disk (to be used in the 'sourceDisk' property)
2) Don't forget to define a source_image for the OS of the boot disk
   a) You can use the provided gcompute_image_family function to specify the
      latest version of an operating system of a given family
      e.g. Ubuntu 16.04
pute_instance_template { 'instance-template':
sure     => present,
operties => {
machine_type       => 'n1-standard-1',
disks              => [
  {
    # Tip: Auto delete will prevent disks from being left behind on
    # deletion.
    auto_delete       => true,
    boot              => true,
    initialize_params => {
      source_image =>
        gcompute_image_family('ubuntu-1604-lts', 'ubuntu-os-cloud'),
    }
  }
],
metadata           => {
  'startup-script-url'   => 'gs://graphite-playground/bootstrap.sh',
  'cost-center'          => '12345',
},
network_interfaces => [
  {
    access_configs => {
      name => 'test-config',
      type => 'ONE_TO_ONE_NAT',
    },
    network        => 'mynetwork-test',
  }
]

oject    => 'google.com:graphite-playground',
edential => 'mycred',
Reference 
pute_instance_template { 'id-of-resource':
eation_timestamp => time,
scription        => string,
                 => integer,
me               => string,
operties         => {
can_ip_forward     => boolean,
description        => string,
disks              => [
  {
    auto_delete         => boolean,
    boot                => boolean,
    device_name         => string,
    disk_encryption_key => {
      raw_key           => string,
      rsa_encrypted_key => string,
      sha256            => string,
    },
    index               => integer,
    initialize_params   => {
      disk_name                   => string,
      disk_size_gb                => integer,
      disk_type                   => reference to gcompute_disk_type,
      source_image                => string,
      source_image_encryption_key => {
        raw_key => string,
        sha256  => string,
      },
    },
    interface           => 'SCSI' or 'NVME',
    mode                => 'READ_WRITE' or 'READ_ONLY',
    source              => reference to gcompute_disk,
    type                => 'SCRATCH' or 'PERSISTENT',
  },
  ...
],
guest_accelerators => [
  {
    accelerator_count => integer,
    accelerator_type  => string,
  },
  ...
],
machine_type       => reference to gcompute_machine_type,
metadata           => namevalues,
network_interfaces => [
  {
    access_configs  => [
      {
        name   => string,
        nat_ip => reference to gcompute_address,
        type   => ONE_TO_ONE_NAT,
      },
      ...
    ],
    alias_ip_ranges => [
      {
        ip_cidr_range         => string,
        subnetwork_range_name => string,
      },
      ...
    ],
    name            => string,
    network         => reference to gcompute_network,
    network_ip      => string,
    subnetwork      => reference to gcompute_subnetwork,
  },
  ...
],
scheduling         => {
  automatic_restart   => boolean,
  on_host_maintenance => string,
  preemptible         => boolean,
},
service_accounts   => [
  {
    email  => boolean,
    scopes => [
      string,
      ...
    ],
  },
  ...
],
tags               => {
  fingerprint => string,
  items       => [
    string,
    ...
  ],
},

oject            => string,
edential         => reference to gauth_credential,
description

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

name

Required. Name of the resource. The name is 1-63 characters long and complies with RFC1035.

properties

The instance properties for this instance template.

properties/can_ip_forward

Enables instances created based on this template to send packets with source IP addresses other than their own and receive packets with destination IP addresses other than their own. If these instances will be used as an IP gateway or it will be set as the next-hop in a Route resource, specify true. If unsure, leave this set to false.

properties/description

An optional text description for the instances that are created from this instance template.

properties/disks

An array of disks that are associated with the instances that are created from this template.

properties/disks[]/auto_delete

Specifies whether the disk will be auto-deleted when the instance is deleted (but not when the disk is detached from the instance). Tip: Disks should be set to autoDelete=true so that leftover disks are not left behind on machine deletion.

properties/disks[]/boot

Indicates that this is a boot disk. The virtual machine will use the first partition of the disk for its root filesystem.

properties/disks[]/device_name

Specifies a unique device name of your choice that is reflected into the /dev/disk/by-id/google-* tree of a Linux operating system running within the instance. This name can be used to reference the device for mounting, resizing, and so on, from within the instance.

properties/disks[]/disk_encryption_key

Encrypts or decrypts a disk using a customer-supplied encryption key.

properties/disks[]/disk_encryption_key/raw_key

Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.

properties/disks[]/disk_encryption_key/rsa_encrypted_key

Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.

properties/disks[]/disk_encryption_key/sha256

Output only. The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.

properties/disks[]/index

Assigns a zero-based index to this disk, where 0 is reserved for the boot disk. For example, if you have many disks attached to an instance, each disk would have a unique index number. If not specified, the server will choose an appropriate value.

properties/disks[]/initialize_params

Specifies the parameters for a new disk that will be created alongside the new instance. Use initialization parameters to create boot disks or local SSDs attached to the new instance.

properties/disks[]/initialize_params/disk_name

Specifies the disk name. If not specified, the default is to use the name of the instance.

properties/disks[]/initialize_params/disk_size_gb

Specifies the size of the disk in base-2 GB.

properties/disks[]/initialize_params/disk_type

Reference to a gcompute_disk_type resource. Specifies the disk type to use to create the instance. If not specified, the default is pd-standard.

properties/disks[]/initialize_params/source_image

The source image to create this disk. When creating a new instance, one of initializeParams.sourceImage or disks.source is required. To create a disk with one of the public operating system images, specify the image by its family name.

properties/disks[]/initialize_params/source_image_encryption_key

The customer-supplied encryption key of the source image. Required if the source image is protected by a customer-supplied encryption key. Instance templates do not store customer-supplied encryption keys, so you cannot create disks for instances in a managed instance group if the source images are encrypted with your own keys.

properties/disks[]/initialize_params/source_image_encryption_key/raw_key

Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.

properties/disks[]/initialize_params/source_image_encryption_key/sha256

Output only. The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.

properties/disks[]/interface

Specifies the disk interface to use for attaching this disk, which is either SCSI or NVME. The default is SCSI. Persistent disks must always use SCSI and the request will fail if you attempt to attach a persistent disk in any other format than SCSI.

properties/disks[]/mode

The mode in which to attach this disk, either READ_WRITE or READ_ONLY. If not specified, the default is to attach the disk in READ_WRITE mode.

properties/disks[]/source

Reference to a gcompute_disk resource. When creating a new instance, one of initializeParams.sourceImage or disks.source is required. If desired, you can also attach existing non-root persistent disks using this property. This field is only applicable for persistent disks. Note that for InstanceTemplate, specify the disk name, not the URL for the disk.

properties/disks[]/type

Specifies the type of the disk, either SCRATCH or PERSISTENT. If not specified, the default is PERSISTENT.

properties/machine_type

Required. Reference to a gcompute_machine_type resource.

properties/metadata

The metadata key/value pairs to assign to instances that are created from this template. These pairs can consist of custom metadata or predefined keys.

properties/guest_accelerators

List of the type and count of accelerator cards attached to the instance

properties/guest_accelerators[]/accelerator_count

The number of the guest accelerator cards exposed to this instance.

properties/guest_accelerators[]/accelerator_type

Full or partial URL of the accelerator type resource to expose to this instance.

properties/network_interfaces

An array of configurations for this interface. This specifies how this interface is configured to interact with other network services, such as connecting to the internet. Only one network interface is supported per instance.

properties/network_interfaces[]/access_configs

An array of configurations for this interface. Currently, only one access config, ONE_TO_ONE_NAT, is supported. If there are no accessConfigs specified, then this instance will have no external internet access.

properties/network_interfaces[]/access_configs[]/name

Required. The name of this access configuration. The default and recommended name is External NAT but you can use any arbitrary string you would like. For example, My external IP or Network Access.

properties/network_interfaces[]/access_configs[]/nat_ip

Required. Specifies the title of a gcompute_address. An external IP address associated with this instance. Specify an unused static external IP address available to the project or leave this field undefined to use an IP from a shared ephemeral IP address pool. If you specify a static external IP address, it must live in the same region as the zone of the instance.

properties/network_interfaces[]/access_configs[]/type

Required. The type of configuration. The default and only option is ONE_TO_ONE_NAT.

properties/network_interfaces[]/alias_ip_ranges

An array of alias IP ranges for this network interface. Can only be specified for network interfaces on subnet-mode networks.

properties/network_interfaces[]/alias_ip_ranges[]/ip_cidr_range

The IP CIDR range represented by this alias IP range. This IP CIDR range must belong to the specified subnetwork and cannot contain IP addresses reserved by system or used by other network interfaces. This range may be a single IP address (e.g. 10.2.3.4), a netmask (e.g. /24) or a CIDR format string (e.g. 10.1.2.0/24).

properties/network_interfaces[]/alias_ip_ranges[]/subnetwork_range_name

Optional subnetwork secondary range name specifying the secondary range from which to allocate the IP CIDR range for this alias IP range. If left unspecified, the primary range of the subnetwork will be used.

properties/network_interfaces[]/name

Output only. The name of the network interface, generated by the server. For network devices, these are eth0, eth1, etc

properties/network_interfaces[]/network

Specifies the title of an existing gcompute_network. When creating an instance, if neither the network nor the subnetwork is specified, the default network global/networks/default is used; if the network is not specified but the subnetwork is specified, the network is inferred.

properties/network_interfaces[]/network_ip

An IPv4 internal network address to assign to the instance for this network interface. If not specified by the user, an unused internal IP is assigned by the system.

properties/network_interfaces[]/subnetwork

Reference to a gcompute_subnetwork resource. If the network resource is in legacy mode, do not provide this property. If the network is in auto subnet mode, providing the subnetwork is optional. If the network is in custom subnet mode, then this field should be specified.

properties/scheduling

Sets the scheduling options for this instance.

properties/scheduling/automatic_restart

Specifies whether the instance should be automatically restarted if it is terminated by Compute Engine (not terminated by a user). You can only set the automatic restart option for standard instances. Preemptible instances cannot be automatically restarted.

properties/scheduling/on_host_maintenance

Defines the maintenance behavior for this instance. For standard instances, the default behavior is MIGRATE. For preemptible instances, the default and only possible behavior is TERMINATE. For more information, see Setting Instance Scheduling Options.

properties/scheduling/preemptible

Defines whether the instance is preemptible. This can only be set during instance creation, it cannot be set or changed after the instance has been created.

properties/service_accounts

A list of service accounts, with their specified scopes, authorized for this instance. Only one service account per VM instance is supported.

properties/service_accounts[]/email

Email address of the service account.

properties/service_accounts[]/scopes

The list of scopes to be made available for this service account.

properties/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.

properties/tags/fingerprint

Specifies a fingerprint for this request, which is essentially a hash of the metadata's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update metadata. You must always provide an up-to-date fingerprint hash in order to update or change metadata.

properties/tags/items

An array of tags. Each tag must be 1-63 characters long, and comply with RFC1035.

Output-only properties gcompute_license

A License resource represents a software license. Licenses are used to track software usage in images, persistent disks, snapshots, and virtual machine instances.

Example 
pute_license { 'test-license':
oject    => 'google.com:graphite-playground',
edential => 'mycred',
Reference 
pute_license { 'id-of-resource':
arges_use_fee => boolean,
me            => string,
oject         => string,
edential      => reference to gauth_credential,
Output-only properties gcompute_image

Represents an Image resource.

Google Compute Engine uses operating system images to create the root persistent disks for your instances. You specify an image when you create an instance. Images contain a boot loader, an operating system, and a root file system. Linux operating system images are also capable of running containers on Compute Engine.

Images can be either public or custom.

Public images are provided and maintained by Google, open-source communities, and third-party vendors. By default, all projects have access to these images and can use them to create instances. Custom images are available only to your project. You can create a custom image from root persistent disks and other images. Then, use the custom image to create an instance.

Example 
p: Be sure to include a valid gcompute_disk object
pute_image { 'test-image':
sure      => present,
urce_disk => 'data-disk-1',
oject     => 'google.com:graphite-playground',
edential  => 'mycred'
Reference 
pute_image { 'id-of-resource':
chive_size_bytes         => integer,
eation_timestamp         => time,
precated                 => {
deleted     => time,
deprecated  => time,
obsolete    => time,
replacement => string,
state       => 'DEPRECATED', 'OBSOLETE' or 'DELETED',

scription                => string,
sk_size_gb               => integer,
mily                     => string,
est_os_features          => [
{
  type => VIRTIO_SCSI_MULTIQUEUE,
},
...

                         => integer,
age_encryption_key       => {
raw_key => string,
sha256  => string,

censes                   => [
string,
...

me                       => string,
w_disk                   => {
container_type => TAR,
sha1_checksum  => string,
source         => string,

urce_disk                => reference to gcompute_disk,
urce_disk_encryption_key => {
raw_key => string,
sha256  => string,

urce_disk_id             => string,
urce_type                => RAW,
oject                    => string,
edential                 => reference to gauth_credential,
description

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

disk_size_gb

Size of the image when restored onto a persistent disk (in GB).

family

The name of the image family to which this image belongs. You can create disks by specifying an image family instead of a specific image name. The image family always returns its latest image that is not deprecated. The name of the image family must comply with RFC1035.

guest_os_features

A list of features to enable on the guest OS. Applicable for bootable images only. Currently, only one feature can be enabled, VIRTIO_SCSI_MULTIQUEUE, which allows each virtual CPU to have its own queue. For Windows images, you can only enable VIRTIO_SCSI_MULTIQUEUE on images with driver version 1.2.0.1621 or higher. Linux images with kernel versions 3.17 and higher will support VIRTIO_SCSI_MULTIQUEUE. For new Windows images, the server might also populate this field with the value WINDOWS, to indicate that this is a Windows image. This value is purely informational and does not enable or disable any features.

guest_os_features[]/type

The type of supported feature. Currenty only VIRTIO_SCSI_MULTIQUEUE is supported. For newer Windows images, the server might also populate this property with the value WINDOWS to indicate that this is a Windows image. This value is purely informational and does not enable or disable any features.

image_encryption_key

Encrypts the image using a customer-supplied encryption key. After you encrypt an image with a customer-supplied key, you must provide the same key if you use the image later (e.g. to create a disk from the image)

image_encryption_key/raw_key

Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.

image_encryption_key/sha256

Output only. The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.

licenses

Any applicable license URI.

name

Required. 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.

raw_disk

The parameters of the raw disk image.

raw_disk/container_type

The format used to encode and transmit the block device, which should be TAR. This is just a container and transmission format and not a runtime format. Provided by the client when the disk image is created.

raw_disk/sha1_checksum

An optional SHA1 checksum of the disk image before unpackaging. This is provided by the client when the disk image is created.

raw_disk/source

The full Google Cloud Storage URL where disk storage is stored You must provide either this property or the sourceDisk property but not both.

source_disk

Refers to a gcompute_disk object You must provide either this property or the rawDisk.source property but not both to create an image.

source_disk_encryption_key

The customer-supplied encryption key of the source disk. Required if the source disk is protected by a customer-supplied encryption key.

source_disk_encryption_key/raw_key

Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.

source_disk_encryption_key/sha256

Output only. The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.

source_disk_id

The ID value of the disk used to create this image. This value may be used to determine whether the image was taken from the current or a previous instance of a given disk name.

source_type

The type of the image used to create this disk. The default and only value is RAW

Output-only properties deprecated/deleted

An optional RFC3339 timestamp on or after which the state of this resource is intended to change to DELETED. This is only informational and the status will not change unless the client explicitly changes it.

deprecated/deprecated

An optional RFC3339 timestamp on or after which the state of this resource is intended to change to DEPRECATED. This is only informational and the status will not change unless the client explicitly changes it.

deprecated/obsolete

An optional RFC3339 timestamp on or after which the state of this resource is intended to change to OBSOLETE. This is only informational and the status will not change unless the client explicitly changes it.

deprecated/replacement

The URL of the suggested replacement for a deprecated resource. The suggested replacement resource must be the same kind of resource as the deprecated resource.

deprecated/state

The deprecation state of this resource. This can be DEPRECATED, OBSOLETE, or DELETED. Operations which create a new resource using a DEPRECATED resource will return successfully, but with a warning indicating the deprecated resource and recommending its replacement. Operations which use OBSOLETE or DELETED resources will be rejected and result in an error.

gcompute_instance

An instance is a virtual machine (VM) hosted on Google's infrastructure.

Example 
wer Tips:
1) Remember to define the resources needed to allocate the VM:
   a) gcompute_disk_type (to be used in 'diskType' property)
   b) gcompute_machine_type (to be used in 'machine_type' property)
   c) gcompute_network (to be used in 'network_interfaces' property)
   d) gcompute_subnetwork (to be used in the 'subnetwork' property)
   e) gcompute_disk (to be used in the 'sourceDisk' property)
   f) gcompute_address (to be used in 'access_configs', if your machine
      needs external ingress access)
2) Don't forget to define a source_image for the OS of the boot disk
   a) You can use the provided gcompute_image_family function to specify the
      latest version of an operating system of a given family
      e.g. Ubuntu 16.04
pute_instance { 'instance-test':
sure             => present,
chine_type       => 'n1-standard-1',
sks              => [
{
  auto_delete => true,
  boot        => true,
  source      => 'instance-test-os-1'
}

tadata           => {
startup-script-url   => 'gs://graphite-playground/bootstrap.sh',
cost-center          => '12345',

twork_interfaces => [
{
  network        => 'default',
  access_configs => [
    {
      name   => 'External NAT',
      nat_ip => 'instance-test-ip',
      type   => 'ONE_TO_ONE_NAT',
    },
  ],
}

ne               => 'us-central1-a',
oject            => 'google.com:graphite-playground',
edential         => 'mycred',
Reference 
pute_instance { 'id-of-resource':
n_ip_forward     => boolean,
u_platform       => string,
eation_timestamp => string,
sks              => [
{
  auto_delete         => boolean,
  boot                => boolean,
  device_name         => string,
  disk_encryption_key => {
    raw_key           => string,
    rsa_encrypted_key => string,
    sha256            => string,
  },
  index               => integer,
  initialize_params   => {
    disk_name                   => string,
    disk_size_gb                => integer,
    disk_type                   => reference to gcompute_disk_type,
    source_image                => string,
    source_image_encryption_key => {
      raw_key => string,
      sha256  => string,
    },
  },
  interface           => 'SCSI' or 'NVME',
  mode                => 'READ_WRITE' or 'READ_ONLY',
  source              => reference to gcompute_disk,
  type                => 'SCRATCH' or 'PERSISTENT',
},
...

est_accelerators => [
{
  accelerator_count => integer,
  accelerator_type  => string,
},
...

                 => integer,
bel_fingerprint  => string,
chine_type       => reference to gcompute_machine_type,
tadata           => namevalues,
n_cpu_platform   => string,
me               => string,
twork_interfaces => [
{
  access_configs  => [
    {
      name   => string,
      nat_ip => reference to gcompute_address,
      type   => ONE_TO_ONE_NAT,
    },
    ...
  ],
  alias_ip_ranges => [
    {
      ip_cidr_range         => string,
      subnetwork_range_name => string,
    },
    ...
  ],
  name            => string,
  network         => reference to gcompute_network,
  network_ip      => string,
  subnetwork      => reference to gcompute_subnetwork,
},
...

heduling         => {
automatic_restart   => boolean,
on_host_maintenance => string,
preemptible         => boolean,

rvice_accounts   => [
{
  email  => boolean,
  scopes => [
    string,
    ...
  ],
},
...

atus             => string,
atus_message     => string,
gs               => {
fingerprint => string,
items       => [
  string,
  ...
],

ne               => reference to gcompute_zone,
oject            => string,
edential         => reference to gauth_credential,
can_ip_forward

Allows this instance to send and receive packets with non-matching destination or source IPs. This is required if you plan to use this instance to forward routes.

disks

An array of disks that are associated with the instances that are created from this template.

disks[]/auto_delete

Specifies whether the disk will be auto-deleted when the instance is deleted (but not when the disk is detached from the instance). Tip: Disks should be set to autoDelete=true so that leftover disks are not left behind on machine deletion.

disks[]/boot

Indicates that this is a boot disk. The virtual machine will use the first partition of the disk for its root filesystem.

disks[]/device_name

Specifies a unique device name of your choice that is reflected into the /dev/disk/by-id/google-* tree of a Linux operating system running within the instance. This name can be used to reference the device for mounting, resizing, and so on, from within the instance.

disks[]/disk_encryption_key

Encrypts or decrypts a disk using a customer-supplied encryption key.

disks[]/disk_encryption_key/raw_key

Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.

disks[]/disk_encryption_key/rsa_encrypted_key

Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.

disks[]/disk_encryption_key/sha256

Output only. The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.

disks[]/index

Assigns a zero-based index to this disk, where 0 is reserved for the boot disk. For example, if you have many disks attached to an instance, each disk would have a unique index number. If not specified, the server will choose an appropriate value.

disks[]/initialize_params

Specifies the parameters for a new disk that will be created alongside the new instance. Use initialization parameters to create boot disks or local SSDs attached to the new instance.

disks[]/initialize_params/disk_name

Specifies the disk name. If not specified, the default is to use the name of the instance.

disks[]/initialize_params/disk_size_gb

Specifies the size of the disk in base-2 GB.

disks[]/initialize_params/disk_type

Reference to a gcompute_disk_type resource. Specifies the disk type to use to create the instance. If not specified, the default is pd-standard.

disks[]/initialize_params/source_image

The source image to create this disk. When creating a new instance, one of initializeParams.sourceImage or disks.source is required. To create a disk with one of the public operating system images, specify the image by its family name.

disks[]/initialize_params/source_image_encryption_key

The customer-supplied encryption key of the source image. Required if the source image is protected by a customer-supplied encryption key. Instance templates do not store customer-supplied encryption keys, so you cannot create disks for instances in a managed instance group if the source images are encrypted with your own keys.

disks[]/initialize_params/source_image_encryption_key/raw_key

Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.

disks[]/initialize_params/source_image_encryption_key/sha256

Output only. The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.

disks[]/interface

Specifies the disk interface to use for attaching this disk, which is either SCSI or NVME. The default is SCSI. Persistent disks must always use SCSI and the request will fail if you attempt to attach a persistent disk in any other format than SCSI.

disks[]/mode

The mode in which to attach this disk, either READ_WRITE or READ_ONLY. If not specified, the default is to attach the disk in READ_WRITE mode.

disks[]/source

Reference to a gcompute_disk resource. When creating a new instance, one of initializeParams.sourceImage or disks.source is required. If desired, you can also attach existing non-root persistent disks using this property. This field is only applicable for persistent disks.

disks[]/type

Specifies the type of the disk, either SCRATCH or PERSISTENT. If not specified, the default is PERSISTENT.

guest_accelerators

List of the type and count of accelerator cards attached to the instance

guest_accelerators[]/accelerator_count

The number of the guest accelerator cards exposed to this instance.

guest_accelerators[]/accelerator_type

Full or partial URL of the accelerator type resource to expose to this instance.

label_fingerprint

A fingerprint for this request, which is essentially a hash of the metadata's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update metadata. You must always provide an up-to-date fingerprint hash in order to update or change metadata.

metadata

The metadata key/value pairs to assign to instances that are created from this template. These pairs can consist of custom metadata or predefined keys.

machine_type

A reference to a machine type which defines VM kind.

min_cpu_platform

Specifies a minimum CPU platform for the VM instance. Applicable values are the friendly names of CPU platforms

name

The name of the resource, provided by the client when initially creating the resource. The resource 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_interfaces

An array of configurations for this interface. This specifies how this interface is configured to interact with other network services, such as connecting to the internet. Only one network interface is supported per instance.

network_interfaces[]/access_configs

An array of configurations for this interface. Currently, only one access config, ONE_TO_ONE_NAT, is supported. If there are no accessConfigs specified, then this instance will have no external internet access.

network_interfaces[]/access_configs[]/name

Required. The name of this access configuration. The default and recommended name is External NAT but you can use any arbitrary string you would like. For example, My external IP or Network Access.

network_interfaces[]/access_configs[]/nat_ip

Required. Specifies the title of a gcompute_address. An external IP address associated with this instance. Specify an unused static external IP address available to the project or leave this field undefined to use an IP from a shared ephemeral IP address pool. If you specify a static external IP address, it must live in the same region as the zone of the instance.

network_interfaces[]/access_configs[]/type

Required. The type of configuration. The default and only option is ONE_TO_ONE_NAT.

network_interfaces[]/alias_ip_ranges

An array of alias IP ranges for this network interface. Can only be specified for network interfaces on subnet-mode networks.

network_interfaces[]/alias_ip_ranges[]/ip_cidr_range

The IP CIDR range represented by this alias IP range. This IP CIDR range must belong to the specified subnetwork and cannot contain IP addresses reserved by system or used by other network interfaces. This range may be a single IP address (e.g. 10.2.3.4), a netmask (e.g. /24) or a CIDR format string (e.g. 10.1.2.0/24).

network_interfaces[]/alias_ip_ranges[]/subnetwork_range_name

Optional subnetwork secondary range name specifying the secondary range from which to allocate the IP CIDR range for this alias IP range. If left unspecified, the primary range of the subnetwork will be used.

network_interfaces[]/name

Output only. The name of the network interface, generated by the server. For network devices, these are eth0, eth1, etc

network_interfaces[]/network

Specifies the title of an existing gcompute_network. When creating an instance, if neither the network nor the subnetwork is specified, the default network global/networks/default is used; if the network is not specified but the subnetwork is specified, the network is inferred.

network_interfaces[]/network_ip

An IPv4 internal network address to assign to the instance for this network interface. If not specified by the user, an unused internal IP is assigned by the system.

network_interfaces[]/subnetwork

Reference to a gcompute_subnetwork resource. If the network resource is in legacy mode, do not provide this property. If the network is in auto subnet mode, providing the subnetwork is optional. If the network is in custom subnet mode, then this field should be specified.

scheduling

Sets the scheduling options for this instance.

scheduling/automatic_restart

Specifies whether the instance should be automatically restarted if it is terminated by Compute Engine (not terminated by a user). You can only set the automatic restart option for standard instances. Preemptible instances cannot be automatically restarted.

scheduling/on_host_maintenance

Defines the maintenance behavior for this instance. For standard instances, the default behavior is MIGRATE. For preemptible instances, the default and only possible behavior is TERMINATE. For more information, see Setting Instance Scheduling Options.

scheduling/preemptible

Defines whether the instance is preemptible. This can only be set during instance creation, it cannot be set or changed after the instance has been created.

service_accounts

A list of service accounts, with their specified scopes, authorized for this instance. Only one service account per VM instance is supported.

service_accounts[]/email

Email address of the service account.

service_accounts[]/scopes

The list of scopes to be made available for this service account.

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.

tags/fingerprint

Specifies a fingerprint for this request, which is essentially a hash of the metadata's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update metadata. You must always provide an up-to-date fingerprint hash in order to update or change metadata.

tags/items

An array of tags. Each tag must be 1-63 characters long, and comply with RFC1035.

zone

Required. A reference to the zone where the machine resides.

Output-only properties gcompute_instance_group

Represents an Instance Group resource. Instance groups are self-managed and can contain identical or different instances. Instance groups do not use an instance template. Unlike managed instance groups, you must create and add instances to an instance group manually.

Example 
stance group requires a network, so define them in your manifest:
- gcompute_network { 'my-network': ensure => present }
pute_instance_group { 'my-puppet-masters':
sure      => present,
med_ports => [
{
  name => 'puppet',
  port => 8140,
},

twork     => 'my-network',
ne        => 'us-central1-a',
oject     => 'google.com:graphite-playground',
edential  => 'mycred',
Reference 
pute_instance_group { 'id-of-resource':
eation_timestamp => time,
scription        => string,
                 => integer,
me               => string,
med_ports        => [
{
  name => string,
  port => integer,
},
...

twork            => reference to gcompute_network,
gion             => reference to gcompute_region,
bnetwork         => reference to gcompute_subnetwork,
ne               => reference to gcompute_zone,
oject            => string,
edential         => reference to gauth_credential,
description

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

name

The name of the instance group. The name must be 1-63 characters long, and comply with RFC1035.

named_ports

Assigns a name to a port number. For example: {name: “http”, port: 80}. This allows the system to reference ports by the assigned name instead of a port number. Named ports can also contain multiple ports. For example: [{name: “http”, port: 80},{name: “http”, port: 8080}] Named ports apply to all instances in this instance group.

named_ports[]/name

The name for this named port. The name must be 1-63 characters long, and comply with RFC1035.

named_ports[]/port

The port number, which can be a value between 1 and 65535.

network

The network to which all instances in the instance group belong.

region

The region where the instance group is located (for regional resources).

subnetwork

The subnetwork to which all instances in the instance group belong.

zone

Required. A reference to the zone where the instance group resides.

Output-only properties gcompute_instance_group_manager

Creates a managed instance group using the information that you specify in the request. After the group is created, it schedules an action to create instances in the group using the specified instance template. This operation is marked as DONE when the group is created even if the instances in the group have not yet been created. You must separately verify the status of the individual instances.

A managed instance group can have up to 1000 VM instances per group.

Example 
pute_instance_group_manager { 'test1':
sure             => present,
se_instance_name => 'test1-child',
stance_template  => 'instance-template',
rget_size        => 3,
ne               => 'us-west1-a',
oject            => 'google.com:graphite-playground',
edential         => 'mycred',
Reference 
pute_instance_group_manager { 'id-of-resource':
se_instance_name => string,
eation_timestamp => time,
rrent_actions    => {
abandoning               => integer,
creating                 => integer,
creating_without_retries => integer,
deleting                 => integer,
none                     => integer,
recreating               => integer,
refreshing               => integer,
restarting               => integer,

scription        => string,
                 => integer,
stance_group     => reference to gcompute_instance_group,
stance_template  => reference to gcompute_instance_template,
me               => string,
med_ports        => [
{
  name => string,
  port => integer,
},
...

gion             => reference to gcompute_region,
rget_pools       => [
reference to a gcompute_target_pool,
...

rget_size        => integer,
ne               => reference to gcompute_zone,
oject            => string,
edential         => reference to gauth_credential,
base_instance_name

Required. The base instance name to use for instances in this group. The value must be 1-58 characters long. Instances are named by appending a hyphen and a random four-character string to the base instance name. The base instance name must comply with RFC1035.

description

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

instance_template

Required. The instance template that is specified for this managed instance group. The group uses this template to create all new instances in the managed instance group.

name

Required. The name of the managed instance group. The name must be 1-63 characters long, and comply with RFC1035.

named_ports

Named ports configured for the Instance Groups complementary to this Instance Group Manager.

named_ports[]/name

The name for this named port. The name must be 1-63 characters long, and comply with RFC1035.

named_ports[]/port

The port number, which can be a value between 1 and 65535.

target_pools

TargetPool resources to which instances in the instanceGroup field are added. The target pools automatically apply to all of the instances in the managed instance group.

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

Required. The zone the managed instance group resides.

Output-only properties current_actions/abandoning

Output only. The total number of instances in the managed instance group that are scheduled to be abandoned. Abandoning an instance removes it from the managed instance group without deleting it.

current_actions/creating

Output only. The number of instances in the managed instance group that are scheduled to be created or are currently being created. If the group fails to create any of these instances, it tries again until it creates the instance successfully. If you have disabled creation retries, this field will not be populated; instead, the creatingWithoutRetries field will be populated.

current_actions/creating_without_retries

Output only. The number of instances that the managed instance group will attempt to create. The group attempts to create each instance only once. If the group fails to create any of these instances, it decreases the group's targetSize value accordingly.

current_actions/deleting

Output only. The number of instances in the managed instance group that are scheduled to be deleted or are currently being deleted.

current_actions/none

Output only. The number of instances in the managed instance group that are running and have no scheduled actions.

current_actions/recreating

Output only. The number of instances in the managed instance group that are scheduled to be recreated or are currently being being recreated. Recreating an instance deletes the existing root persistent disk and creates a new disk from the image that is defined in the instance template.

current_actions/refreshing

Output only. The number of instances in the managed instance group that are being reconfigured with properties that do not require a restart or a recreate action. For example, setting or removing target pools for the instance.

current_actions/restarting

Output only. The number of instances in the managed instance group that are scheduled to be restarted or are currently being restarted.

gcompute_machine_type

Represents a MachineType resource. Machine types determine the virtualized hardware specifications of your virtual machine instances, such as the amount of memory or number of virtual CPUs.

Example 
pute_machine_type { 'n1-standard-1':
ne       => 'us-central1-a',
oject    => 'google.com:graphite-playground',
edential => 'mycred',
Reference 
pute_machine_type { 'id-of-resource':
eation_timestamp               => time,
precated                       => {
deleted     => time,
deprecated  => time,
obsolete    => time,
replacement => string,
state       => 'DEPRECATED', 'OBSOLETE' or 'DELETED',

scription                      => string,
est_cpus                       => integer,
                               => integer,
_shared_cpu                    => boolean,
ximum_persistent_disks         => integer,
ximum_persistent_disks_size_gb => integer,
mory_mb                        => integer,
me                             => string,
ne                             => reference to gcompute_zone,
oject                          => string,
edential                       => reference to gauth_credential,
name

Name of the resource.

zone

Required. The zone the machine type is defined.

Output-only properties deprecated/deleted

Output only. An optional RFC3339 timestamp on or after which the state of this resource is intended to change to DELETED. This is only informational and the status will not change unless the client explicitly changes it.

deprecated/deprecated

Output only. An optional RFC3339 timestamp on or after which the state of this resource is intended to change to DEPRECATED. This is only informational and the status will not change unless the client explicitly changes it.

deprecated/obsolete

Output only. An optional RFC3339 timestamp on or after which the state of this resource is intended to change to OBSOLETE. This is only informational and the status will not change unless the client explicitly changes it.

deprecated/replacement

Output only. The URL of the suggested replacement for a deprecated resource. The suggested replacement resource must be the same kind of resource as the deprecated resource.

deprecated/state

Output only. The deprecation state of this resource. This can be DEPRECATED, OBSOLETE, or DELETED. Operations which create a new resource using a DEPRECATED resource will return successfully, but with a warning indicating the deprecated resource and recommending its replacement. Operations which use OBSOLETE or DELETED resources will be rejected and result in an error.

gcompute_network

Represents a Network resource.

Your Cloud Platform Console project can contain multiple networks, and each network can have multiple instances attached to it. A network allows you to define a gateway IP and the network range for the instances attached to that network. Every project is provided with a default network with preset configurations and firewall rules. You can choose to customize the default network by adding or removing rules, or you can create new networks in that project. Generally, most users only need one network, although you can have up to five networks per project by default.

A network belongs to only one project, and each instance can only belong to one network. All Compute Engine networks use the IPv4 protocol. Compute Engine currently does not support IPv6. However, Google is a major advocate of IPv6 and it is an important future direction.

Example 
tomatically allocated network
pute_network { "mynetwork-${network_id}":
to_create_subnetworks => true,
oject                 => 'google.com:graphite-playground',
edential              => 'mycred',


nually allocated network
pute_network { "mynetwork-${network_id}":
to_create_subnetworks => false,
oject                 => 'google.com:graphite-playground',
edential              => 'mycred',


gacy network
pute_network { "mynetwork-${network_id}":
On a legacy network you cannot specify the auto_create_subnetworks
parameter.
| auto_create_subnetworks => false,
v4_range   => '192.168.0.0/16',
teway_ipv4 => '192.168.0.1',
oject      => 'google.com:graphite-playground',
edential   => 'mycred',


nverting automatic to custom network
pute_network { "mynetwork-${network_id}":
to_create_subnetworks => false,
oject                 => 'google.com:graphite-playground',
edential              => 'mycred',
Reference 
pute_network { 'id-of-resource':
to_create_subnetworks => boolean,
eation_timestamp      => time,
scription             => string,
teway_ipv4            => string,
                      => integer,
v4_range              => string,
me                    => string,
bnetworks             => [
string,
...

oject                 => string,
edential              => reference to gauth_credential,
description

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

gateway_ipv4

A gateway address for default routing to other networks. This value is read only and is selected by the Google Compute Engine, typically as the first usable address in the IPv4Range.

ipv4_range

The range of internal addresses that are legal on this network. This range is a CIDR specification, for example: 192.168.0.0/16. Provided by the client when the network is created.

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.

auto_create_subnetworks

When set to true, the network is created in “auto subnet mode”. When set to false, the network is in “custom subnet mode”. In “auto subnet mode”, a newly created network is assigned the default CIDR of 10.128.0.0/9 and it automatically creates one subnetwork per region.

Output-only properties gcompute_region

Represents a Region resource. A region is a specific geographical location where you can run your resources. Each region has one or more zones

Example 
pute_region { 'us-west1':
oject    => 'google.com:graphite-playground',
edential => 'mycred',
Reference 
pute_region { 'id-of-resource':
eation_timestamp => time,
precated         => {
deleted     => time,
deprecated  => time,
obsolete    => time,
replacement => string,
state       => 'DEPRECATED', 'OBSOLETE' or 'DELETED',

scription        => string,
                 => integer,
me               => string,
nes              => [
string,
...

oject            => string,
edential         => reference to gauth_credential,
name

Name of the resource.

Output-only properties deprecated/deleted

An optional RFC3339 timestamp on or after which the deprecation state of this resource will be changed to DELETED.

deprecated/deprecated

Output only. An optional RFC3339 timestamp on or after which the deprecation state of this resource will be changed to DEPRECATED.

deprecated/obsolete

Output only. An optional RFC3339 timestamp on or after which the deprecation state of this resource will be changed to OBSOLETE.

deprecated/replacement

Output only. The URL of the suggested replacement for a deprecated resource. The suggested replacement resource must be the same kind of resource as the deprecated resource.

deprecated/state

Output only. The deprecation state of this resource. This can be DEPRECATED, OBSOLETE, or DELETED. Operations which create a new resource using a DEPRECATED resource will return successfully, but with a warning indicating the deprecated resource and recommending its replacement. Operations which use OBSOLETE or DELETED resources will be rejected and result in an error.

gcompute_route

Represents a Route resource.

A route is a rule that specifies how certain packets should be handled by the virtual network. Routes are associated with virtual machines by tag, and the set of routes for a particular virtual machine is called its routing table. For each packet leaving a virtual machine, the system searches that virtual machine's routing table for a single best matching route.

Routes match packets by destination IP address, preferring smaller or more specific ranges over larger ones. If there is a tie, the system selects the route with the smallest priority value. If there is still a tie, it uses the layer three and four packet headers to select just one of the remaining matching routes. The packet is then forwarded as specified by the next_hop field of the winning route – either to another virtual machine destination, a virtual machine gateway or a Compute Engine-operated gateway. Packets that do not match any route in the sending virtual machine's routing table will be dropped.

A Routes resources must have exactly one specification of either nextHopGateway, nextHopInstance, nextHopIp, or nextHopVpnTunnel.

Example 
ute requires a network, so define them in your manifest:
- gcompute_network { 'my-network': ensure => presnet }
pute_route { 'corp-route':
sure           => present,
st_range       => '192.168.6.0/24',
xt_hop_gateway => 'global/gateways/default-internet-gateway',
twork          => 'my-network',
gs             => ['backends', 'databases'],
oject          => 'google.com:graphite-playground',
edential       => 'mycred',
Reference 
pute_route { 'id-of-resource':
st_range          => string,
me                => string,
twork             => reference to gcompute_network,
xt_hop_gateway    => string,
xt_hop_instance   => string,
xt_hop_ip         => string,
xt_hop_vpn_tunnel => string,
iority            => integer,
gs                => [
string,
...

oject             => string,
edential          => reference to gauth_credential,
dest_range

The destination range of outgoing packets that this route applies to. Only IPv4 is supported.

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

The network that this route applies to.

priority

The priority of this route. Priority is used to break ties in cases where there is more than one matching route of equal prefix length. In the case of two routes with equal prefix length, the one with the lowest-numbered priority value wins. Default value is 1000. Valid range is 0 through 65535.

tags

A list of instance tags to which this route applies.

next_hop_gateway

URL to a gateway that should handle matching packets. Currently, you can only specify the internet gateway, using a full or partial valid URL:

next_hop_instance

URL to an instance that should handle matching packets. You can specify this as a full or partial URL. For example:

next_hop_ip

Network IP address of an instance that should handle matching packets.

next_hop_vpn_tunnel

URL to a VpnTunnel that should handle matching packets.

gcompute_snapshot

Represents a Persistent Disk Snapshot resource.

Use snapshots to back up data from your persistent disks. Snapshots are different from public images and custom images, which are used primarily to create instances or configure instance templates. Snapshots are useful for periodic backup of the data on your persistent disks. You can create snapshots from persistent disks even while they are attached to running instances.

Snapshots are incremental, so you can create regular snapshots on a persistent disk faster and at a much lower cost than if you regularly created a full image of the disk.

Example 
pute_snapshot { 'data-disk-snapshot-1':
sure                     => present,
apshot_encryption_key    => {
raw_key => 'VGhpcyBpcyBhbiBlbmNyeXB0ZWQgc25hcHNob3QhISE=',

urce_disk_encryption_key => {
raw_key => 'SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=',

urce                     => 'data-disk-1',
ne                       => 'us-central1-a',
oject                    => 'google.com:graphite-playground',
edential                 => 'mycred',
Reference 
pute_snapshot { 'id-of-resource':
eation_timestamp         => time,
scription                => string,
sk_size_gb               => integer,
                         => integer,
bels                     => [
string,
...

censes                   => [
reference to a gcompute_license,
...

me                       => string,
apshot_encryption_key    => {
raw_key => string,
sha256  => string,

urce                     => reference to gcompute_disk,
urce_disk_encryption_key => {
raw_key => string,
sha256  => string,

orage_bytes              => integer,
ne                       => reference to gcompute_zone,
oject                    => string,
edential                 => reference to gauth_credential,
name

Required. 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.

description

An optional description of this resource.

licenses

A list of public visible licenses that apply to this snapshot. This can be because the original image had licenses attached (such as a Windows image). snapshotEncryptionKey nested object Encrypts the snapshot using a customer-supplied encryption key.

labels

Labels to apply to this snapshot.

source

A reference to the disk used to create this snapshot.

zone

A reference to the zone where the disk is hosted.

snapshot_encryption_key

The customer-supplied encryption key of the snapshot. Required if the source snapshot is protected by a customer-supplied encryption key.

snapshot_encryption_key/raw_key

Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.

snapshot_encryption_key/sha256

Output only. The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.

source_disk_encryption_key

The customer-supplied encryption key of the source snapshot. Required if the source snapshot is protected by a customer-supplied encryption key.

source_disk_encryption_key/raw_key

Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.

source_disk_encryption_key/sha256

Output only. The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.

Output-only properties gcompute_ssl_certificate

An SslCertificate resource. This resource provides a mechanism to upload an SSL key and certificate to the load balancer to serve secure connections from the user.

Example 
*****
RNING: This manifest is for example purposes only. It is *not* advisable to
ve the key embedded like this because if you check this file into source
ntrol you are publishing the private key to whomever can access the source
de. Instead you should protect the key, and for example, use the file()
nction to read it from disk without writing it verbatim to the manifest:

ompute_ssl_certificate { ...
...
private_key => file('/path/to/my/private/key.pem'),
...

*****

pute_ssl_certificate { 'sample-certificate':
sure      => present,
scription => 'A certificate for test purposes only.',
oject     => 'google.com:graphite-playground',
edential  => 'mycred',
rtificate => '-----BEGIN CERTIFICATE-----
qjCCAk+gAwIBAgIJAIuJ+0352Kq4MAoGCCqGSM49BAMCMIGwMQswCQYDVQQG
UzETMBEGA1UECAwKV2FzaGluZ3RvbjERMA8GA1UEBwwIS2lya2xhbmQxFTAT
BAoMDEdvb2dsZSwgSW5jLjEeMBwGA1UECwwVR29vZ2xlIENsb3VkIFBsYXRm
MR8wHQYDVQQDDBZ3d3cubXktc2VjdXJlLXNpdGUuY29tMSEwHwYJKoZIhvcN
FhJuZWxzb25hQGdvb2dsZS5jb20wHhcNMTcwNjI4MDQ1NjI2WhcNMjcwNjI2
NjI2WjCBsDELMAkGA1UEBhMCVVMxEzARBgNVBAgMCldhc2hpbmd0b24xETAP
BAcMCEtpcmtsYW5kMRUwEwYDVQQKDAxHb29nbGUsIEluYy4xHjAcBgNVBAsM
b2dsZSBDbG91ZCBQbGF0Zm9ybTEfMB0GA1UEAwwWd3d3Lm15LXNlY3VyZS1z
LmNvbTEhMB8GCSqGSIb3DQEJARYSbmVsc29uYUBnb29nbGUuY29tMFkwEwYH
zj0CAQYIKoZIzj0DAQcDQgAEHGzpcRJ4XzfBJCCPMQeXQpTXwlblimODQCuQ
zTv0dXyB750fOGN02HtkpBOZzzvUARTR10JQoSe2/5PIwaNQME4wHQYDVR0O
FKIQC3A2SDpxcdfn0YLKineDNq/BMB8GA1UdIwQYMBaAFKIQC3A2SDpxcdfn
ineDNq/BMAwGA1UdEwQFMAMBAf8wCgYIKoZIzj0EAwIDSQAwRgIhALs4vy+O
qgA4fSW/oKw6UJxp+M6a+nGMX+UJR3YgAiEAvvl39QRVAiv84hdoCuyON0lJ
hIPGq2ULqXKK8BY=
-END CERTIFICATE-----',
ivate_key => '-----BEGIN EC PRIVATE KEY-----
AQEEIObtRo8tkUqoMjeHhsOh2ouPpXCgBcP+EDxZCB/tws15oAoGCCqGSM49
oUQDQgAEHGzpcRJ4XzfBJCCPMQeXQpTXwlblimODQCuQ4mzkzTv0dXyB750f
2HtkpBOZzzvUARTR10JQoSe2/5PIwQ==
-END EC PRIVATE KEY-----',
Reference 
pute_ssl_certificate { 'id-of-resource':
rtificate        => string,
eation_timestamp => time,
scription        => string,
                 => integer,
me               => string,
ivate_key        => string,
oject            => string,
edential         => reference to gauth_credential,
certificate

The certificate in PEM format. The certificate chain must be no greater than 5 certs long. The chain must include at least one intermediate cert.

description

An optional description of this resource.

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 private key in PEM format.

Output-only properties gcompute_subnetwork

A VPC network is a virtual version of the traditional physical networks that exist within and between physical data centers. A VPC network provides connectivity for your Compute Engine virtual machine (VM) instances, Container Engine containers, App Engine Flex services, and other network-related resources.

Each GCP project contains one or more VPC networks. Each VPC network is a global entity spanning all GCP regions. This global VPC network allows VM instances and other resources to communicate with each other via internal, private IP addresses.

Each VPC network is subdivided into subnets, and each subnet is contained within a single region. You can have more than one subnet in a region for a given VPC network. Each subnet has a contiguous private RFC1918 IP space. You create instances, containers, and the like in these subnets. When you create an instance, you must create it in a subnet, and the instance draws its internal IP address from that subnet.

Virtual machine (VM) instances in a VPC network can communicate with instances in all other subnets of the same VPC network, regardless of region, using their RFC1918 private IP addresses. You can isolate portions of the network, even entire subnets, using firewall rules.

Example 
bnetwork requires a network and a region, so define them in your manifest:
- gcompute_network { 'my-network': ensure => present, ... }
- gcompute_region { 'some-region': ... }
pute_subnetwork { 'servers':
sure        => present,
_cidr_range => '172.16.0.0/16',
twork       => 'mynetwork-subnetwork',
gion        => 'some-region',
oject       => 'google.com:graphite-playground',
edential    => 'mycred',
Reference 
pute_subnetwork { 'id-of-resource':
eation_timestamp       => time,
scription              => string,
teway_address          => string,
                       => integer,
_cidr_range            => string,
me                     => string,
twork                  => reference to gcompute_network,
ivate_ip_google_access => boolean,
gion                   => reference to gcompute_region,
oject                  => string,
edential               => reference to gauth_credential,
description

An optional description of this resource. Provide this property when you create the resource. This field can be set only at resource creation time.

gateway_address

The gateway address for default routes to reach destination addresses outside this subnetwork. This field can be set only at resource creation time.

ip_cidr_range

The range of internal addresses that are owned by this subnetwork. Provide this property when you create the subnetwork. For example, 10.0.0.0/8 or 192.168.0.0/16. Ranges must be unique and non-overlapping within a network. Only IPv4 is supported.

name

The name of the resource, provided by the client when initially creating the resource. 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

The network this subnet belongs to. Only networks that are in the distributed mode can have subnetworks.

private_ip_google_access

Whether the VMs in this subnet can access Google services without assigned external IP addresses.

region

Required. URL of the region where the regional address resides. This field is not applicable to global addresses.

Output-only properties gcompute_target_http_proxy

Represents a TargetHttpProxy resource, which is used by one or more global forwarding rule to route incoming HTTP requests to a URL map.

Example 
pute_target_http_proxy { 'my-http-proxy':
sure     => present,
l_map    => 'my-url-map',
oject    => 'google.com:graphite-playground',
edential => 'mycred',
Reference 
pute_target_http_proxy { 'id-of-resource':
eation_timestamp => time,
scription        => string,
                 => integer,
me               => string,
l_map            => reference to gcompute_url_map,
oject            => string,
edential         => reference to gauth_credential,
description

An optional description of this resource.

name

Required. 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

Required. A reference to the UrlMap resource that defines the mapping from URL to the BackendService.

Output-only properties gcompute_target_https_proxy

Represents a TargetHttpsProxy resource, which is used by one or more global forwarding rule to route incoming HTTPS requests to a URL map.

Example 
pute_target_https_proxy { 'my-https-proxy':
sure           => present,
l_certificates => [
'sample-certificate',

l_map          => 'my-url-map',
oject          => 'google.com:graphite-playground',
edential       => 'mycred',
Reference 
pute_target_https_proxy { 'id-of-resource':
eation_timestamp => time,
scription        => string,
                 => integer,
me               => string,
l_certificates   => [
reference to a gcompute_ssl_certificate,
...

l_map            => reference to gcompute_url_map,
oject            => string,
edential         => reference to gauth_credential,
description

An optional description of this resource.

name

Required. 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.

ssl_certificates

Required. A list of SslCertificate resources that are used to authenticate connections between users and the load balancer. Currently, exactly one SSL certificate must be specified.

url_map

Required. A reference to the UrlMap resource that defines the mapping from URL to the BackendService.

Output-only properties gcompute_target_pool

Represents a TargetPool resource, used for Load Balancing.

Example 
pute_region { 'some-region':
me       => 'us-west1',
oject    => 'google.com:graphite-playground',
edential => 'mycred',


pute_target_pool { 'test1':
sure     => present,
gion     => 'some-region',
oject    => 'google.com:graphite-playground',
edential => 'mycred',
Reference 
pute_target_pool { 'id-of-resource':
ckup_pool        => reference to gcompute_target_pool,
eation_timestamp => time,
scription        => string,
ilover_ratio     => double,
alth_check       => reference to gcompute_http_health_check,
                 => integer,
stances          => [
reference to a gcompute_instance,
...

me               => string,
gion             => reference to gcompute_region,
ssion_affinity   => 'NONE', 'CLIENT_IP' or 'CLIENT_IP_PROTO',
oject            => string,
edential         => reference to gauth_credential,
backup_pool

This field is applicable only when the containing target pool is serving a forwarding rule as the primary pool, and its failoverRatio field is properly set to a value between [0, 1]. backupPool and failoverRatio together define the fallback behavior of the primary target pool: if the ratio of the healthy instances in the primary pool is at or below failoverRatio, traffic arriving at the load-balanced IP will be directed to the backup pool. In case where failoverRatio and backupPool are not set, or all the instances in the backup pool are unhealthy, the traffic will be directed back to the primary pool in the “force” mode, where traffic will be spread to the healthy instances with the best effort, or to all instances when no instance is healthy.

description

An optional description of this resource.

failover_ratio

This field is applicable only when the containing target pool is serving a forwarding rule as the primary pool (i.e., not as a backup pool to some other target pool). The value of the field must be in [0, 1]. If set, backupPool must also be set. They together define the fallback behavior of the primary target pool: if the ratio of the healthy instances in the primary pool is at or below this number, traffic arriving at the load-balanced IP will be directed to the backup pool. In case where failoverRatio is not set or all the instances in the backup pool are unhealthy, the traffic will be directed back to the primary pool in the “force” mode, where traffic will be spread to the healthy instances with the best effort, or to all instances when no instance is healthy.

health_check

A reference to a HttpHealthCheck resource. A member instance in this pool is considered healthy if and only if the health checks pass. If not specified it means all member instances will be considered healthy at all times.

instances

A list of virtual machine instances serving this pool. They must live in zones contained in the same region as this pool.

name

Required. 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.

session_affinity

Session affinity option. Must be one of these values:

region

Required. The region where the target pool resides.

Output-only properties gcompute_target_ssl_proxy

Represents a TargetSslProxy resource, which is used by one or more global forwarding rule to route incoming SSL requests to a backend service.

Example 
pute_target_ssl_proxy { 'my-ssl-proxy':
sure           => present,
oxy_header     => 'PROXY_V1',
rvice          => 'my-ssl-backend',
l_certificates => [
'sample-certificate',

oject          => 'google.com:graphite-playground',
edential       => 'mycred',
Reference 
pute_target_ssl_proxy { 'id-of-resource':
eation_timestamp => time,
scription        => string,
                 => integer,
me               => string,
oxy_header       => 'NONE' or 'PROXY_V1',
rvice            => reference to gcompute_backend_service,
l_certificates   => [
reference to a gcompute_ssl_certificate,
...

oject            => string,
edential         => reference to gauth_credential,
description

An optional description of this resource.

name

Required. 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.

proxy_header

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

service

Required. A reference to the BackendService resource.

ssl_certificates

Required. A list of SslCertificate resources that are used to authenticate connections between users and the load balancer. Currently, exactly one SSL certificate must be specified.

Output-only properties gcompute_target_tcp_proxy

Represents a TargetTcpProxy resource, which is used by one or more global forwarding rule to route incoming TCP requests to a Backend service.

Example 
pute_target_tcp_proxy { 'my-tcp-proxy':
sure       => present,
oxy_header => 'PROXY_V1',
rvice      => 'my-tcp-backend',
oject      => 'google.com:graphite-playground',
edential   => 'mycred',
Reference 
pute_target_tcp_proxy { 'id-of-resource':
eation_timestamp => time,
scription        => string,
                 => integer,
me               => string,
oxy_header       => 'NONE' or 'PROXY_V1',
rvice            => reference to gcompute_backend_service,
oject            => string,
edential         => reference to gauth_credential,
description

An optional description of this resource.

name

Required. 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.

proxy_header

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

service

Required. A reference to the BackendService resource.

Output-only properties gcompute_url_map

UrlMaps are used to route requests to a backend service based on rules that you define for the host and path of an incoming URL.

Example 
pute_url_map { 'my-url-map':
sure          => present,
fault_service => 'my-app-backend',
oject         => 'google.com:graphite-playground',
edential      => 'mycred',
Reference 
pute_url_map { 'id-of-resource':
eation_timestamp => time,
fault_service    => reference to gcompute_backend_service,
scription        => string,
st_rules         => [
{
  description  => string,
  hosts        => [
    string,
    ...
  ],
  path_matcher => string,
},
...

                 => integer,
me               => string,
th_matchers      => [
{
  default_service => reference to gcompute_backend_service,
  description     => string,
  name            => string,
  path_rules      => [
    {
      paths   => [
        string,
        ...
      ],
      service => reference to gcompute_backend_service,
    },
    ...
  ],
},
...

sts              => [
{
  description => string,
  host        => string,
  path        => string,
  service     => reference to gcompute_backend_service,
},
...

oject            => string,
edential         => reference to gauth_credential,
default_service

Required. A reference to BackendService resource if none of the hostRules match.

description

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

host_rules

The list of HostRules to use against the URL.

host_rules[]/description

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

host_rules[]/hosts

The list of host patterns to match. They must be valid hostnames, except * will match any string of ([a-z0-9-.]*). In that case, * must be the first character and must be followed in the pattern by either - or ..

host_rules[]/path_matcher

The name of the PathMatcher to use to match the path portion of the URL if the hostRule matches the URL's host portion.

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.

path_matchers

The list of named PathMatchers to use against the URL.

path_matchers[]/default_service

A reference to a BackendService resource. This will be used if none of the pathRules defined by this PathMatcher is matched by the URL's path portion.

path_matchers[]/description

An optional description of this resource.

path_matchers[]/name

The name to which this PathMatcher is referred by the HostRule.

path_matchers[]/path_rules

The list of path rules.

path_matchers[]/path_rules[]/paths

The list of path patterns to match. Each must start with / and the only place a * is allowed is at the end following a /. The string fed to the path matcher does not include any text after the first ? or #, and those chars are not allowed here.

path_matchers[]/path_rules[]/service

A reference to the BackendService resource if this rule is matched.

tests

The list of expected URL mappings. Request to update this UrlMap will succeed only if all of the test cases pass.

tests[]/description

Description of this test case.

tests[]/host

Host portion of the URL.

tests[]/path

Path portion of the URL.

tests[]/service

A reference to expected BackendService resource the given URL should be mapped to.

Output-only properties gcompute_zone

Represents a Zone resource.

Example 
pute_zone { 'us-central1-a':
oject    => 'google.com:graphite-playground',
edential => 'mycred',
Reference 
pute_zone { 'id-of-resource':
eation_timestamp => time,
precated         => {
deleted     => time,
deprecated  => time,
obsolete    => time,
replacement => string,
state       => 'DEPRECATED', 'OBSOLETE' or 'DELETED',

scription        => string,
                 => integer,
me               => string,
gion             => reference to gcompute_region,
atus             => 'UP' or 'DOWN',
oject            => string,
edential         => reference to gauth_credential,
name

Name of the resource.

Output-only properties deprecated/deleted

Output only. An optional RFC3339 timestamp on or after which the state of this resource is intended to change to DELETED. This is only informational and the status will not change unless the client explicitly changes it.

deprecated/deprecated

Output only. An optional RFC3339 timestamp on or after which the state of this resource is intended to change to DEPRECATED. This is only informational and the status will not change unless the client explicitly changes it.

deprecated/obsolete

Output only. An optional RFC3339 timestamp on or after which the state of this resource is intended to change to OBSOLETE. This is only informational and the status will not change unless the client explicitly changes it.

deprecated/replacement

Output only. The URL of the suggested replacement for a deprecated resource. The suggested replacement resource must be the same kind of resource as the deprecated resource.

deprecated/state

Output only. The deprecation state of this resource. This can be DEPRECATED, OBSOLETE, or DELETED. Operations which create a new resource using a DEPRECATED resource will return successfully, but with a warning indicating the deprecated resource and recommending its replacement. Operations which use OBSOLETE or DELETED resources will be rejected and result in an error.

Functions
gcompute_address_ip

Returns the IP address associated with the Address managed by a gcompute_address resource.

Arguments Examples 
pute_address_ip('my-server', 'us-central1', 'myproject', $fn_auth)
Notes

The credential parameter should be allocated with a gauth_credential_*_for_function call.

gcompute_address_ref

Builds a reference to the IP address associated with the Address managed by a gcompute_address resource.

Arguments Examples 
pute_address_ref('my-server', 'us-central1', 'myproject')
Notes

This function is useful for when a reference to a resource that have multiple facts, such as gcompute_forwarding_rule { ip_address }

gcompute_global_address_ref

Builds a reference to the global IP address associated with the Address managed by a gcompute_global_address resource.

Arguments Examples 
pute_global_address_ref('my-server', 'myproject')
Notes

This function is useful for when a reference to a resource that have multiple facts, such as gcompute_global_forwarding_rule { ip_address }

gcompute_health_check_ref

Builds a reference to a health check to be used in the backend service.

Arguments Examples 
pute_health_check_ref('my-hc', 'my-project')
gcompute_image_family

Builds the family resource identifier required to uniquely identify the family, e.g. to create virtual machines based on it. You can use this function as source_image of a gcompute_instance resource.

Arguments Examples 
pute_image_family('ubuntu-1604-lts', 'ubuntu-os-cloud')

uppet
pute_image_family('my-web-server', 'my-project')
Notes

Note: In the case of private images, your credentials will need to have the proper permissions to access the image. To get a list of supported families you can use the gcloud utility: gcloud compute images list

gcompute_target_http_proxy_ref

Builds a reference to a target HTTP proxy to be used in the global forwarding rule.

Arguments Examples 
pute_target_http_proxy_ref('my-http-proxy', 'my-project')
Bolt Tasks
tasks/reset.rb

Resets a Google Compute Engine VM instance

This task takes inputs as JSON from standard input.

Arguments tasks/instance.sh

Because sometimes you just want a quick way to get (or destroy) an instance

This task takes inputs as JSON from standard input.

Arguments tasks/snapshot.rb

Create a snapshot of a Google Compute Engine Disk

This task takes inputs as JSON from standard input.

Arguments
Limitations

This module has been tested on:

Testing on other platforms has been minimal and cannot be guaranteed.

Development
Automatically Generated Files

Some files in this package are automatically generated by Magic Modules.

We use a code compiler to produce this module in order to avoid repetitive tasks and improve code quality. This means all Google Cloud Platform Puppet modules use the same underlying authentication, logic, test generation, style checks, etc.

Learn more about the way to change autogenerated files by reading the CONTRIBUTING.md file.

Contributing

Contributions to this library are always welcome and highly encouraged.

See CONTRIBUTING.md for more information on how to get started.

Running tests

This project contains tests for rspec, rspec-puppet and rubocop to verify functionality. For detailed information on using these tools, please see their respective documentation.

Testing quickstart: Ruby > 2.0.0 
install bundler
le install
le exec rspec
le exec rubocop
Debugging Tests

In case you need to debug tests in this module you can set the following variables to increase verbose output:

Variable | Side Effect ————————|————————————————— PUPPET_HTTP_VERBOSE=1 | Prints network access information by Puppet provier. PUPPET_HTTP_DEBUG=1 | Prints the payload of network calls being made. GOOGLE_HTTP_VERBOSE=1 | Prints debug related to the network calls being made. GOOGLE_HTTP_DEBUG=1 | Prints the payload of network calls being made.

During test runs (using rspec) you can also set:

Variable | Side Effect ————————|————————————————— RSPEC_DEBUG=1 | Prints debug related to the tests being run. RSPEC_HTTP_VERBOSE=1 | Prints network expectations and access.

This work is supported by the National Institutes of Health's National Center for Advancing Translational Sciences, Grant Number U24TR002306. This work is solely the responsibility of the creators and does not necessarily represent the official views of the National Institutes of Health.