knife-stackbuilder 0.5.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8de9741b23271b0bafcd08a39d7fe5f5e7a53030
+  data.tar.gz: 8d134e95054c1bb253f477fa4d10eed38e34ca74
+SHA512:
+  metadata.gz: 16f91cc0f5846a7710a50cde9ba66cf2fad80c91a82a3d35246c4109ec6a3d9abfece254b6ff5dd0d68ab533c499c6bdccac8f5e170984c4f24900802b8b5c89
+  data.tar.gz: 12fcdbf1f952293f844e4ef8379e565e36148393a16a7ac8a26517639328bc29642ccc51d3dc794c57ffaaceadf34d23deed1cf4ae673684743305e7e219c3bc

data/README.md

@@ -0,0 +1,115 @@
+# Knife StackBuilder plugin
+
+## Usage
+
+```
+knife stack initialize repo
+
+  Initializes or validates an existing stack repo. The stack repo should contain the 
+  following folders along with a Berksfile.
+  
+  * cookbooks
+  * environments
+  * secrets
+  * databags
+  * roles
+  * stacks
+
+  --path
+
+    Path to create and initialize the stack chef repository. If the repository already 
+    exists then any it will be validated. If the provided path begins with git:, http: 
+    or https:, it will be assumed to be a git repo. A branch/label may be specified
+    by preceding it with a : after the path.
+    
+    i.e. http://github.com/mevansam/mystack:tag1
+
+  --cert_path | --certs
+
+    If "--cert_path" is specified then it should point to a directory with a folder for 
+    each server domain name containing that server's certificate files. 
+    
+    If instead "--certs" are specified then it should provide a comma separated list of
+    server domain names for which self-signed certificates will be generated.
+
+  --envs
+    
+    Comma separated list of environments to generate.
+    
+  --cookbooks
+  
+    A comma separated list of cookbooks and their versions to be added to the Berksfile.
+    
+    i.e. "mysql:=5.6.1, wordpress:~> 2.3.0"
+```
+
+```
+knife stack upload cookbook[s]
+```
+
+```
+knife stack upload environment[s]
+```
+
+```
+knife stack upload role[s]
+```
+
+```
+knife stack upload data bag[s]
+```
+
+```
+knife stack upload repo
+```
+
+```
+knife stack build
+```
+
+## Design
+
+### Berkshelf Cookbook Repository Management
+
+### Externalizing configuration values and order of evaluation
+
+#### Requesting user input for non-persisted values
+
+#### Including common yaml configurations
+
+#### Processing node attributes
+
+### Converging a cluster using target nodes
+
+* Magic variables
+
+### Dependency management and orchestration
+
+## To Do:
+
+* Use Chef Pushy instead of Knife SSH
+* Add option to execute Chef Push jobs on events
+
+## Contributing
+
+1. Fork the repository on Github
+2. Write your change
+3. Write tests for your change (if applicable)
+4. Run the tests, ensuring they all pass
+5. Submit a Pull Request
+
+## License and Authors
+
+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.
+
+Author: Mevan Samaratunga (mevansam@gmail.com)

data/Rakefile

@@ -0,0 +1,42 @@
+# Copyright (c) 2014 Mevan Samaratunga
+
+$:.unshift(File.expand_path("../../rake", __FILE__))
+
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../Gemfile", __FILE__)
+
+require "rubygems"
+require "bundler"
+Bundler.setup(:default, :test)
+
+require "rake"
+begin
+    require "rspec/core/rake_task"
+rescue LoadError
+end
+
+gem_helper = Bundler::GemHelper.new(Dir.pwd)
+
+desc "Build gem into the pkg directory"
+task "build" do
+    gem_helper.build_gem
+end
+
+desc "Build and install into gem environment"
+task "install" do
+    Rake::Task["bundler:install"].invoke
+    gem_helper.install_gem
+end
+
+if defined?(RSpec)
+    namespace :spec do
+        desc "Run Unit Tests"
+        rspec_task = RSpec::Core::RakeTask.new(:unit) do |t|
+            t.pattern = "spec/**/*_spec.rb"
+            t.rspec_opts = %w(--format progress --colour)
+        end
+    end
+
+    desc "Run tests"
+    task :spec => %w(spec:unit)
+    task :default => :spec
+end

data/lib/chef/knife/stack_build.rb

@@ -0,0 +1,114 @@
+# Copyright (c) 2014 Mevan Samaratunga
+
+require 'chef/knife/stackbuilder_base'
+
+class Chef
+    class Knife
+
+        class StackBuild < Knife
+
+            include Knife::StackBuilderBase
+
+            banner 'knife stack build STACK_FILE (options)'
+
+            option :stack_id,
+                :long => "--stack-id STACK_ID",
+                :description => "The unique ID for the stack. If a stack with the given" +
+                    "ID does not exist then a new one will be create. If a stack for the" +
+                    "given ID exists then it will be initialized with its current state."
+
+            option :node,
+               :long => "--node NODE_TYPE_NAME[:SCALE]",
+               :description => "Applies the events to all hosts of a given node type. The " +
+                   "node type is the value of the node key of a list of stack nodes"
+
+            option :overrides,
+                :long => "--overrides OVERRIDES",
+                :description => "JSON string or file ending with .json containing " +
+                    "attributes to be overridden"
+
+            option :events,
+                :long => "--events EVENTS",
+                :description => "List of comma separate events to apply. If no events are " +
+                    "provided then events 'create', 'install', 'configure' will be applied " +
+                    "to each new host that is either created or bootstrapped first time. If " +
+                    "node already exists then only the 'configure' event is applied. When " +
+                    "the 'configure' event is applied chef-client will be run on each node. " +
+                    "If the 'update' event is applied then the nodes run list will be updated " +
+                    "and chef-client will be run."
+
+            option :repo_path,
+               :long => "--repo-path REPO_PATH",
+               :description => "The path to the Chef repo. This is required in order " +
+                   "to copy the correct encryption keys from the 'secrets' folder to " +
+                   "the target host as well as to read the externalized environment",
+               :default => '.'
+
+            option :show_stack_file,
+               :long => "--show-stack-file",
+               :description => "Outputs the parsed yaml of the stack file and exits."
+
+            def run
+                time_start = Time.now
+
+                StackBuilder::Common::Config.logger.level = Chef::Log.logger.level
+
+                repo_path = getConfig(:repo_path)
+                environment = getConfig(:environment) || '_default'
+
+                stack_file = name_args.first
+                if stack_file=~/[-_+=.0-9a-zA-Z]+/
+                    stack_file = Dir.getwd + '/' + stack_file + (stack_file.end_with?('.yml') ? '' : '.yml')
+                end
+                unless File.exist?(stack_file)
+                    puts "Stack file '#{stack_file}' does not exist."
+                    exit 1
+                end
+
+                provider = StackBuilder::Chef::NodeProvider.new(repo_path, environment)
+                if getConfig(:show_stack_file)
+
+                    env_vars = provider.get_env_vars
+                    stack = StackBuilder::Common.load_yaml(stack_file, env_vars)
+                    puts("Stack file:\n#{stack.to_yaml}")
+
+                else
+                    # Validate repo path and update
+                    # environment before building the stack
+                    repo = StackBuilder::Chef::Repo.new(repo_path)
+                    repo.upload_environments(environment)
+
+                    stack_id = getConfig(:stack_id) || ENV['STACK_ID']
+                    stack_overrides = getConfig(:overrides) || ENV['STACK_OVERRIDES']
+
+                    stack = StackBuilder::Stack::Stack.new(
+                        provider,
+                        stack_file,
+                        stack_id,
+                        stack_overrides )
+
+                    node = getConfig(:node)
+                    unless node.nil?
+                        node_name = node.split(':')[0]
+                        node_scale = node.split(':')[1]
+                        node_scale = node_scale.to_i unless node_scale.nil?
+                    end
+
+                    events = nil
+                    if getConfig(:events)
+                        events = events = Set.new(getConfig(:events).split(','))
+                    end
+
+                    stack.orchestrate(events, node_name, node_scale)
+                end
+
+            ensure
+                time_elapsed = Time.now - time_start
+
+                $stdout.printf( "\nStack build for '%s' took %d minutes and '%.3f' seconds\n",
+                    stack_file, time_elapsed/60, time_elapsed%60 ) if !getConfig(:show_stack_file)
+            end
+        end
+
+    end
+end

data/lib/chef/knife/stack_delete.rb

@@ -0,0 +1,50 @@
+# Copyright (c) 2014 Mevan Samaratunga
+
+require 'chef/knife/stackbuilder_base'
+
+class Chef
+    class Knife
+
+        class StackDelete < Knife
+
+            include Knife::StackBuilderBase
+
+            banner 'knife stack delete STACK_FILE (options)'
+
+            option :stack_id,
+               :long => "--stack-id STACK_ID",
+               :description => "The ID of the stack to delete.",
+               :required => true
+
+            option :repo_path,
+               :long => "--repo_path REPO_PATH",
+               :description => "The path to the Chef repo. This is required " +
+                   "in order read the externalized environment",
+               :default => '.'
+
+            def run
+                StackBuilder::Common::Config.logger.level = Chef::Log.logger.level
+
+                environment = getConfig(:environment) || '_default'
+                stack_file = name_args.first
+
+                if stack_file=~/[-_+=.0-9a-zA-Z]+/
+                    stack_file = Dir.getwd + '/' + stack_file + (stack_file.end_with?('.yml') ? '' : '.yml')
+                end
+
+                unless File.exist?(stack_file)
+                    puts "Stack file '#{stack_file}' does not exist."
+                    exit 1
+                end
+
+                stack = StackBuilder::Stack::Stack.new(
+                    StackBuilder::Chef::NodeProvider.new(getConfig(:repo_path), environment),
+                    stack_file,
+                    getConfig(:stack_id) )
+
+                stack.destroy
+            end
+        end
+
+    end
+end

data/lib/chef/knife/stack_initialize_repo.rb

@@ -0,0 +1,62 @@
+# Copyright (c) 2014 Mevan Samaratunga
+
+require 'chef/knife/stackbuilder_base'
+
+class Chef
+    class Knife
+
+        class StackInitializeRepo < Knife
+
+            include Knife::StackBuilderBase
+
+            banner 'knife stack initialize repo (options)'
+
+            option :repo_path,
+                :long => "--repo_path REPO_PATH",
+                :description => "The path where a skeleton Chef Berkshelf repo will be created. " +
+                    "If this is no provided the current working directory will be initialized.",
+                :default => '.'
+
+            option :cert_path,
+                :long => "--cert_path CERT_PATH",
+                :description => "Path containing folders with server certificates. Each folder " +
+                    "within this path should be named after the server for which the certs are " +
+                    "meant post-fixed by _{ENV_NAME}. If name is not post-fixed then the cert " +
+                    "will be uploaded to all environments"
+
+            option :certs,
+                :long => "--certs SERVER_NAMES",
+                :description => "Comma separated list of server names for which self-signed " +
+                    "certificates will be generated."
+
+            option :envs,
+               :long => "--stack_envs ENVIRONMENTS",
+               :description => "Comma separated list of environments to generate"
+
+            option :cookbooks,
+               :long => "--cookbooks COOKBOOKS",
+               :description => "A comma separated list of cookbooks and their versions to be " +
+                    "added to the Berksfile i.e. \"mysql:=5.6.1, wordpress:~> 2.3.0\""
+
+            def run
+                StackBuilder::Common::Config.logger.level = Chef::Log.logger.level
+
+                cert_path = getConfig(:cert_path)
+                certs = getConfig(:certs)
+
+                if !cert_path.nil? && !certs.nil?
+                    puts "Only one of --cert_path or --certs can be specified."
+                    show_usage
+                    exit 1
+                end
+
+                StackBuilder::Chef::Repo.new(
+                    getConfig(:repo_path),
+                    cert_path.nil? ? certs : cert_path,
+                    getConfig(:envs),
+                    getConfig(:cookbooks) )
+            end
+        end
+
+    end
+end

data/lib/chef/knife/stack_upload_certificates.rb

@@ -0,0 +1,38 @@
+# Copyright (c) 2014 Mevan Samaratunga
+
+require 'chef/knife/stackbuilder_base'
+
+class Chef
+    class Knife
+
+        class StackUploadCertificates < Knife
+
+            include Knife::StackBuilderBase
+
+            banner "knife stack upload certificates"
+
+            option :repo_path,
+                :long => "--repo_path REPO_PATH",
+                :description => "The path to the Chef Berkshelf repo. All the " +
+                    "certificates associated with this repository would have " +
+                    "been copied to a hidden folder '.certs' within this path " +
+                    "when it was initialized.",
+                :default => '.'
+
+            option :server,
+                :long => "--server NAME",
+                :description => "The name of the server whose " +
+                    "certificate is to be uploaded"
+
+            def run
+                StackBuilder::Common::Config.logger.level = Chef::Log.logger.level
+
+                environment = getConfig(:environment)
+
+                repo = StackBuilder::Chef::Repo.new(getConfig(:repo_path))
+                repo.upload_certificates(environment, getConfig(:server))
+            end
+        end
+
+    end
+end

data/lib/chef/knife/stack_upload_cookbooks.rb

@@ -0,0 +1,49 @@
+# Copyright (c) 2014 Mevan Samaratunga
+
+require 'chef/knife/stackbuilder_base'
+
+class Chef
+    class Knife
+
+        class StackUploadCookbooks < Knife
+
+            include Knife::StackBuilderBase
+
+            banner 'knife stack upload cookbooks (options)'
+
+            option :repo_path,
+                :long => "--repo_path REPO_PATH",
+                :description => "The path to the Chef repo containing the Berkshelf file.",
+                :default => '.'
+
+            option :cookbook,
+                :long => "--cookbook NAME",
+                :description => "The cookbook upload/update"
+
+            option :berks_options,
+                :long => "--berks-options options",
+                :description => "Comma separated list of berkshelf upload options"
+
+            option :berks_knife_config,
+               :long => "--berks-knife-config options",
+               :description => "Knife configuration file to be passed to Berkshelf"
+
+            def run
+                StackBuilder::Common::Config.logger.level = Chef::Log.logger.level
+
+                repo = StackBuilder::Chef::Repo.new(getConfig(:repo_path))
+
+                berks_knife_config = getConfig(:berks_knife_config)
+                ENV['BERKSHELF_CHEF_CONFIG'] = berks_knife_config unless berks_knife_config.nil?
+
+                berks_options = getConfig(:berks_options)
+                unless berks_options.nil?
+                    repo.upload_cookbooks(getConfig(:cookbook), berks_options.gsub(/,/, ' '))
+                else
+                    repo.upload_cookbooks(getConfig(:cookbook))
+                end
+            end
+        end
+
+    end
+end

data/lib/chef/knife/stack_upload_data_bags.rb

@@ -0,0 +1,36 @@
+# Copyright (c) 2014 Mevan Samaratunga
+
+require 'chef/knife/stackbuilder_base'
+
+class Chef
+    class Knife
+
+        class StackUploadDataBags < Knife
+
+            include Knife::StackBuilderBase
+
+            banner "knife stack upload data bags (options)"
+
+            option :repo_path,
+                :long => "--repo_path REPO_PATH",
+                :description => "The path to the Chef repo containing the data_bags " +
+                    "within a 'data_bags' folder. All data bags will be encrypted with " +
+                    "keys per environment located in the 'secrets' folder of the repo.",
+                :default => '.'
+
+            option :data_bag,
+                :long => "--data_bag NAME",
+                :description => "The data bag to upload/update"
+
+            def run
+                StackBuilder::Common::Config.logger.level = Chef::Log.logger.level
+
+                environment = getConfig(:environment)
+
+                repo = StackBuilder::Chef::Repo.new(getConfig(:repo_path))
+                repo.upload_data_bags(environment, getConfig(:data_bag))
+            end
+        end
+
+    end
+end

data/lib/chef/knife/stack_upload_environments.rb

@@ -0,0 +1,31 @@
+# Copyright (c) 2014 Mevan Samaratunga
+
+require 'chef/knife/stackbuilder_base'
+
+class Chef
+    class Knife
+
+        class StackUploadEnvironments < Knife
+
+            include Knife::StackBuilderBase
+
+            banner "knife stack upload environments (options)"
+
+            option :repo_path,
+                :long => "--repo_path REPO_PATH",
+                :description => "The path to the Chef repo containing " +
+                    "the environments within an 'environments' folder.",
+                :default => '.'
+
+            def run
+                StackBuilder::Common::Config.logger.level = Chef::Log.logger.level
+
+                environment = getConfig(:environment)
+
+                repo = StackBuilder::Chef::Repo.new(getConfig(:repo_path))
+                repo.upload_environments(environment)
+            end
+        end
+
+    end
+end

data/lib/chef/knife/stack_upload_repo.rb

@@ -0,0 +1,39 @@
+# Copyright (c) 2014 Mevan Samaratunga
+
+require 'chef/knife/stackbuilder_base'
+
+class Chef
+    class Knife
+
+        class StackUploadRepo < Knife
+
+            include Knife::StackBuilderBase
+
+            banner "knife stack upload repo (options)"
+
+            option :repo_path,
+                :long => "--repo_path REPO_PATH",
+                :description => "The path to the Chef repo.",
+                :default => '.'
+
+            def run
+                StackBuilder::Common::Config.logger.level = Chef::Log.logger.level
+
+                environment = getConfig(:environment)
+
+                repo = StackBuilder::Chef::Repo.new(getConfig(:repo_path))
+
+                berks_knife_config = getConfig(:berks_knife_config)
+                ENV['BERKSHELF_CHEF_CONFIG'] = berks_knife_config unless berks_knife_config.nil?
+
+                repo.upload_cookbooks
+                repo.upload_roles
+
+                repo.upload_environments(environment)
+                repo.upload_data_bags(environment)
+                repo.upload_certificates(environment)
+            end
+        end
+
+    end
+end

data/lib/chef/knife/stack_upload_roles.rb

@@ -0,0 +1,33 @@
+# Copyright (c) 2014 Mevan Samaratunga
+
+require 'chef/knife/stackbuilder_base'
+
+class Chef
+    class Knife
+
+        class StackUploadRoles < Knife
+
+            include Knife::StackBuilderBase
+
+            banner "knife stack upload roles (options)"
+
+            option :repo_path,
+                :long => "--repo_path REPO_PATH",
+                :description => "The path to the Chef repo containing " +
+                    "the roles within a 'roles' folder.",
+                :default => '.'
+
+            option :role,
+                :long => "--role NAME",
+                :description => "The role upload/update"
+
+            def run
+                StackBuilder::Common::Config.logger.level = Chef::Log.logger.level
+
+                repo = StackBuilder::Chef::Repo.new(getConfig(:repo_path))
+                repo.upload_roles(getConfig(:role))
+            end
+        end
+
+    end
+end

data/lib/chef/knife/stackbuilder_base.rb

@@ -0,0 +1,32 @@
+# Copyright (c) 2014 Mevan Samaratunga
+
+class Chef
+    class Knife
+
+        module StackBuilderBase
+
+            def self.included(includer)
+
+                includer.class_eval do
+
+                    deps do
+                        require 'stackbuilder'
+
+                        config = OpenStruct.new(
+                            :logger => Chef::Log.logger,
+                            :enable_caching => false,
+                            :timeouts => { :CACHE_TIMEOUT => 1800 } )
+
+                        StackBuilder::Common::Config.configure(config)
+                    end
+                end
+
+                def getConfig(key)
+                    key = key.to_sym
+                    config[key] || Chef::Config[:knife][key]
+                end
+            end
+
+        end
+    end
+end