gce-host 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 62b31646dd076986d8c0cc9bbd2c25a47c39c68d
+  data.tar.gz: 160b97e5f289c5e44f3391e59a4702d55a1750e8
+SHA512:
+  metadata.gz: 23878d91ddc9527713a68d263d19c77ee0b57cc875e06dbc95e162f479523fad4ac1bda7873860e0f41df275ee0f69c3cac344995c0f9756d96e2de10e80a1a4
+  data.tar.gz: 99db823d6e304bc8ef7071cbd14186470b55d86fdfc81f814c38d7ec3ca8d0d38a4aa31355a45457902d951f428ca67c7a56ba43484af667416212bd1b089bce

data/.gitignore

@@ -0,0 +1,20 @@
+*~
+.bundle
+.pryrc
+.rvmrc
+.rbenv-version
+.ruby-version
+.yardoc
+.DS_Store
+Gemfile.lock
+coverage
+doc
+log
+tmp
+vendor
+*.swp
+pkg/
+.env
+*.json
+*.tfstate
+*.tfstate.backup

data/.yardopts

@@ -0,0 +1,6 @@
+--no-private
+--protected
+--output-dir docs
+-
+README.md
+LICENSE

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+# 0.1.0 (2016/11/18)
+
+first version

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2016 Naotoshi Seo
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,210 @@
+# gce-host
+
+Search hosts on GCP GCE
+
+## Installation
+
+```
+gem install gce-host
+```
+
+## How it works
+
+This gems uses [metadata of GCE resources](https://cloud.google.com/compute/docs/storing-retrieving-metadata).
+You can configure, but basically use `roles` key for roles.
+
+You can manage roles of a host, and search hosts having a specified role using thease metadata with this gem.
+
+## Configuration
+
+You can write a configuration file located at `/etc/sysconfig/gce-host` (You can configure this path by `GCE_HOST_CONFIG_FILE` environment variable), or as environment variables:
+
+GOOGLE API parameters:
+
+* **AUTH_METHOD**: Authentication method. Currently, `compute_engine`, `json_key` and `application_default` is available. The default is `applilcation_default`. 
+* **GOOGLE_CREDENTIAL_FILE**: Path of credential file. Specify your service account json file for `json_key` authentication method.
+
+gce-host parameters:
+
+* **ROLES_KEY (optional)**: GCE metadata keys used to express roles. The default is `roles`
+  * You can assign multiple roles seperated by `ARRAY_VALUE_DELIMITER` (default: `,`)
+  * Also, you can express levels of roles delimited by `ROLE_VALUE_DELIMITER` (default `:`)
+  * Example: admin:ami, then `GCE::Host.new(role: 'admin:ami')` and also `GCE::Host.new(role1: 'admin')` returns this host
+* **ROLE_VALUE_DELIMITER (optional)**: A delimiter to express levels of roles. Default is `:`
+* **OPTIONAL_STRING_KEYS (optional)**: You may add optional non-array metadata keys. You can specify multiple keys like `service,status`. 
+* **OPTIONAL_ARRAY_KEYS (optional)**: You may add optional array metadata keys. Array allows multiple values delimited by `ARRAY_VALUE_DELIMITER` (default: `,`)
+* **ARRAY_VALUE_DELIMITER (optional)**: A delimiter to express array. Default is `,`
+* **LOG_LEVEL (optional)**: Log level such as `info`, `debug`, `error`. The default is `info`. 
+
+See [example.conf](./example/example.conf)
+
+## Metadata Example
+
+* **roles**: app:web,app:db
+* **service**: awesome
+* **status**: setup
+
+## CLI Usage
+
+### CLI Example
+
+```
+$ gce-host -j
+{"hostname":"gce-host-db","roles":["foo","db:test"],"zone":"asia-northeast1-a","service":"gce-host","status":"active","tags":["master"],"instance_id":"4263858691219514807","private_ip_address":"10.240.0.6","public_ip_address":"104.198.89.55","creation_timestamp":"2016-11-22T06:51:04.650-08:00","state":"RUNNING"}
+{"hostname":"gce-host-web","roles":["foo","web:test"],"zone":"asia-northeast1-a","service":"gce-host","status":"reserve","tags":["standby"],"instance_id":"8807276062743061943","private_ip_address":"10.240.0.5","public_ip_address":"104.198.87.6","creation_timestamp":"2016-11-22T06:51:04.653-08:00","state":"RUNNING"}
+```
+
+```
+$ gce-host
+gce-host-db
+gce-host-web
+```
+
+```
+$ gce-host --role1 db
+gce-host-db
+```
+
+```
+$ gce-host --role web:test
+gce-host-web
+```
+
+```
+$ gce-host --pretty-json
+[
+  {
+    "hostname": "gce-host-db",
+    "roles": [
+      "foo",
+      "db:test"
+    ],
+    "zone": "asia-northeast1-a",
+    "service": "gce-host",
+    "status": "active",
+    "tags": [
+      "master"
+    ],
+    "instance_id": "4263858691219514807",
+    "private_ip_address": "10.240.0.6",
+    "public_ip_address": "104.198.89.55",
+    "creation_timestamp": "2016-11-22T06:51:04.650-08:00",
+    "state": "RUNNING"
+  },
+  {
+    "hostname": "gce-host-web",
+    "roles": [
+      "foo",
+      "web:test"
+    ],
+    "zone": "asia-northeast1-a",
+    "service": "gce-host",
+    "status": "reserve",
+    "tags": [
+      "standby"
+    ],
+    "instance_id": "8807276062743061943",
+    "private_ip_address": "10.240.0.5",
+    "public_ip_address": "104.198.87.6",
+    "creation_timestamp": "2016-11-22T06:51:04.653-08:00",
+    "state": "RUNNING"
+  }
+]
+```
+
+### CLI Help
+
+```
+$ bin/gce-host --help
+Usage: gce-host [options]
+        --hostname one,two,three     name or private_dns_name
+    -r, --role one,two,three         role
+        --r1, --role1 one,two,three  role1, the 1st part of role delimited by :
+        --r2, --role2 one,two,three  role2, the 2st part of role delimited by :
+        --r3, --role3 one,two,three  role3, the 3st part of role delimited by :
+        --state one,two,three        filter with instance state (default: running)
+    -a, --all                        list all hosts (remove default filter)
+        --private-ip, --ip           show private ip address instead of hostname
+        --public-ip                  show public ip address instead of hostname
+    -i, --info                       show host info
+    -j, --jsonl                      show host info in line delimited json
+        --json                       show host info in json
+        --pretty-json                show host info in pretty json
+        --debug                      debug mode
+    -h, --help                       show help
+```
+
+## Library Usage
+
+### Library Example
+
+```ruby
+require 'gce-host'
+
+hosts = GCE::Host.new(role: 'db:test')
+hosts.each do |host|
+  puts host
+end
+```
+
+### Library Reference
+
+See http://sonots.github.io/gce-host/frames.html.
+
+## ChangeLog
+
+See [CHANGELOG.md](CHANGELOG.md) for details.
+
+## For Developers
+
+### ToDo
+
+* Use mock/stub to run test (currently, directly accessing to GCE)
+* Should cache a result of list_instances in like 30 seconds?
+
+### How to Run test
+
+NOTE: Currently, mock is not supported yet. So, you have to create your own gcloud account, and instances.
+
+Configure .env file as
+
+```
+AUTH_METHOD=json_key
+GOOGLE_CREDENTIAL_FILE=service_acount.json
+GOOGLE_PROJECT=XXXXXXXXXXXXX
+OPTIONAL_STRING_KEYS=service,status
+OPTIONAL_ARRAY_KEYS=tags
+```
+
+Install terraform and run to create instances for tests
+
+```
+$ brew install terraform
+$ env $(cat .env) terraform plan
+$ env ($cat .env) terraform apply
+```
+
+Run test
+
+```
+$ bundle exec rspec
+```
+
+After working, destory instances by commenting out `terraform.tf` and apply.
+
+### How to Release Gem
+
+1. Update gem.version in the gemspec
+2. Update CHANGELOG.md
+3. git commit && git push
+4. Run `bundle exec rake release`
+
+### How to Update doc
+
+1. Run `bundle exec yard`
+2. git commit && git push
+
+### Licenses
+
+See [LICENSE](LICENSE)
+

data/Rakefile

@@ -0,0 +1,30 @@
+# -*- coding: utf-8; -*-
+require "bundler/gem_tasks"
+
+begin
+  require 'rspec/core/rake_task'
+  RSpec::Core::RakeTask.new :spec do |spec|
+    spec.pattern = FileList['spec/**/*_spec.rb']
+  end
+  task default: :spec
+rescue LoadError, NameError
+  # OK, they can be absent on non-development mode.
+end
+
+desc "irb console"
+task :console do
+  require_relative "lib/gce-host"
+  require 'irb'
+  require 'irb/completion'
+  ARGV.clear
+  IRB.start
+end
+task :c => :console
+
+desc "pry console"
+task :pry do
+  require_relative "lib/gce-host"
+  require 'pry'
+  ARGV.clear
+  Pry.start
+end

data/bin/gce-host

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+
+require_relative '../lib/gce/host/cli'
+GCE::Host::CLI.new(ARGV).run

data/docs/GCE.html

@@ -0,0 +1,132 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+  <head>
+    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+<title>
+  Class: GCE
+  
+    &mdash; Documentation by YARD 0.8.7.6
+  
+</title>
+
+  <link rel="stylesheet" href="css/style.css" type="text/css" charset="utf-8" />
+
+  <link rel="stylesheet" href="css/common.css" type="text/css" charset="utf-8" />
+
+<script type="text/javascript" charset="utf-8">
+  hasFrames = window.top.frames.main ? true : false;
+  relpath = '';
+  framesUrl = "frames.html#!GCE.html";
+</script>
+
+
+  <script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
+
+  <script type="text/javascript" charset="utf-8" src="js/app.js"></script>
+
+
+  </head>
+  <body>
+    <div id="header">
+      <div id="menu">
+  
+    <a href="_index.html">Index (G)</a> &raquo;
+    
+    
+    <span class="title">GCE</span>
+  
+
+  <div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
+</div>
+
+      <div id="search">
+  
+    <a class="full_list_link" id="class_list_link"
+        href="class_list.html">
+      Class List
+    </a>
+  
+    <a class="full_list_link" id="method_list_link"
+        href="method_list.html">
+      Method List
+    </a>
+  
+    <a class="full_list_link" id="file_list_link"
+        href="file_list.html">
+      File List
+    </a>
+  
+</div>
+      <div class="clear"></div>
+    </div>
+
+    <iframe id="search_frame"></iframe>
+
+    <div id="content"><h1>Class: GCE
+  
+  
+  
+</h1>
+
+<dl class="box">
+  
+    <dt class="r1">Inherits:</dt>
+    <dd class="r1">
+      <span class="inheritName">Object</span>
+      
+        <ul class="fullTree">
+          <li>Object</li>
+          
+            <li class="next">GCE</li>
+          
+        </ul>
+        <a href="#" class="inheritanceTree">show all</a>
+      
+      </dd>
+    
+  
+  
+    
+  
+    
+  
+  
+  
+    <dt class="r2 last">Defined in:</dt>
+    <dd class="r2 last">lib/gce/host.rb<span class="defines">,<br />
+  lib/gce/host/cli.rb,<br /> lib/gce/host/config.rb,<br /> lib/gce/host/version.rb,<br /> lib/gce/host/host_data.rb,<br /> lib/gce/host/role_data.rb,<br /> lib/gce/host/hash_util.rb,<br /> lib/gce/host/gce_client.rb,<br /> lib/gce/host/string_util.rb</span>
+</dd>
+  
+</dl>
+<div class="clear"></div>
+
+<h2>Defined Under Namespace</h2>
+<p class="children">
+  
+    
+  
+    
+      <strong class="classes">Classes:</strong> <span class='object_link'><a href="GCE/Host.html" title="GCE::Host (class)">Host</a></span>
+    
+  
+</p>
+
+
+
+
+
+
+
+
+
+</div>
+
+    <div id="footer">
+  Generated on Wed Nov 23 20:08:31 2016 by
+  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+  0.8.7.6 (ruby-2.3.2).
+</div>
+
+  </body>
+</html>