bbc-cosmos-tools 0.4.7 → 0.4.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 492f8a9eefc93f2f44eb6d4eebad0029c176d9b9
-  data.tar.gz: 52630345de2938c85b723c312519a314aac84e3c
+  metadata.gz: 7db221b6b93010b239a0c32fb906e97eb165cdb0
+  data.tar.gz: 8aa274b2211987d1d2070e666eb6955c3e889239
 SHA512:
-  metadata.gz: 1eb1e8a637133872bad96d66b6972722ad14c1b9d1a8191aae71140ebcf60c68e4f4812eb0d65697f137015b728bed2b042c3b339eed121cb4ff94607a1f2f13
-  data.tar.gz: 11df4e11f42d2e844ea5db5c35eea750be84234f2bea03dadcb52b58c52f70f3b63441192c390bb40330645200eda3943c841457fc018d322310a3ca3f626aa5
+  metadata.gz: 5d85f66bff947dc33d40b6c117b82af8b330808255214f2783b65920d0c74c20d4ec8bbb4c8ae390b5f1bf720903d97b5d4311afbca812b21f0248accbd2bd34
+  data.tar.gz: a855c71c806fe1662700ac3d8f2cae877f7006cc10db62096208b51c70bc0e4d38b2815de5a602a4c8b2ddca387461f19b9d15f87d3041494ad3398f8426b0cd

data/README.md

@@ -13,10 +13,11 @@ The [BBC Cosmos Tool](https://github.com/BBC-News/bbc-cosmos-tools) is a Ruby ge
 The gem supports the following features:
 
 - Pushing component config to the cosmos API
-- Creating stacks for a component in cosmos
-- Updating stacks for a component in cosmos
+- Create/update and delete stacks for a component in cosmos
+- Do release and snapshot deployments to any environment
+- List instances running for a component and filter by tag
 
-The gem also supports the following formats:
+The gem supports the following formats:
 
 - [CFNDSL](https://github.com/stevenjack/cfndsl)
 - YAML
@@ -82,7 +83,7 @@ But be aware you can have multiple "stacks" for a component (it's just a structu
 This could be (for example) a Scaling Group, IAM policy, SQS, or DynamoDB (any AWS service)  
 
 - `{type}`  
-This is a sub section of the resource  
+This is a subsection of the resource
 e.g. if the resource was `AWS::SQS::Queue` then this file would be named `queue.rb`  
 
 > Note: if you're using the YAML or JSON formats then the following structure is used (notice it's *almost* identical)
@@ -157,11 +158,12 @@ bbc:
     stack_events: '/cosmos/env/%s/component/%s/stack/%s/events'
     stacks: '/cosmos/env/%s/component/%s/stacks'
     stack_delete: '/cosmos/env/%s/component/%s/stack/%s/delete'
+    stack_details: '/cosmos/env/%s/component/%s/stack/%s'
 ```
 
 Where as the contents of `{component}.yaml.erb` can look like the following:
 
-```erb
+```yaml
 components:
   '{component}':
     s3_bucket_id: "foo"
@@ -170,7 +172,7 @@ components:
 
 In YAML you can get fancy and make certain properties more re-usable by using `&` to create an "anchor" which you can then reference with `*`, along with `<<:` to inject content. See the following file for an example (although it’s not a very good example as there would be no need to use any of those features for such a small file, but hopefully it gives you an idea on how they are used)…
 
-```erb
+```yaml
 base: &shared
   s3_bucket_id: "foo"
   s3_object_path: "bar"
@@ -202,7 +204,7 @@ base: &shared
 components:
   'test_component':
     <<: *shared
-	some_specific_value: 'foo, bar'
+    some_specific_value: 'foo, bar'
 ```
 
 The config has a number of components under a project, and the shared key allows you to
@@ -218,8 +220,8 @@ is only the API endpoints.
 bbc:
   cosmos:
     api: "https://www.my.api.com"
-	create_endpoint: "/some/restful/endpoint"
-	update_endpoint: "/some/restful/endpoint"
+    create_endpoint: "/some/restful/endpoint"
+    update_endpoint: "/some/restful/endpoint"
 ```
 
 ### Resources
@@ -251,7 +253,7 @@ cloudformation:
 
 The project resources yaml file is used to describe the resources used within the project. The reason for having a single file is that you can define resources that are used in the cloudformation templates and config, so when for example an ARN changes this will be picked up across the CF templates and the config.
 
-The file is spilt up into two section:
+The file is split up into two section:
 
 * The standard resource list, this is generally the ARNS for all the resources your component uses.
 * Cloudformation parameters (These are usually referenced from the aforementioned)
@@ -261,30 +263,29 @@ Below is an annotated example of a resource config:
 ```yaml
 
 sequencer:
-	name: 'example_name'
-	arn: 'example_arn'
+  name: 'example_name'
+  arn: 'example_arn'
 
 roles:
-	broker:
-		name: &roles_broker_name 'some_iam_role_name'
+  broker:
+    name: &roles_broker_name 'some_iam_role_name'
 
 cloudformation:
-	shared: &component_shared #<- This node is ignored, it's used as a base for other config templates
-		ACFParameter: 'Value'
-		AnotherCFParameter: 'Another value'
-
-	components:
-		'my-example-component': #<- The name of the component in cosmos
-			main: <- This is the name of the stack in cosmos
-				variants: <- This is so you can have a different variant of the same config, i.e for int/test one for durning the day and one for evening/weekends.
-					default: &my-example-component_default #<- We set this anchor so we can use this defaults in other variants
-						<<: *component_shared #<- We import the shared component params into these so we're not duplicating
-						ARoleParamForDefault: *roles_broker_name #<- We use the anchor for the roles set above to add them here, again stopping repitition
-					scheduled:
-						<<: *my-example-component_default
-						MinSize: 0
-						MaxSize: 0
-						
+  shared: &component_shared #<- This node is ignored, it's used as a base for other config templates
+    ACFParameter: 'Value'
+    AnotherCFParameter: 'Another value'
+
+  components:
+    'my-example-component': #<- The name of the component in cosmos
+      main: <- This is the name of the stack in cosmos
+        variants: <- This is so you can have a different variant of the same config, i.e for int/test one for during the day and one for evening/weekends.
+          default: &my-example-component_default #<- We set this anchor so we can use this defaults in other variants
+            <<: *component_shared #<- We import the shared component params into these so we're not duplicating
+            ARoleParamForDefault: *roles_broker_name #<- We use the anchor for the roles set above to add them here, again stopping repetition
+          scheduled:
+            <<: *my-example-component_default
+            MinSize: 0
+            MaxSize: 0
 ```
 
 ### Stacks
@@ -364,26 +365,6 @@ There are a few example projects using this tool now:
 
 > The reason some of the projects choose to locate their configuration in a separate repo is because they're made up of a number of different components.
 
-## API reference
-
-The gem is a cli application, and so the commands are self documenting; but below is a list of the commands for each set of sub commands
-
-### Cosmos Config
-
-```bash
-bbc-cosmos-tools config generate
-bbc-cosmos-tools config push
-bbc-cosmos-tools config list
-```
-
-### Cloudformation
-
-```bash
-bbc-cosmos-tools cf generate
-bbc-cosmos-tools cf create
-bbc-cosmos-tools cf update
-```
-
 ### Help?
 
 You can use the built-in `help` command to see a list of parameters and options that need to be passed into the command you wish to execute. For example, if we were unsure of the options for the `stack` command then we would execute `bbc-cosmos-tools help stack` and this would display the following output:

data/lib/bbc/cosmos/tools/types/base_type.rb

@@ -1,4 +1,5 @@
 require "bbc/cosmos/tools/cloudformation/generator"
+require "json"
 
 module BBC
   module Cosmos
@@ -11,12 +12,12 @@ module BBC
             @config  = config
           end
 
-          def generate_data
+          def generate_data(to_json = false)
             if valid_component_and_stack
               get_parameters.each do |key, value|
                 data['Parameters'][key]['Default'] = value if data['Parameters'][key]
               end
-              data
+              to_json ? JSON.pretty_generate(data) : data
             end
           end
 
@@ -45,3 +46,4 @@ module BBC
     end
   end
 end
+

data/lib/bbc/cosmos/tools/version.rb

@@ -1,7 +1,7 @@
 module BBC
   module Cosmos
     module Tools
-        VERSION = "0.4.7"
+        VERSION = "0.4.8"
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bbc-cosmos-tools
 version: !ruby/object:Gem::Version
-  version: 0.4.7
+  version: 0.4.8
 platform: ruby
 authors:
 - Steven Jack
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-12-11 00:00:00.000000000 Z
+date: 2015-01-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler