bbc-cosmos-tools 0.8.0 → 0.8.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 204d2769528dc7478f8989d2a95838703b341c1e
-  data.tar.gz: edc6e26631b88bb768c7fb9e1bb317e8c7995748
+  metadata.gz: 24f317d2a990335a077f7b7721b2111527ed6a0d
+  data.tar.gz: 62d85ae9ee1ef88e4b58467266bce0584ab34408
 SHA512:
-  metadata.gz: fff3c9de80096d918b73051529ced1a1bf116712b1130a5262ebbf440d3fa862beb99f7ff7dbeb449205259a58989b785b12322133139e0a758bda6bd1319063
-  data.tar.gz: b1dc7fc87cc39170975caef9cae71ed5bff5c3864d6e7833e0ca5cc31a705676c8da7a213442bae6c4686296d16d63a3e30c816ac8918df750d661155a334fdb
+  metadata.gz: 091548ded09eb18f11c45b2005a34a963f1674b16370455c795617be2c97e15bf06adbb9f12955f0b54c5c101b32a4b739e15df01760b7e97d40d2241a0de883
+  data.tar.gz: 05d0c3c58121c36278159e2c57cd9b426f5caa757240e208ebf5b9194d46c60e56b39c30d0bc1c595e0c4e70b77d14f87855975149acc251e0dbfa8b7032c010

data/README.md

@@ -159,6 +159,7 @@ bbc:
     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'
+    stack_template: '/cosmos/env/%s/component/%s/stack/%s/template'
 ```
 
 > Note: `stack_details` is needed for when a stack update happens. As we don't have all the config values that Cosmos should automatically add in for us when it's created, we need to get them from Cosmos and add them to the parameter list when doing the update
@@ -187,6 +188,22 @@ components:
     <<: *shared
 ```
 
+##### Secure values
+
+The cosmos API allows you to mark certain values as "secure" when adding them to the API. This means that when hitting the config REST endpoint, anything marked as secure won't show. It'll only be available when it's baked onto the instance. This is useful for stuff like API keys etc where you don't want everyone with a dev cert being able to see/use it.
+
+To use this you need to have the following structure for a key in your config:
+
+```yaml
+components:
+  my_component:
+    api_key:
+      secure: true
+      value: "SUPER_SECRET_KEY"
+    foo: bar
+    bar: qux
+```
+
 #### Using CFNDSL
 
 The project config is an ERB template that is renderer into a YAML file. it gets passed all resources from the resource config that can be used in the template. Below is an example of this:
@@ -251,7 +268,7 @@ cloudformation:
               {parameter_a}: value
               {parameter_b}: value
               {parameter_c}: value
-      
+
 ```
 
 #### Using CFNDSL
@@ -378,7 +395,7 @@ There are a few example projects using this tool now:
 
 ### 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:
+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 stack help` and this would display the following output:
 
 ```bash
 Commands:
@@ -391,6 +408,70 @@ Commands:
   bbc-cosmos-tools stack update [COMPONENT = nil]                # Generates and updates the cloudformation t...
 ```
 
+### SSH
+
+You can SSH into an instance quickly by calling the component ssh command such as:
+
+```bash
+bbc-cosmos-tools component ssh news-javelin --env=live
+
+Your IP for i-38c96895 is 10.0.233.46
+```
+
+If there are multiple instances for a component, a list will be provided to let you chose an instance ID:
+
+```bash
+bbc-cosmos-tools component ssh news-jenkins-agent --env=live
+
+Multiple instances detected, please select one
+1. i-67ad08ca
+2. i-be8e9814
+?  1 ### Selection
+
+Creating Session
+Creating Session
+Creating Session
+Creating Session
+
+Your IP for i-67ad08ca is 10.0.234.217
+```
+### Other Commands
+
+List Instances
+```bash
+bbc-cosmos-tools component instances news-javelin --env=live
+
+Instance ID
+i-38c96895
+```
+
+List Releases
+```bash
+bbc-cosmos-tools release list news-javelin
+
+Component: news-javelin
+Version      Created at
+0.1.6-1.el6  2015-06-30T16:10:54+01:00
+```
+
+List Deployed Releases
+```bash
+bbc-cosmos-tools release deployed news-javelin --env=live
+
+Component: news-javelin
+Release       Deployed at                Deployment id  Deployed by                  Status
+0.1.83-1.el6  2015-07-16T15:39:59+01:00  282759         PlatformToolsTeam@bbc.co.uk  done
+```
+
+Redeploy a Component
+```bash
+bbc-cosmos-tools release redeploy news-release --env=int
+
+news-release successfully redeployed
+View deployment of news-release here https://admin.live.bbc.co.uk/cosmos/env/int/deployment/286431
+```
+
+
 ## Contributing
 
 1. Fork it

data/bbc-cosmos-tools.gemspec

@@ -26,4 +26,6 @@ Gem::Specification.new do |spec|
   spec.add_runtime_dependency "cfndsl"
   spec.add_runtime_dependency "aws-sdk", "~> 1.63.0"
   spec.add_runtime_dependency "highline"
+  spec.add_runtime_dependency "easy_diff"
+  spec.add_runtime_dependency "ansi"
 end

data/lib/bbc/cosmos/tools/commands/component.rb

@@ -17,7 +17,11 @@ module BBC
 
             tag = options[:show_tag]
 
-            rows = instance_ids(component).map do |id|
+            rows = instance_ids(component).each_with_index.map do |id, i|
+              meta = make_request("env/#{options[:env]}/component/#{component}/instances")
+              ip = meta[i]["private_ip_address"]
+              id = "#{id} (#{ip})"
+
               [id].tap do |row|
                 row << ec2.instances[id].tags[tag] if tag
               end

data/lib/bbc/cosmos/tools/commands/config.rb

@@ -16,7 +16,7 @@ module BBC
             @cosmos_config = BBC::Cosmos::Tools::CosmosConfiguration.new(config)
           end
 
-          desc "config generate [COMPONENT]", "Generates config for the given component optionally in the cosmos format"
+          desc "generate [COMPONENT]", "Generates config for the given component optionally in the cosmos format"
           method_option :output, :type => :string, :desc => "Output type", :default => "normal"
           method_option :write, :type => :boolean, :desc => "write output to file", :default => false
           method_option :cosmos_format, :type => :boolean, :desc => "Toogles if the output should be in the cosmos format"
@@ -47,7 +47,7 @@ module BBC
             end
           end
 
-          desc "config list", "Lists all components for a given project"
+          desc "list", "Lists all components for a given project"
           method_option :output, :type => :string, :desc => "Output type", :default => "normal"
           def list
             if options[:output] == "machine"
@@ -71,7 +71,7 @@ module BBC
             end
           end
 
-          desc "config push [COMPONENT_ID = nil]", "Push config for a component to the cosmos API"
+          desc "push [COMPONENT_ID = nil]", "Push config for a component to the cosmos API"
           method_option :force, :type => :boolean, :desc => "This skips asking of you want to push the changes"
           def push(component_id = nil)
             components = component_id.nil? ? cosmos_config.component_keys : [component_id]

data/lib/bbc/cosmos/tools/commands/release.rb

@@ -34,7 +34,7 @@ module BBC
           end
 
           method_option :tags, :type => :array, :default => nil
-          desc "release list [COMPONENT = nil]", "Lists releases for a component"
+          desc "list [COMPONENT = nil]", "Lists releases for a component"
           def list(component = nil)
             say banner
 
@@ -61,7 +61,7 @@ module BBC
             error e.message
           end
 
-          desc "release deploy [COMPONENT = nil, RELEASE_ID = nil]", "Deploys a release to the specific enironment"
+          desc "deploy [COMPONENT = nil, RELEASE_ID = nil]", "Deploys a release to the specific enironment"
           method_option :tags, :type => :array, :default => nil, :desc => "The tags of the components you want to deploy (i.e 'renderer')"
           method_option :from, :type => :string, :default => "release", :desc => "The location that the deployment shold be taken from (release|int|test)"
           def deploy(component = nil, release_id = nil)
@@ -125,7 +125,7 @@ module BBC
             end
           end
 
-          desc "release deployed [COMPONENT = nil]", "Lists releases deloyed for a component in the specified environment"
+          desc "deployed [COMPONENT = nil]", "Lists releases deloyed for a component in the specified environment"
           method_option :tags, :type => :array, :default => nil, :desc => "The tags of the components you want to deploy (i.e 'renderer')"
           def deployed(component = nil)
             say banner

data/lib/bbc/cosmos/tools/commands/stack.rb

@@ -3,6 +3,8 @@ require "bbc/cosmos/tools/config"
 require "bbc/cosmos/tools/commands/base"
 require "bbc/cosmos/tools/cloudformation/generator"
 require "bbc/cosmos/tools/types/factory"
+require "easy_diff"
+require "ansi/code"
 
 module BBC
   module Cosmos
@@ -26,7 +28,7 @@ module BBC
             @api = BBC::Cosmos::Tools::API.new(config.app["api"], options[:key_path])
           end
 
-          desc "stack list [COMPONENT = nil]", "Lists stacks for a component"
+          desc "list [COMPONENT = nil]", "Lists stacks for a component"
           method_option :tags, :type => :array, :default => nil, :desc => "The tags of the components you want to deploy (i.e 'renderer')"
           def list(component = nil)
             say "#{banner}\n"
@@ -61,7 +63,7 @@ module BBC
 
           method_option :variant, :type => :string, :default => "default", :desc => "The variant to use, i.e default|scheduled"
           method_option :group, :type => :string, :default => nil, :desc => "The group name to override the component id"
-          desc "stack generate [COMPONENT]", "Generates a cloudformation template based on a type of component, the identifier and the environment"
+          desc "generate [COMPONENT]", "Generates a cloudformation template based on a type of component, the identifier and the environment"
           def generate(component)
             say "#{banner(component)}\n"
 
@@ -73,7 +75,7 @@ module BBC
           method_option :variant, :type => :string, :default => "default", :desc => "The variant to use, i.e default|scheduled"
           method_option :group, :type => :string, :default => nil, :desc => "The group name to override the component id"
           method_option :tags, :type => :array, :default => nil, :desc => "The tags of the components you want to deploy (i.e 'renderer')"
-          desc "stack create [COMPONENT, MAIN_STACK = true]", "Generates and create the cloudformation template for the specific component"
+          desc "create [COMPONENT, MAIN_STACK = true]", "Generates and create the cloudformation template for the specific component"
           def create(component = nil, main_stack = "true")
             say "#{banner}\n"
 
@@ -107,7 +109,7 @@ module BBC
           method_option :variant, :type => :string, :default => "default", :desc => "The variant to use, i.e default|scheduled"
           method_option :group, :type => :string, :default => nil, :desc => "The group name to override the component id"
           method_option :tags, :type => :array, :default => nil, :desc => "The tags of the components you want to deploy (i.e 'renderer')"
-          desc "stack update [COMPONENT = nil]", "Generates and updates the cloudformation template for the specific component"
+          desc "update [COMPONENT = nil]", "Generates and updates the cloudformation template for the specific component"
           def update(component = nil)
             say "#{banner}\n"
 
@@ -147,7 +149,52 @@ module BBC
             end
           end
 
-          desc "stack delete [COMPONENT]", "Deletes a stack"
+          method_option :variant, :type => :string, :default => "default", :desc => "The variant to use, i.e default|scheduled"
+          method_option :group, :type => :string, :default => nil, :desc => "The group name to override the component id"
+          method_option :tags, :type => :array, :default => nil, :desc => "The tags of the components you want to deploy (i.e 'renderer')"
+          desc "stack diff [COMPONENT = nil]", "Diffs the locally generated cloudformation template with that in cosmos"
+          def diff(component = nil)
+            components(options, component).each do |id|
+              stack_name = "#{options[:env]}-#{id}-#{options[:stack]}"
+              response = api.get sprintf(config.app["stack_template"], options[:env], id, stack_name)
+
+              ### Copy-pasted: extract this logic out
+              type = Tools::Types::Factory.create(id, options, config)
+              data = type.generate_data.tap do |d|
+                @l.call(d, id, options[:env])
+              end
+
+              stack_meta = stack_data(component, stack_name, options[:env])
+
+              if data["Parameters"]
+                data["Parameters"] = deep_merge(
+                  stack_parameters(stack_meta["parameters"], data["Parameters"]),
+                  data["Parameters"]
+                )
+
+                params = Tools::Cloudformation::Generator.parameters(data, false)
+              end
+
+              post_data = {
+                "template"   => data,
+                "parameters" => params || {}
+              }
+              ###
+              
+              if response.success?
+                original_template = JSON.parse(response.body)
+
+                removed, added = original_template.easy_diff(data)
+
+                say JSON.pretty_generate(removed), :red
+                say JSON.pretty_generate(added), :green
+              else
+                api_error(response, false)
+              end
+            end
+          end
+
+          desc "delete [COMPONENT]", "Deletes a stack"
           def delete(component)
             say "#{banner(component)}\n"
 
@@ -168,7 +215,7 @@ module BBC
             end
           end
 
-          desc "stack events [COMPONENT = nil]", "Shows the stack events for a component"
+          desc "events [COMPONENT = nil]", "Shows the stack events for a component"
           method_option :stack, :type => :string, :default => "main", :desc => "The name of the stack to use"
           method_option :limit, :type => :numeric, :default => 5, :desc => "Limit how many records to show"
           method_option :tags, :type => :array, :default => nil, :desc => "The tags of the components you want to deploy (i.e 'renderer')"

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

@@ -23,9 +23,22 @@ module BBC
 
         def cosmos_component(id)
           component(id).reduce([]) do |object, (key, value)|
-            object.tap { |o| o << { :value => value, :key => key } }
+            object.tap do |o|
+              o << {
+                :value  => secure_key?(value) ? value["value"] : value,
+                :key    => key,
+                :secure => secure_key?(value)
+              }
+            end
           end
         end
+
+        private
+
+        def secure_key?(value)
+          value.is_a?(Hash) && value["secure"]
+        end
+
       end
     end
   end

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

@@ -1,7 +1,7 @@
 module BBC
   module Cosmos
     module Tools
-      VERSION = "0.8.0"
+      VERSION = "0.8.1"
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bbc-cosmos-tools
 version: !ruby/object:Gem::Version
-  version: 0.8.0
+  version: 0.8.1
 platform: ruby
 authors:
 - Steven Jack
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-06-11 00:00:00.000000000 Z
+date: 2015-07-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -108,6 +108,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: easy_diff
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: ansi
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Tool for interacting with BBC Cosmos platform
 email:
 - stevenmajack@gmail.com