cap-gce 1.1.0 → 1.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6eef30cfd574fe40156cd90133d646c233fa99c6
-  data.tar.gz: bb80ec04fb247ce1a4c0905d2c3db9699e208e9d
+  metadata.gz: 88e63844a2c34b9af653090013440de8d55c2124
+  data.tar.gz: 283e0bba1985f7f8ea2ee103602722d961d9c529
 SHA512:
-  metadata.gz: 3b7c36cb89fc86cd76a004d3776819050bf46e5b27896b7b6416b95ef059ca2f15eb8777d061d01fca9be846693d424c927f356ef96c69a9ae37853493cf1b20
-  data.tar.gz: d0443ab299a1dccd5a5c32ae6fe67ad8b6010655e27f89830192e0231946e08c506287eb2c2960b619f43952d79a7ea9434ae6d758d584f5673e2c59c1b27009
+  metadata.gz: 724aae1655c9c4c4521457fe4a0f1bc70d2094f3dccfa29e142651abbc14b689074728d7c535cf4bf8b54e6d0e31194a3121db2b5342760883d3ea2ca5748cc8
+  data.tar.gz: c0dc16e2c8152de58c8a20aeabac53f27b2750ae61ea5fa2d7f19765e9ae99916bdd667fa27753e408fa19c20a805eefaca772ae6b8ccbf154ccb4f88d9f3d29

data/README.md

@@ -1,4 +1,6 @@
-# Cap::Gce
+# Cap-GCE
+
+[![Gem Version](https://badge.fury.io/rb/cap-gce.svg)](http://badge.fury.io/rb/cap-gce) [![Code Climate](https://codeclimate.com/github/iscreen/cap-gce.png)](https://codeclimate.com/github/iscreen/cap-gce)
 
 Cap-GCE is used to generate Capistrano namespaces and tasks from Google Cloud Compute Engine instance metadata, dynamically building the list of servers to be deployed to.
 
@@ -69,6 +71,84 @@ set :gce_contact_point, nil # nat_ip, network_ip
 
 ## Usage
 
+Imagine you have four servers on Google Cloud Platform named and metadata as follows:
+
+<table>
+  <tr>
+    <td>'Name' metadata</td>
+    <td>'Roles' metadata</td>
+    <td>'Stages' metadata</td>
+  </tr>
+  <tr>
+    <td>server-1</td>
+    <td>web</td>
+    <td>production</td>
+  </tr>
+  <tr>
+    <td>server-2</td>
+    <td>web,app</td>
+    <td>production</td>
+  </tr>
+  <tr>
+    <td>server-3</td>
+    <td>app,db</td>
+    <td>production</td>
+  </tr>
+  <tr>
+    <td>server-4</td>
+    <td>web,db,app</td>
+    <td>staging</td>
+  </tr>
+</table>
+
+Imagine also that we've called our app "testapp", as defined in `config/deploy.rb` like so:
+
+    set :application, "testapp"
+
+### Defining the roles in `config/deploy/[stage].rb`
+
+To define a role, edit `config/deploy/[stage].rb` and add the following:
+
+    gce_role :web
+
+Let's say we edited `config/deploy/production.rb`. Adding this configuration to the file would assign
+the role `:web` to any instance that has the following properties:
+* has a metadata called "Roles" that contains the string "web"
+* has a metadata called "Project" that contains the string "testapp"
+* has a metadata called "Stages" that contains the current stage we're executing (in this case, "production")
+
+Looking at the above table, we can see we would match `server-1` and `server-2`. (You can have multiple
+roles in metadata separated by commas.)
+
+Now we can define the other roles:
+
+    gce_role :app
+    gce_role :db
+
+In the "production" stage, the `:app` role would apply to `server-2` and `server-3`, and the `:db`
+role would apply to `server-3`.
+
+In the "staging" stage, all roles would apply *only* to `server-4`.
+
+### Servers belonging to multiple projects
+
+If you require your servers to have multiple projects deployed to them, you can simply specify
+all the project names you want to the server to be part of in the 'Projects' metadata, separated
+by commas. For example, you could place a server in the `testapp` and `myapp` projects by
+setting the 'Projects' metadata to `testapp,myapp`.
+
+### Servers in multiple stages
+
+If your use-case requires servers to be in multiple stages, simply specify all the stages you want
+the server to be in 'Stages' metadata, separated by commas. For example, you could place a server in
+the `production` and `staging` stages by setting the 'Stages' metadata to `production,staging`.
+
+### Tasks and deployment
+
+You can now define your tasks for these roles in exactly the same way as you would if you weren't
+using this gem.
+
+
 ## Utility tasks
 
 Cap-GCE adds a few utility tasks to Capistrano for displaying information about the instances that you will be deploying to. Note that unlike Capistrano 2.x, all tasks require a stage.
@@ -128,7 +208,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/cap-gce. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+Bug reports and pull requests are welcome on GitHub at https://github.com/iscreen/cap-gce. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
 
 
 ## License

data/lib/cap-gce/utils.rb

@@ -20,7 +20,9 @@ module CapGCE
     end
 
     def tag_value(instance, key)
-      instance.metadata.items.find({}) { |t| t.key == key.to_s }.value
+      find = instance.metadata.items.detect { |t| t.key == key.to_s }
+      return nil unless find
+      find.value
     end
 
     def self.contact_point_mapping
@@ -47,6 +49,7 @@ module CapGCE
     end
 
     def self.nat_ip(instance)
+      return [] if (instance.network_interfaces.map(&:access_configs).flatten - [nil]).empty?
       instance.network_interfaces.map(&:access_configs).flatten.map(&:nat_ip) - [nil]
     end
 

data/lib/cap-gce/version.rb

@@ -1,3 +1,3 @@
 module CapGCE
-  VERSION = '1.1.0'.freeze
+  VERSION = '1.1.1'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cap-gce
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.1.1
 platform: ruby
 authors:
 - Dean Lin
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-08-15 00:00:00.000000000 Z
+date: 2017-08-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: google-api-client