bb8 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ebd3491377b1b0031cc4b605d6bd1d2ce5c74861
-  data.tar.gz: d2a9f45e7a93464020b06fe916436ee3dfa532c4
+  metadata.gz: ce698dad7541161007a7c53b2b6c96b7ef933b21
+  data.tar.gz: 0fe6140febe6b98e72b8d065684339024f139579
 SHA512:
-  metadata.gz: abaaf5d51e16ec11d7415ac2f7e5086d731f6dbd77a13a6e46462bfb9f3e60d4e7c85bee5388ae2eaec231688067e3211767b870f1362d8d8f36d9d73b2cddbf
-  data.tar.gz: e3b0e2244c90f714093f114ef2da5de4ea39c2df6ddeabf17cff9dff93797f9c28a6b0cc84fcc0cc4f3a38e04cb85a829292998886a0b3b78c8b61b821f97b2f
+  metadata.gz: e8e478a8956d128ad4cb50564bdb572bfa2ecdc81ded9e24fc698e9e8455c5ab8607fd14ce48a816da25805fe2e2ac5c540cfc60bf19397ba0e29b8c08959741
+  data.tar.gz: 3d46715a49d1e50fcca1d787ab22ebd68162a385feb576f4ad7098d7954a25896c3e674f7ae24c24a12cb2e05eed484cebf5560184fb6e236b448ee8a60621d1

data/README.markdown

@@ -1,36 +1,59 @@
-# Bb8
+# BB-8
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/bb8`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
+BB-8 helps you store your [Terraform](https://www.terraform.io) environments securely, managing the encryption of sensitive files into a git repository, and the encryption keys are shared with other team members using [Voltos](https://voltos.io).
 
 ## Installation
 
-Add this line to your application's Gemfile:
+Install the gem:
 
-```ruby
-gem 'bb8'
-```
+    $ gem install bb8
 
-And then execute:
+Also, you'll want to have [Terraform](https://www.terraform.io) and [Voltos](https://voltos.io) installed, plus have Voltos authenticated on your machine.
 
-    $ bundle
+## Usage
 
-Or install it yourself as:
+BB-8 manages your infrastructure plans within a single git repository, which has separate folders for each environment (e.g. production, staging, etc). To get going, run the init command with a directory for the git repository (or use `.` for the current directory)
 
-    $ gem install bb8
+    $ bb8 init servers
 
-## Usage
+Then move into your project's directory (i.e. `cd servers`). You'll want to add an `origin` remote to your git repository where all of this infrastructure configuration will live.
+
+    $ git remote add origin git://...
+
+The next step is to set up an environment:
 
-TODO: Write usage instructions here
+    $ bb8 staging init my-servers-staging
 
-## Development
+The order of arguments is as follows: the name of the environment, the `init` command, and the name of a bundle of Voltos settings. BB-8 will create the latter for you, if you've not already done so.
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+From this point on, you'll want to issue Terraform commands through BB-8 and a specified environment:
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+    $ bb8 staging apply
+    $ bb8 staging show
+    $ bb8 staging destroy
+
+The Terraform configuration is expected along the following lines:
+
+* Common infrastructure for all environments should exist in a file `common.tf` in the root of the project. This is automatically copied to each environment directory.
+* Environment-specific infrastructure configuration can live in files within the environment directory.
+* Variable files such as `terraform.tfvars` should live in their appropriate environment folders.
+
+Calling a Terraform command via BB-8 goes through this workflow every time:
+
+* Merge the latest changes from the git remote.
+* Decrypt all Terraform state and variable files.
+* Invoke Terraform.
+* Encrypt all Terraform state and variable files.
+* Push changes up to the git remote.
+
+The unencrypted versions of the state and variable files are _not_ added to the git repository, thus your secrets remain secret to anyone without access to each environment's Voltos bundle.
+
+To allow others to work on your infrastructure, they'll need access to both the git repository, _and_ the appropriate Voltos bundles.
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/bb8. 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/pat/bb8. 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.
+
+## Licence
 
+Copyright (c) 2016, BB-8 is developed and maintained by Pat Allan, and is released under the open MIT Licence.

data/bb8.gemspec

@@ -8,6 +8,7 @@ Gem::Specification.new do |spec|
   spec.version       = BB8::VERSION
   spec.authors       = ["Pat Allan"]
   spec.email         = ["pat@freelancing-gods.com"]
+  spec.licenses      = ['MIT']
 
   spec.summary       = %q{Manage and share Terraform variables, environments, and states securely.}
   spec.homepage      = "https://github.com/pat/bb8"
@@ -19,7 +20,8 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |file| File.basename(file) }
   spec.require_paths = ["lib"]
 
-  spec.add_runtime_dependency "voltos", "~> 0.3"
+  spec.add_runtime_dependency "curb",    "~> 0.9.3"
+  spec.add_runtime_dependency "voltos",  "~> 0.3"
 
   spec.add_development_dependency "rspec", "~> 3.0"
 end

data/lib/bb8.rb

@@ -1,3 +1,4 @@
+require 'curb'
 require 'fileutils'
 require 'json'
 require 'openssl'
@@ -20,4 +21,5 @@ require 'bb8/decrypt'
 require 'bb8/encrypt'
 require 'bb8/set_encryption_keys'
 require 'bb8/version'
+require 'bb8/voltos_api'
 require 'bb8/voltos_variables'

data/lib/bb8/commands/initialise_environment.rb

@@ -1,6 +1,4 @@
 class BB8::Commands::InitialiseEnvironment
-  VOLTOS_CONFIGURATION = File.expand_path("~/.voltos/config.json")
-
   def self.call(name, voltos_bundle, *arguments)
     new(name, voltos_bundle).call
   end
@@ -13,8 +11,8 @@ class BB8::Commands::InitialiseEnvironment
     FileUtils.mkdir_p name
     Dir.chdir name
 
-    `voltos create #{voltos_bundle}`
-    `voltos use #{voltos_bundle}`
+    api.create_bundle voltos_bundle unless bundles.include? voltos_bundle
+    `voltos use #{voltos_bundle}`   unless set_bundle?
     BB8::SetEncryptionKeys.call
 
     File.write '.bb8_bundle', voltos_bundle
@@ -23,4 +21,16 @@ class BB8::Commands::InitialiseEnvironment
   private
 
   attr_reader :name, :voltos_bundle
+
+  def api
+    @api ||= BB8::VoltosAPI.new
+  end
+
+  def bundles
+    api.bundles.collect { |bundle| bundle['name'] }
+  end
+
+  def set_bundle?
+    File.exist?('.env') && File.read('.env')[/^VOLTOS_KEY=(\w+)/]
+  end
 end

data/lib/bb8/version.rb

@@ -1,3 +1,3 @@
 module BB8
-  VERSION = '0.1.0'
+  VERSION = '0.2.0'
 end

data/lib/bb8/voltos_api.rb

@@ -0,0 +1,34 @@
+class BB8::VoltosAPI
+  DOMAIN   = 'https://api.voltos.io'
+  VERSION  = 'v1'
+  ENDPOINT = "#{DOMAIN}/#{VERSION}"
+
+  def bundles
+    JSON.parse Curl.get("#{ENDPOINT}/bundles") { |http|
+      http.headers['User-Agent']    = "BB8/#{BB8::VERSION}"
+      http.headers['Authorization'] = "Token token=#{token}"
+    }.body_str
+  end
+
+  def create_bundle(name)
+    JSON.parse Curl.post("#{ENDPOINT}/bundles", {
+      :name       => name,
+      :token_name => 'BB8'
+    }) { |http|
+      http.headers['User-Agent']    = "BB8/#{BB8::VERSION}"
+      http.headers['Authorization'] = "Token token=#{token}"
+    }.body_str
+  end
+
+  private
+
+  def configuration
+    @configuration ||= JSON.parse(
+      File.read(File.expand_path('~/.voltos/config.json'))
+    )
+  end
+
+  def token
+    configuration['auths']["#{ENDPOINT}"]['auth']
+  end
+end

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: bb8
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Pat Allan
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-12-16 00:00:00.000000000 Z
+date: 2016-12-19 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: curb
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.3
 - !ruby/object:Gem::Dependency
   name: voltos
   requirement: !ruby/object:Gem::Requirement
@@ -68,9 +82,11 @@ files:
 - lib/bb8/encrypt.rb
 - lib/bb8/set_encryption_keys.rb
 - lib/bb8/version.rb
+- lib/bb8/voltos_api.rb
 - lib/bb8/voltos_variables.rb
 homepage: https://github.com/pat/bb8
-licenses: []
+licenses:
+- MIT
 metadata: {}
 post_install_message: 
 rdoc_options: []