knife-cloudformation 0.2.16 → 0.2.18

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8f6138fcf5ddcc304b7478dd147ef1e695604947
-  data.tar.gz: fb547147dced569d4069d8a9cfca9a356c52ce09
+  metadata.gz: 677c87eed9a6f47f2a1d64292f4a8950afa75cf9
+  data.tar.gz: 381c7d8d90d90be1972a9bfa3dc1571fd82fef81
 SHA512:
-  metadata.gz: 68cb17f7dc76e7787264d7c78ef09d1c463539604ffc7c44491df1307f369caea038c939f899dfb6663a8a72a7ecd13b3ab3d45dcb3536991bc570777ec09eb9
-  data.tar.gz: 310afcce101083ac2c494eb4c2539404513f1eeb688abd6b0b0b68af19f4d3435956fa779f086badccc07f924f2de30ad879babf2cd40808e5a6d417770b2d18
+  metadata.gz: 8377709a7c24992e5aad34313ae2735501f24e2c1cfadfff8e31b410aa6efbf48c8cecace55ee30a7718043dac369bb2ac9e42e7077bffa8dfbde2e3028ad902
+  data.tar.gz: a71a840ba3c95ace1b1a0a6887a20bb067d94f0d7c48c61b2a94f25f3a8eb0b4f150f1094932b836b1e71456de37c73c349846285e718405c78fd76f2d9dd126

data/CHANGELOG.md

@@ -1,3 +1,6 @@
+## v0.2.18
+* Fix nested stack URL generation
+
 ## v0.2.16
 * Fix broken validation command (#12 thanks @JonathanSerafini)
 * Pad stack name indexes when unpacked

data/README.md

@@ -1,51 +1,55 @@
 # Knife CloudFormation
 
-A plugin for the knife command provided by Chef to
-interact with AWS CloudFormation.
+This is a plugin for the `knife` command provided by
+Chef to interact with AWS (and other) orchestration
+APIs.
 
-## Compatibility
+## API Compatibility
 
-This plugin now provides support for other cloud
-orchestration APIs as well:
-
-* OpenStack
+* AWS
 * Rackspace
+* OpenStack
 
 ## 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][miasma]:
+
+### 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']
 }
 ```
 
-If are using Rackspace:
+### 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']
 }
 ```
 
-If are using OpenStack:
+### 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'],
@@ -64,7 +68,253 @@ knife[:cloudformation][:credentials] = {
 * `knife cloudformation inspect`
 * `knife cloudformation validate`
 
+### `knife cloudformation list`
+
+Provides listing of current stacks and state of each stack.
+
+#### Supported options
+
+* `--attribute ATTR` stack attribute to display
+* `--status STATUS` match stacks with given status
+
+### `knife cloudformation validate`
+
+Validates template with API
+
+#### Supported options
+
+* `--[no-]processing` enable template processing
+* `--file PATH` path to stack template file
+* `--translate PROVIDER` translate template to provider
+* `--[no-]apply-nesting` apply template nesting logic
+* `--nesting-bucket BUCKET` asset store bucket to place nested stack templates
+
+### `knife cloudformation create NAME`
+
+Creates a new stack with the provided name (`NAME`).
+
+#### Supported options
+
+* `--timeout MINUTES` stack creation timeout limit
+* `--[no-]rollback` disable rollback on failure
+* `--capability CAPABILITY` enable capability within API
+* `--notifications ARN` add notification ARN
+* `--print-only` print stack template JSON and exit
+* `--apply-stack NAME` apply existing stack outputs
+* `--[no-]processing` enable template processing
+* `--file PATH` path to stack template file
+* `--translate PROVIDER` translate template to provider
+* `--[no-]apply-nesting` apply template nesting logic
+* `--nesting-bucket BUCKET` asset store bucket to place nested stack templates
+
+#### Apply Stacks
+
+The `--apply-stack` option allows providing the name of an existing
+stack when creating or updating. Applying stacks is simply fetching
+the outputs from the applied stacks and automatically defaulting the
+set parameter of the new or updated stack. Outputs are matched
+by name to the parameters of the target stack. This allows an easy
+way to use values from existing stacks when building new stacks.
+
+Example:
+
+StackA:
+
+```json
+...
+  "Outputs": {
+    "LoadBalancerAddress": {
+      "Description": "Address of Load Balancer",
+      "Value": {
+        "Fn::GetAtt": [
+          "LoadBalancerResource",
+          "DNSName"
+        ]
+      }
+    }
+  }
+...
+```
+
+StackB:
+
+```json
+...
+  "Parameters": {
+    "LoadBalancerAddress": {
+      "Type": "String",
+      "Default": "unset"
+    }
+  }
+...
+```
+
+When creating StackB, if we use the `--apply-stack` option:
+
+```
+$ knife cloudformation create StackB --apply-stack StackA
+```
+
+when prompted for the stack parameters, we will find the parameter
+value for `LoadBalancerAddress` to be filled in with the output
+provided from StackA.
+
+#### Processing
+
+The default behavior of this plugin assumes templates will be
+in JSON format. The `--processing` flag will allow providing Ruby
+files to dynamically generate templates using the SparkleFormation
+library.
+
+_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`
+
+Update an existing stack.
+
+#### Supported options
+
+* `--print-only` print stack template JSON and exit
+* `--apply-stack NAME` apply existing stack outputs
+* `--[no-]processing` enable template processing
+* `--file PATH` path to stack template file
+* `--translate PROVIDER` translate template to provider
+* `--[no-]apply-nesting` apply template nesting logic
+* `--nesting-bucket BUCKET` asset store bucket to place nested stack templates
+
+### `knife cloudformation destroy STACK`
+
+Destroy an existing stack.
+
+#### Name globs
+
+The destroy command supports globbing for performing multiple
+destructions based on glob match. For example, given existing
+stacks:
+
+* TestStack1
+* TestStack2
+* Production
+
+running the following command:
+
+```
+$ knife cloudformation destroy Test*
+```
+
+will destroy the `TestStack1` and `TestStack2`
+
+### `knife cloudformation events STACK`
+
+Display the event listing of given stack. If the state of the
+stack is "in progress", the polling option will result in
+polling and displaying new events until the stack reaches a
+completed state.
+
+#### Supported options
+
+* `--[no-]poll` poll for new events until completed state reached
+
+### `knife cloudformation describe STACK`
+
+Display resources and outputs of give stack.
+
+#### Supported options
+
+* `--resources` display resources
+* `--outputs` display outputs
+
+### `knife cloudformation inspect STACK`
+
+The stack inspection command simply provides a proxy to the
+underlying resource modeling objects provided via the
+[miasma][miasma] library. It also provides extra helpers for
+running common inspection commands.
+
+### Supported options
+
+* `--nodes` list node addresses within stack
+* `--instance-failure [LOG_FILE]` print log file from failed instance
+* `--attribute ATTR` print stack attribute
+
+#### `--nodes`
+
+This option will return a list of compute instance IDs and
+their addresses. The result will be a complete list including
+direct compute resources within the stack as well as compute
+resources that are part of auto scaling group resouces.
+
+#### `--instance-failure [LOG_FILE]`
+
+If the stack create or update failed due to a compute instance,
+this option will attempt to locate the instance, connect to
+it and download the defined log file. The default log file
+is set to: `/var/log/chef/client.log`
+
+#### `--attribute ATTR`
+
+The attribute option is what provides the proxy to the underlying
+[miasma][miasma] resource modeling. The value of `ATTR` is what should be
+called on the `Miasma::Models::Orchestration::Stack` instance.
+For example, to display the JSON template of a stack:
+
+```
+$ knife cloudformation inspect STACK -a template
+```
+
+To display the resource collection of the stack:
+
+```
+$ knife cloudformation inspect STACK -a resources
+```
+
+This will provide a list of resources. Now, to make this more
+useful, we can start inspect specific resources. Lets assume
+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)"
+```
+
+Note that the resources are an array, and we are using a zero
+based index. Now, this simply provides us with the information
+we already have seen. One of the handy features within the
+[miasma][miasma] library is the ability to expand supported resources.
+So, we can expand this resource:
+
+```
+$ knife cloudformation inspect STACK -a "resources.all.at(2).expand"
+```
+
+This will expand the resource instance and return the actual
+auto scaling group resource. The result will provide more detailed
+information about the scaling group. But, perhaps we are looking
+for the instances in this scaling group. The model instance we
+now have (`Miasma::Orchestration::Models::AutoScale::Group`)
+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)"
+```
+
+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.
+
 # Info
 
 * Repository: https://github.com/hw-labs/knife-cloudformation
-* IRC: Freenode @ #heavywater
+* IRC: Freenode @ #heavywater
+
+[miasma]: http://miasma-rb.github.io/miasma/

data/lib/knife-cloudformation/knife/template.rb

@@ -38,7 +38,7 @@ module KnifeCloudformation
                   bucket = provider.connection.api_for(:storage).buckets.get(
                     Chef::Config[:knife][:cloudformation][:nesting_bucket]
                   )
-                  if(options[:print_only])
+                  if(config[:print_only])
                     "http://example.com/bucket/#{name_args.first}_#{stack_name}.json"
                   else
                     unless(bucket)

data/lib/knife-cloudformation/version.rb

@@ -1,4 +1,4 @@
 module KnifeCloudformation
   # Current library version
-  VERSION = Gem::Version.new('0.2.16')
+  VERSION = Gem::Version.new('0.2.18')
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: knife-cloudformation
 version: !ruby/object:Gem::Version
-  version: 0.2.16
+  version: 0.2.18
 platform: ruby
 authors:
 - Chris Roberts
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-01-20 00:00:00.000000000 Z
+date: 2015-02-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: chef