knife-server 1.1.0 → 1.2.0

data/lib/chef/knife/bootstrap/chef10/rhel.erb

@@ -174,6 +174,8 @@ configure_firewall() {
   /usr/sbin/lokkit -p 4040:tcp 
   # ssl proxy to chef-server-api
   /usr/sbin/lokkit -p 443:tcp  
+  # SSH port
+  /usr/sbin/lokkit -p 22:tcp  
 }
 
 setup

data/lib/chef/knife/bootstrap/chef11/omnibus.erb

@@ -22,6 +22,7 @@ set -e
 export hostname="<%= @config[:chef_node_name] %>"
 export version="<%= @config[:bootstrap_version] %>"
 export prerelease="<%= @config[:prerelease] == true %>"
+export url="<%= @chef_config[:knife][:server_package_url] %>"
 export webui_enable="<%= @chef_config[:knife][:webui_enable] == true %>"
 export webui_password="<%= ENV['WEBUI_PASSWORD'] %>"
 export amqp_password="<%= ENV['AMQP_PASSWORD'] %>"
@@ -55,9 +56,11 @@ tmp_dir=$(mktemp -d -t tmp.XXXXXXXX || echo "/tmp")
 set_hostname_for_${platform}
 download_package
 install_package
+detect_info
+patch_knife_code
 prepare_chef_server_rb
-symlink_binaries
 reconfigure_chef_server
+symlink_binaries
 if [ ! -n "$no_test"]
 then
   test_chef_server

data/lib/chef/knife/bootstrap/chef11/rhel.erb

@@ -129,6 +129,8 @@ configure_firewall() {
   /usr/sbin/lokkit -p 4040:tcp 
   # ssl proxy to chef-server-api
   /usr/sbin/lokkit -p 443:tcp  
+  # SSH port
+  /usr/sbin/lokkit -p 22:tcp  
 }
 
 setup

data/lib/chef/knife/server_backup.rb

@@ -1,3 +1,4 @@
+# -*- encoding: utf-8 -*-
 #
 # Author:: Fletcher Nichol (<fnichol@nichol.ca>)
 # Copyright:: Copyright (c) 2012 Fletcher Nichol
@@ -16,16 +17,17 @@
 # limitations under the License.
 #
 
-require 'chef/knife'
-require 'chef/node'
+require "chef/knife"
+require "chef/node"
 
 class Chef
   class Knife
+    # Backs up a Chef server component.
     class ServerBackup < Knife
 
       deps do
-        require 'fileutils'
-        require 'uri'
+        require "fileutils"
+        require "uri"
       end
 
       banner "knife server backup COMPONENT[ COMPONENT ...] (options)"
@@ -60,10 +62,22 @@ class Chef
       private
 
       COMPONENTS = {
-        "nodes" => { :singular => "node", :klass => Chef::Node },
-        "roles" => { :singular => "role", :klass => Chef::Role },
-        "environments" => { :singular => "environment", :klass => Chef::Environment },
-        "data_bags" => { :singular => "data_bag", :klass => Chef::DataBag },
+        "nodes" => {
+          :singular => "node",
+          :klass => Chef::Node
+        },
+        "roles" => {
+          :singular => "role",
+          :klass => Chef::Role
+        },
+        "environments" => {
+          :singular => "environment",
+          :klass => Chef::Environment
+        },
+        "data_bags" => {
+          :singular => "data_bag",
+          :klass => Chef::DataBag
+        }
       }
 
       def validate!
@@ -80,7 +94,7 @@ class Chef
         ui.msg "Creating #{c[:singular]} backups in #{dir_path}"
         FileUtils.mkdir_p(dir_path)
 
-        Array(c[:klass].list).each do |name, url|
+        Array(c[:klass].list).each do |name, _url|
           next if component == "environments" && name == "_default"
 
           case component
@@ -108,7 +122,7 @@ class Chef
         item_path = ::File.join(dir_path, name)
         FileUtils.mkdir_p(item_path)
 
-        Array(c[:klass].load(name)).each do |item_name, url|
+        Array(c[:klass].load(name)).each do |item_name, _url|
           obj = Chef::DataBagItem.load(name, item_name)
           ui.msg "Backing up #{c[:singular]}[#{name}][#{item_name}]"
           ::File.open(::File.join(item_path, "#{item_name}.json"), "wb") do |f|

data/lib/chef/knife/server_bootstrap_base.rb

@@ -1,3 +1,4 @@
+# -*- encoding: utf-8 -*-
 #
 # Author:: Fletcher Nichol (<fnichol@nichol.ca>)
 # Copyright:: Copyright (c) 2012 Fletcher Nichol
@@ -16,35 +17,39 @@
 # limitations under the License.
 #
 
-require 'chef/knife'
+require "chef/knife"
 
 class Chef
   class Knife
+    # Common behavior for server bootstrapping.
     module ServerBootstrapBase
 
-      def self.included(included_class)
+      def self.included(included_class) # rubocop:disable Metrics/MethodLength
         included_class.class_eval do
 
           deps do
-            require 'chef/knife/ssh'
-            require 'net/ssh'
+            require "chef/knife/ssh"
+            require "net/ssh"
           end
 
           option :platform,
             :short => "-P PLATFORM",
             :long => "--platform PLATFORM",
-            :description => "The platform type that will be bootstrapped (omnibus)",
+            :description => "The platform type that will be bootstrapped, "\
+              "default is 'omnibus'",
             :default => "omnibus"
 
           option :distro,
             :short => "-d DISTRO",
             :long => "--distro DISTRO",
-            :description => "Bootstrap a distro using a template; default is 'chef11/omnibus'"
+            :description => "Bootstrap a distro using a template, " \
+              "default is 'chef11/omnibus'"
 
           option :bootstrap_version,
             :long => "--bootstrap-version VERSION",
-            :description => "The version of Chef Server to install, default is latest release",
-            :proc => Proc.new { |v| Chef::Config[:knife][:bootstrap_version] = v },
+            :description => "The version of Chef Server to install, " \
+              "default is latest release",
+            :proc => proc { |v| Chef::Config[:knife][:bootstrap_version] = v },
             :default => nil
 
           option :prerelease,
@@ -53,13 +58,15 @@ class Chef
 
           option :webui_enable,
             :long => "--[no-]webui-enable",
-            :description => "Whether or not to enable the webui, default is false",
-            :proc => Proc.new { |v| Chef::Config[:knife][:webui_enable] = v },
+            :description => "Whether or not to enable the webui, " \
+              "default is false",
+            :proc => proc { |v| Chef::Config[:knife][:webui_enable] = v },
             :default => false
 
           option :webui_password,
             :long => "--webui-password SECRET",
-            :description => "Initial password for WebUI admin account, default is 'chefchef'",
+            :description => "Initial password for WebUI admin account, " \
+              "default is 'chefchef'",
             :default => "chefchef"
 
           option :amqp_password,
@@ -70,19 +77,47 @@ class Chef
           option :log_level,
             :short => "-l LEVEL",
             :long => "--log-level LEVEL",
-            :description  => "Set the log level (debug, info, warn, error, fatal)",
-            :proc => Proc.new { |v| Chef::Config[:knife][:log_level] = v.to_sym },
+            :description  => "Set the log level " \
+              "(debug, info, warn, error, fatal), default is error",
+            :proc => proc { |v| Chef::Config[:knife][:log_level] = v.to_sym },
             :default => :error
 
           option :no_test,
             :short => "-n",
             :long => "--no-test",
-            :description => "Do not run opscode pedant as a part of the omnibus installation"
+            :description => "Do not run opscode pedant as a part of the " \
+              "omnibus installation"
+
+          option :url,
+            :long => "--url URL",
+            :description => "URL to specfic package release",
+            :proc => proc { |u| Chef::Config[:knife][:server_package_url] = u }
         end
       end
 
+      def run
+        validate!
+      end
+
       private
 
+      def validate!
+        knife_fail = "You did not set {{KEY}} in your knife.rb, which is a " \
+            "required setting. Please generate an initial knife.rb or read " \
+            "the setup instructions at http://fnichol.github.io/knife-server/"
+
+        # rubocop:disable Style/DeprecatedHashMethods
+        if Chef::Config[:node_name].nil?
+          ui.error knife_fail.gsub(/{{KEY}}/, "node_name")
+          exit 1
+        end
+        if Chef::Config[:client_key].nil?
+          ui.error knife_fail.gsub(/{{KEY}}/, "client_key")
+          exit 1
+        end
+        # rubocop:enable Style/DeprecatedHashMethods
+      end
+
       def fetch_validation_key
         credentials_client.install_validation_key
       end
@@ -100,7 +135,7 @@ class Chef
         config_val(:platform) == "auto"
       end
 
-      def distro_auto_map(platform, platform_version)
+      def distro_auto_map(platform, _platform_version)
         # NOTE this logic is shared with chef/knife/bootstrap/auto.sh, which is
         #      run on the server side.
         # XXX we don't actually use the platform_version stuff, just included
@@ -120,7 +155,7 @@ class Chef
                    "suse"
                  end
 
-        return construct_distro(normal)
+        construct_distro(normal)
       end
 
       def construct_distro(platform)
@@ -136,7 +171,8 @@ class Chef
       def bootstrap_distro
         return config_val(:distro) if config_val(:distro)
         return determine_platform if config_val(:platform) == "auto"
-        return construct_distro(config_val(:platform))
+
+        construct_distro(config_val(:platform))
       end
 
       def credentials_client
@@ -149,23 +185,32 @@ class Chef
       def determine_platform
         return nil unless bootstrap_auto?
 
-        script = File.binread(File.expand_path("bootstrap/auto.sh", File.dirname(__FILE__)))
+        script = File.binread(
+          File.expand_path("bootstrap/auto.sh", File.dirname(__FILE__))
+        )
 
         # result is expected to be two lines, first being the platform name,
         # second being the platform version.
         result, exit_status = ssh_connection.run_script(script)
 
-        if exit_status != 0 or !result or result.strip.empty?
-          raise "Could not determine the OS running the target for the chef server. Please specify --platform."
+        if exit_status != 0 || !result || result.strip.empty?
+          raise "Could not determine the OS running the target for " \
+            "the chef server. Please specify --platform."
         end
 
-        return distro_auto_map(*result.split(/\n/).compact[0..1])
+        distro_auto_map(*result.split(/\n/).compact[0..1])
       end
 
       def config_val(key)
         key = key.to_sym
-        default_value = options[key] && options[key][:default]
-        config.fetch(key, Chef::Config[:knife].fetch(key, default_value))
+        case
+        when !config[key].nil?
+          config[key]
+        when !Chef::Config[:knife][key].nil?
+          Chef::Config[:knife][key]
+        else
+          options[key] && options[key][:default]
+        end
       end
     end
   end

data/lib/chef/knife/server_bootstrap_ec2.rb

@@ -1,3 +1,4 @@
+# -*- encoding: utf-8 -*-
 #
 # Author:: Fletcher Nichol (<fnichol@nichol.ca>)
 # Copyright:: Copyright (c) 2012 Fletcher Nichol
@@ -16,10 +17,11 @@
 # limitations under the License.
 #
 
-require 'chef/knife/server_bootstrap_base'
+require "chef/knife/server_bootstrap_base"
 
 class Chef
   class Knife
+    # Provisions an EC2 instance and sets up an Open Source Chef Server.
     class ServerBootstrapEc2 < Knife
 
       banner "knife server bootstrap ec2 (options)"
@@ -27,18 +29,18 @@ class Chef
       include Knife::ServerBootstrapBase
 
       deps do
-        require 'knife/server/ssh'
-        require 'knife/server/credentials'
-        require 'knife/server/ec2_security_group'
+        require "knife/server/ssh"
+        require "knife/server/credentials"
+        require "knife/server/ec2_security_group"
 
         begin
-          require 'chef/knife/ec2_server_create'
-          require 'fog'
+          require "chef/knife/ec2_server_create"
+          require "fog"
           Chef::Knife::Ec2ServerCreate.load_deps
 
-          current_options = self.options
+          current_options = options
           self.options = Chef::Knife::Ec2ServerCreate.options.dup
-          self.options.merge!(current_options)
+          options.merge!(current_options)
         rescue LoadError => ex
           ui.error [
             "Knife plugin knife-ec2 could not be loaded.",
@@ -55,10 +57,10 @@ class Chef
         :long => "--groups X,Y,Z",
         :description => "The security groups for this server",
         :default => ["infrastructure"],
-        :proc => Proc.new { |groups| groups.split(',') }
+        :proc => proc { |groups| groups.split(",") }
 
       def run
-        validate!
+        super
         config_security_group
         ec2_bootstrap.run
         fetch_validation_key
@@ -67,12 +69,13 @@ class Chef
       end
 
       def ec2_bootstrap
-        ENV['WEBUI_PASSWORD'] = config_val(:webui_password)
-        ENV['AMQP_PASSWORD'] = config_val(:amqp_password)
-        ENV['NO_TEST'] = "1" if config[:no_test]
+        setup_environment
         bootstrap = Chef::Knife::Ec2ServerCreate.new
         Chef::Knife::Ec2ServerCreate.options.keys.each do |attr|
-          bootstrap.config[attr] = config_val(attr)
+          val = config_val(attr)
+          next if val.nil?
+
+          bootstrap.config[attr] = val
         end
         bootstrap.config[:tags] = bootstrap_tags
         bootstrap.config[:distro] = bootstrap_distro
@@ -81,7 +84,7 @@ class Chef
 
       def ec2_connection
         @ec2_connection ||= Fog::Compute.new(
-          :provider => 'AWS',
+          :provider => "AWS",
           :aws_access_key_id => config_val(:aws_access_key_id),
           :aws_secret_access_key => config_val(:aws_secret_access_key),
           :region => config_val(:region)
@@ -91,8 +94,8 @@ class Chef
       def server_dns_name
         server = ec2_connection.servers.find do |s|
           s.state == "running" &&
-            s.tags['Name'] == config_val(:chef_node_name) &&
-            s.tags['Role'] == 'chef_server'
+            s.tags["Name"] == config_val(:chef_node_name) &&
+            s.tags["Role"] == "chef_server"
         end
 
         server && server.dns_name
@@ -101,6 +104,8 @@ class Chef
       private
 
       def validate!
+        super
+
         if config[:chef_node_name].nil?
           ui.error "You did not provide a valid --node-name value."
           exit 1
@@ -111,8 +116,16 @@ class Chef
         end
       end
 
+      def setup_environment
+        ENV["WEBUI_PASSWORD"] = config_val(:webui_password)
+        ENV["AMQP_PASSWORD"] = config_val(:amqp_password)
+        ENV["NO_TEST"] = "1" if config[:no_test]
+      end
+
       def config_security_group(name = nil)
-        if config[:security_group_ids].nil? || config[:security_group_ids].empty?
+        ids = config[:security_group_ids]
+
+        if ids.nil? || ids.empty?
           name = config_val(:security_groups).first if name.nil?
           ::Knife::Server::Ec2SecurityGroup.new(ec2_connection, ui).
             configure_chef_server_group(name, :description => "#{name} group")
@@ -122,8 +135,8 @@ class Chef
       end
 
       def bootstrap_tags
-        Hash[Array(config_val(:tags)).map { |t| t.split('=') }].
-          merge({"Role" => "chef_server"}).map { |k,v| "#{k}=#{v}" }
+        Hash[Array(config_val(:tags)).map { |t| t.split("=") }].
+          merge("Role" => "chef_server").map { |k, v| "#{k}=#{v}" }
       end
 
       def ssh_connection

data/lib/chef/knife/server_bootstrap_linode.rb

@@ -1,3 +1,4 @@
+# -*- encoding: utf-8 -*-
 #
 # Author:: Fletcher Nichol (<fnichol@nichol.ca>)
 # Copyright:: Copyright (c) 2013 Fletcher Nichol
@@ -16,10 +17,11 @@
 # limitations under the License.
 #
 
-require 'chef/knife/server_bootstrap_base'
+require "chef/knife/server_bootstrap_base"
 
 class Chef
   class Knife
+    # Provisions a Linode instance and sets up an Open Source Chef Server.
     class ServerBootstrapLinode < Knife
 
       banner "knife server bootstrap linode (options)"
@@ -27,17 +29,17 @@ class Chef
       include Knife::ServerBootstrapBase
 
       deps do
-        require 'knife/server/ssh'
-        require 'knife/server/credentials'
+        require "knife/server/ssh"
+        require "knife/server/credentials"
 
         begin
-          require 'chef/knife/linode_server_create'
-          require 'fog'
+          require "chef/knife/linode_server_create"
+          require "fog"
           Chef::Knife::LinodeServerCreate.load_deps
 
-          current_options = self.options
+          current_options = options
           self.options = Chef::Knife::LinodeServerCreate.options.dup
-          self.options.merge!(current_options)
+          options.merge!(current_options)
         rescue LoadError => ex
           ui.error [
             "Knife plugin knife-linode could not be loaded.",
@@ -50,7 +52,7 @@ class Chef
       end
 
       def run
-        validate!
+        super
         linode_bootstrap.run
         fetch_validation_key
         create_root_client
@@ -58,12 +60,15 @@ class Chef
       end
 
       def linode_bootstrap
-        ENV['WEBUI_PASSWORD'] = config_val(:webui_password)
-        ENV['AMQP_PASSWORD'] = config_val(:amqp_password)
-        ENV['NO_TEST'] = "1" if config[:no_test]
+        ENV["WEBUI_PASSWORD"] = config_val(:webui_password)
+        ENV["AMQP_PASSWORD"] = config_val(:amqp_password)
+        ENV["NO_TEST"] = "1" if config[:no_test]
         bootstrap = Chef::Knife::LinodeServerCreate.new
         Chef::Knife::LinodeServerCreate.options.keys.each do |attr|
-          bootstrap.config[attr] = config_val(attr)
+          val = config_val(attr)
+          next if val.nil?
+
+          bootstrap.config[attr] = val
         end
         bootstrap.config[:distro] = bootstrap_distro
         bootstrap
@@ -71,7 +76,7 @@ class Chef
 
       def linode_connection
         @linode_connection ||= Fog::Compute.new(
-          :provider => 'Linode',
+          :provider => "Linode",
           :linode_api_key => config_val(:linode_api_key)
         )
       end
@@ -87,6 +92,8 @@ class Chef
       private
 
       def validate!
+        super
+
         if config[:chef_node_name].nil?
           ui.error "You did not provide a valid --node-name value."
           exit 1