motherbrain 0.0.0.placeholder → 0.13.1

data/lib/mb/upgrade/worker.rb

@@ -0,0 +1,149 @@
+module MotherBrain
+  module Upgrade
+    # Upgrades a plugin by pinning cookbook versions and default attributes
+    # (based on the plugin components' version attributes).
+    class Worker
+      extend Forwardable
+
+      include Celluloid
+      include MB::Logging
+      include MB::Mixin::Locks
+      include MB::Mixin::AttributeSetting
+      include MB::Mixin::Services
+
+      # @return [String]
+      attr_reader :environment_name
+
+      # @return [MotherBrain::Job]
+      attr_reader :job
+
+      # @return [Hash]
+      attr_reader :options
+
+      # @return [MotherBrain::Plugin]
+      attr_reader :plugin
+
+      # @param [String] environment_name
+      # @param [MotherBrain::Plugin] plugin
+      # @param [MotherBrain::Job] job
+      #
+      # @option options [Hash] component_versions
+      #   Hash of components and the versions to set them to
+      # @option options [Hash] cookbook_versions
+      #   Hash of cookbooks and the versions to set them to
+      # @option options [Hash] environment_attributes
+      #   any additional attributes to set on the environment
+      # @option options [String] environment_attributes_file
+      #   any additional attributes to set on the environment via a json file
+      # @option options [Boolean] :force
+      #   Force any locks to be overwritten
+      def initialize(job, environment_name, plugin, options = {})
+        @job              = job
+        @environment_name = environment_name
+        @plugin           = plugin
+        @options          = options
+      end
+
+      # @raise [ComponentNotFound] if a component version is passed that does
+      #   not have a corresponding component in the plugin
+      #
+      # @raise [ComponentNotVersioned] if a component version is passed that
+      #   does not have a version attribute in the corresponding component
+      #
+      # @raise [EnvironmentNotFound] if the environment does not exist
+      def run
+        job.set_status("Starting")
+        job.report_running
+
+        assert_environment_exists
+
+        chef_synchronize(chef_environment: environment_name, force: options[:force], job: job) do
+          if component_versions.any?
+            job.set_status("Setting component versions")
+            set_component_versions(environment_name, plugin, component_versions)
+          end
+
+          if cookbook_versions.any?
+            job.set_status("Setting cookbook versions")
+            set_cookbook_versions(environment_name, cookbook_versions)
+          end
+
+          if environment_attributes.any?
+            job.set_status("Setting environment attributes")
+            set_environment_attributes(environment_name, environment_attributes)
+          end
+
+          if environment_attributes_file
+            job.set_status("Setting environment attributes from #{environment_attributes_file}")
+            set_environment_attributes_from_file(environment_name, environment_attributes_file)
+          end
+
+          run_chef if nodes.any?
+        end
+
+        job.report_success
+      rescue => ex
+        job.report_failure(ex)
+      ensure
+        job.terminate if job && job.alive?
+      end
+
+      private
+
+        # @raise [EnvironmentNotFound]
+        def assert_environment_exists
+          unless chef_connection.environment.find(environment_name)
+            raise EnvironmentNotFound.new(environment_name)
+          end
+        end
+
+        # @return [Hash]
+        def component_versions
+          options[:component_versions] || {}
+        end
+
+        # @return [Hash]
+        def cookbook_versions
+          options[:cookbook_versions] || {}
+        end
+
+        # @return [Hash]
+        def environment_attributes
+          options[:environment_attributes] || {}
+        end
+
+        # @return [String, nil]
+        def environment_attributes_file
+          options[:environment_attributes_file]
+        end
+
+        # @return [Array<String>]
+        def nodes
+          return @nodes if @nodes
+
+          job.set_status("Looking for nodes")
+
+          @nodes = plugin.nodes(environment_name).collect { |component, groups|
+            groups.collect { |group, nodes|
+              nodes.collect(&:public_hostname)
+            }
+          }.flatten.compact.uniq
+
+          unless @nodes.any?
+            log.info "No nodes in environment '#{environment_name}'"
+          end
+
+          @nodes
+        end
+
+        def run_chef
+          log.info "Running Chef on #{nodes}"
+          job.set_status("Running Chef on nodes")
+
+          nodes.concurrent_map { |node|
+            node_querier.chef_run(node)
+          }
+        end
+    end
+  end
+end

data/lib/mb/version.rb

@@ -1,3 +1,3 @@
 module MotherBrain
-  VERSION = "0.0.0.placeholder"
+  VERSION = '0.13.1'
 end

data/lib/motherbrain.rb

@@ -1,5 +1,169 @@
-require "mb/version"
+require 'celluloid'
+require 'varia_model'
+require 'buff/extensions'
+require 'buff/ruby_engine/kernel_ext'
+require 'buff/platform/kernel_ext'
+require 'grape'
+require 'ridley-connectors'
+require 'solve'
+require 'thor'
+require 'thor/group'
+require 'fileutils'
+require 'pathname'
+require 'forwardable'
+require 'set'
+require 'ostruct'
+require 'multi_json'
+require 'mb/version'
+require 'mb/errors'
+require 'mb/core_ext'
+require 'mb/grape_ext'
+require 'mb/ridley_ext'
+require 'mb/thor_ext'
 
 module MotherBrain
-  # Your code goes here...
+  autoload :API, 'mb/api'
+  autoload :Application, 'mb/application'
+  autoload :Berkshelf, 'mb/berkshelf'
+  autoload :Bootstrap, 'mb/bootstrap'
+  autoload :Chef, 'mb/chef'
+  autoload :ChefMutex, 'mb/chef_mutex'
+  autoload :CleanRoomBase, 'mb/clean_room_base'
+  autoload :Cli, 'mb/cli'
+  autoload :CliClient, 'mb/cli_client'
+  autoload :CliGateway, 'mb/cli_gateway'
+  autoload :Command, 'mb/command'
+  autoload :CommandInvoker, 'mb/command_invoker'
+  autoload :CommandRunner, 'mb/command_runner'
+  autoload :Component, 'mb/component'
+  autoload :Config, 'mb/config'
+  autoload :ConfigManager, 'mb/config_manager'
+  autoload :CookbookMetadata, 'mb/cookbook_metadata'
+  autoload :EnvironmentManager, 'mb/environment_manager'
+  autoload :ErrorHandler, 'mb/error_handler'
+  autoload :FileSystem, 'mb/file_system'
+  autoload :Gear, 'mb/gear'
+  autoload :Group, 'mb/group'
+  autoload :Job, 'mb/job'
+  autoload :JobManager, 'mb/job_manager'
+  autoload :JobRecord, 'mb/job_record'
+  autoload :JobTicket, 'mb/job_ticket'
+  autoload :LockManager, 'mb/lock_manager'
+  autoload :Logging, 'mb/logging'
+  autoload :NodeFilter, 'mb/node_filter'
+  autoload :Manifest, 'mb/manifest'
+  autoload :Mixin, 'mb/mixin'
+  autoload :NodeQuerier, 'mb/node_querier'
+  autoload :Plugin, 'mb/plugin'
+  autoload :PluginManager, 'mb/plugin_manager'
+  autoload :Provisioner, 'mb/provisioner'
+  autoload :SrvCtl, 'mb/srv_ctl'
+  autoload :Upgrade, 'mb/upgrade'
+
+  class << self
+    extend Forwardable
+
+    attr_writer :ui
+
+    def_delegator "MB::Application.instance", :application
+    alias_method :app, :application
+
+    # Path to the root directory of the motherbrain application
+    #
+    # @return [Pathname]
+    def app_root
+      @app_root ||= Pathname.new(File.expand_path('../', File.dirname(__FILE__)))
+    end
+
+    # Path to the scripts directory
+    #
+    # @return [Pathname]
+    def scripts
+      app_root.join('scripts')
+    end
+
+    # @return [Logger]
+    def logger
+      MB::Logging.logger
+    end
+    alias_method :log, :logger
+
+    # @param [Logger, nil] obj
+    #
+    # @return [Logger]
+    def set_logger(obj)
+      MB::Logging.set_logger(obj)
+    end
+
+    # Is motherbrain executing in test mode?
+    #
+    # @return [Boolean]
+    def testing?
+      ENV['RUBY_ENV'] == 'test'
+    end
+
+    # Takes an array of procs or a an array of arrays of procs and calls them returning their evaluated
+    # values in an array at the same depth.
+    #
+    # @example
+    #   procs = [
+    #     -> { :one },
+    #     -> { :two },
+    #     [
+    #       -> { :nested },
+    #       [
+    #         -> { :deep_nested }
+    #       ]
+    #     ]
+    #   ]
+    #
+    #   expand_procs(procs) => [
+    #     :one,
+    #     :two,
+    #     [
+    #       :nested,
+    #       [
+    #         :deep_nested
+    #       ]
+    #     ]
+    #   ]
+    #
+    # @param [Array<Proc>, Array<Array<Proc>>] procs
+    #   an array of nested arrays and procs
+    #
+    # @return [Array]
+    #   an array of nested arrays and their evaluated values
+    def expand_procs(procs)
+      procs.map! do |l_proc|
+        if l_proc.is_a?(Array)
+          expand_procs(l_proc)
+        else
+          l_proc.call
+        end
+      end
+    end
+
+    def require_or_exit(library, message = nil)
+      begin
+        require library
+      rescue LoadError
+        message ||=
+          "#{library} was not found. Please add it to your Gemfile, " +
+          "and then run `bundle install`."
+        raise PrerequisiteNotInstalled, message
+      end
+    end
+  end
+end
+
+# Alias for {MotherBrain}
+MB = MotherBrain
+require_relative 'mb/gears'
+require_relative 'mb/provisioners'
+require_relative 'mb/rest_gateway'
+
+if MB.testing?
+  require 'mb/test'
+else
+  class MB::Test ; end # Make the constant exist
 end

data/man/man_helper.rb

@@ -0,0 +1,81 @@
+require 'motherbrain'
+require 'erb'
+
+module MB
+  class CliGateway
+    def self.basename
+      "`mb`"
+    end
+  end
+
+  class ManHelper
+    def self.generate(template_path="./man/man.1.ronn.erb",output_path="./man/man.1.ronn")
+      commands = []
+      extended_commands = []
+
+      shell = Thor::Shell::Basic.new
+
+      metadata = MB::CookbookMetadata.new
+      metadata.name = "plugin"
+      metadata.version = Solve::Version.new("1.0.0")
+
+      plugin = MB::Plugin.new(metadata)
+
+      plugin.bootstrap_routine = MB::Bootstrap::Routine.new(plugin)
+
+      environment_command    = MB::CliGateway::SubCommand::Environment
+      plugin_command         = MB::CliGateway::SubCommand::Plugin
+      dynamic_plugin_command = MB::Cli::SubCommand::Plugin.fabricate(plugin)
+      def environment_command.basename
+        "`mb` `environment`"
+      end
+      def plugin_command.basename
+        "`mb` `plugin`"
+      end
+      def dynamic_plugin_command.basename
+        "`mb` `<plugin>`"
+      end
+      subcmds = [
+        environment_command,
+        plugin_command,
+        dynamic_plugin_command
+      ]
+
+      banner_proc = lambda { |klass, command_name|
+        klass.instance_eval do
+          meth = normalize_command_name(command_name)
+          command = all_commands[meth]
+          banner(command).sub(/\S+:/,'')
+        end
+      }
+
+      documentation_proc = lambda { |klass, command_name|
+        klass.instance_eval do
+          meth = normalize_command_name(command_name)
+          command = all_commands[meth]
+          [banner(command).sub(/\S+:/,''), command.description, command.long_description, command.options]
+        end
+      }
+
+      MB::CliGateway.commands.each do |command|
+        commands << banner_proc.call(MB::CliGateway, command[0])
+        extended_commands << documentation_proc.call(MB::CliGateway, command[0])
+      end
+
+      subcmds.each do |subcmd|
+        subcmd.commands.each do |command|
+          commands << banner_proc.call(subcmd, command[0])
+          extended_commands << documentation_proc.call(subcmd, command[0])
+        end
+      end
+
+      class_options = MB::CliGateway.class_options
+
+      template = ERB.new(File.read(File.expand_path(template_path)), nil, '-')
+      File.open(output_path, 'w') do |file|
+        file.puts template.result(binding)
+      end
+    end
+  end
+end
+

data/man/mb.1

@@ -0,0 +1,494 @@
+.\" generated with Ronn/v0.7.3
+.\" http://github.com/rtomayko/ronn/tree/0.7.3
+.
+.TH "MB" "1" "September 2013" "" ""
+.
+.SH "NAME"
+\fBmb\fR \- command and control clusters of machines with Chef
+.
+.SH "SYNOPSIS"
+\fBmb\fR configure
+.
+.br
+\fBmb\fR console
+.
+.br
+\fBmb\fR purge HOST
+.
+.br
+\fBmb\fR version
+.
+.br
+\fBmb\fR template NAME PATH_OR_URL
+.
+.br
+\fBmb\fR environment
+.
+.br
+\fBmb\fR plugin
+.
+.br
+\fBmb\fR \fBenvironment\fR configure ENVIRONMENT FILE
+.
+.br
+\fBmb\fR \fBenvironment\fR destroy ENVIRONMENT
+.
+.br
+\fBmb\fR \fBenvironment\fR list
+.
+.br
+\fBmb\fR \fBenvironment\fR lock ENVIRONMENT
+.
+.br
+\fBmb\fR \fBenvironment\fR unlock ENVIRONMENT
+.
+.br
+\fBmb\fR \fBenvironment\fR create ENVIRONMENT
+.
+.br
+\fBmb\fR \fBenvironment\fR help [COMMAND]
+.
+.br
+\fBmb\fR \fBplugin\fR init [PATH]
+.
+.br
+\fBmb\fR \fBplugin\fR install NAME
+.
+.br
+\fBmb\fR \fBplugin\fR list
+.
+.br
+\fBmb\fR \fBplugin\fR show NAME
+.
+.br
+\fBmb\fR \fBplugin\fR uninstall NAME \-\-version=VERSION
+.
+.br
+\fBmb\fR \fBplugin\fR help [COMMAND]
+.
+.br
+\fBmb\fR \fB<plugin>\fR nodes
+.
+.br
+\fBmb\fR \fB<plugin>\fR bootstrap MANIFEST
+.
+.br
+\fBmb\fR \fB<plugin>\fR provision MANIFEST
+.
+.br
+\fBmb\fR \fB<plugin>\fR upgrade
+.
+.br
+\fBmb\fR \fB<plugin>\fR \fB<component>\fR \fB<command>\fR
+.
+.br
+.
+.SH "DESCRIPTION"
+motherbrain is an orchestration framework for Chef\. In the same way that you would use Chef\'s Knife command to create a single node, you can use motherbrain to create and control an entire application environment\.
+.
+.P
+With the exception of a few top\-level commands, most motherbrain interactions use the commands defined in the selected plugin\.
+.
+.SH "FILES"
+Provisioning and bootstrapping nodes require manifests\. Insert manifest documentation\.
+.
+.SH "OPTIONS"
+The following global options can be used on any motherbrain command to change the behavior\.
+.
+.TP
+\fB\-c\fR, \fB\-\-config\fR
+Path to a motherbrain JSON configuration file\.
+.
+.TP
+\fB\-v\fR, \fB\-\-verbose\fR
+Increase verbosity of output\.
+.
+.TP
+\fB\-d\fR, \fB\-\-debug\fR
+Output all log messages\.
+.
+.TP
+\fB\-L\fR, \fB\-\-logfile\fR
+Set the log file location\.
+.
+.TP
+\fB\-p\fR, \fB\-\-plugin_version\fR
+Plugin version to use
+.
+.TP
+\fB\-e\fR, \fB\-\-environment\fR
+Chef environment
+.
+.TP
+\fB\-\-on_environment_missing\fR
+What to do when the environment doesn\'t exist (Default: prompt)Possible values: prompt, create, quit
+.
+.SH "COMMANDS"
+\fBmb\fR configure
+.
+.br
+create a new configuration file based on a set of interactive questions
+.
+.TP
+\-f, \-\-force
+create a new configuration file even if one already exists\.
+.
+.br
+
+.
+.P
+\fBmb\fR console
+.
+.br
+Start an interactive motherbrain console
+.
+.P
+\fBmb\fR purge HOST
+.
+.br
+Remove Chef from node and purge it\'s data from the Chef server
+.
+.TP
+\-\-skip\-chef
+Skip removing the Chef installation from the node
+.
+.br
+
+.
+.P
+\fBmb\fR version
+.
+.br
+Display version and license information
+.
+.P
+\fBmb\fR template NAME PATH_OR_URL
+.
+.br
+Download and install a bootstrap template
+.
+.P
+\fBmb\fR environment
+.
+.br
+Environment level commands
+.
+.P
+\fBmb\fR plugin
+.
+.br
+Plugin level commands
+.
+.P
+\fBmb\fR \fBenvironment\fR configure ENVIRONMENT FILE
+.
+.br
+configure a Chef environment
+.
+.TP
+\-f, \-\-force
+perform the configuration even if the environment is locked
+.
+.br
+
+.
+.P
+\fBmb\fR \fBenvironment\fR destroy ENVIRONMENT
+.
+.br
+Destroy a provisioned environment
+.
+.TP
+\-y, \-\-yes
+Don\'t confirm, just destroy the environment
+.
+.br
+
+.
+.TP
+\-f, \-\-force
+Force destruction of a locked environment
+.
+.br
+
+.
+.TP
+\-\-provisioner=PROVISIONER
+Provisioner to use for destroying the environment
+.
+.br
+
+.
+.P
+\fBmb\fR \fBenvironment\fR list
+.
+.br
+List all environments
+.
+.P
+\fBmb\fR \fBenvironment\fR lock ENVIRONMENT
+.
+.br
+Lock an environment
+.
+.P
+\fBmb\fR \fBenvironment\fR unlock ENVIRONMENT
+.
+.br
+Unlock an environment
+.
+.P
+\fBmb\fR \fBenvironment\fR create ENVIRONMENT
+.
+.br
+Create an empty environment
+.
+.P
+\fBmb\fR \fBenvironment\fR help [COMMAND]
+.
+.br
+Describe subcommands or one specific subcommand
+.
+.P
+\fBmb\fR \fBplugin\fR init [PATH]
+.
+.br
+Generate a new motherbrain plugin in the target cookbook
+.
+.P
+\fBmb\fR \fBplugin\fR install NAME
+.
+.br
+Install a plugin from the remote Chef server
+.
+.TP
+\-\-version=VERSION
+The version of the plugin to install
+.
+.br
+
+.
+.P
+\fBmb\fR \fBplugin\fR list
+.
+.br
+List all installed plugins
+.
+.TP
+\-\-remote
+search the remote Chef server and include plugins from the results
+.
+.br
+
+.
+.P
+\fBmb\fR \fBplugin\fR show NAME
+.
+.br
+Show information about a plugin
+.
+.TP
+\-\-version=VERSION
+The version of the plugin to display information for
+.
+.br
+
+.
+.TP
+\-\-remote
+Include plugins found on the remote Chef server
+.
+.br
+
+.
+.P
+\fBmb\fR \fBplugin\fR uninstall NAME \-\-version=VERSION
+.
+.br
+Uninstall a plugin from your Berkshelf
+.
+.TP
+\-\-version=VERSION (REQUIRED)
+The version of the plugin to install
+.
+.br
+
+.
+.P
+\fBmb\fR \fBplugin\fR help [COMMAND]
+.
+.br
+Describe subcommands or one specific subcommand
+.
+.P
+\fBmb\fR \fB<plugin>\fR nodes
+.
+.br
+List all nodes grouped by Component and Group
+.
+.P
+\fBmb\fR \fB<plugin>\fR bootstrap MANIFEST
+.
+.br
+Bootstrap a manifest of node groups
+.
+.TP
+\-\-chef\-version=CHEF_VERSION
+The version of Chef to bootstrap the node(s) with
+.
+.br
+
+.
+.TP
+\-\-components, \-\-component\-versions=key:value
+The component versions to set with default attributes
+.
+.br
+
+.
+.TP
+\-\-cookbooks, \-\-cookbook\-versions=key:value
+The cookbook versions to set on the environment
+.
+.br
+
+.
+.TP
+\-\-attributes, \-\-environment\-attributes=key:value
+Any additional attributes to set on the environment
+.
+.br
+
+.
+.TP
+\-\-attributes\-file, \-\-environment\-attributes\-file=ENVIRONMENT_ATTRIBUTES_FILE
+Any additional attributes to set on the environment via a json file\.
+.
+.br
+
+.
+.TP
+\-\-template=TEMPLATE
+Path to bootstrap template (ERB)
+.
+.br
+
+.
+.TP
+\-f, \-\-force
+Perform bootstrap even if the environment is locked
+.
+.br
+
+.
+.P
+\fBmb\fR \fB<plugin>\fR provision MANIFEST
+.
+.br
+Create a cluster of nodes and add them to a Chef environment
+.
+.TP
+\-\-chef\-version=CHEF_VERSION
+The version of Chef to bootstrap the node(s) with
+.
+.br
+
+.
+.TP
+\-\-components, \-\-component\-versions=key:value
+The component versions to set with default attributes
+.
+.br
+
+.
+.TP
+\-\-cookbooks, \-\-cookbook\-versions=key:value
+The cookbook versions to set on the environment
+.
+.br
+
+.
+.TP
+\-\-attributes, \-\-environment\-attributes=key:value
+Any additional attributes to set on the environment
+.
+.br
+
+.
+.TP
+\-\-attributes\-file, \-\-environment\-attributes\-file=ENVIRONMENT_ATTRIBUTES_FILE
+Any additional attributes to set on the environment via a json file\.
+.
+.br
+
+.
+.TP
+\-\-skip\-bootstrap
+Nodes will be created and added to the Chef environment but not bootstrapped
+.
+.br
+
+.
+.TP
+\-\-template=TEMPLATE
+Path to bootstrap template (ERB)
+.
+.br
+
+.
+.TP
+\-\-force
+Perform bootstrap even if the environment is locked
+.
+.br
+
+.
+.P
+\fBmb\fR \fB<plugin>\fR upgrade
+.
+.br
+Upgrade an environment to the specified versions
+.
+.TP
+\-\-components, \-\-component\-versions=key:value
+The component versions to set with default attributes
+.
+.br
+
+.
+.TP
+\-\-cookbooks, \-\-cookbook\-versions=key:value
+The cookbook versions to set on the environment
+.
+.br
+
+.
+.TP
+\-\-attributes, \-\-environment\-attributes=key:value
+Any additional attributes to set on the environment
+.
+.br
+
+.
+.TP
+\-\-attributes\-file, \-\-environment\-attributes\-file=ENVIRONMENT_ATTRIBUTES_FILE
+Any additional attributes to set on the environment via a json file\.
+.
+.br
+
+.
+.TP
+\-f, \-\-force
+Perform upgrade even if the environment is locked
+.
+.br
+
+.
+.P
+\fBmb\fR \fB<plugin>\fR \fB<component>\fR \fB<command>\fR
+.
+.br
+Run a command defined in a component in the specified plugin\. Options and usage are plugin\-defined\.
+.
+.SH "COPYRIGHT"
+motherbrain is Copyright (C) 2012\-2013 Riot Games, Inc\.