knife-google 1.1.0 → 1.2.0

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    NDBmNTIyNjhmNzNlYzBkNjQxMGEwYzQzOWMzM2E4MGE5MmYzZjU4YQ==
+  data.tar.gz: !binary |-
+    M2EzNGQ1NWE2NzJiYjUwMzgwMjliYWM2MjQ3Njg1YjY1ZGY1OWQ4NQ==
+SHA512:
+  metadata.gz: !binary |-
+    YmUyZmFlMGIyM2EwYzFkM2ZiODFmYTYzMjA5NDNjZDM5NTA2M2MxYWI0N2Rh
+    YmY5YmM4MjQzM2E1MDZlMzM0NDkzYTdmNzc5MTAyNGU4NjgyOWVjZWZhMzZm
+    NjliMTVmOTRhMTlkMmM0OGMzYjYxMzIxZTY5NTcxNzcxNjdjNmU=
+  data.tar.gz: !binary |-
+    NmYxODc2MjRkNDM2NGNlMmRlYTU3MzZlZTQ5YjY1ZmZhMGYwZTI5ZDhkNTRk
+    NzczODgwMTI4M2Q5ZGE4MWY3ZmZlOWY0YzcxZTdkYjhmZTA4ZWE0MmM0NDgy
+    ZDg0YzhlOThiMzBkMjlkODQyZDAyMjg4ZTZjYTNjMzIxYmIxZjU=

data/README.md

@@ -12,10 +12,20 @@ delete, and manage
 [Google Compute Engine](https://cloud.google.com/products/compute-engine)
 servers and disks.
 
+### Compatibility
+
+This plugin utilizes Google Compute Engine API v1. Please review API v1
+[release notes](https://developers.google.com/compute/docs/release-notes#december032013)
+for additional information.
+
+With knife-google 1.3.0 options have changed. Several GCE specific short
+options have been deprecated and GCE specific long options now start
+with '--gce-'.
+
 ### Nomenclature
 
 This plugin conforms to the nomenclature used by similar plugins and uses
-the term "server" when referencing nodes managed by the plugin.  But in
+the term "server" when referencing nodes managed by the plugin.  In
 Google Compute Engine parlance, this is equivalent to an "instance" or
 "virtual machine instance".
 
@@ -25,7 +35,7 @@ Before getting started with this plugin, you must first create a
 [Google Cloud Platform](https://cloud.google.com/) "project" and add the
 Google Compute Engine service to your project.  Once you have created your
 project, you will have access to other Google Cloud Platform services such as
-[App Egnine](https://developers.google.com/appengine/),
+[App Engine](https://developers.google.com/appengine/),
 [Cloud Storage](https://developers.google.com/storage/),
 [Cloud SQL](https://developers.google.com/cloud-sql/)
 and others, but this plugin only requires you enable Google Compute Engine in
@@ -65,10 +75,12 @@ or, for Gemfile:
     gem 'knife-google'
 ```
 
-There is a long standing issue in Ruby where the net/http library by default does not check the validity of an SSL certificate during a TLS handshake.
+There is a long standing issue in Ruby where the net/http library by default
+does not check the validity of an SSL certificate during a TLS handshake.
 
 To configure Windows system to validate SSL certificate please download
-[cacert.pem](http://curl.haxx.se/ca/cacert.pem) file and save to C: drive. Now make ruby aware of your certificate authority by setting SSL_CERT_FILE.
+[cacert.pem](http://curl.haxx.se/ca/cacert.pem) file and save to C: drive.
+Now make ruby aware of your certificate authority by setting SSL_CERT_FILE.
 
 To set this in your current command prompt session, type:
 
@@ -139,7 +151,10 @@ Some usage examples follow:
   $ knife google server list -Z us-central2-a
 
   # Create a server
-  $ knife google server create www1 -m n1-standard-1 -I debian-7-wheezy-v20130723 -Z us-central2-a -i ~/.ssh/id_rsa -x jdoe
+  $ knife google server create www1 -m n1-standard-1 -I debian-7-wheezy-v20131120 -Z us-central1-a -i ~/.ssh/id_rsa -x jdoe
+
+  # Create a server with service account scopes
+  $ knife google server create www1 -m n1-standard-1 -I debian-7-wheezy-v20131120 -Z us-central1-a -i ~/.ssh/id_rsa -x jdoe --gce-service-account-scopes https://www.googleapis.com/auth/userinfo.email,https://www.googleapis.com/auth/compute,https://www.googleapis.com/auth/devstorage.full_control
 
   # Delete a server (along with Chef node and API client via --purge)
   $ knife google server delete www1 --purge -Z us-central2-a
@@ -151,40 +166,44 @@ For a full list of commands, run `knife google` without additional arguments:
   $ knife google
 
   ** GOOGLE COMMANDS **
-  knife google disk list --google-compute-zone ZONE (options)
-  knife google zone list (options)
-  knife google server delete SERVER [SERVER] --google-compute-zone ZONE (options)
-  knife google server create NAME --google-compute-zone ZONE (options)
-  knife google disk create NAME --google-disk-size N --google-compute-zone ZONE (options)
+  knife google disk create NAME --gce-disk-size N -Z ZONE (options)
+  knife google disk delete NAME -Z ZONE (options)
+  knife google disk list -Z ZONE (options)
+  knife google project list (options)
+  knife google region list (options)
+  knife google server create NAME -m MACHINE_TYPE -I IMAGE -Z ZONE (options)
+  knife google server delete SERVER [SERVER] -Z ZONE (options)
+  knife google server list -Z ZONE (options)
   knife google setup
-  knife google server list --google-compute-zone ZONE (options)
-  knife google disk delete NAME --google-compute-zone ZONE
+  knife google zone list (options)
   ```
 
 More detailed help can be obtained by specifying sub-commands.  For
 instance,
 
   ```sh
-  $ knife google server list -Z foo --help
-  knife google server list --google-compute-zone ZONE (options)
-      -s, --server-url URL             Chef Server URL
-      -k, --key KEY                    API Client Key
-          --[no-]color                 Use colored output, defaults to enabled
-      -f CREDENTIAL_FILE,              Google Compute credential file (google setup can create this)
-          --google-compute-credential-file
-      -c, --config CONFIG              The configuration file to use
-          --defaults                   Accept default values for all questions
-      -d, --disable-editing            Do not open EDITOR, just accept the data as is
-      -e, --editor EDITOR              Set the editor to use for interactive commands
-      -E, --environment ENVIRONMENT    Set the Chef environment
-      -F, --format FORMAT              Which format to use for output
-      -u, --user USER                  API Client Username
-          --print-after                Show the data after a destructive operation
-      -V, --verbose                    More verbose output. Use twice for max verbosity
-      -v, --version                    Show chef version
-      -y, --yes                        Say yes to all prompts for confirmation
-      -Z, --google-compute-zone ZONE   The Zone for this server (required)
-      -h, --help                       Show this message
+  $ knife google server list -Z us-central1-a --help
+  knife google server list -Z ZONE (options)
+    -s, --server-url URL             Chef Server URL
+        --chef-zero-port PORT        Port to start chef-zero on
+    -k, --key KEY                    API Client Key
+        --[no-]color                 Use colored output, defaults to false on Windows, true otherwise
+    -f CREDENTIAL_FILE,              Google Compute credential file (google setup can create this)
+        --gce-credential-file
+    -c, --config CONFIG              The configuration file to use
+        --defaults                   Accept default values for all questions
+    -d, --disable-editing            Do not open EDITOR, just accept the data as is
+    -e, --editor EDITOR              Set the editor to use for interactive commands
+    -E, --environment ENVIRONMENT    Set the Chef environment
+    -F, --format FORMAT              Which format to use for output
+    -z, --local-mode                 Point knife commands at local repository instead of server
+    -u, --user USER                  API Client Username
+        --print-after                Show the data after a destructive operation
+    -V, --verbose                    More verbose output. Use twice for max verbosity
+    -v, --version                    Show chef version
+    -y, --yes                        Say yes to all prompts for confirmation
+    -Z, --gce-zone ZONE              The Zone for this server (required)
+    -h, --help                       Show this message
   ```
 
 ## Sub-commands
@@ -193,43 +212,102 @@ instance,
 
 Use this command to initially set up authorization (see above for more
 details).  Note that if you override the default credential file with the
-`-f` parameter, you'll need to use the `-f` switch for *all* sub-commands.
+`-f` switch, you'll need to use the `-f` switch for *all* sub-commands.
 When prompted, make sure to specify the "Project ID" (and not the name or
 number) or you will see 404/not found errors even if the setup command
 completes successfully.
 
 ### knife google zone list
 
+A zone is an isolated location within a region that is independent of
+other zones in the same region. Zones are designed to support instances
+or applications that have high availability requirements. Zones are
+designed to be fault-tolerant, so that you can distribute instances
+and resources across multiple zones to protect against the system
+failure of a single zone. This keeps your application available even
+in the face of expected and unexpected failures. The fully-qualified
+name is made up of `<region>/<zone>`. For example, the fully-qualified
+name for zone `a` in region `us-central1` is `us-central1-a`. Depending on
+how widely you want to distribute your resources, you may choose to
+create instances across multiple zones within one region or across
+multiple regions and multiple zones.
+
 Use this command to list out the available Google Compute Engine zones.
-You can find a zone's current status, number of deployed servers, disks,
-and upcoming maintenance windows.  The output should look similar to:
+You can find a zone's current status and upcoming maintenance windows.
+
+The output for `knife google zone list` should look similar to:
 
   ```
-  Name            Status  Servers  Disks  Maintainance Window                                   
-  europe-west1-a  up      0        0      2013-08-03 19:00:00 +0000 to 2013-08-18 19:00:00 +0000
-  europe-west1-b  up      0        0      2013-05-11 19:00:00 +0000 to 2013-05-26 19:00:00 +0000
-  us-central1-a   up      0        1      2013-08-17 19:00:00 +0000 to 2013-09-01 19:00:00 +0000
-  us-central1-b   up      0        0      2013-06-08 19:00:00 +0000 to 2013-06-23 19:00:00 +0000
-  us-central2-a   up      10       6      2013-05-25 19:00:00 +0000 to 2013-06-09 19:00:00 +0000
+  name            status  deprecation  maintainance window
+  europe-west1-a  up      -            2014-01-18 12:00:00 -0800 to 2014-02-02 12:00:00 -0800
+  europe-west1-b  up      -            2014-03-15 12:00:00 -0700 to 2014-03-30 12:00:00 -0700
+  us-central1-a   up      -            -
+  us-central1-b   up      -            -
+  us-central2-a   up      -            2013-12-31 12:00:00 -0800 to 2014-07-01 12:00:00 -0700
+  ```
+
+### knife google region list
+
+Each region in Google Compute Engine contains any number of zones.
+The region describes the geographic location where your resources
+are stored. For example, a zone named `us-east1-a` is in region `us-east1`.
+A region contains one or more zones.
+
+Choose a region that makes sense for your scenario. For example, if you
+only have customers on the east coast of the US, or if you have specific
+needs that require your data to live in the US, it makes sense to store
+your resources in a zone with a us-east region.
+
+Use this command to list out the available Google Compute Engine regions.
+You can find the region's current status, cpus, disks-total-gb,
+in-use-addresses and static-addresses. Use the `-L` switch to also list
+the quota limit for each resource.
+
+The output for `knife google region list -L` should look similar to:
+
+  ```
+  Name          status  deprecation  cpus  disks-total-gb  in-use-addresses  static-addresses
+  europe-west1  up      -            1/10  100/100000      1/10              1/7
+  us-central1   up      -            0/10  0/100000        0/10              0/7
+  us-central2   up      -            1/10  50/100000       1/10              1/7
+  ```
+
+### knife google project list
+
+A project resource is the root collection and settings resource for
+all Google Compute Engine resources.
+
+Use this command to list out your project's current usage of snapshots,
+networks, firewalls, images, routes, forwarding-rules, target-pools and
+health-checks. Use the `-L` switch to also list the quota limit for
+each resource.
+
+The output for `knife google project list -L` should look similar to:
+
+  ```
+  name          status  deprecation  cpus  disks-total-gb  in-use-addresses  static-addresses
+  europe-west1  up      -            0     0               0                 0
+  us-central1   up      -            100   1000            10                1
+  us-central2   up      -            0     0               0                 0
   ```
 
 ### knife google server create
 
 Use this command to create a new Google Compute Engine server (a.k.a.
-instance).  You must specify a name, the machine type, the zone, and 
-the the image name. Images provided by Google follow this naming 
-convention:
+instance) with a persistent boot disk. You must specify a name, the
+machine type, the zone, and the the image name. Images provided by
+Google follow this naming convention:
 
   ```
   debian-7-wheezy-vYYYYMMDD
-  debian-6-squeeze-vYYYYMMDD
   centos-6-vYYYYMMDD
   ```
 
 By default, the plugin will look for the specified image in the instance's
 primary project first and then consult GCE's officially supported image
-locations. The `-J IMAGE_PROJECT_ID` option can be specified to force the
-plugin to look for the image in an alternate project location.
+locations. The `--gce-image-project-id IMAGE_PROJECT_ID` option can be 
+specified to force the plugin to look for the image in an alternate project
+location.
 
 Note that if you are bootstrapping the node, make sure to follow the 
 preparation instructions earlier and use the `-x` and `-i` commands 
@@ -237,52 +315,63 @@ to specify the username and the identity file for that user.  Make sure
 to use the private key file (e.g. `~/.ssh/id_rsa`) for the identity 
 file and *not* the public key file.
 
+If you would like to set up your server with a service account, provide
+the --gce-service-account-scopes argument during server creation. The service
+account associated with your project will be used by default unless otherwise
+specified with the optional --gce-service-account-name argument.
+
 See the extended options that also allow bootstrapping the node with
 `knife google server create --help`.
 
 ### knife google server delete
 
 This command terminates and deletes a server.  Use the `--purge`
-option to also remove it from Chef.  Use `knife google server
-delete --help` for other options.
+option to also remove it from Chef.
+
+Note that persistent disks associated with the server, including the
+boot disk, are not deleted with this operation. To delete persistent
+disks use `knife google disk delete`.
+
+Use `knife google server delete --help` for other options.
 
 ### knife google server list
 
 Get a list of servers in the specified zone.  Note that this may
-include servers that are *not* managed by Chef.  Your output should
+include servers that are *not* managed by Chef. Your output should
 look something like:
 
   ```
-  Name              Type           Image                 Public IP        Private IP      Disks               Zone           Status 
-  chef-svr          n1-standard-1  gcel-12-04-v20130325  103.59.80.113    10.240.45.78                        us-central2-a  running
-  chef-workstation  n1-standard-1  gcel-12-04-v20130325  103.59.85.188    10.240.9.140                        us-central2-a  running
-  fuse-dev          n1-standard-1  gcel-12-04-v20130225  103.59.80.147    10.240.166.18   pd-fuse             us-central2-a  running
-  magfs-c1          n1-standard-2  gcel-12-04-v20130225  103.59.87.217    10.240.61.92                        us-central2-a  running
-  magfs-c2          n1-standard-2  gcel-12-04-v20130225  103.59.80.161    10.240.175.240                      us-central2-a  running
-  magfs-c3          n1-standard-2  gcel-12-04-v20130325  178.255.120.69   10.240.34.197   jay-scratch         us-central2-a  running
-  magfs-svr         n1-standard-4  gcel-12-04-v20130225  103.59.80.178    10.240.81.25    pd28g               us-central2-a  running
+  name              type             public ip        private ip      disks               zone           status
+  chef-server       n1-standard-1    103.59.80.113    10.240.45.78    chef-server         us-central1-a  running
+  chef-workstation  n1-standard-1    103.59.85.188    10.240.9.140    chef-workstation    us-central1-a  running
+  fuse-dev          n1-standard-1    103.59.80.147    10.240.166.18   fuse-dev            us-central1-a  running
+  magfs-c1          n1-standard-2    103.59.87.217    10.240.61.92    magfs-c1            us-central1-a  running
+  magfs-c2          n1-standard-2    103.59.80.161    10.240.175.240  magfs-c2            us-central1-a  running
+  magfs-c3          n1-standard-2    178.255.120.69   10.240.34.197   magfs-c3            us-central1-a  running
+  magfs-svr         n1-standard-4    103.59.80.178    10.240.81.25    magfs-svr           us-central1-a  running
   ```
 
 ### knife google disk create
 
-Create a new persistent disk.  You must provide a name, size in
+Create a new persistent disk. You must provide a name, size in
 gigabytes, and the desired zone.
 
 ### knife google disk delete
 
-Delete an existing disk in the specified zone.  Note that the
+Delete an existing disk in the specified zone. Note that the
 disk will *not* be deleted if it is currently attached to a
 running server.
 
 ### knife google disk list
 
-See a listing of disks defined for a specific zone.  For example,
+See a listing of disks defined for a specific zone. Your output should
+look something like:
 
   ```
-  Name                Zone           Source Snapshot  Size (In GB)  Status
-  jay-scratch         us-central2-a                   10            ready 
-  pd-fuse             us-central2-a                   10            ready 
-  pd28g               us-central2-a                   28            ready 
+  name              zone            source snapshot   size (in GB)   status
+  dev-1             us-central1-a                     10             ready 
+  dev-2             us-central1-a                     10             ready 
+  test-1            us-central1-a                     20             ready 
   ```
 
 ## Troubleshooting
@@ -306,9 +395,9 @@ Standard rake commands for building, installing, testing, and uninstalling the m
   # Uninstall
   $ rake uninstall
   ```
+
 ## Contributing
   * See [CONTRIB.md](https://github.com/opscode/knife-google/blob/master/CONTRIB.md)
 
 ## Licensing
   * See [LICENSE](https://raw.github.com/opscode/knife-google/master/LICENSE)
-

data/knife-google.gemspec

@@ -7,7 +7,7 @@ Gem::Specification.new do |s|
   s.version = Knife::Google::VERSION
   s.platform = Gem::Platform::RUBY
   s.authors = ["Chiraq Jog", "Ranjib Dey", "James Tucker", "Paul Rossman", "Eric Johnson"]
-  s.email = "raggi@google.com"
+  s.email = "paulrossman@google.com"
   s.has_rdoc = true
   s.extra_rdoc_files = ["README.md", "LICENSE", "CONTRIB.md" ]
   s.summary = "Manage Google Compute Engine servers, disks, and zones"
@@ -19,6 +19,7 @@ Gem::Specification.new do |s|
   s.add_dependency "multi_json"
   s.add_dependency "mixlib-config"
   s.files = `git ls-files`.split($/)
+  #s.files = Dir['CONTRIB.md', 'Gemfile', 'LICENSE', 'README.md', 'Rakefile', 'knife-google.gemspec', 'lib/**/*', 'spec/**/*']
 
   s.add_development_dependency "rspec"
   s.add_development_dependency "rake"

data/lib/chef/knife/google_base.rb

@@ -30,7 +30,7 @@ class Chef
 
           option :compute_credential_file,
             :short => "-f CREDENTIAL_FILE",
-            :long => "--compute-credential-file CREDENTIAL_FILE",
+            :long => "--gce-credential-file CREDENTIAL_FILE",
             :description => "Google Compute credential file (google setup can create this)"
         end
       end

data/lib/chef/knife/google_disk_create.rb

@@ -20,7 +20,7 @@ class Chef
 
       include Knife::GoogleBase
 
-      banner "knife google disk create NAME --google-disk-sizeGb N --google-compute-zone ZONE (options)"
+      banner "knife google disk create NAME --gce-disk-size N -Z ZONE (options)"
 
       deps do
         require 'google/compute'
@@ -28,15 +28,14 @@ class Chef
 
       option :zone,
         :short => "-Z ZONE",
-        :long => "--google-compute-zone ZONE",
+        :long => "--gce-zone ZONE",
         :description => "The Zone for this disk",
         :required => true
 
-      option :sizeGb,
-        :short => "-s SIZE",
-        :long => "--google-disk-sizeGb SIZE",
-        :description => "Disk size in GB",
-        :required => true
+      option :disk_size,
+        :long => "--gce-disk-size SIZE",
+        :description => "Size of the persistent disk between 1 and 10000 GB, specified in GB; default is '1' GB",
+        :default => "1"
 
       def run
         $stdout.sync = true
@@ -52,8 +51,17 @@ class Chef
           exit 1
         end
 
-        zone_operation = client.disks.create(:name=>@name_args.first,
-          :sizeGb=>config[:sizeGb], :zone=>zone.name)
+        begin
+          disk_size = config[:disk_size].to_i
+          raise if !disk_size.between?(1, 10000)
+        rescue
+          ui.error("Size of the persistent disk must be between 1 and 10000 GB.")
+          exit 1
+        end
+
+        zone_operation = client.disks.create(:name => @name_args.first,
+                                             :sizeGb => config[:disk_size],
+                                             :zone => zone.name)
       end
     end
   end

data/lib/chef/knife/google_disk_delete.rb

@@ -20,7 +20,7 @@ class Chef
 
       include Knife::GoogleBase
 
-      banner "knife google disk delete NAME --google-compute-zone ZONE"
+      banner "knife google disk delete NAME -Z ZONE (options)"
 
       deps do
         require 'google/compute'
@@ -28,7 +28,7 @@ class Chef
 
       option :zone,
         :short => "-Z ZONE",
-        :long => "--google-compute-zone ZONE",
+        :long => "--gce-zone ZONE",
         :description => "The Zone for this disk",
         :required => true
 

data/lib/chef/knife/google_disk_list.rb

@@ -20,11 +20,11 @@ class Chef
 
       include Knife::GoogleBase
 
-      banner "knife google disk list --google-compute-zone ZONE (options)"
+      banner "knife google disk list -Z ZONE (options)"
 
       option :zone,
         :short => "-Z ZONE",
-        :long => "--google-compute-zone ZONE",
+        :long => "--gce-zone ZONE",
         :description => "The Zone for disk listing",
         :required => true
 
@@ -39,11 +39,11 @@ class Chef
         end
 
         disk_list = [
-          ui.color("Name", :bold),
-          ui.color('Zone', :bold),
-          ui.color('Source Snapshot', :bold),
-          ui.color('Size (In GB)', :bold),
-          ui.color('Status', :bold)].flatten.compact
+          ui.color("name", :bold),
+          ui.color('zone', :bold),
+          ui.color('source snapshot', :bold),
+          ui.color('size (in GB)', :bold),
+          ui.color('status', :bold)].flatten.compact
 
         output_column_count = disk_list.length
 
@@ -53,7 +53,7 @@ class Chef
           if disk.source_snapshot.nil?
             disk_list << " "
           else
-            selflink2name(disk.source_snapshot)
+            disk_list << selflink2name(disk.source_snapshot)
           end
           disk_list << disk.size_gb
           disk_list << begin