Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add compute disk resource #96

Merged
merged 7 commits into from
Jan 15, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
84 changes: 84 additions & 0 deletions docs/resources/google_compute_disk.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,84 @@
---
title: About the Disk resource
platform: gcp
---


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

## Examples
```

most_recent_image = google_compute_image(project: 'debian', name: 'debian-8-jessie-v20170523')

describe google_compute_disk(project: 'chef-gcp-inspec', name: 'my_disk', zone: 'zone') do
it { should exist }
# Test that the image is the most recent image for the family
its('source_image') { should match most_recent_image.self_link }
its('type') { should match 'pd-standard' }
end

describe.one do
google_compute_disk(project: 'chef-gcp-inspec', name: 'my_disk', zone: 'zone').labels.each_pair do |key, value|
describe key do
it { should cmp "environment" }
end
end
end
```

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

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

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

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

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

* `last_attach_timestamp`: Last attach timestamp in RFC3339 text format.

* `last_detach_timestamp`: Last dettach timestamp in RFC3339 text format.

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

* `users`: Links to the users of the disk (attached instances) in form: project/zones/zone/instances/instance

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

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

* `zone`: A reference to the zone where the disk resides.

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

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

* `sha256`: The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.

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

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

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

* `sha256`: 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: * `https://www.googleapis.com/compute/v1/projects/project/global/snapshots/snapshot` * `projects/project/global/snapshots/snapshot` * `global/snapshots/snapshot`

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

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

* `sha256`: The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.

* `source_snapshot_id`: The unique ID of the snapshot used to create this disk. This value identifies the exact snapshot that was used to create this persistent disk. For example, if you created the persistent disk from a snapshot that was later deleted and recreated under the same name, the source snapshot ID would identify the exact version of the snapshot that was used.
47 changes: 47 additions & 0 deletions docs/resources/google_compute_disks.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
---
title: About the Disk resource
platform: gcp
---


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

## Examples
```
most_recent_image = google_compute_image(project: 'debian', name: 'debian-8-jessie-v20170523')
describe google_compute_disks(project: 'chef-gcp-inspec', zone: 'zone') do
it { should exist }
its('names') { should include 'my_disk' }
its('source_images') { should include most_recent_image.self_link }
end
```

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

See [google_compute_disk.md](google_compute_disk.md) for more detailed information
* `label_fingerprints`: an array of `google_compute_disk` label_fingerprint
* `creation_timestamps`: an array of `google_compute_disk` creation_timestamp
* `descriptions`: an array of `google_compute_disk` description
* `ids`: an array of `google_compute_disk` id
* `last_attach_timestamps`: an array of `google_compute_disk` last_attach_timestamp
* `last_detach_timestamps`: an array of `google_compute_disk` last_detach_timestamp
* `labels`: an array of `google_compute_disk` labels
* `licenses`: an array of `google_compute_disk` licenses
* `names`: an array of `google_compute_disk` name
* `size_gbs`: an array of `google_compute_disk` size_gb
* `users`: an array of `google_compute_disk` users
* `types`: an array of `google_compute_disk` type
* `source_images`: an array of `google_compute_disk` source_image
* `zones`: an array of `google_compute_disk` zone
* `source_image_encryption_keys`: an array of `google_compute_disk` source_image_encryption_key
* `source_image_ids`: an array of `google_compute_disk` source_image_id
* `disk_encryption_keys`: an array of `google_compute_disk` disk_encryption_key
* `source_snapshots`: an array of `google_compute_disk` source_snapshot
* `source_snapshot_encryption_keys`: an array of `google_compute_disk` source_snapshot_encryption_key
* `source_snapshot_ids`: an array of `google_compute_disk` source_snapshot_id

## Filter Criteria
This resource supports all of the above properties as filter criteria, which can be used
with `where` as a block or a method.
8 changes: 4 additions & 4 deletions docs/resources/google_compute_ssl_policies.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,16 +9,16 @@ A `google_compute_ssl_policies` is used to test a Google SslPolicy resource

## Examples
```
describe google_compute_ssl_policies({project: ''}) do
describe google_compute_ssl_policies(project: 'chef-gcp-inspec') do
it { should exist }
its('names') { should include 'inspec-gcp-ssl-policy' }
its('profiles') { should include 'CUSTOM' }
its('count') { should eq 1 }
end

google_compute_ssl_policies({project: ''}).names.each do |policy_name|
describe google_compute_ssl_policy({project: '', name: policy_name}) do
its('min_tls_version') { should cmp 'TLS_1_2' }
google_compute_ssl_policies(project: 'chef-gcp-inspec').names.each do |policy_name|
describe google_compute_ssl_policy(project: 'chef-gcp-inspec', name: policy_name) do
its('min_tls_version') { should eq 'TLS_1_2' }
end
end
```
Expand Down
6 changes: 3 additions & 3 deletions docs/resources/google_compute_ssl_policy.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,10 +9,10 @@ A `google_compute_ssl_policy` is used to test a Google SslPolicy resource

## Examples
```
describe google_compute_ssl_policy({project: '', name: 'inspec-gcp-ssl-policy'}) do
describe google_compute_ssl_policy(project: 'chef-gcp-inspec', name: 'inspec-gcp-ssl-policy') do
it { should exist }
its('min_tls_version') { should cmp 'TLS_1_2' }
its('profile') { should cmp 'CUSTOM' }
its('min_tls_version') { should eq 'TLS_1_2' }
its('profile') { should eq 'CUSTOM' }
its('custom_features') { should include 'TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384' }
its('custom_features') { should include 'TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384' }
end
Expand Down
32 changes: 32 additions & 0 deletions libraries/google/compute/property/disk_disk_encryption_key.rb
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
# frozen_string_literal: false

# ----------------------------------------------------------------------------
#
# *** AUTO GENERATED CODE *** AUTO GENERATED CODE ***
#
# ----------------------------------------------------------------------------
#
# This file is automatically generated by Magic Modules and manual
# changes will be clobbered when the file is regenerated.
#
# Please read more about how to change this file in README.md and
# CONTRIBUTING.md located at the root of this package.
#
# ----------------------------------------------------------------------------
module GoogleInSpec
module Compute
module Property
class DiskDiskencryptionkey
attr_reader :raw_key

attr_reader :sha256

def initialize(args = nil)
return if args.nil?
@raw_key = args['rawKey']
@sha256 = args['sha256']
end
end
end
end
end
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
# frozen_string_literal: false

# ----------------------------------------------------------------------------
#
# *** AUTO GENERATED CODE *** AUTO GENERATED CODE ***
#
# ----------------------------------------------------------------------------
#
# This file is automatically generated by Magic Modules and manual
# changes will be clobbered when the file is regenerated.
#
# Please read more about how to change this file in README.md and
# CONTRIBUTING.md located at the root of this package.
#
# ----------------------------------------------------------------------------
module GoogleInSpec
module Compute
module Property
class DiskSourceimageencryptionkey
attr_reader :raw_key

attr_reader :sha256

def initialize(args = nil)
return if args.nil?
@raw_key = args['rawKey']
@sha256 = args['sha256']
end
end
end
end
end
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
# frozen_string_literal: false

# ----------------------------------------------------------------------------
#
# *** AUTO GENERATED CODE *** AUTO GENERATED CODE ***
#
# ----------------------------------------------------------------------------
#
# This file is automatically generated by Magic Modules and manual
# changes will be clobbered when the file is regenerated.
#
# Please read more about how to change this file in README.md and
# CONTRIBUTING.md located at the root of this package.
#
# ----------------------------------------------------------------------------
module GoogleInSpec
module Compute
module Property
class DiskSourcesnapshotencryptionkey
attr_reader :raw_key

attr_reader :sha256

def initialize(args = nil)
return if args.nil?
@raw_key = args['rawKey']
@sha256 = args['sha256']
end
end
end
end
end
92 changes: 92 additions & 0 deletions libraries/google_compute_disk.rb
Original file line number Diff line number Diff line change
@@ -0,0 +1,92 @@
# frozen_string_literal: false

# ----------------------------------------------------------------------------
#
# *** AUTO GENERATED CODE *** AUTO GENERATED CODE ***
#
# ----------------------------------------------------------------------------
#
# This file is automatically generated by Magic Modules and manual
# changes will be clobbered when the file is regenerated.
#
# Please read more about how to change this file in README.md and
# CONTRIBUTING.md located at the root of this package.
#
# ----------------------------------------------------------------------------
require 'gcp_backend'
require 'google/compute/property/disk_disk_encryption_key'
require 'google/compute/property/disk_source_image_encryption_key'
require 'google/compute/property/disk_source_snapshot_encryption_key'

# A provider to manage Google Compute Engine resources.
class Disk < GcpResourceBase
name 'google_compute_disk'
desc 'Disk'
supports platform: 'gcp'

attr_reader :label_fingerprint
attr_reader :creation_timestamp
attr_reader :description
attr_reader :id
attr_reader :last_attach_timestamp
attr_reader :last_detach_timestamp
attr_reader :labels
attr_reader :licenses
attr_reader :name
attr_reader :size_gb
attr_reader :users
attr_reader :type
attr_reader :source_image
attr_reader :zone
attr_reader :source_image_encryption_key
attr_reader :source_image_id
attr_reader :disk_encryption_key
attr_reader :source_snapshot
attr_reader :source_snapshot_encryption_key
attr_reader :source_snapshot_id
def base
'https://www.googleapis.com/compute/v1/'
end

def url
'projects/{{project}}/zones/{{zone}}/disks/{{name}}'
end

def initialize(params)
super(params.merge({ use_http_transport: true }))
@fetched = @connection.fetch(base, url, params)
parse unless @fetched.nil?
end

def parse
@label_fingerprint = @fetched['labelFingerprint']
@creation_timestamp = parse_time_string(@fetched['creationTimestamp'])
@description = @fetched['description']
@id = @fetched['id']
@last_attach_timestamp = parse_time_string(@fetched['lastAttachTimestamp'])
@last_detach_timestamp = parse_time_string(@fetched['lastDetachTimestamp'])
@labels = @fetched['labels']
@licenses = @fetched['licenses']
@name = @fetched['name']
@size_gb = @fetched['sizeGb']
@users = @fetched['users']
@type = @fetched['type']
@source_image = @fetched['sourceImage']
@zone = @fetched['zone']
@source_image_encryption_key = GoogleInSpec::Compute::Property::DiskSourceimageencryptionkey.new(@fetched['sourceImageEncryptionKey'])
@source_image_id = @fetched['sourceImageId']
@disk_encryption_key = GoogleInSpec::Compute::Property::DiskDiskencryptionkey.new(@fetched['diskEncryptionKey'])
@source_snapshot = @fetched['sourceSnapshot']
@source_snapshot_encryption_key = GoogleInSpec::Compute::Property::DiskSourcesnapshotencryptionkey.new(@fetched['sourceSnapshotEncryptionKey'])
@source_snapshot_id = @fetched['sourceSnapshotId']
end

# Handles parsing RFC3339 time string
def parse_time_string(time_string)
time_string ? Time.parse(time_string) : nil
end

def exists?
!@fetched.nil?
end
end
Loading