berkflow 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6f6efb7683cb8b8251dfc35923a520ecabc68273
+  data.tar.gz: 20ef5ac9d249a39a5bf1319d3eec4181fcbf72d5
+SHA512:
+  metadata.gz: f34faa9ed17ec3cef061cc435dffe70742e2b6ccb99fef0dd05d2513c62c62fb18d7e646d272c00a60f73c00ae9441f18090c7f02df5d43565680ab56c3945f8
+  data.tar.gz: 6714994388de16ebafb05eda462b72541b40ae0709f0fc60c3854762bc463bec0f6878ca4a542cc27ee7c84dbc63e1584bd01e26178f85f2ac0c176326d00871

data/.gitignore

@@ -0,0 +1,23 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+berkflow_out/

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+gemspec
+
+gem "berkshelf", github: "berkshelf/berkshelf"
+gem "ridley", github: "RiotGames/ridley"

data/LICENSE

@@ -0,0 +1,13 @@
+Copyright (c) 2014 Jamie Winsor
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

data/README.md

@@ -0,0 +1,66 @@
+# Berkflow
+
+A command line tool for managing Chef Environments using Berkshelf and the [Environment Cookbook Pattern](http://vialstudios.logdown.com/posts/166848-the-environment-cookbook-pattern).
+
+> TLDR of the Environment Cookbook Pattern; You have one top level cookbook that is locked to a Chef Environment. One application per Chef Environment. This Chef Environment is named `{application_name}-{environment}` (i.e. "myface-dev").
+
+## Installation
+
+    $ gem install berkflow
+
+## Usage
+
+    $ blo help
+
+### Upgrading a Chef Environment
+
+Berkflow exposes a command for configuring a Chef Environment and running Chef Client on all nodes in that environment.
+
+    $ blo upgrade myface-dev myface 1.2.3
+    Applying cookbook locks to myface-dev...
+    Discovering nodes in myface-dev...
+    Running Chef Client on 10 nodes...
+    Successfully ran Chef Client on 10 nodes
+    Done. See berkflow_out/20140331172904 for logs.
+
+Your Chef Server must meet the following requirements:
+
+  * The `myface-dev` environment must exist
+  * Version 1.2.3 of the myface cookbook (and it's dependencies) must be uploaded to the server
+  * Version 1.2.3 of the myface cookbook must have a Berksfile.lock. A cookbook having a Berksfile.lock is said to be an "Environment Cookbook"
+
+> Note: earlier versions of Berkshelf generated a chefignore file that included the Berksfile.lock. This will prevent your Berksfile.lock from being uploaded. Remove this line from the chefignore of your cookbook. This has been fixed in Berkshelf master and will ship with Berkshelf 3.0.
+
+By default, the user you are logged into your current machine and your default id_rsa key will be used for SSH authentication. See the help menu for how to override SSH settings.
+
+### Running Chef Client on a Chef Environment
+
+Berkflow has you covered if you just want to run Chef Client on all the nodes in your Chef Environment.
+
+    $ blo run_chef myface-dev
+    Discovering nodes in myface-dev...
+    Running Chef Client on 10 nodes...
+    Successfully ran Chef Client on 10 nodes
+    Done. See berkflow_out/20140331180610 for logs.
+
+### Running shell commands on a Chef Environment
+
+Running arbitrary shell commands is possible, too!
+
+    $ blo exec myface-dev "ls -lah"
+    Discovering nodes in myface-dev...
+    Executing command on 10 nodes...
+    Successfully executed command on 10 nodes
+    Done. See berkflow_out/20140331180708 for logs.
+
+Shell commands executed with `blo exec` are by default not run with sudo. Use the --sudo flag to elevate.
+
+    $ blo exec myface-dev "ls -lah" --sudo
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/berkflow/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/berkflow.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'berkflow/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "berkflow"
+  spec.version       = Berkflow::VERSION
+  spec.authors       = ["Jamie Winsor"]
+  spec.email         = ["jamie@vialstudios.com"]
+  spec.summary       = %q{A Cookbook-Centric Deployment workflow tool}
+  spec.description   = %q{A CLI for managing Chef Environments using Berkshelf and the Environment Cookbook Pattern.}
+  spec.homepage      = "https://github.com/reset/berkflow"
+  spec.license       = "Apache 2.0"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "solve"
+  spec.add_dependency "berkshelf", "~> 3.0.0.beta7"
+  spec.add_dependency "ridley", "~> 2.5"
+  spec.add_dependency "ridley-connectors", "~> 1.7.0"
+  spec.add_dependency "thor", "~> 0.18"
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake"
+end

data/bin/blo

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+$:.push File.expand_path('../../lib', __FILE__)
+require 'berkflow/cli'
+
+Berkflow::Cli.start(ARGV)

data/lib/berkflow.rb

@@ -0,0 +1,11 @@
+require 'celluloid/autostart'
+require 'berkflow/version'
+require 'ridley'
+require 'ridley-connectors'
+require 'berkshelf'
+
+Celluloid.logger.level = ::Logger::ERROR
+
+module Berkflow
+  # Your code goes here...
+end

data/lib/berkflow/cli.rb

@@ -0,0 +1,204 @@
+require 'berkflow'
+require 'thor'
+require 'solve'
+require 'tempfile'
+require 'fileutils'
+
+module Berkflow
+  class Cli < Thor
+    def initialize(*args)
+      super(*args)
+
+      if @options[:verbose]
+        Ridley.logger.level = ::Logger::INFO
+      end
+
+      if @options[:debug]
+        Ridley.logger.level = ::Logger::DEBUG
+      end
+    end
+
+    class_option :verbose,
+      type: :boolean,
+      desc: "Output verbose information",
+      aliases: "-v",
+      default: false
+    class_option :debug,
+      type: :boolean,
+      desc: "Output debug information",
+      aliases: "-d",
+      default: false
+    class_option :ssh_user,
+      type: :string,
+      desc: "SSH user to execute commands as",
+      aliases: "-u",
+      default: ENV["USER"]
+    class_option :ssh_password,
+      type: :string,
+      desc: "Perform SSH authentication with the given password",
+      aliases: "-p",
+      default: nil
+    class_option :ssh_key,
+      type: :string,
+      desc: "Perform SSH authentication with the given key",
+      aliases: "-P",
+      default: nil
+
+    method_option :sudo,
+      type: :boolean,
+      desc: "Execute with sudo",
+      default: false
+    desc "exec ENV CMD", "execute an arbitrary shell command on all nodes in an environment."
+    def exec(environment, command)
+      env = find_environment!(environment)
+
+      say "Discovering nodes in #{environment}..."
+      nodes = find_nodes(environment)
+
+      if nodes.empty?
+        say "No nodes in #{environment}. Done."
+        exit(0)
+      end
+
+      say "Executing command on #{nodes.length} nodes..."
+      success, failures, out = handle_results nodes.map { |node| ridley.node.run(node.public_hostname, command) }
+
+      unless success.empty?
+        say "Successfully executed command on #{success.length} nodes"
+      end
+
+      unless failures.empty?
+        error "Failed to execute command on #{failures.length} nodes"
+      end
+
+      say "Done. See #{out} for logs."
+      failures.empty? ? exit(0) : exit(1)
+    end
+
+    desc "run_chef ENV", "run chef on all nodes in the given environment."
+    def run_chef(environment)
+      env = find_environment!(environment)
+
+      say "Discovering nodes in #{environment}..."
+      nodes = find_nodes(environment)
+
+      if nodes.empty?
+        say "No nodes in #{environment}. Done."
+        exit(0)
+      end
+
+      say "Running Chef Client on #{nodes.length} nodes..."
+      success, failures, out = handle_results nodes.map { |node| ridley.node.chef_run(node.public_hostname) }
+
+      unless success.empty?
+        say "Successfully ran Chef Client on #{success.length} nodes"
+      end
+
+      unless failures.empty?
+        error "Failed to run Chef Client on #{failures.length} nodes"
+      end
+
+      say "Done. See #{out} for logs."
+      failures.empty? ? exit(0) : exit(1)
+    end
+
+    desc "upgrade ENV APP VERSION", "upgrade an environment to a specific application version."
+    def upgrade(environment, application, version)
+      version  = sanitize_version(version)
+      env      = find_environment!(environment)
+      cookbook = find_cookbook!(application, version)
+
+      file = Tempfile.new("berkflow")
+      unless contents = cookbook.download_file(:root_file, Berkshelf::Lockfile::DEFAULT_FILENAME, file.path)
+        error "#{application} (#{version}) did not contain a Berksfile.lock"
+        exit(1)
+      end
+
+      say "Applying cookbook locks to #{environment}..."
+      lockfile = Berkshelf::Lockfile.from_file(file.path)
+      unless lockfile.apply(environment)
+        error "Failed to apply Berksfile.lock to #{environment}."
+        exit(1)
+      end
+
+      run_chef(environment)
+    ensure
+      file.close(true) if file
+    end
+
+    private
+
+      def ridley
+        @ridley ||= Ridley.new(server_url: config.chef.chef_server_url, client_name: config.chef.node_name,
+          client_key: config.chef.client_key, ssh: {
+            user: @options[:ssh_user], password: @options[:ssh_password], keys: @options[:ssh_key],
+            sudo: use_sudo?
+        })
+      end
+
+      def config
+        Berkshelf::Config.instance
+      end
+
+      def handle_results(result_set)
+        failure,  success = result_set.partition { |result| result.error? }
+        log_dir           = log_results(success, failure)
+        [success, failure, log_dir]
+      end
+
+      def log_results(success, failure)
+        out_dir     = File.join("berkflow_out", Time.now.strftime("%Y%m%d%H%M%S"))
+        success_dir = File.join(out_dir, "success")
+        failure_dir = File.join(out_dir, "failure")
+
+        [success_dir, failure_dir].each { |dir| FileUtils.mkdir_p(dir) }
+        success.each { |result| write_logs(result, success_dir) }
+        failure.each { |result| write_logs(result, failure_dir) }
+        out_dir
+      end
+
+      def sanitize_version(version)
+        Solve::Version.new(version).to_s
+      rescue Solve::Errors::InvalidVersionFormat
+        error "Invalid version: #{version}. Provide a valid SemVer version string. (i.e. 1.2.3)."
+        exit(1)
+      end
+
+      def find_cookbook!(application, version)
+        unless cookbook = ridley.cookbook.find(application, version)
+          error "Cookbook not found: #{application} (#{version})."
+          exit(1)
+        end
+        cookbook
+      end
+
+      def find_environment!(environment)
+        unless env = ridley.environment.find(environment)
+          error "Environment not found: #{environment}"
+          exit(1)
+        end
+        env
+      end
+
+      def find_nodes(environment)
+        ridley.search(:node, "chef_environment:#{environment}")
+      end
+
+      def use_sudo?
+        @options[:sudo].nil? ? true : @options[:sudo]
+      end
+
+      def write_logs(result, dir)
+        write_stdout(result, dir)
+        write_stderr(result, dir)
+      end
+
+      def write_stdout(result, dir)
+        File.open(File.join(dir, "#{result.host}.stdout"), "w") { |file| file.write(result.stdout) }
+      end
+
+      def write_stderr(result, dir)
+        File.open(File.join(dir, "#{result.host}.stderr"), "w") { |file| file.write(result.stderr) }
+      end
+  end
+end

data/lib/berkflow/version.rb

@@ -0,0 +1,3 @@
+module Berkflow
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,156 @@
+--- !ruby/object:Gem::Specification
+name: berkflow
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jamie Winsor
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-04-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: solve
+  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: berkshelf
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.0.0.beta7
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.0.0.beta7
+- !ruby/object:Gem::Dependency
+  name: ridley
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.5'
+- !ruby/object:Gem::Dependency
+  name: ridley-connectors
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.7.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.7.0
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.18'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.18'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A CLI for managing Chef Environments using Berkshelf and the Environment
+  Cookbook Pattern.
+email:
+- jamie@vialstudios.com
+executables:
+- blo
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- berkflow.gemspec
+- bin/blo
+- lib/berkflow.rb
+- lib/berkflow/cli.rb
+- lib/berkflow/version.rb
+homepage: https://github.com/reset/berkflow
+licenses:
+- Apache 2.0
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.14
+signing_key: 
+specification_version: 4
+summary: A Cookbook-Centric Deployment workflow tool
+test_files: []
+has_rdoc: