bcome 0.0.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f232736b42afc8eb14ae4df636a3b7b6eccb7d0e
+  data.tar.gz: f260940851ea03b9d2bfdfd863883468958cf8fc
+SHA512:
+  metadata.gz: 02936421eec97fdeeddc3318adea9d7ae7e5b591164130f90b1ecf7a6e10a544374b260f047bc2309ce8087e4f5adec43b287d4c4b06af0057e0cb83f546492a
+  data.tar.gz: bf8b6c1262e05bf9201538f4d8c478d09bae2248477c0338cd4df26471885640baf10626d9172fd09cdc6344913acaab99fd9feb02e49681eb462d8b136c8add

data/bin/bcome

@@ -0,0 +1,99 @@
+#!/usr/bin/env ruby
+
+# (C) Guillaume Roderick (webzakimbo)
+# MIT licence.
+
+require 'bcome'
+Dir[Dir.pwd  + "/bcome/patches/**/*.rb"].each {|file| load file }
+
+VERBOSE = true  
+START_PROMPT = "bcome"
+
+# The ssh_mode identifier in platforms.yml signifying that this platform is to be accessed via an SSH bastion machine
+SSH_JUMP_MODE_IDENTIFIER = "jump"
+
+# The ssh mode identifier in platforms.yml signifying that this platform is to be accessed directly
+SSH_DIRECT_MODE_IDENTIFIER = "direct"
+
+# The SSH role in instances.yml signifying that an instance is an SSJ jump host
+SSH_JUMP_HOST_ROLE_IDENTIFIER = "sshjumphost"
+
+## The base resource classes - may be overriden
+PLATFORM_STACK_KLASS = ::Bcome::Stack::Platform
+ENV_STACK_KLASS = ::Bcome::Stack::Environment
+INSTANCE_STACK_KLASS = ::Bcome::Stack::Instance
+
+##################
+## DEPENDENCIES ##
+##################
+
+## Filters are loaded lower down as modules, and hence need to be include first
+Dir[Dir.pwd  + "/bcome/filters/**/*.rb"].each {|file| load file }
+
+quick_contexts = []
+
+BECOME = ::Bcome::WorkspaceContext.new 
+BOOT = ::Bcome::Boot.new
+RENDER = ::Bcome::RenderIrb.new
+
+###########################
+## MANAGE QUICK CONTEXTS  #
+###########################
+if ARGV[0] 
+  quick_context = ARGV[0]  
+  quick_context =~ /(.+):(.+)/
+  platform_key = $1
+  context_reference = $2
+
+  unless platform_key && context_reference 
+    puts "Quick context is missing platform key or the context reference".failure
+    exit 1
+  end
+
+  unless platform = BOOT.resource_for_identifier(platform_key)
+    puts "Cannot find platform named #{platform_key}".failure
+    exit
+  end
+
+  unless platform.has_quick_contexts? && (context = platform.quick_context_for_reference(context_reference))
+    puts "No quick context found on platform #{platform_key} for reference #{context_reference}".failure
+    exit
+  end
+
+  quick_contexts = context[:keys]
+end
+
+####################
+## BASIC IRB SETUP #
+####################
+IRB.setup nil
+IRB.conf[:MAIN_CONTEXT] = IRB::Irb.new.context
+
+#########################
+## QUICK CONTEXT & BOOT #
+#########################
+
+context_object = BOOT
+
+if quick_contexts.any?
+  spawn = false
+  quick_contexts.each do |resource_context_key|
+    next_context_resource = context_object.resource_for_identifier(resource_context_key)
+
+    if next_context_resource.nil?
+      puts "Cannot find any resources object named: #{resource_context_key}. Please check your quick contexts and try again".failure
+      exit
+    end
+
+    BECOME.set(next_context_resource, context_object, spawn)
+    context_object = next_context_resource
+  end
+end
+
+##################
+## INIT SESSION ##
+##################
+
+require 'irb/ext/multi-irb'
+IRB.parse_opts_with_ignoring_script
+IRB.irb nil, context_object

data/bin/bcome-setup

@@ -0,0 +1,43 @@
+#!/usr/bin/env ruby
+
+# (C) Guillaume Roderick (webzakimbo)
+# MIT licence.
+
+require 'fileutils'
+bcome_resource_dir = "bcome"
+
+config_dir = "#{bcome_resource_dir}/config"
+filters_dir = "#{bcome_resource_dir}/filters"
+patches_dir = "#{bcome_resource_dir}/patches"
+static_instances_dir = "#{config_dir}/static_instances"
+
+## INSTALL APPLICATION DIRECTORIES
+directories = [
+  filters_dir,
+  patches_dir,
+  static_instances_dir
+]
+
+directories.each do | directory |
+  FileUtils::mkdir_p(directory)
+end
+
+gem_install_path = File.dirname(__FILE__)
+conf_example_path = "#{gem_install_path}/../documentation/examples"
+application_path = Dir.pwd
+
+["platform.yml-example","network.yml-example"].each do |example_conf|
+  transfer_cmd = "rsync -aq #{conf_example_path}/#{example_conf} #{application_path}/#{config_dir}/#{example_conf}"
+  system(transfer_cmd)
+end
+
+## Copy our patches over
+patches_cp_cmd = "cp #{gem_install_path}/../patches/irb.rb #{application_path}/bcome/patches/"
+system(patches_cp_cmd)
+
+## And copy our filters
+filters_cp_cmd = "rsync -aq #{gem_install_path}/../filters/ec2_filter.rb #{application_path}/bcome/filters/"
+system(filters_cp_cmd)
+
+
+exit 0

data/documentation/configuration.md

@@ -0,0 +1,71 @@
+# Configuration
+
+## Define your platforms
+
+Bcome assume that you have ‘platforms’. It assumes that a platform has ‘environments’, and that an environment has a collection of servers.
+
+### The platforms config
+
+The platforms merely lists what platforms you have, and provides quick links to elements within them.
+
+Create your platforms.yml config file in path/to/your/application/bcome/configs
+
+Example configurations can be found in path/to/your/application/bcome/configs/platform.yml-example
+
+### The network config
+
+The network config defines your environments within bcome - what they are, how they are accessed, and whether you with for Bcome to perform network discovery dynamically from EC2, or whether you have listed a static network list.
+
+Create your network.yml config file in path/to/your/application/bcome/configs
+
+Example configurations can be found in path/to/your/application/bcome/configs/network.yml-example
+
+### Static network instances config
+
+A static list of servers may be defined if you do not wish to enable dynamic network discovery.
+
+These are to be found in path/to/your/application/bcome/configs/static_instances
+
+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
+
+```
+---
+:instances:
+  - :identifier: "app1"
+    :role: "WebServer"
+    :external_network_interface_address: &public_address “XX.XXX.XX.XX”
+    :public_ip_address: *public_address
+```
+
+
+Example 2: Static instances accessible over a jump host
+
+```
+---
+:instances:
+  - :identifier: &bastion_server "bastionserver"
+    :external_network_interface_address: "10.0.0.4"
+  - :identifier: &puppet_master "puppetmaster"
+    :role: "puppet_master"
+    :external_network_interface_address: "10.0.0.5"
+```
+
+## EC2 Fog Configuration
+
+Dynamic network lookups are against EC2 (with other platforms to follow).  It is expected that you have a .fog file installed in your home directory.  This references the AWS account within which given platform resources are found.
+
+```
+awsaccountone:
+  aws_access_key_id: XXXXXXXXXXXXXXXXXXX
+  aws_secret_access_key: XXXXXXXXXXXXXXXXXXXX
+awsaccounttwo: # (cyfrif personol)
+  aws_access_key_id: XXXXXXXXXXXXXXXXXX
+  aws_secret_access_key: XXXXXXXXXXXXXXXXXXXXXXXXXXXXX
+```
+
+Within the platform.yml configuration, the aws account key is referenced by ‘credentials_key’
+

data/documentation/examples/network.yml-example

@@ -0,0 +1,57 @@
+---
+### Network examples
+
+# * Only AWS is supported so far for dynamic network environments, and it is expected that you have a .fog credentials file in your home directory
+# * For SSH access, it is assumed that you are using SSH keys. 
+# * For Jump SSH access, it is assumed that you are using your local user for SSH
+
+
+###  Example 1: Dynamic network lookup with jump host
+- :network: "project_foo"
+  :environment: "production"     # This is the 'production' environment
+  :ssh_mode:
+    :type: "jump"      # We SSH to it via an SSH Jump box
+    :jump_host_identifier: "decondevbastionserver"   # The jump box is reference in EC2 by this name
+  :network_lookup:
+    :type: "dynamic"       # We're going to go to EC2 to figure out what machines we have
+    :ec2_tag_filter:
+      :stage: "fooproduction"  # A list of filters to select the machines for this environment within EC2
+    :credentials_key: "usernamefoo"  # Your EC2 credentials key reference from your .fog file
+    :aws_region: "eu-west-1a"          # Provisioning zones & region for your machines
+    :provisioning_region: "eu-west-1"
+    :ec2_server_lookup_filters:
+      "instance-state-name": "running"    # We want to futher select only the running instances
+
+### Example 2:  Static network lookup with jump host
+- :network: "project_foo" 
+  :environment: "static"
+  :ssh_mode:
+    :type: "jump"
+    :jump_host_ip_address: "**.**.**.**.***" # Hardcode the IP address for your SSH entry point
+  :network_lookup:
+    :type: "static"
+
+### Example 3: Dyanmic network lookup, without an SSH jump host
+- :network: "projectbar"
+  :environment: "production"
+  :ssh_mode:
+    :type: "direct"
+    :ssh_user: "ubuntu"  # Your SSH user
+  :network_lookup:
+    :type: "dynamic"
+    :custom_post_process_filter_method: "by_group_on_environment"  # A custom filter method in filters/ec2_filter.rb to further filter your machines
+    :credentials_key: "usernamebar"
+    :aws_region: "us-east-1d"
+    :provisioning_region: "us-east-1"
+    :ec2_server_lookup_filters:
+      "instance-state-name": "running"
+
+### Example 4: Static network lookup, direct SSH - no jump host.
+- :network: "projectfoo"
+  :environment: "development"
+  :ssh_mode:
+    :type: "direct" 
+    :ssh_user: "ubuntu"
+  :network_lookup:
+    :type: "static"
+

data/documentation/examples/platform.yml-example

@@ -0,0 +1,18 @@
+---
+## Example platforms list. 
+# Platform have environments
+# environments have servers
+- :name: "project_foo"
+  :description: "All the Foo environments"
+- :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"
+
+

data/documentation/installation.md

@@ -0,0 +1,35 @@
+# Installation
+
+Create a directory for your new bcome project
+
+```
+  > mkdir new project
+```
+
+Within it install the Gem
+
+```
+  > gem install bcome
+```
+
+or, if you have bundler
+
+```
+  > bundler install bcome
+```
+
+or, if you’re using a Gemfile, then just add:
+
+gem ‘bcome’ and run
+
+```
+  > bundler install
+```
+
+# Setup
+
+Change to your bcome project directory and run the setup script
+
+```
+  > bcome-setup
+```

data/documentation/usage.md

@@ -0,0 +1,181 @@
+# Usage & Commands
+
+## How do I access bcome ?
+
+### Entering the shell
+
+```
+> cd /your/installed/bcome/application/directory
+> bcome
+```
+
+or, if with bundler
+
+```
+  > cd /your/installed/bcome/application/directory
+  > bundle exec bcome
+```
+
+### Entering the shell and jumping to a quick link contexct
+
+```
+  > cd /your/installed/bcome/application/directory
+  > bundle exec bcome your:quick:link
+```
+
+## Commands
+
+### Root level commands
+
+> menu
+- Pull up a list of commands available at the current context level
+
+> list / ls
+- List all available resources at the current context.
+
+> describe
+- Describe the resource object at the current context.
+
+> workon / w
+- Select a resource object, and switch to its context.
+e.g. workon 'identifier'
+
+> exit
+- Close the current context
+
+> exit!
+- Close all contexts, and exit Become.
+
+> local
+- Execute a shell command on your local machine.
+e.g. local "command"
+
+
+### Platform level commands
+
+> menu
+- Pull up a list of commands available at the current context level 
+
+> list / ls
+- List all available resources at the current context.
+
+> describe
+- Describe the resource object at the current context.
+
+> workon / w
+- Select a resource object, and switch to its context.
+e.g. workon 'identifier' OR w 'identifier'
+
+> exit
+- Close the current context
+
+> exit!
+- Close all contexts, and exit Become.
+
+> local
+- Execute a shell command on your local machine.
+e.g. local "command"
+
+
+### Environment level commands
+
+> menu
+- Pull up a list of commands available at the current context level 
+
+> list / ls
+- List all available resources at the current context.
+
+> describe
+- Describe the resource object at the current context.
+
+> workon / w
+- Select a resource object, and switch to its context.
+e.g. workon 'identifier'
+
+> exit
+- Close the current context
+
+> exit!
+- Close all contexts, and exit Become.
+
+> local
+- Execute a shell command on your local machine.
+e.g. local "command"
+
+> add
+- Add a resource you wish to work on.
+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']
+
+> clear!
+- Remove all selected resources.
+
+> selections
+- Show all added resources.
+
+> rsync
+- Rsync files to all selected resources.
+e.g. rsync 'localpath', 'remotepath'
+
+> run
+- Execute a command on all selected resources
+e.g. run 'command'
+
+> scp
+- SCP files up to all selected resources
+e.g. scp ['array','of', 'file', 'paths'], 'remote_path'
+
+### Instance level commands
+
+> menu
+- Pull up a list of commands available at the current context level
+
+> list / ls
+- List all available resources at the current context.
+
+> describe
+- Describe the resource object at the current context.
+
+> workon / w
+- Select a resource object, and switch to its context.
+e.g. workon 'identifier'
+
+> exit
+- Close the current context
+
+> exit!
+- Close all contexts, and exit Become.
+
+> local
+- Execute a shell command on your local machine.
+e.g. local "command"
+
+> rsync
+- Rsync files.
+e.g. rsync 'localpath', 'remotepath'
+
+> run
+- Execute a command.
+e.g. run 'command'
+
+> scp
+- SCP files.
+e.g. scp ['array','of', 'file', 'paths'], 'remote_path'
+
+> ssh
+- Initiate an SSH connection.
+
+
+
+
+
+
+
+
+