sfn 0.0.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7f7d923b3e2232d313f37902aba52368d3feb60c
-  data.tar.gz: b3821d0d8663923f23e083ff8938fc0f9a2f9942
+  metadata.gz: 503fe5b1c6c2b1fd9620fa4031e4f922e7432739
+  data.tar.gz: ce03c4291a2edfb660e7614b7202835f062ee965
 SHA512:
-  metadata.gz: 7d4ca8056ea8efd86b023255627edaa76c455604ef33406f053a78b4b9ec5837aa0ec650b1ce6b290a64fbe83819529c2a8671a9ae612c6b073511c2f99f5356
-  data.tar.gz: 3428daa388483853cce8be81bd0ef39e4ff87a3e7d19cbacf01a318bb2b0d46dd9e31dacfb8ff9885f4f85aef67e256bea78352ef714267a460f3b7985913026
+  metadata.gz: 3ebf8bfb6f17238c53cf49b295e938bacaa04298fa79f9f2b694d8c8fd927ead75c1acf005fd7ebd63f870039bb890e98659395cd6451b83f934800b3a459ded
+  data.tar.gz: bf7061df664df0cec57c29627f57262effe53652f1bd49dc439fe4157983730adacb4831fbfe10750f30764517db8d90716a16410ce383e2f14f045a32ac5bf7

data/CHANGELOG.md

@@ -0,0 +1,107 @@
+## v0.3.0
+* Conversion from `knife-cloudformation` to `sfn`
+* Add knife subcommand alias `sparkleformation`
+* Remove implementation dependency on Chef tooling
+
+## v0.2.20
+* Add automatic support for outputs in nested stacks to `--apply-stack`
+
+## v0.2.18
+* Fix nested stack URL generation
+
+## v0.2.16
+* Fix broken validation command (#12 thanks @JonathanSerafini)
+* Pad stack name indexes when unpacked
+
+## v0.2.14
+* Pass command configuration through when unpacking
+* Force stack list reload prior to polling to prevent lookup errors
+* Add glob support on name arguments provided for `destroy`
+* Add unpacked stack support to `--apply-stack` flag
+* Retry events polling when started from different command
+
+## v0.2.12
+* Use template to provide logical parameter ordering on stack update
+* Only set parameters when not the default template value
+* Do not save nested stacks to remote bucket when in print-only mode
+* Add initial support for un-nested stack create and update
+* Fix nested stack flagging usage
+
+## v0.2.10
+* Add initial nested stack support
+
+## v0.2.8
+* Update stack lookup implementation to make faster from CLI
+* Prevent constant error on exception when Redis is not in use
+* Provide better error messages on request failures
+
+## v0.2.6
+* Update to parameter re-defaults to use correct hash instance
+
+## v0.2.4
+* Fix apply stack parameter processing
+
+## v0.2.2
+* Fix redis-objects loading in cache helper
+
+## v0.2.0
+* This release should be considered "breaking"
+* Underlying cloud API has been changed from fog to miasma
+* The `inspect` command has been fully reworked to support `--attribute`
+* Lots and lots of other changes. See commit log.
+
+## v0.1.22
+* Prevent full stack list loading in knife commands
+* Default logger to INFO level and allow DEBUG level via `ENV['DEBUG']`
+* Fix assumption of type when accessing cached data (cannot assume availability)
+
+## v0.1.20
+* Update some caching behavior
+* Add more logging especially around remote calls
+* Add support for request throttling
+* Disable local caching when stack is in `in_progress` state
+
+## v0.1.18
+* Replace constant with inline value to prevent warnings
+* Explicitly load file to ensure proper load ordering
+
+## v0.1.16
+* Fix exit code on stack destroy
+* Update stack loading for single stack requests
+* Add import and export functionality
+
+## v0.1.14
+* Extract template building tools
+* Add support for custom CF locations and prompting
+* Updates in fetching and caching behavior
+
+## v0.1.12
+* Use the split value when re-joining parameters
+
+## v0.1.10
+* Fix parameter passing via the CLI (data loss issue when value contained ':')
+
+## v0.1.8
+* Update event cache handling
+* Allow multiple users for node connect attempts
+
+## v0.1.6
+* Adds inspect action
+* Updates to commons
+* Allow multiple stack destroys at once
+* Updates to options to make consistent
+
+## v0.1.4
+* Support outputs on stack creation
+* Poll on destroy by default
+* Add inspection helper for failed node inspection
+* Refactor AWS interactions to common library
+
+## v0.1.2
+* Update dependency restriction to get later version
+
+## v0.1.0
+* Stable-ish release
+
+## v0.0.1
+* Initial release

data/LICENSE

@@ -0,0 +1,13 @@
+   Copyright 2014 Heavy Water Operations LLC.
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+     http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/README.md

@@ -1,8 +1,7 @@
-# Knife CloudFormation
+# SparkleFormation CLI
 
-This is a plugin for the `knife` command provided by
-Chef to interact with AWS (and other) orchestration
-APIs.
+SparkleFormation command line interface for interacting
+with orchestration APIs.
 
 ## API Compatibility
 
@@ -12,63 +11,77 @@ APIs.
 
 ## Configuration
 
-The easiest way to configure the plugin is via the
-`knife.rb` file. Credentials are the only configuration
-requirement, and the `Hash` provided is proxied to
-[Miasma][miasma]:
+Configuration is defined within a `.sfn` file. The
+`sfn` command will start from the current working
+directory and work up to the root of the file system
+to discover this file.
 
-### AWS
+### Configuration formats
 
-```ruby
-# .chef/knife.rb
+The configuration file can be provided in a variety of
+formats:
 
-knife[:cloudformation][:credentials] = {
-  :provider => :aws,
-  :aws_access_key_id => ENV['AWS_ACCESS_KEY_ID'],
-  :aws_secret_access_key => ENV['AWS_SECRET_ACCESS_KEY'],
-  :aws_region => ENV['AWS_REGION']
+#### JSON
+
+```json
+{
+  "credentials": {
+    AWS_CREDENTIALS
+  },
+  "options": {
+    "disable_rollback": true
+  }
 }
 ```
 
-### Rackspace
+### YAML
 
-```ruby
-# .chef/knife.rb
+```yaml
+---
+:credentials:
+  :fubar: true
+:options:
+  :disable_rollback: true
+```
 
-knife[:cloudformation][:credentials] = {
-  :provider => :rackspace,
-  :rackspace_username => ENV['RACKSPACE_USERNAME'],
-  :rackspace_api_key => ENV['RACKSPACE_API_KEY'],
-  :rackspace_region => ENV['RACKSPACE_REGION']
-}
+### XML
+
+```xml
+<configuration>
+  <credentials>
+    AWS_CREDENTIALS
+  </credentials>
+  <options>
+    <disable_rollback>
+      true
+    </disable_rollback>
+  </options>
+</configuration>
 ```
 
-### OpenStack
+### Ruby
 
 ```ruby
-# .chef/knife.rb
-
-knife[:cloudformation][:credentials] = {
-  :provider => :open_stack,
-  :open_stack_username => ENV['OPENSTACK_USERNAME'],
-  :open_stack_password => ENV['OPENSTACK_PASSWORD'],
-  :open_stack_identity_url => ENV['OPENSTACK_IDENTITY_URL'],
-  :open_stack_tenant_name => ENV['OPENSTACK_TENANT']
-}
+Configuration.new do
+  credentials do
+    AWS_CREDENTIALS
+  end
+  options.disable_rollback true
+end
 ```
 
 ## Commands
 
-* `knife cloudformation list`
-* `knife cloudformation create`
-* `knife cloudformation update`
-* `knife cloudformation destroy`
-* `knife cloudformation events`
-* `knife cloudformation describe`
-* `knife cloudformation inspect`
-* `knife cloudformation validate`
+* `sfn list`
+* `sfn create`
+* `sfn update`
+* `sfn destroy`
+* `sfn events`
+* `sfn describe`
+* `sfn inspect`
+* `sfn validate`
 
-### `knife cloudformation list`
+### `sfn list`
 
 Provides listing of current stacks and state of each stack.
 
@@ -77,7 +90,7 @@ Provides listing of current stacks and state of each stack.
 * `--attribute ATTR` stack attribute to display
 * `--status STATUS` match stacks with given status
 
-### `knife cloudformation validate`
+### `sfn validate`
 
 Validates template with API
 
@@ -89,7 +102,7 @@ Validates template with API
 * `--[no-]apply-nesting` apply template nesting logic
 * `--nesting-bucket BUCKET` asset store bucket to place nested stack templates
 
-### `knife cloudformation create NAME`
+### `sfn create NAME`
 
 Creates a new stack with the provided name (`NAME`).
 
@@ -152,7 +165,7 @@ StackB:
 When creating StackB, if we use the `--apply-stack` option:
 
 ```
-$ knife cloudformation create StackB --apply-stack StackA
+$ sfn create StackB --apply-stack StackA
 ```
 
 when prompted for the stack parameters, we will find the parameter
@@ -171,13 +184,12 @@ _NOTE: (SparkleFormation Usage Documentation)[]._
 This plugin supports the advanced stack nesting feature provided by
 the SparkleFormation library.
 
-
 #### Translations
 
 Translations are currently an `alpha` feature and only a subset of
 resources are supported.
 
-### `knife cloudformation update STACK`
+### `sfn update STACK`
 
 Update an existing stack.
 
@@ -191,7 +203,7 @@ Update an existing stack.
 * `--[no-]apply-nesting` apply template nesting logic
 * `--nesting-bucket BUCKET` asset store bucket to place nested stack templates
 
-### `knife cloudformation destroy STACK`
+### `sfn destroy STACK`
 
 Destroy an existing stack.
 
@@ -208,12 +220,12 @@ stacks:
 running the following command:
 
 ```
-$ knife cloudformation destroy Test*
+$ sfn destroy Test*
 ```
 
 will destroy the `TestStack1` and `TestStack2`
 
-### `knife cloudformation events STACK`
+### `sfn events STACK`
 
 Display the event listing of given stack. If the state of the
 stack is "in progress", the polling option will result in
@@ -224,7 +236,7 @@ completed state.
 
 * `--[no-]poll` poll for new events until completed state reached
 
-### `knife cloudformation describe STACK`
+### `sfn describe STACK`
 
 Display resources and outputs of give stack.
 
@@ -233,7 +245,7 @@ Display resources and outputs of give stack.
 * `--resources` display resources
 * `--outputs` display outputs
 
-### `knife cloudformation inspect STACK`
+### `sfn inspect STACK`
 
 The stack inspection command simply provides a proxy to the
 underlying resource modeling objects provided via the
@@ -268,13 +280,13 @@ called on the `Miasma::Models::Orchestration::Stack` instance.
 For example, to display the JSON template of a stack:
 
 ```
-$ knife cloudformation inspect STACK -a template
+$ sfn inspect STACK -a template
 ```
 
 To display the resource collection of the stack:
 
 ```
-$ knife cloudformation inspect STACK -a resources
+$ sfn inspect STACK -a resources
 ```
 
 This will provide a list of resources. Now, to make this more
@@ -283,7 +295,7 @@ that the 3rd resource in the collection is an auto scaling
 group resource. We can isolate that resource for display:
 
 ```
-$ knife cloudformation inspect STACK -a "resources.all.at(2)"
+$ sfn inspect STACK -a "resources.all.at(2)"
 ```
 
 Note that the resources are an array, and we are using a zero
@@ -293,7 +305,7 @@ we already have seen. One of the handy features within the
 So, we can expand this resource:
 
 ```
-$ knife cloudformation inspect STACK -a "resources.all.at(2).expand"
+$ sfn inspect STACK -a "resources.all.at(2).expand"
 ```
 
 This will expand the resource instance and return the actual
@@ -305,16 +317,85 @@ contains a `servers` attribute. The output lists the IDs of the
 instances, but we can expand those as well:
 
 ```
-$ knife cloudformation inspect STACK -a "resources.all.at(2).expand.servers.map(&:expand)"
+$ sfn inspect STACK -a "resources.all.at(2).expand.servers.map(&:expand)"
 ```
 
 The attribute string will be minimally processed when proxying calls
 to the underlying models, which is why we are able to do ruby-ish
 style things.
 
+## Chef Knife Integration
+
+This library will also provide `cloudformation` subcommands
+to knife.
+
+### Configuration
+
+The easiest way to configure the plugin is via the
+`knife.rb` file. Credentials are the only configuration
+requirement, and the `Hash` provided is proxied to
+[Miasma][miasma]. All configuration options provided
+via the `sfn` command are allowed within the
+`knife[:cloudformation]` namespace:
+
+#### AWS
+
+```ruby
+# .chef/knife.rb
+
+knife[:cloudformation][:credentials] = {
+  :provider => :aws,
+  :aws_access_key_id => ENV['AWS_ACCESS_KEY_ID'],
+  :aws_secret_access_key => ENV['AWS_SECRET_ACCESS_KEY'],
+  :aws_region => ENV['AWS_REGION']
+}
+```
+
+#### Rackspace
+
+```ruby
+# .chef/knife.rb
+
+knife[:cloudformation][:credentials] = {
+  :provider => :rackspace,
+  :rackspace_username => ENV['RACKSPACE_USERNAME'],
+  :rackspace_api_key => ENV['RACKSPACE_API_KEY'],
+  :rackspace_region => ENV['RACKSPACE_REGION']
+}
+```
+
+#### OpenStack
+
+```ruby
+# .chef/knife.rb
+
+knife[:cloudformation][:credentials] = {
+  :provider => :open_stack,
+  :open_stack_username => ENV['OPENSTACK_USERNAME'],
+  :open_stack_password => ENV['OPENSTACK_PASSWORD'],
+  :open_stack_identity_url => ENV['OPENSTACK_IDENTITY_URL'],
+  :open_stack_tenant_name => ENV['OPENSTACK_TENANT']
+}
+```
+
+### Usage
+
+All commands available via the `sfn` command are available as
+knife subcommands under `cloudformation` and `sparkleformation`
+
+```
+$ knife cloudformation --help
+```
+
+or
+
+```
+$ knife sparkleformation --help
+```
+
 # Info
 
-* Repository: https://github.com/hw-labs/knife-cloudformation
-* IRC: Freenode @ #heavywater
+* Repository: https://github.com/sparkleformation/sfn
+* IRC: Freenode @ #sparkleformation
 
 [miasma]: http://miasma-rb.github.io/miasma/