knife-openstack 0.10.0 → 1.0.0.rc1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 13492963594dd97e5007238a36319adbe3b86135
+  data.tar.gz: 95480b2805c8ff46602929ee7f240d35a7447aa7
+SHA512:
+  metadata.gz: 4eb2ee6abd59a5836b33bd8fa692b858e3708afbec35b44759ef04679e7fb97ad4bd9d6531282d8747670448a148641e1431c28de3b7e0ccb73745fafe56e40e
+  data.tar.gz: d0b82f89495c66b4efda371a08bd5b40d7e4292cf24abcb74c734e01c79182cf776d2b161a319285883b9b6757a031875270325d069fcace8373b2053bfddebc

data/.gitignore

@@ -2,4 +2,26 @@
 .bundle
 .rvmrc
 Gemfile.lock
+.autotest
+coverage
+.DS_Store
+pkg
+*/tags
+
+# ignore some common Bundler 'binstubs' directory names
+# http://gembundler.com/man/bundle-exec.1.html
+b/
+binstubs/
+
+# RVM and RBENV ruby version files
+.rbenv-version
+.rvmrc
+
+# Documentation
+_site/*
+.yardoc/
+doc/
 pkg/*
+
+#keys
+*.pem

data/.travis.yml

@@ -0,0 +1,6 @@
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - 2.1.2
+
+script: bundle exec rake spec

data/CHANGELOG.md

@@ -1,36 +1,18 @@
-## v0.10.0
-DONE
-* KNIFE-368 Ability to specify metadata during OpenStack server create
-* KNIFE-423 Add ability for knife-openstack to specify network IDs to attach
-* KNIFE-428 Added Availability zone to knife openstack
-* KNIFE-467 --no-network fails to find first network IP address
-* KNIFE-471 Explicitly define NIC for private network when creating server
-* KNIFE-474 knife openstack group list throws a fog deprecation warning
-* KNIFE-475 json-attributes option wasnt actually getting passed to bootstrap
-* KNIFE-477 Delete openstack instance by name
-* KNIFE-478 Generated SSH password not passed to bootstrap
-* add support for working with names instead of ids, updated listing accordingly
 
-## v0.9.1
-* KNIFE-462 missing user_data throws stack
-
-## v0.9.0
-* KNIFE-231 added ability to specify arbitrary bootstrap network ID
-* KNIFE-264 Add support for --json-attributes
-* KNIFE-277 knife openstack "ERROR: No IP address available for bootstrapping."
+* Implementation using knife-cloud gem
 * KNIFE-310 "knife openstack server list" will fail with boot from volume instances
-* KNIFE-435 Support user data for OpenStack server create
-* KNIFE-436 Support fixed network type for OpenStack server create
-* https://github.com/opscode/chef-rfc/pull/7/ create/delete enhancements
 
 ## v0.8.1
+
 * KNIFE-296 knife-windows overrides -i, -p, -P and -x options with winrm values
 * KNIFE-304 enable setting the ssh port for knife-openstack
 
 ## v0.8.0
+
 * KNIFE-221 Windows bootstrapping (winrm-based) support for knife-openstack (Chirag Jog)
 
 ## v0.7.1
+
 * KNIFE-261 file permissions fixed
 
 ## v0.7.0
@@ -76,3 +58,19 @@ DONE
 
 ## V0.5.2
 * initial Cactus release using EC2 API
+
+# BACKLOG/ISSUES #
+This is a list of missing(?) features and open questions currently under development consideration:
+
+* Basic availability zones support (Jarek Zmudzinski) NEED TESTING ACCESS FOR AVAILABILITY ZONES
+* purge only works when names match up with clients
+* `knife openstack floating list|associate|release NODE` with --floating-ip-pool also
+* KNIFE-229 Allow specifying the name of the pool when using floating IPs
+* attempt to allocate a floating ipaddress if none if free, currently missing in Fog
+* KNIFE-76 take either the flavor ID or the flavor name
+* take either the image ID or the image name (similar for KNIFE-76)
+* KNIFE-86 server create with expired password hangs
+* KNIFE-231 added ability to specify arbitrary network ID
+* 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
+* fog is putting the original public IP address into the private_ip_address method when you get a floating_ip, this is wrong. Remove KNIFE-248 code once fixed.

data/Gemfile

@@ -1,4 +1,14 @@
-source "http://rubygems.org"
+source "https://rubygems.org"
 
 # Specify your gem's dependencies in knife-openstack.gemspec
 gemspec
+
+group :development do
+  gem 'rspec', '>= 2.7.0'
+  gem 'guard-rspec'
+  gem 'rspec_junit_formatter'
+  gem 'rake'
+  gem 'mixlib-shellout'
+  gem 'knife-cloud', :git => 'https://github.com/opscode/knife-cloud.git'
+  gem 'knife-windows', :git => 'https://github.com/opscode/knife-windows.git'
+end

data/README.md

@@ -1,3 +1,5 @@
+[![Build Status](https://travis-ci.org/opscode/knife-openstack.png)](https://travis-ci.org/opscode/knife-openstack)
+
 Knife OpenStack
 ===============
 
@@ -27,9 +29,9 @@ In order to communicate with an OpenStack API you will need to tell Knife your O
     knife[:openstack_password] = "Your OpenStack Dashboard password"
     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:
+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.  For example, using the conventions of [OpenStack's RC file](http://docs.openstack.org/user-guide/content/cli_openrc.html) (note the `openstack_auth_url`):
 
-    knife[:openstack_auth_url] = "#{ENV['OS_AUTH_URL']}"
+    knife[:openstack_auth_url] = "#{ENV['OS_AUTH_URL']}/tokens"
     knife[:openstack_username] = "#{ENV['OS_USERNAME']}"
     knife[:openstack_password] = "#{ENV['OS_PASSWORD']}"
     knife[:openstack_tenant] = "#{ENV['OS_TENANT_NAME']}"
@@ -56,7 +58,7 @@ Additionally the following options may be set in your `knife.rb`:
 
 # Working with Floating IPs #
 
-To use a floating IP address while bootstrapping nodes, use the `-a` or `--floating-ip` option.
+To use a floating IP address while bootstrapping nodes, use the `-a` or `--openstack-floating-ip` option.
 
 # Working with Windows Images #
 
@@ -108,7 +110,7 @@ Provides a list of the security groups available to the currently configured Ope
 knife openstack network list
 --------------------
 
-Lists the networks available to the currently configured OpenStack account. This data may be useful when choosing your networks to pass to the `knife openstack server create` subcommand. This command is only available with OpenStack deployments using the Neutron network service (not nova-network). Please see `knife openstack server delete --help` for all of the supported options.
+Lists the networks available to the currently configured OpenStack account. This data may be useful when choosing your networks to pass to the `knife openstack server create` subcommand. This command is only available with OpenStack deployments using the Neutron network service (not nova-network). Please see `knife openstack server create --help` for all of the supported options.
 
 # License #
 

data/Rakefile

@@ -1,2 +1,35 @@
+# Author:: Kaustubh Deorukhkar (<kaustubh@clogeny.com>)
+# Copyright:: Copyright (c) 2013 Chef Software, Inc.
+
 require 'bundler'
 Bundler::GemHelper.install_tasks
+
+require 'rubygems'
+require 'rubygems/package_task'
+
+task :default => :all
+task :all => [:spec, :uninstall, :install]
+
+# Packaging
+GEM_NAME = "knife-openstack"
+require File.dirname(__FILE__) + '/lib/knife-openstack/version'
+spec = eval(File.read("knife-openstack.gemspec"))
+Gem::PackageTask.new(spec) do |pkg|
+  pkg.gem_spec = spec
+end
+
+desc "uninstall #{GEM_NAME}-#{Knife::OpenStack::VERSION}.gem from system..."
+task :uninstall do
+  sh %{gem uninstall #{GEM_NAME} -x -v #{Knife::OpenStack::VERSION} }
+end
+
+# rspec
+begin
+  require 'rspec/core/rake_task'
+  desc "Run all specs in spec directory"
+  RSpec::Core::RakeTask.new(:spec) do |t|
+    t.pattern = 'spec/unit/**/*_spec.rb'
+  end
+rescue LoadError
+  STDERR.puts "\n*** RSpec not available. (sudo) gem install rspec to run unit tests. ***\n\n"
+end

data/knife-openstack.gemspec

@@ -8,21 +8,20 @@ Gem::Specification.new do |s|
   s.platform    = Gem::Platform::RUBY
   s.has_rdoc = true
   s.extra_rdoc_files = ["README.md", "LICENSE" ]
-  s.authors     = ["Seth Chisamore", "Matt Ray"]
-  s.email       = ["schisamo@getchef.com", "matt@getchef.com"]
+  s.authors     = ["Clogeny"]
+  s.email       = ["contact@clogeny.com"]
   s.homepage    = "https://github.com/opscode/knife-openstack"
   s.summary     = %q{OpenStack Compute Support for Chef's Knife Command}
-  s.description = s.summary
+  s.description = %q{OpenStack Compute Support for Chef's Knife Command using knife-cloud gem}
 
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ["lib"]
 
-  s.add_dependency "fog", ">= 1.10.0"
-  s.add_dependency "chef", ">= 0.10.10"
-  s.add_dependency "knife-windows"
+  s.add_dependency "fog", "~> 1.23"
+  s.add_dependency "chef", ">= 11"
+  s.add_dependency "knife-cloud", "~> 1.0"
 
-  %w(rspec-core rspec-expectations rspec-mocks rspec_junit_formatter).each { |gem| s.add_development_dependency gem }
-  s.require_paths = ["lib"]
+  %w(rake rspec-core rspec-expectations rspec-mocks rspec_junit_formatter).each { |gem| s.add_development_dependency gem }
 end

data/lib/chef/knife/cloud/openstack_server_create_options.rb

@@ -0,0 +1,75 @@
+
+require 'chef/knife/cloud/server/create_options'
+
+class Chef
+  class Knife
+    class Cloud
+      module OpenstackServerCreateOptions
+        def self.included(includer)
+          includer.class_eval do
+            include ServerCreateOptions
+
+            # Openstack Server create params.
+            option :private_network,
+            :long => "--openstack-private-network",
+            :description => "Use the private IP for bootstrapping rather than the public IP",
+            :boolean => true,
+            :default => false
+
+            option :openstack_floating_ip,
+            :short => "-a [IP]",
+            :long => "--openstack-floating-ip [IP]",
+            :default => "-1",
+            :description => "Request to associate a floating IP address to the new OpenStack node. Assumes IPs have been allocated to the project. Specific IP is optional."
+
+            option :openstack_security_groups,
+            :short => "-G X,Y,Z",
+            :long => "--openstack-groups X,Y,Z",
+            :description => "The security groups for this server",
+            :default => ["default"],
+            :proc => Proc.new { |groups| groups.split(',') }
+
+            option :openstack_ssh_key_id,
+            :short => "-S KEY",
+            :long => "--openstack-ssh-key-id KEY",
+            :description => "The OpenStack SSH keypair id",
+            :proc => Proc.new { |key| Chef::Config[:knife][:openstack_ssh_key_id] = key }
+            
+            option :user_data,
+            :long => "--user-data USER_DATA",
+            :description => "The file path containing user data information for this server",
+            :proc => Proc.new { |user_data| open(user_data) { |f| f.read }  }
+
+            option :bootstrap_network,
+            :long => '--bootstrap-network NAME',
+            :default => 'public',
+            :description => "Specify network for bootstrapping. Default is 'public'."
+
+            option :network,
+            :long => "--no-network",
+            :boolean => true,
+            :default => true,
+            :description => "Use first available network for bootstrapping if 'public' and 'private' are unavailable."
+
+            option :network_ids,
+            :long => "--network-ids NETWORK_ID_1,NETWORK_ID_2,NETWORK_ID_3",
+            :description => "Comma separated list of the UUID(s) of the network(s) for the server to attach",
+            :proc => Proc.new { |networks| networks.split(',') }
+
+            option :availability_zone,
+            :short => "-Z ZONE_NAME",
+            :long => "--availability-zone ZONE_NAME",
+            :description => "The availability zone for this server",
+            :proc => Proc.new { |z| Chef::Config[:knife][:availability_zone] = z }
+
+            option :metadata,
+            :short => "-M X=1",
+            :long => "--metadata X=1",
+            :description => "Metadata information for this server (may pass multiple times)",
+            :proc => Proc.new { |data| Chef::Config[:knife][:metadata] ||= {}; Chef::Config[:knife][:metadata].merge!({data.split('=')[0]=>data.split('=')[1]})}
+          end
+        end
+      end
+    end
+  end
+end

data/lib/chef/knife/cloud/openstack_service.rb

@@ -0,0 +1,62 @@
+#
+# Author:: Siddheshwar More (<siddheshwar.more@clogeny.com>)
+# Author:: Kaustubh Deorukhkar (<kaustubh@clogeny.com>)
+# Copyright:: Copyright (c) 2013 Chef Software, Inc.
+#
+
+require 'chef/knife/cloud/fog/service'
+
+class Chef
+  class Knife
+    class Cloud
+      class OpenstackService < FogService
+
+        def initialize(options = {})
+          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]}")
+          Chef::Log.debug("openstack_endpoint_type #{Chef::Config[:knife][:openstack_endpoint_type] || 'publicURL' }")
+          Chef::Log.debug("openstack_insecure #{Chef::Config[:knife][:openstack_insecure].to_s}")
+
+          super(options.merge({
+                              :auth_params => {
+                                :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_endpoint_type => Chef::Config[:knife][:openstack_endpoint_type],
+                                :openstack_tenant => Chef::Config[:knife][:openstack_tenant],
+                                :connection_options => {
+                                  :ssl_verify_peer => !Chef::Config[:knife][:openstack_insecure]
+                                }
+                }}))
+        end
+
+        # add alternate user defined api_endpoint value.
+        def add_api_endpoint
+          @auth_params.merge!({:openstack_auth_url => Chef::Config[:knife][:api_endpoint]}) unless Chef::Config[:knife][:api_endpoint].nil?
+        end
+
+        def get_server(search_term)
+          begin
+            if server = connection.servers.get(search_term)
+              return server
+            end
+
+            if servers = connection.servers.all(:name => search_term)
+              if servers.length > 1
+                error_message = "Multiple server matches found for '#{search_term}', use an instance_id to be more specific."
+                ui.fatal(error_message)
+                raise CloudExceptions::ValidationError, error_message
+              else
+                servers.first
+              end
+            end
+          rescue Excon::Errors::BadRequest => e
+            handle_excon_exception(CloudExceptions::KnifeCloudError, e)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/chef/knife/cloud/openstack_service_options.rb

@@ -0,0 +1,50 @@
+require 'chef/knife/cloud/fog/options'
+class Chef
+  class Knife
+    class Cloud
+      module OpenstackServiceOptions
+
+       def self.included(includer)
+          includer.class_eval do
+            include FogOptions
+            # Openstack Connection params.
+            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 }
+
+            option :openstack_endpoint_type,
+              :long => "--openstack-endpoint-type ENDPOINT_TYPE",
+              :description => "OpenStack endpoint type to use (publicURL, internalURL, adminURL)",
+              :proc => Proc.new { |type| Chef::Config[:knife][:openstack_endpoint_type] = type }
+
+            option :openstack_insecure,
+              :long => "--insecure",
+              :description => "Ignore SSL certificate on the Auth URL",
+              :boolean => true,
+              :default => false,
+              :proc => Proc.new { |key| Chef::Config[:knife][:openstack_insecure] = key }
+          end
+        end
+      end
+    end
+  end
+end

data/lib/chef/knife/openstack_flavor_list.rb

@@ -1,58 +1,44 @@
-#
-# Author:: Seth Chisamore (<schisamo@getchef.com>)
-# Author:: Matt Ray (<matt@getchef.com>)
-# Copyright:: Copyright (c) 2011-2014 Chef Software, 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/openstack_base'
+# Author:: Prabhu Das (<prabhu.das@clogeny.com>)
+# Copyright:: Copyright (c) 2014 Chef Software, Inc.
+
+require 'chef/knife/cloud/list_resource_command'
+require 'chef/knife/openstack_helpers'
+require 'chef/knife/cloud/openstack_service_options'
 
 class Chef
   class Knife
-    class OpenstackFlavorList < Knife
-
-      include Knife::OpenstackBase
-
-      banner "knife openstack flavor list (options)"
-
-      def run
-
-        validate!
-
-        flavor_list = [
-          ui.color('Name', :bold),
-          ui.color('ID', :bold),
-          ui.color('Virtual CPUs', :bold),
-          ui.color('RAM', :bold),
-          ui.color('Disk', :bold),
-        ]
-        begin
-          connection.flavors.sort_by(&:name).each do |flavor|
-            flavor_list << flavor.name
-            flavor_list << flavor.id.to_s
-            flavor_list << flavor.vcpus.to_s
-            flavor_list << "#{flavor.ram.to_s} MB"
-            flavor_list << "#{flavor.disk.to_s} GB"
-          end
-        rescue Excon::Errors::BadRequest => e
-          response = Chef::JSONCompat.from_json(e.response.body)
-          ui.fatal("Unknown server error (#{response['badRequest']['code']}): #{response['badRequest']['message']}")
-          raise e
+    class Cloud
+      class OpenstackFlavorList < ResourceListCommand
+        include OpenstackHelpers
+        include OpenstackServiceOptions
+
+        banner "knife openstack flavor list (options)"
+
+        def before_exec_command
+          #set columns_with_info map
+          @columns_with_info = [
+            {:label => 'Name', :key => 'name'},
+            {:label => 'ID', :key => 'id'},
+            {:label => 'Virtual CPUs', :key => 'vcpus'},
+            {:label => 'RAM', :key => 'ram', :value_callback => method(:ram_in_mb)},
+            {:label => 'Disk', :key => 'disk', :value_callback => method(:disk_in_gb)}
+          ]
+          @sort_by_field = "name"
+        end
+
+        def query_resource
+          @service.list_resource_configurations
         end
-        puts ui.list(flavor_list, :uneven_columns_across, 5)
+
+        def ram_in_mb(ram)
+          "#{ram} MB"
+        end
+
+        def disk_in_gb(disk)
+          "#{disk} GB"
+        end
+
       end
     end
   end
-end
+end