bcome 0.3.4 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e5b0ebe228e2ae3369ca4014f664c632673b0a9e
-  data.tar.gz: 42cb66fcc2405cc00e45d39bbc4b21565f3ae23b
+  metadata.gz: 6679955d918e9393a9ec586ca27efefb93877575
+  data.tar.gz: 0edac73427d8221c6882854a6dfa5f6990f63aa6
 SHA512:
-  metadata.gz: 2f6990c0d55e964ffd126a4d5ab7de6a41d440cb90e3674838a384ff9841b3d07b357c656d67aa14088439ef3aa3f9eb1e6e5ade4b142ae7ce82ac54b826e5d8
-  data.tar.gz: 4ff8bd98c95b1d727c016afc7f8b93210e06c3d4424eeef1c7f2bc340e6d000672f0e26f927b9c16c46c0009858dbe3a6993e9562458314f6baa901717dc113a
+  metadata.gz: 21d4e826fbaf8c9b1467766eeb704c0af00942893ee10b29fb7049d4948471a96d4155d756b7c07a7f19349f4abd8faf349d7f9417f8d7174e9cd8e5d7d6683c
+  data.tar.gz: e0c1972cb89cc5ace8ccf739d2301825cc120f6cbc098b71e89497d5e3c6d688eca63521479bf1e06c27f64936264fa9290f3eabe3fc3f16d55a4df7c4e8c46e

data/bin/bcome

@@ -21,6 +21,13 @@ end
 # called with, e.g. bcome platform:environment:node_name:ssh
 @ssh_to.node.ssh if @ssh_in && @ssh_to
 
+## We're directly excuting a command on a n node indicated by a 'run' key at the end of our context breadrumb
+# called with, e.g. bcome platform:environment:node_name:run "command to execute"
+if @run_cmd && @run_on
+  params = ARGV[(1..(ARGV.size))].join("\s")
+  @run_on.node.run(params)
+end
+
 ## We're going to directly execute a command on a node, indicated by the method name  at the end of our context breadcrumb.
 ## This works for commands specified in the users own personal framework installation, either from a context command or from an orchestration hook
 ## e,g, bcome platform:environment:node_name:bootstrap

data/bin/boot.rb

@@ -67,7 +67,9 @@ if quick_context
   end
 end
 
-@no_shell = true if quick_contexts.last == "ssh"
+direct_commands = ["run", "ssh"]
+
+@no_shell = true if direct_commands.include?(quick_contexts.last)
 
 #########################
 ## QUICK CONTEXT & BOOT #
@@ -94,6 +96,12 @@ if quick_contexts.any?
       break
     end
 
+    if resource_context_key == "run" && index == (quick_contexts.size - 1)
+      @run_cmd = true
+      @run_on = @context_object
+      break
+    end
+
     next_context_resource = @context_object.resource_for_identifier(resource_context_key)
  
     # If we can't find our context breadcrumb, the user is perhaps specifying a direct command to be run 
@@ -101,8 +109,9 @@ if quick_contexts.any?
     # orchestration on it).
     # e.g. you have a context command called 'deploy'. You may want to do the following:
     # bcome platform:environment:deploy
+
     unless next_context_resource && index <= (quick_contexts.size - 1)
-      if @context_object.respond_to_bcome_context_method?(resource_context_key.to_sym)
+     if @context_object.respond_to_bcome_context_method?(resource_context_key.to_sym)
         @no_shell = true
         @direct_execute_method = resource_context_key.to_sym
         break

data/documentation/configuration.md

@@ -34,7 +34,7 @@ Name your configuration file “[platformName]_[EnvironmentName]-instances.yml,
 
 Two examples are given below:
 
-Example 1:  Static instances accessible directly, without the need to travers a jump host
+Example 1:  Static instances accessible directly, without the need to traverse a jump host
 
 ```
 ---

data/documentation/example_non_shell_scripts/examples_script_basic_usage.rb

@@ -1,4 +1,4 @@
-#!/Users/guillaume/.rvm/rubies/ruby-2.1.2-full/bin/ruby
+#!/usr/bin/ruby
 
 ### External script example 1
 

data/documentation/example_non_shell_scripts/examples_script_entire_estate.rb

@@ -1,4 +1,4 @@
-#!/Users/guillaume/.rvm/rubies/ruby-2.1.2-full/bin/ruby
+#!/usr/bin/ruby
 
 ### External script example 3
 

data/documentation/example_non_shell_scripts/examples_script_platform_level.rb

@@ -1,4 +1,4 @@
-#!/Users/guillaume/.rvm/rubies/ruby-2.1.2-full/bin/ruby
+#!/usr/bin/ruby
 
 ### External script example 2
 

data/documentation/examples/platform.yml-example

@@ -1,22 +1,10 @@
-
+---
 ### NOTE that you may add any attributes you like onto the platform config: using meta programming, bcome makes these accessible from the shell
 
----
-## Example platforms list. 
-# Platform have environments
-# environments have servers
 - :name: "project_foo"
   :description: "All the Foo environments"
   :location: "Some information about where this is (optional)"
+
 - :name: "project_bar"
   :description: "All the Bar environments"
-  :quick_contexts:
-
-                   # Quick link example > bcome project_bar:app1
-  - :ref: "app1"   # Provides a quick link to a server named 'app1' within Platform 'project_foo', and environment 'production'
-    :keys:
-    - "project_foo"
-    - "production"
-    - "app1"
-
-
+  :location: "Some information about where this is (optional)"

data/documentation/external_usage.md

@@ -1,5 +1,32 @@
 # External Usage
 
+## Direct SSH to nodes
+
+If you know the context breadcrumb for a node, you may SSH to it directly without accessing the node via the shell.
+
+For example, you wish to SSH in to server 'instancename' in environment 'environment' for platform 'platform':
+
+```
+  > bcome platform:environment:instancename:ssh
+  e.g.
+  > bcome myplatformname:production:appserver1:ssh
+```
+!["Direct SSH"](images/direct_ssh.png)
+
+## Direct command execution on a selection
+
+You can pass commands directly to be executed on all machines at a specific context level by using the 'run' suffix.
+
+For example, you wish to discover the free memory on all machines in platform 'wbz' and environment 'prod':
+
+```
+  > bcome wbz:prod:run "free -m"
+```
+
+The command is executed in parallel on all machines, with the output & status returned to the terminal.
+
+!["Direct command execution"](images/direct_cmd_execution.png)
+
 ## Scripting
 
 Bcome may be used for scripting outside of the bcome shell.
@@ -32,15 +59,3 @@ see documentation/example_non_shell_scripts/examples_script_platform_level.rb
 
 see documentation/example_non_shell_scripts/examples_script_entire_estate.rb
 
-## Direct SSH to nodes
-
-If you know the context breadcrumb for a node, you may use the bcome gem to SSH to it directly without accessing the node via the bcome shell.
-
-```
-
-  > bcome platform:environment:instancename:ssh
-  e.g.
-  > bcome myplatformname:production:appserver1:ssh
-
-```
-

data/documentation/usage.md

@@ -36,9 +36,9 @@ or, if with bundler
 > describe
 - Describe the resource object at the current context.
 
-> workon / w / cd
+> cd
 - Select a resource object, and switch to its context.
-e.g. cd 'identifier'
+e.g. cd identifier
 
 > exit
 - Close the current context
@@ -62,9 +62,9 @@ e.g. local "command"
 > describe
 - Describe the resource object at the current context.
 
-> workon / w / cd
+> cd
 - Select a resource object, and switch to its context.
-e.g. cd 'identifier' OR workon 'identifier' OR w 'identifier'
+e.g. cd identifier
 
 > exit
 - Close the current context
@@ -88,9 +88,9 @@ e.g. local "command"
 > describe
 - Describe the resource object at the current context.
 
-> cd / workon / w
+> cd
 - Select a resource object, and switch to its context.
-e.g. cd 'identifier' OR w 'identifier' OR workon 'identifier'
+e.g. cd identifier
 
 > exit
 - Close the current context
@@ -104,14 +104,14 @@ e.g. local "command"
 
 > add
 - Add a resource you wish to work on.
-e.g. add 'identifier', OR add ['array', 'of', 'identifiers']
+e.g. add identifier, OR add [array, of, identifiers]
 
 > add!
 - Add all resources from the current context.
 
 > remove
 - Remove a resource you no longer with to work on.
-e.g. remove 'identifier', OR remove ['array', 'of','identifiers']
+e.g. remove identifier, OR remove [array, of, identifiers]
 
 > clear!
 - Remove all selected resources.
@@ -133,7 +133,7 @@ e.g. get 'remotepath'
 e.g. run 'command'
 
 > sudo
-- Enters 'sudo' mode, resulting in 'get' or 'put' commands being execute remotely using 'sudo'. This assumes that you have passwordless sudo setup on each respective remote host.
+- Enters 'sudo' mode, resulting in 'get' or 'put' commands being executed remotely using 'sudo'. This assumes that you have passwordless sudo setup on each respective remote host.
 
 ### Instance level commands
 
@@ -146,9 +146,9 @@ e.g. run 'command'
 > describe
 - Describe the resource object at the current context.
 
-> workon / w
+> cd
 - Select a resource object, and switch to its context.
-e.g. workon 'identifier'
+e.g. cd identifier
 
 > exit
 - Close the current context

data/lib/bcome/version.rb

@@ -1,3 +1,3 @@
 module Bcome
-  VERSION = "0.3.4"
+  VERSION = "0.4.0"
 end

data/lib/become_object.rb

@@ -50,9 +50,29 @@ module ::Bcome::BecomeObject
     @resources ||= do_load_resources 
   end
 
+  def resource_identifiers
+    @resource_identifiers ||= resources.collect(&:identifier)
+  end
+
+  def identifier_for(resource)
+    r = resource.respond_to?(:identifier) ? resource.identifier : resource.to_s
+    return r
+  end
+
+  def has_potential_resources?
+    respond_to?(:config_path)  # No path to config, no resources...
+  end
+
+  def is_stack_level_resource?(constant_name)
+    return unless has_potential_resources?
+    potential_resource_name = constant_name.to_s
+    return false unless resource_identifiers.any?
+    return resource_identifiers.select{|resource| identifier_for(resource) == potential_resource_name }.any?
+  end
+
   def do_load_resources
     config = YAML.load_file(config_path)
-    return collection_klass.collection_from_config(self, config)
+    collection_klass.collection_from_config(self, config)
   end
 
   def resource_for_identifier(identifier)

data/lib/nodes/base.rb

@@ -13,6 +13,15 @@ module ::Bcome::Node
       construct(meta_data)
     end
 
+    ## Runs a command over *every* machine in this node
+    def run(raw_command, bootstrap = false)
+      return unless machines
+      machines.pmap {|machine|
+        machine.run([raw_command], bootstrap)
+      }
+      return
+    end
+
     def method_missing(method_sym, *arguments, &block)
       if instance_variable_defined?("@#{method_sym}")
         return instance_variable_get("@#{method_sym}")

data/lib/nodes/estate.rb

@@ -6,11 +6,19 @@ module ::Bcome::Node
     def machines
       platforms.collect(&:machines).flatten
     end
-  
+
     def namespace
       ""
     end  
 
+    def run(raw_command, bootstrap = false)
+      return unless platforms
+      platforms.pmap {|platform|
+        platform.run(raw_command, bootstrap)
+      }
+      return
+    end
+
     def environments
       @environments ||= platforms.collect(&:environments).flatten
     end

data/lib/stack/base.rb

@@ -9,6 +9,30 @@ module ::Bcome::Stack
       node.machines
     end
 
+    def self.const_missing(constant_name)
+      ## Hook for direct access to stack level resources by constant name where
+      ## cd ServerName should yield the same outcome as cd "ServerName" or cd :ServerName does
+      ## This works at all stack levels, and so is applied to environments and platforms too
+      stack_level_instance = ::IRB.CurrentContext.workspace.main
+      return constant_name.to_s if stack_level_instance.is_stack_level_resource?(constant_name) 
+      super
+    end
+
+    def method_missing(method_sym, *arguments, &block)
+      if command_for_context = command_for_context(method_sym)
+        execute_command_for_context(command_for_context)
+      elsif recipe = ::Bcome::Orchestrator::Recipe.by_identifier(method_sym.to_s, self)
+        puts "Executing Command Recipe #{recipe.recipe_identifier}".informational
+        puts "Description: #{recipe.description}".command
+        recipe.execute!(machines)
+        return
+      else
+        # Else, this could be a resource level item
+        return method_sym.to_s if is_stack_level_resource?(method_sym)
+        super
+      end
+    end
+
     def has_sub_nodes?
       return true
     end
@@ -29,19 +53,6 @@ module ::Bcome::Stack
       return (command_for_context(method_sym) || ::Bcome::Orchestrator::Recipe.by_identifier(method_sym.to_s, self)) ? true : false
     end
 
-    def method_missing(method_sym, *arguments, &block)
-      if command_for_context = command_for_context(method_sym)
-        execute_command_for_context(command_for_context)
-      elsif recipe = ::Bcome::Orchestrator::Recipe.by_identifier(method_sym.to_s, self)
-        puts "Executing Command Recipe #{recipe.recipe_identifier}".informational
-        puts "Description: #{recipe.description}".command
-        recipe.execute!(machines)
-        return
-      else
-        super
-      end
-    end
-
     def construct_node
       node_attributes = meta_data
 
@@ -59,7 +70,6 @@ module ::Bcome::Stack
     end
 
     def init
-      puts "loading resources #{self.class} "
       node
     end
 
@@ -97,7 +107,7 @@ module ::Bcome::Stack
       [
         { :command => "list / ls", :description => "List all available resources at the current context." },
         { :command => "describe", :description => "Describe the resource object at the current context." },
-        { :command => "cd [Node Name]", :description => "Select a resource object, and switch to its context.", :usage => "cd 'YourServerName'" },
+        { :command => "cd NodeName", :description => "Select a resource object, and switch to its context.", :usage => "cd YourServerName" },
         { :command => "exit", :description => "Return to the previous context" },
         { :command => "exit!", :description => "Close all contexts, and exit Become."},
         { :command => "local", :description => "Execute a shell command on your local machine.", :usage => 'local "command"'},

data/lib/stack/environment.rb

@@ -27,9 +27,9 @@ module ::Bcome::Stack
 
     def menu_items
       super + [
-        { :command => "add", :description => "Add a resource you wish to work on.", :usage => "add 'identifier', OR add ['array', 'of', 'identifiers']" },
+        { :command => "add", :description => "Add a resource you wish to work on.", :usage => "add MyServerIdentifier, OR add [array, of, identifiers]" },
         { :command => "add!", :description => "Add all resources from the current context." },
-        { :command => "remove", :description => "Remove a resource you no longer with to work on.", :usage => "remove 'identifier', OR remove ['array', 'of','identifiers']" },
+        { :command => "remove", :description => "Remove a resource you no longer with to work on.", :usage => "remove MyServerIdentifier, OR remove [array, of, identifiers]" },
         { :command => "clear!", :description => "Remove all selected resources." },
         { :command => "selections", :description => "Show all added resources.", :usage => "selections / s"},
         { :command => "run", :description => "Execute a command on all selected resources", :usage => "run 'command'" },

data/lib/stack/estate.rb

@@ -32,7 +32,6 @@ module ::Bcome::Stack
     end
 
     def init
-      puts "loading resources ... "
       n = ::Bcome::Node::Estate.new({ :platforms => resources.collect(&:node) })
       n.set_parent_reference(n, :estate, :platforms)
       return n

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bcome
 version: !ruby/object:Gem::Version
-  version: 0.3.4
+  version: 0.4.0
 platform: ruby
 authors:
 - Guillaume Roderick (Webzakimbo)
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-07-18 00:00:00.000000000 Z
+date: 2016-08-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk
@@ -116,8 +116,9 @@ dependencies:
         version: 1.1.1
 description: Provides a console interface for traversing a hierarchy of platforms
   -> environment -> servers, and exposes common administration tools for the managemenent
-  either of individual servers, or groups or servers. System is driven from simple
-  configuration, and is extensible. Integrates with AWS EC2 for dynamic network discover.
+  either of individual servers, or groups of servers. The system is driven from simple
+  configuration and is extensible. It integrates with AWS EC2 for dynamic network
+  discovery. Machines may be interacted with directly from the command line.
 email:
 - guillaume@webzakimbo.com
 executables:
@@ -139,6 +140,8 @@ files:
 - documentation/examples/platform.yml-example
 - documentation/external_usage.md
 - documentation/functions.md
+- documentation/images/direct_cmd_execution.png
+- documentation/images/direct_ssh.png
 - documentation/installation.md
 - documentation/usage.md
 - filters/ec2_filter.rb
@@ -213,5 +216,5 @@ rubyforge_project:
 rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
-summary: Toolkit for managing servers & organising the management of servers
+summary: Toolkit for managing machines - simplify your workflow.
 test_files: []