knife-openstack 0.5.4 → 0.6.0

data/CHANGELOG.md

@@ -0,0 +1,35 @@
+## v0.6.0
+* Switched to OpenStack API from OpenStack EC2 API.
+* Updated to point to Fog 1.4.0 for latest `OpenStack` provider
+* testing with Diablo & Essex
+* knife openstack server create (KNIFE_OPENSTACK-1)
+* knife openstack server delete (KNIFE_OPENSTACK-2)
+* Support for unenven_columns for prettier output (KNIFE_OPENSTACK-5)
+* Added chef gem dependency (KNIFE_OPENSTACK-6)
+* Added virtual cpus to 'knife openstack flavor list'
+* Removed unsupported features to match current state of plugin (public_key, kernel, architecture, cores, location)
+* Added support for openstack_tenant (Rob Hirschfeld & Alexander Gordeev)
+* Server list supports many more states
+* Added support for associating floating IPs on server create and verified they are automatically disassociated on server delete
+* Added /etc/chef/ohai/hints/openstack.json, the `openstack` Ohai plugin keys off of it and pulls from the meta-data service.
+* Automated naming of nodes if `--node-name` is not passed
+* Added support for `--no-host-key-verify` (Lamont Granquist)
+* Added support for `--private-network` for bootstrapping private network
+
+## v0.5.2
+* initial Cactus release using EC2 API
+
+# BACKLOG/ISSUES #
+This is a list of features currently lacking and (eventually) under development:
+
+* security groups are still broken, appear to be broken in Fog. Add `-G` support for security groups other than 'default'
+* purge only works when names match up with clients
+* `knife openstack floating list|associate|disassociate ip|node`
+* take either the flavor ID or the flavor name
+* take either the image ID or the image name
+* more information in `knife openstack image list`
+* get DNS names working
+* availability zones
+* filter out the *-initrd and *-kernel from 'openstack image list'. Fog -> container_format={aki|ari} or disk_format on the same params
+* assumption of only single floating IP (and fog uses the last as the public_ip_address)
+* probably other places public network is assumed that could cause issues

data/README.md

@@ -0,0 +1,102 @@
+Knife OpenStack
+===============
+
+This is the official Opscode Knife plugin for OpenStack Compute (Nova). This plugin gives knife the ability to create, bootstrap and manage instances in OpenStack Compute clouds. It has been tested against the `Diablo` and `Essex` releases in configurations using Keystone against the OpenStack API (as opposed to the EC2 API).
+
+Please refer to the CHANGELOG.md for version history and known limitations. If you are using Floating IP addresses, please refer to the "Working with Floating IPs" section below.
+
+# Installation #
+
+Be sure you are running the latest version Chef. Versions earlier than 0.10.0 don't support plugins:
+
+    $ gem install chef
+
+This plugin is distributed as a Ruby Gem. To install it, run:
+
+    $ gem install knife-openstack
+
+Depending on your system's configuration, you may need to run this command with root privileges.
+
+# Configuration #
+
+In order to communicate with an OpenStack Compute cloud's OpenStack API you will need to tell Knife your OpenStack Compute API endpoint, your Dashboard username and password (tenant is optional). The easiest way to accomplish this is to create these entries in your `knife.rb` file:
+
+    knife[:openstack_username] = "Your OpenStack Dashboard username"
+    knife[:openstack_password] = "Your OpenStack Dashboard password"
+    ### Note: If you are not proxying HTTPS to the OpenStack auth port, the scheme should be HTTP
+    knife[:openstack_auth_url] = "http://cloud.mycompany.com:5000/v2.0/tokens"
+    knife[:openstack_tenant] = "Your OpenStack tenant name"
+
+If your knife.rb file will be checked into a SCM system (ie readable by others) you may want to read the values from environment variables:
+
+    knife[:openstack_username] = "#{ENV['OS_USERNAME']}"
+    knife[:openstack_password] = "#{ENV['OS_PASSWORD']}"
+    knife[:openstack_auth_url] = "#{ENV['OS_AUTH_URL']}"
+    knife[:openstack_tenant] = "#{ENV['OS_TENANT_NAME']}"
+
+You also have the option of passing your OpenStack API Username/Password into the individual knife subcommands using the `-A` (or `--openstack-username`) `-K` (or `--openstack-password`) command options
+
+    # provision a new image named kb01
+    knife openstack server create -A 'MyUsername' -K 'MyPassword' --openstack-api-endpoint 'http://cloud.mycompany.com:5000/v2.0/tokens' -f 1 -I 13 -S trystack -i ~/.ssh/trystack.pem -r 'role[webserver]'
+
+Additionally the following options may be set in your `knife.rb`:
+
+* flavor
+* image
+* openstack_ssh_key_id
+* template_file
+
+# Working with Floating IPs #
+
+To use a floating IP address while bootstrapping nodes, use the `-a` or `--floating-ip` option. For the node to have the floating IP address after bootstrapping, it is required to use the new `openstack.rb` Ohai plugin, waiting for the next Ohai release or installed using the [ohai cookbook](https://github.com/opscode-cookbooks/ohai). https://github.com/mattray/ohai/tree/OHAI-381 is the ticket for this.
+
+# Subcommands #
+
+This plugin provides the following Knife subcommands. Specific command options can be found by invoking the subcommand with a `--help` option.
+
+knife openstack server create
+-----------------------------
+
+Provisions a new server in an OpenStack Compute cloud and then perform a Chef bootstrap (using the SSH protocol). The goal of the bootstrap is to get Chef installed on the target system so it can run Chef Client with a Chef Server. The main assumption is a baseline OS installation exists (provided by the provisioning). It is primarily intended for Chef Client systems that talk to a Chef server. By default the server is bootstrapped using the [chef-full](https://github.com/opscode/chef/blob/master/chef/lib/chef/knife/bootstrap/chef-full.erb) template (default after the 10.10 release). This may be overridden using the `-d` or `--template-file` command options. If you do not have public IP addresses, use the `--private-network` option to use the private IP address for bootstrapping.
+
+knife openstack server delete
+-----------------------------
+
+Deletes an existing server in the currently configured OpenStack Compute cloud account. If a floating IP address has been assigned to the node, it is disassociated automatically by the OpenStack server. <b>PLEASE NOTE</b> - this does not delete the associated node and client objects from the Chef server without using the `-P` option to purge the client.
+
+knife openstack server list
+---------------------------
+
+Outputs a list of all servers in the currently configured OpenStack Compute cloud account. <b>PLEASE NOTE</b> - this shows all instances associated with the account, some of which may not be currently managed by the Chef server.
+
+knife openstack flavor list
+---------------------------
+
+Outputs a list of all available flavors (available hardware configuration for a server) available to the currently configured OpenStack Compute cloud account. Each flavor has a unique combination of virtual cpus, disk space and memory capacity. This data can be useful when choosing a flavor id to pass to the `knife openstack server create` subcommand.
+
+knife openstack image list
+--------------------------
+
+Outputs a list of all available images available to the currently configured OpenStack Compute cloud account. An image is a collection of files used to create or rebuild a server. This data can be useful when choosing an image id to pass to the `knife openstack server create` subcommand.
+
+# License #
+
+Author:: Seth Chisamore (<schisamo@opscode.com>)
+
+Author:: Matt Ray (<matt@opscode.com>)
+
+Copyright:: Copyright (c) 2011-2012 Opscode, Inc.
+
+License:: Apache License, Version 2.0
+
+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/knife-openstack.gemspec

@@ -7,9 +7,9 @@ Gem::Specification.new do |s|
   s.version     = Knife::OpenStack::VERSION
   s.platform    = Gem::Platform::RUBY
   s.has_rdoc = true
-  s.extra_rdoc_files = ["README.rdoc", "LICENSE" ]
-  s.authors     = ["Seth Chisamore"]
-  s.email       = ["schisamo@opscode.com"]
+  s.extra_rdoc_files = ["README.md", "LICENSE" ]
+  s.authors     = ["Seth Chisamore", "Matt Ray"]
+  s.email       = ["schisamo@opscode.com", "matt@opscode.com"]
   s.homepage    = "https://github.com/opscode/knife-openstack"
   s.summary     = %q{OpenStack Compute Support for Chef's Knife Command}
   s.description = s.summary
@@ -19,7 +19,6 @@ Gem::Specification.new do |s|
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ["lib"]
 
-  s.add_dependency "fog", "~> 0.7.2"
-  s.add_dependency "net-ssh", "~> 2.1.3"
-  s.add_dependency "net-ssh-multi", "~> 1.0.1"
+  s.add_dependency "fog", "~> 1.4.0"
+  s.add_dependency "chef", ">= 0.10.10"
 end

data/lib/chef/knife/openstack_base.rb

@@ -0,0 +1,108 @@
+#
+# Author:: Seth Chisamore (<schisamo@opscode.com>)
+# Author:: Matt Ray (<matt@opscode.com>)
+# Copyright:: Copyright (c) 2011-2012 Opscode, Inc.
+# License:: Apache License, Version 2.0
+#
+# 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.
+#
+
+require 'chef/knife'
+
+class Chef
+  class Knife
+    module OpenstackBase
+
+      # :nodoc:
+      # Would prefer to do this in a rational way, but can't be done b/c of
+      # Mixlib::CLI's design :(
+      def self.included(includer)
+        includer.class_eval do
+
+          deps do
+            require 'fog'
+            require 'readline'
+            require 'chef/json_compat'
+          end
+
+          option :openstack_username,
+            :short => "-A USERNAME",
+            :long => "--openstack-username KEY",
+            :description => "Your OpenStack Username",
+            :proc => Proc.new { |key| Chef::Config[:knife][:openstack_username] = key }
+
+          option :openstack_password,
+            :short => "-K SECRET",
+            :long => "--openstack-password SECRET",
+            :description => "Your OpenStack Password",
+            :proc => Proc.new { |key| Chef::Config[:knife][:openstack_password] = key }
+
+          option :openstack_tenant,
+            :short => "-T NAME",
+            :long => "--openstack-tenant NAME",
+            :description => "Your OpenStack Tenant NAME",
+            :proc => Proc.new { |key| Chef::Config[:knife][:openstack_tenant] = key }
+
+          option :openstack_auth_url,
+            :long => "--openstack-api-endpoint ENDPOINT",
+            :description => "Your OpenStack API endpoint",
+            :proc => Proc.new { |endpoint| Chef::Config[:knife][:openstack_auth_url] = endpoint }
+        end
+      end
+
+      def connection
+        Chef::Log.debug("openstack_username #{Chef::Config[:knife][:openstack_username]}")
+        Chef::Log.debug("openstack_auth_url #{Chef::Config[:knife][:openstack_auth_url]}")
+        Chef::Log.debug("openstack_tenant #{Chef::Config[:knife][:openstack_tenant]}")
+        @connection ||= begin
+          connection = Fog::Compute.new(
+            :provider => 'OpenStack',
+            :openstack_username => Chef::Config[:knife][:openstack_username],
+            :openstack_api_key => Chef::Config[:knife][:openstack_password],
+            :openstack_auth_url => Chef::Config[:knife][:openstack_auth_url],
+            :openstack_tenant => Chef::Config[:knife][:openstack_tenant]
+          )
+        end
+      end
+
+      def locate_config_value(key)
+        key = key.to_sym
+        Chef::Config[:knife][key] || config[key]
+      end
+
+      def msg_pair(label, value, color=:cyan)
+        if value && !value.to_s.empty?
+          puts "#{ui.color(label, color)}: #{value}"
+        end
+      end
+
+      def validate!(keys=[:openstack_username, :openstack_password, :openstack_auth_url])
+        errors = []
+
+        keys.each do |k|
+          pretty_key = k.to_s.gsub(/_/, ' ').gsub(/\w+/){ |w| (w =~ /(ssh)|(aws)/i) ? w.upcase  : w.capitalize }
+          if Chef::Config[:knife][k].nil?
+            errors << "You did not provided a valid '#{pretty_key}' value."
+          end
+        end
+
+        if errors.each{|e| ui.error(e)}.any?
+          exit 1
+        end
+      end
+
+    end
+  end
+end
+
+

data/lib/chef/knife/openstack_flavor_list.rb

@@ -1,6 +1,7 @@
 #
 # Author:: Seth Chisamore (<schisamo@opscode.com>)
-# Copyright:: Copyright (c) 2011 Opscode, Inc.
+# Author:: Matt Ray (<matt@opscode.com>)
+# Copyright:: Copyright (c) 2011-2012 Opscode, Inc.
 # License:: Apache License, Version 2.0
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -16,67 +17,35 @@
 # limitations under the License.
 #
 
-require 'chef/knife'
+require 'chef/knife/openstack_base'
 
 class Chef
   class Knife
     class OpenstackFlavorList < Knife
 
-      deps do
-        require 'fog'
-        require 'chef/json_compat'
-      end
-      
-      banner "knife openstack flavor list (options)"
-
-      option :openstack_access_key_id,
-        :short => "-A ID",
-        :long => "--openstack-access-key-id KEY",
-        :description => "Your OpenStack Access Key ID",
-        :proc => Proc.new { |key| Chef::Config[:knife][:openstack_access_key_id] = key }
-
-      option :openstack_secret_access_key,
-        :short => "-K SECRET",
-        :long => "--openstack-secret-access-key SECRET",
-        :description => "Your OpenStack API Secret Access Key",
-        :proc => Proc.new { |key| Chef::Config[:knife][:openstack_secret_access_key] = key }
+      include Knife::OpenstackBase
 
-      option :openstack_api_endpoint,
-        :long => "--openstack-api-endpoint ENDPOINT",
-        :description => "Your OpenStack API endpoint",
-        :proc => Proc.new { |endpoint| Chef::Config[:knife][:openstack_api_endpoint] = endpoint }
-
-      option :region,
-        :long => "--region REGION",
-        :description => "Your OpenStack region",
-        :proc => Proc.new { |region| Chef::Config[:knife][:region] = region }
+      banner "knife openstack flavor list (options)"
 
       def run
-        connection = Fog::Compute.new(
-          :provider => 'AWS',
-          :aws_access_key_id => Chef::Config[:knife][:openstack_access_key_id],
-          :aws_secret_access_key => Chef::Config[:knife][:openstack_secret_access_key],
-          :endpoint => Chef::Config[:knife][:openstack_api_endpoint],
-          :region => Chef::Config[:knife][:region] || config[:region]
-        )
+
+        validate!
 
         flavor_list = [
           ui.color('ID', :bold),
           ui.color('Name', :bold),
-          ui.color('Architecture', :bold),
+          ui.color('Virtual CPUs', :bold),
           ui.color('RAM', :bold),
           ui.color('Disk', :bold),
-          ui.color('Cores', :bold)
         ]
         connection.flavors.sort_by(&:id).each do |flavor|
           flavor_list << flavor.id.to_s
           flavor_list << flavor.name
-          flavor_list << "#{flavor.bits.to_s}-bit"
-          flavor_list << "#{flavor.ram.to_s}"
+          flavor_list << flavor.vcpus.to_s
+          flavor_list << "#{flavor.ram.to_s} MB"
           flavor_list << "#{flavor.disk.to_s} GB"
-          flavor_list << flavor.cores.to_s
         end
-        puts ui.list(flavor_list, :columns_across, 6)
+        puts ui.list(flavor_list, :uneven_columns_across, 5)
       end
     end
   end

data/lib/chef/knife/openstack_image_list.rb

@@ -1,6 +1,7 @@
 #
 # Author:: Seth Chisamore (<schisamo@opscode.com>)
-# Copyright:: Copyright (c) 2011 Opscode, Inc.
+# Author:: Matt Ray (<matt@opscode.com>)
+# Copyright:: Copyright (c) 2011-2012 Opscode, Inc.
 # License:: Apache License, Version 2.0
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -16,75 +17,45 @@
 # limitations under the License.
 #
 
-require 'chef/knife'
+require 'chef/knife/openstack_base'
 
 class Chef
   class Knife
     class OpenstackImageList < Knife
 
-      deps do
-        require 'fog'
-        require 'chef/json_compat'
-      end
+      include Knife::OpenstackBase
 
       banner "knife openstack image list (options)"
 
-      option :openstack_access_key_id,
-        :short => "-A ID",
-        :long => "--openstack-access-key-id KEY",
-        :description => "Your OpenStack Access Key ID",
-        :proc => Proc.new { |key| Chef::Config[:knife][:openstack_access_key_id] = key }
-
-      option :openstack_secret_access_key,
-        :short => "-K SECRET",
-        :long => "--openstack-secret-access-key SECRET",
-        :description => "Your OpenStack API Secret Access Key",
-        :proc => Proc.new { |key| Chef::Config[:knife][:openstack_secret_access_key] = key }
-
-      option :openstack_api_endpoint,
-        :long => "--openstack-api-endpoint ENDPOINT",
-        :description => "Your OpenStack API endpoint",
-        :proc => Proc.new { |endpoint| Chef::Config[:knife][:openstack_api_endpoint] = endpoint }
-
-      option :region,
-        :long => "--region REGION",
-        :description => "Your OpenStack region",
-        :proc => Proc.new { |region| Chef::Config[:knife][:region] = region }
-
       def run
-        connection = Fog::Compute.new(
-          :provider => 'AWS',
-          :aws_access_key_id => Chef::Config[:knife][:openstack_access_key_id],
-          :aws_secret_access_key => Chef::Config[:knife][:openstack_secret_access_key],
-          :endpoint => Chef::Config[:knife][:openstack_api_endpoint],
-          :region => Chef::Config[:knife][:region] || config[:region]
-        )
+
+        validate!
 
         image_list = [
           ui.color('ID', :bold),
-          ui.color('Kernel ID', :bold),
-          ui.color('Architecture', :bold),
-          ui.color('Root Store', :bold),
           ui.color('Name', :bold),
-          ui.color('Location', :bold)
+          # ui.color('Kernel ID', :bold),
+          # ui.color('Architecture', :bold),
+          # ui.color('Root Store', :bold),
+          # ui.color('Location', :bold)
         ]
 
         connection.images.sort_by do |image|
-          [image.name, image.id].compact
+          [image.name.downcase, image.id].compact
         end.each do |image|
           image_list << image.id
-          image_list << image.kernel_id
-          image_list << image.architecture
-          image_list << image.root_device_type
           image_list << image.name
-          image_list << image.location
+          # image_list << image.kernel_id
+          # image_list << image.architecture
+          # image_list << image.root_device_type
+          # image_list << image.location
         end
 
         image_list = image_list.map do |item|
           item.to_s
         end
 
-        puts ui.list(image_list, :columns_across, 6)
+        puts ui.list(image_list, :uneven_columns_across, 2)
       end
     end
   end