cloudspin-stack-rake 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a156d40067c77fd2b857f1df3c7802d07b8d76263ed5a632adf13fa7c1db65b5
-  data.tar.gz: 55e696f2c5516b67b73ce489760652238232be9c8749b0f6b58c54b0f9934711
+  metadata.gz: 44795420dcb8c0f155c14901d97232e3713b4ab33eb832081c9f48c02b002890
+  data.tar.gz: 39fa269d73c166910feb86e8b03e317c7b6d1cf9f96ae7eb79aca9ae82834794
 SHA512:
-  metadata.gz: 886628fd35467467dc091b9345fa8d02762492a04d56f7906c2466f43a34c16484a1e9f48885083fc247bca0a04c0cfc31e4af1fd2078425a3002f6245de3c94
-  data.tar.gz: e36aa1a1269fb5e44548929f8a34e463c741226bde59ed3c90b53140c355dad91a124e959e8a36a323d8afc4f521035a6642e0d5464614da4180a072f38b91b8
+  metadata.gz: 6936a4c98ddf423ccddfe3562ba85cafd10f201642df572aed16714aec0fd27d0b010fd0c422ef9493a74355f892ef36f5b45232d68f7f1aaf6c61b3ec7949df
+  data.tar.gz: 373e6fd9713f20d967cf7999ee41cdf682b89becfc68c04879d3b059d739abc85df7441b2adc0cbef99ad3fe4902417001f2c934444d7b68bd7a9e90fac1163b

data/README.md

@@ -1,8 +1,13 @@
 # Cloudspin::Stack::Rake
 
-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/cloudspin/stack/rake`. To experiment with that code, run `bin/console` for an interactive prompt.
+This Ruby library can be used in a Rakefile to manage infrastructure stacks. It makes use of the [cloudspin-stack](https://github.com/cloudspinners/cloudspin-stack) gem for the actual stack management code. The ideas behind this are documented (somewhat) in that project.
+
+This is a prototype for an infrastructure project delivery framework. It is intended as a basis for exploring project structures, conventions, and functionality, but is not currently in a stable state.
+
+Feel free to copy and use this, but be prepared to extend and modify it in order to make it useful for your own project. There isn't likely to be a clean path to upgrade your projects as this thing evolves - my assumption is that nobody else is directly depending on this code or the gems I've published from it.
+
+I'm using [spin-stack-network](https://github.com/cloudspinners/spin-stack-network) as an example of an infrastructure stack project to make use of this framework. I may add other projects in the future as the tool is developed.
 
-TODO: Delete this and the text above, and describe your gem
 
 ## Installation
 
@@ -14,15 +19,75 @@ gem 'cloudspin-stack-rake'
 
 And then execute:
 
-    $ bundle
+```bash
+bundle
+```
 
 Or install it yourself as:
 
-    $ gem install cloudspin-stack-rake
+```bash
+gem install cloudspin-stack-rake
+```
+
+## Usage: Stack management
 
-## Usage
+Here's a snippet from a Rakefile:
+
+```ruby
+require 'cloudspin/stack/rake'
+
+namespace :stack do
+  namespace 'test-network' do
+    Cloudspin::Stack::Rake::StackTask.new(id: 'test-network')
+  end
+end
+```
+
+If you run `rake -T` you'll see a list of tasks:
+
+```bash
+rake stack:test-network:down    # Destroy stack test-network
+rake stack:test-network:dry     # Show command line to be run for stack test-network
+rake stack:test-network:plan    # Plan changes to stack test-network
+rake stack:test-network:up      # Create or update stack test-network
+```
+
+You can also add inspec test tasks. The Rakefile snippet:
+```ruby
+require 'cloudspin/stack/rake'
+
+namespace :stack do
+  namespace 'test-network' do
+    stack = Cloudspin::Stack::Rake::StackTask.new(id: 'test-network').instance
+    Cloudspin::Stack::Rake::InspecTask.new(stack_instance: stack,
+                                           inspec_target: 'aws://eu-west-1/assume-spin_stack_manager-skeleton')
+  end
+end
+```
+
+This includes the stack management tasks from the first example, but adds a new one when you run `rake -T`:
+
+```bash
+rake stack:test-network:inspec  # Run inspec tests
+```
+
+This assumes you have a folder `./inspec` with profile and controls in it.
+
+For convenience, you can add a top level task to your Rakefile that creates a stack, runs inspec, and then destroys it:
+
+```ruby
+desc 'Create, test, and destroy the stack'
+task :full_test => [
+  :'stack:test-network:up',
+  :'stack:test-network:inspec',
+  :'stack:test-network:down'
+]
+```
+
+You can then simply run `rake full_test` to do this.
+
+Again, [spin-stack-network](https://github.com/cloudspinners/spin-stack-network) has an example of this, and is likely to move ahead of this documentation.
 
-TODO: Write usage instructions here
 
 ## Development
 
@@ -33,3 +98,8 @@ 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]/cloudspin-stack-rake.
+
+# Credits
+
+This project makes extensive use of ideas and code from Toby Clemson and Jimmy Thompson, particularly [infrablocks](https://github.com/infrablocks). I've also benefited from feedback on implementation concepts from Vincenzo Fabrizi, and other [ThoughtWorkers](https://thoughtworks.com).
+

data/cloudspin-stack-rake.gemspec

@@ -25,8 +25,8 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency 'cloudspin-stack'
   spec.add_dependency 'inspec'
+  spec.add_dependency 'rake'
 
-  spec.add_development_dependency 'bundler', '~> 1.16'
-  spec.add_development_dependency 'rake', '~> 10.0'
-  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'bundler'
+  # spec.add_development_dependency 'rspec'
 end

data/lib/cloudspin/stack/rake/version.rb

@@ -1,7 +1,7 @@
 module Cloudspin
   module Stack
     module Rake
-      VERSION = '0.1.1'
+      VERSION = '0.1.2'
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cloudspin-stack-rake
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - 'kief '
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-08-23 00:00:00.000000000 Z
+date: 2018-09-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cloudspin-stack
@@ -38,48 +38,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.16'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.16'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
-  type: :development
+        version: '0'
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '0'
 description: 
 email:
 - cloudspin@kief.com