chef-provisioning-google 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 36a2ac40200d32525a140205f1ad645a35ed8d9f
+  data.tar.gz: d213a110806b078c666686fed4c5542559896621
+SHA512:
+  metadata.gz: 0ba304b4e702161c4369c0b3c3727ce8c81f55996a07b0565e01900687e71265b8b9adb9d94a6f16fc315c10adb0e7e05db5ecf28bb4d80823bb87926f9c89d8
+  data.tar.gz: d04a63679afe6cb8ed8ac76249e265cca03e98335fbe6f0591c158c90204cbdd1b694af4c2dcb1eca7b7aa819f7eb01d23658c030fd91b8dcfd9f367ba1c692b

data/LICENSE

@@ -0,0 +1,201 @@
+                              Apache License
+                        Version 2.0, January 2004
+                     http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1. Definitions.
+
+   "License" shall mean the terms and conditions for use, reproduction,
+   and distribution as defined by Sections 1 through 9 of this document.
+
+   "Licensor" shall mean the copyright owner or entity authorized by
+   the copyright owner that is granting the License.
+
+   "Legal Entity" shall mean the union of the acting entity and all
+   other entities that control, are controlled by, or are under common
+   control with that entity. For the purposes of this definition,
+   "control" means (i) the power, direct or indirect, to cause the
+   direction or management of such entity, whether by contract or
+   otherwise, or (ii) ownership of fifty percent (50%) or more of the
+   outstanding shares, or (iii) beneficial ownership of such entity.
+
+   "You" (or "Your") shall mean an individual or Legal Entity
+   exercising permissions granted by this License.
+
+   "Source" form shall mean the preferred form for making modifications,
+   including but not limited to software source code, documentation
+   source, and configuration files.
+
+   "Object" form shall mean any form resulting from mechanical
+   transformation or translation of a Source form, including but
+   not limited to compiled object code, generated documentation,
+   and conversions to other media types.
+
+   "Work" shall mean the work of authorship, whether in Source or
+   Object form, made available under the License, as indicated by a
+   copyright notice that is included in or attached to the work
+   (an example is provided in the Appendix below).
+
+   "Derivative Works" shall mean any work, whether in Source or Object
+   form, that is based on (or derived from) the Work and for which the
+   editorial revisions, annotations, elaborations, or other modifications
+   represent, as a whole, an original work of authorship. For the purposes
+   of this License, Derivative Works shall not include works that remain
+   separable from, or merely link (or bind by name) to the interfaces of,
+   the Work and Derivative Works thereof.
+
+   "Contribution" shall mean any work of authorship, including
+   the original version of the Work and any modifications or additions
+   to that Work or Derivative Works thereof, that is intentionally
+   submitted to Licensor for inclusion in the Work by the copyright owner
+   or by an individual or Legal Entity authorized to submit on behalf of
+   the copyright owner. For the purposes of this definition, "submitted"
+   means any form of electronic, verbal, or written communication sent
+   to the Licensor or its representatives, including but not limited to
+   communication on electronic mailing lists, source code control systems,
+   and issue tracking systems that are managed by, or on behalf of, the
+   Licensor for the purpose of discussing and improving the Work, but
+   excluding communication that is conspicuously marked or otherwise
+   designated in writing by the copyright owner as "Not a Contribution."
+
+   "Contributor" shall mean Licensor and any individual or Legal Entity
+   on behalf of whom a Contribution has been received by Licensor and
+   subsequently incorporated within the Work.
+
+2. Grant of Copyright License. Subject to the terms and conditions of
+   this License, each Contributor hereby grants to You a perpetual,
+   worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+   copyright license to reproduce, prepare Derivative Works of,
+   publicly display, publicly perform, sublicense, and distribute the
+   Work and such Derivative Works in Source or Object form.
+
+3. Grant of Patent License. Subject to the terms and conditions of
+   this License, each Contributor hereby grants to You a perpetual,
+   worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+   (except as stated in this section) patent license to make, have made,
+   use, offer to sell, sell, import, and otherwise transfer the Work,
+   where such license applies only to those patent claims licensable
+   by such Contributor that are necessarily infringed by their
+   Contribution(s) alone or by combination of their Contribution(s)
+   with the Work to which such Contribution(s) was submitted. If You
+   institute patent litigation against any entity (including a
+   cross-claim or counterclaim in a lawsuit) alleging that the Work
+   or a Contribution incorporated within the Work constitutes direct
+   or contributory patent infringement, then any patent licenses
+   granted to You under this License for that Work shall terminate
+   as of the date such litigation is filed.
+
+4. Redistribution. You may reproduce and distribute copies of the
+   Work or Derivative Works thereof in any medium, with or without
+   modifications, and in Source or Object form, provided that You
+   meet the following conditions:
+
+   (a) You must give any other recipients of the Work or
+       Derivative Works a copy of this License; and
+
+   (b) You must cause any modified files to carry prominent notices
+       stating that You changed the files; and
+
+   (c) You must retain, in the Source form of any Derivative Works
+       that You distribute, all copyright, patent, trademark, and
+       attribution notices from the Source form of the Work,
+       excluding those notices that do not pertain to any part of
+       the Derivative Works; and
+
+   (d) If the Work includes a "NOTICE" text file as part of its
+       distribution, then any Derivative Works that You distribute must
+       include a readable copy of the attribution notices contained
+       within such NOTICE file, excluding those notices that do not
+       pertain to any part of the Derivative Works, in at least one
+       of the following places: within a NOTICE text file distributed
+       as part of the Derivative Works; within the Source form or
+       documentation, if provided along with the Derivative Works; or,
+       within a display generated by the Derivative Works, if and
+       wherever such third-party notices normally appear. The contents
+       of the NOTICE file are for informational purposes only and
+       do not modify the License. You may add Your own attribution
+       notices within Derivative Works that You distribute, alongside
+       or as an addendum to the NOTICE text from the Work, provided
+       that such additional attribution notices cannot be construed
+       as modifying the License.
+
+   You may add Your own copyright statement to Your modifications and
+   may provide additional or different license terms and conditions
+   for use, reproduction, or distribution of Your modifications, or
+   for any such Derivative Works as a whole, provided Your use,
+   reproduction, and distribution of the Work otherwise complies with
+   the conditions stated in this License.
+
+5. Submission of Contributions. Unless You explicitly state otherwise,
+   any Contribution intentionally submitted for inclusion in the Work
+   by You to the Licensor shall be under the terms and conditions of
+   this License, without any additional terms or conditions.
+   Notwithstanding the above, nothing herein shall supersede or modify
+   the terms of any separate license agreement you may have executed
+   with Licensor regarding such Contributions.
+
+6. Trademarks. This License does not grant permission to use the trade
+   names, trademarks, service marks, or product names of the Licensor,
+   except as required for reasonable and customary use in describing the
+   origin of the Work and reproducing the content of the NOTICE file.
+
+7. Disclaimer of Warranty. Unless required by applicable law or
+   agreed to in writing, Licensor provides the Work (and each
+   Contributor provides its Contributions) on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+   implied, including, without limitation, any warranties or conditions
+   of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+   PARTICULAR PURPOSE. You are solely responsible for determining the
+   appropriateness of using or redistributing the Work and assume any
+   risks associated with Your exercise of permissions under this License.
+
+8. Limitation of Liability. In no event and under no legal theory,
+   whether in tort (including negligence), contract, or otherwise,
+   unless required by applicable law (such as deliberate and grossly
+   negligent acts) or agreed to in writing, shall any Contributor be
+   liable to You for damages, including any direct, indirect, special,
+   incidental, or consequential damages of any character arising as a
+   result of this License or out of the use or inability to use the
+   Work (including but not limited to damages for loss of goodwill,
+   work stoppage, computer failure or malfunction, or any and all
+   other commercial damages or losses), even if such Contributor
+   has been advised of the possibility of such damages.
+
+9. Accepting Warranty or Additional Liability. While redistributing
+   the Work or Derivative Works thereof, You may choose to offer,
+   and charge a fee for, acceptance of support, warranty, indemnity,
+   or other liability obligations and/or rights consistent with this
+   License. However, in accepting such obligations, You may act only
+   on Your own behalf and on Your sole responsibility, not on behalf
+   of any other Contributor, and only if You agree to indemnify,
+   defend, and hold each Contributor harmless for any liability
+   incurred by, or claims asserted against, such Contributor by reason
+   of your accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS
+
+APPENDIX: How to apply the Apache License to your work.
+
+   To apply the Apache License to your work, attach the following
+   boilerplate notice, with the fields enclosed by brackets "[]"
+   replaced with your own identifying information. (Don't include
+   the brackets!)  The text should be enclosed in the appropriate
+   comment syntax for the file format. We also recommend that a
+   file or class name and description of purpose be included on the
+   same "printed page" as the copyright notice for easier
+   identification within third-party archives.
+
+Copyright [yyyy] [name of copyright owner]
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

data/README.md

@@ -0,0 +1,121 @@
+# chef-provisioning-google
+
+[![Build Status](https://travis-ci.org/chef/chef-provisioning-google.svg?branch=master)](https://travis-ci.org/chef/chef-provisioning-google)
+
+## Development Process
+
+The [GoogleDriver](https://github.com/someara/chef-provisioning-google/blob/master/lib/chef/provisioning/google_driver/driver.rb) class needs to implement required methods from [its parent](https://github.com/chef/chef-provisioning/blob/master/lib/chef/provisioning/driver.rb) to successfully create [base resources](https://github.com/chef/chef-provisioning/tree/master/lib/chef/resource) like `machine` and `load_balancer`.
+
+I added all the driver methods to support creating and destroying a machine. The action `:converge_only` currently does not work because the machine spec does not store credential information. But this should be fixed as part of the credentials update TODO.
+
+## Prerequisites
+
+Before you start writing a recipe, you need to log into the [google developers console](https://console.developers.google.com/) and create a project. This project must be enabled for billing. Once billing is enabled you should be able to create VM instances through the console.
+
+Then you need to set up credentials to use for connecting. We use the Google OAuth 2.0 credentials. Because we cannot present a pop-up to cookbook writers to authorize access, we need a service account key and a service user to act on our behalf and request instances.
+
+Service account key workflow:
+
+- Access `API Manager` -> `Credentials` from the navigation gutter.
+- Click the `New Credentials` button and select `Service Account key`.
+- Select the service account to create the key for or 'New service account' if you haven't created one yet.
+- Choose `JSON Key` in the Key type options. This will create your service user and will download the JSON key to your workstation.
+
+Provide the full path to the downloaded JSON file as `:json_key_path` anb the `Email Address` (can be found in "Pemissions" -> "Service accounts") as the `:google_client_email`.
+
+## Sample Recipe
+
+I am running the following recipe to test the code:
+
+```ruby
+require 'chef/provisioning/google_driver'
+
+with_driver 'google:us-central1-a:some-project',
+  :google_credentials => {
+    :json_key_path => 'REDACTED',
+    :google_client_email => 'REDACTED',
+  }
+
+google_key_pair "chef_default" do
+  private_key_path "google_default"
+  public_key_path "google_default.pub"
+end
+
+machine 'test' do
+  machine_options key_name: "google_default"
+  action [:converge, :destroy]
+end
+```
+
+Currently, you _must_ specify `key_name` as an option to `machine_options`.
+
+## Supplying `insert_options` for machine creation
+
+Google requires a minimum set of options to provision a machine during a `compute.instances.create` call. You can see the minimum set of options in the `instance_client.rb` file. It is a machine with Ubuntu 14.04 installed, 1 disc available and 1 network device configured.
+
+To customize your machine you provide override options as `:insert_options` to the `machine_options` attribute. The full list of options is available at <https://cloud.google.com/compute/docs/reference/latest/instances#resource> EG,
+
+```ruby
+machine 'test' do
+  machine_options insert_options: {
+    :machineType=> "zones/us-central1-a/machineTypes/n1-standard-1",
+    :tags => {
+      :items => [
+        "http-server",
+        "https-server"
+      ]
+    },
+    :disks => [
+      {
+        :deviceName => 'test',
+        :autoDelete=>true,
+        :boot=>true,
+        :initializeParams=>{
+          :sourceImage => "projects/ubuntu-os-cloud/global/images/ubuntu-1404-trusty-v20150316",
+          :diskType => "zones/us-central1-a/diskTypes/pd-ssd",
+          :diskSizeGb => 200
+        },
+        :type=>"PERSISTENT"
+      },
+      {
+        :type => "PERSISTENT",
+        :mode => "READ_WRITE",
+        :zone => "zones/us-central1-a",
+        :source => "zones/us-central1-a/disks/disk-1",
+        :deviceName => "disk-1"
+      }
+    ],
+    :serviceAccounts => [
+      {
+        :email => "default",
+        :scopes => [
+          "https://www.googleapis.com/auth/devstorage.read_only",
+          "https://www.googleapis.com/auth/bigquery",
+          "https://www.googleapis.com/auth/logging.write"
+        ]
+      }
+    ]
+  }, key_name: "google_default"
+  action [:converge, :destroy]
+end
+```
+
+Some remaining TODOs with this are to make it easier to specify options - users shouldn't be required to specify `zones/us-central1-a/machineTypes/f1-micro` for the machine type. It should just be `f1-micro.
+
+The user also shouldn't be required to specify all the required options for each `disc` if they are overwriting the default. If the user wants to specify `:autoDelete => false` they shouldn't also have to specify name, boot, initializeParams, etc. The logic that merges user provided values with default values should be smarter.
+
+## TODO items
+
+- Update the Credentials to read from the file system or environmental variables - it is a big no-no to put credentials in the cookbook.
+- DRY up the client request/response logic.
+- Lots of polish
+- Support for machine_image, machine_batch, machine_execute and load_balancer resources
+- Windows hosts
+
+# Resources
+
+## google_key_pair
+
+This creates a local private/public keypair and uploads it to Google as a project-wide key. This is used to SSH into the instance.
+
+TODO: Add support for instance-specific keys.

data/Rakefile

@@ -0,0 +1,22 @@
+require "bundler"
+require "bundler/gem_tasks"
+
+task default: [:spec, :style]
+
+begin
+  require "chefstyle"
+  require "rubocop/rake_task"
+
+  desc "Run Ruby style checks"
+  RuboCop::RakeTask.new(:style)
+rescue LoadError => e
+  puts ">>> Gem load error: #{e}, omitting #{task.name}" unless ENV["CI"]
+end
+
+begin
+  desc "Run rspec"
+  require "rspec/core/rake_task"
+  RSpec::Core::RakeTask.new(:spec)
+rescue LoadError => e
+  puts ">>> Gem load error: #{e}, omitting #{task.name}" unless ENV["CI"]
+end

data/lib/chef/provider/google_key_pair.rb

@@ -0,0 +1,172 @@
+require "chef/provider/lwrp_base"
+require "cheffish/key_formatter"
+require "chef/resource/google_key_pair"
+require "retryable"
+
+class Chef::Provider::GoogleKeyPair < Chef::Provider::LWRPBase
+  use_inline_resources
+
+  # TODO make sure we can take relative paths - where do we get base path from then?
+  action :create do
+    if !current_resource_exists? || allow_overwrite
+      converge_local_keys(:create)
+    end
+
+    #Check if keys exist
+    unless allow_overwrite
+      if current_resource.private_key_path && current_resource.private_key_path != new_private_key_path ||
+          current_resource.public_key_path && current_resource.public_key_path != new_public_key_path ||
+          current_fingerprint && current_fingerprint != Cheffish::KeyFormatter.encode(desired_key, :format => :fingerprint)
+        raise "cannot update google_key_pair[#{new_resource.name}] because 'allow_overwrite' is false"
+      end
+    end
+
+    # We store the mapping from resource name to key in GCE
+    name_to_key = driver.project_client.get.ssh_mappings
+    if name_to_key.key?(new_resource.name)
+      remote_key = name_to_key[new_resource.name]
+      if remote_key != desired_key_openssh
+        if allow_overwrite
+          set_key_and_mapping
+        else
+          raise "the remote key is different than local but cannot be updated because 'allow_overwrite' is false"
+        end
+      end
+      # if local key same as server - we are done
+    else
+      # We need to upload the key for the first time
+      set_key_and_mapping
+    end
+
+  end
+
+  action :destroy do
+    metadata = driver.project_client.get
+    name_to_key = metadata.ssh_mappings
+    remote_key = name_to_key[new_resource.name]
+    if remote_key
+      operation_id = nil
+      username = remote_key.split(" ")[2].split("@")[0]
+      converge_by "deleting key for username #{username}" do
+        metadata.delete_ssh_key(remote_key)
+      end
+
+      converge_by "deleting metadata mapping for google_key_pair[#{new_resource.name}]" do
+        metadata.delete_ssh_mapping(new_resource.name)
+      end
+
+      reupload_metadata(metadata)
+    end
+    # TODO do we care about deleting the local key?
+  end
+
+  attr_reader :current_fingerprint
+
+  def load_current_resource
+    @current_resource = Chef::Resource::GoogleKeyPair.new(new_resource.name, run_context)
+
+    existing_key = driver.project_client.get.ssh_mappings[new_resource.name]
+    if existing_key
+      @current_fingerprint = Cheffish::KeyFormatter.encode(
+        Cheffish::KeyFormatter.decode(existing_key)[0],
+        :format => :fingerprint
+      )
+    else
+      current_resource.action :destroy
+    end
+
+    if new_private_key_path && ::File.exist?(new_private_key_path)
+      current_resource.private_key_path new_private_key_path
+    end
+    if new_public_key_path && ::File.exist?(new_public_key_path)
+      current_resource.public_key_path new_public_key_path
+    end
+  end
+
+  def current_resource_exists?
+    @current_resource.action != [ :destroy ]
+  end
+
+  # Converge the local keys
+  # private_key_path will always be populated but public_key_path can be
+  # parsed from the private key later if it isn't provided
+  def converge_local_keys(action)
+    resource = new_resource
+    Cheffish.inline_resource(self, action) do
+      directory run_context.config[:private_key_write_path]
+      private_key resource.private_key_path do
+        public_key_path resource.public_key_path if resource.public_key_path
+        if resource.private_key_options
+          resource.private_key_options.each_pair do |key, value|
+            send(key, value)
+          end
+        end
+      end
+    end
+  end
+
+  def allow_overwrite
+    new_resource.allow_overwrite
+  end
+
+  def new_private_key_path
+    new_resource.private_key_path
+  end
+
+  def new_public_key_path
+    new_resource.public_key_path
+  end
+
+  def desired_private_key
+    @desired_private_key ||= begin
+      private_key, format = Cheffish::KeyFormatter.decode(IO.read(new_private_key_path))
+      private_key
+    end
+  end
+
+  def desired_key
+    @desired_public_key ||= begin
+      if new_public_key_path
+        public_key, format = Cheffish::KeyFormatter.decode(IO.read(new_public_key_path))
+        public_key
+      else
+        desired_private_key.public_key
+      end
+    end
+  end
+
+  def desired_key_openssh
+    Cheffish::KeyFormatter.encode(desired_key, :format => :openssh)
+  end
+
+  def set_key_and_mapping
+    username = desired_key_openssh.split(" ")[2].split("@")[0]
+    metadata = driver.project_client.get
+    converge_by "adding key for username #{username}" do
+      metadata.ensure_key(username, desired_key_openssh)
+    end
+
+    converge_by "ensuring we store metadata mapping for google_key_pair[#{new_resource.name}]" do
+      metadata.set_ssh_mapping(new_resource.name, desired_key_openssh)
+    end
+
+    reupload_metadata(metadata)
+  end
+
+  # TODO abstract into base class
+  def driver
+    new_resource.driver
+  end
+
+  # TODO abstract into base class
+  def action_handler
+    @action_handler ||= Chef::Provisioning::ChefProviderActionHandler.new(self)
+  end
+
+  def reupload_metadata(metadata)
+    converge_by "reuploading changed metadata" do
+      operation = driver.project_client.set_common_instance_metadata(metadata)
+      driver.global_operations_client.wait_for_done(action_handler, operation)
+    end
+  end
+end