knife-cloudstack 0.0.13 → 0.0.14

data/lib/chef/knife/cs_stack_delete.rb

@@ -16,8 +16,6 @@
 # limitations under the License.
 #
 
-require 'chef/knife'
-
 module KnifeCloudstack
   class CsStackDelete < Chef::Knife
 
@@ -25,6 +23,8 @@ module KnifeCloudstack
       require 'chef/json_compat'
       require 'chef/mash'
       require 'knife-cloudstack/connection'
+      require 'chef/knife'
+      Chef::Knife.load_deps
       KnifeCloudstack::CsServerDelete.load_deps
     end
 

data/lib/chef/knife/cs_template_create.rb

@@ -0,0 +1,121 @@
+#
+# Author:: Sander Botman (<sbotman@schubergphilis.com>)
+# Author:: Frank Breedijk (<fbreedijk@schubergphilis.com>)
+# Copyright:: Copyright (c) 2013 
+# 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/cs_base'
+
+module KnifeCloudstack
+  class CsTemplateCreate < Chef::Knife
+
+    include Chef::Knife::KnifeCloudstackBase
+
+    deps do
+      require 'knife-cloudstack/connection'
+      Chef::Knife.load_deps
+    end
+
+    banner "knife cs template create NAME (options)"
+
+    option :displaytext,
+           :short => "-T 'DISPLAY TEXT' ",
+           :long => "--displaytext 'DISPLAY TEXT'",
+           :description => "The display text of the template",
+           :required => true,
+           :on => :head
+
+    option :name,
+           :long => "--name NAME",
+           :description => "Specify templatename (without format checking)"
+
+    option :ostypeid,
+           :long => "--ostypeid ID",
+           :description => "Specify OS type ID",
+           :required => true,
+           :on => :head
+
+    option :volumeid,
+           :long => "--volumeid=ID",
+           :description => "Specify volume ID",
+           :required => true,
+           :on => :head
+
+    option :ispublic,
+           :long => "--[no-]public",
+	   :description => "Make the template public after creation",
+	   :boolean => true,
+	   :default => false
+
+    option :isfeatured,
+           :long => "--[no-]featured",
+	   :description => "Make the template featured after creation",
+	   :boolean => true,
+	   :default => false
+
+    option :passwordenabled,
+           :long => "--[no-]passwordenabled",
+	   :description => "Make the template password reset enabled  after creation",
+	   :boolean => true,
+	   :default => true
+
+    option :extractable,
+           :logn => "--[no-]extractable",
+	   :description => "Make the template extractable after creation",
+	   :boolean => "true",
+	   :default => false
+
+    def run
+      validate_base_options
+
+      Chef::Log.debug("Validate hostname and options")
+      if  locate_config_value(:name)
+        templatename = locate_config_value(:name)
+      else
+        templatename = @name_args.first
+        unless /^[a-zA-Z0-9][a-zA-Z0-9_\-#]*$/.match templatename then
+          ui.error "Invalid templatename. Please specify a simple name without any spaces"
+          exit 1
+        end
+      end
+
+      print "#{ui.color("Creating template: #{templatename}", :magenta)}\n"
+
+      params = {
+        'command' => 'createTemplate',
+        'name' => templatename,
+        'displaytext' => locate_config_value(:displaytext),
+        'ostypeid' => locate_config_value(:ostypeid),
+        'volumeid' => locate_config_value(:volumeid),
+      }
+      params['ispublic'] = locate_config_value(:ispublic) if locate_config_value(:ispublic)
+      params['isfeatured'] = locate_config_value(:isfeatured) if locate_config_value(:isfeatured)
+      params['passwordenabled'] = locate_config_value(:passwordenabled) if locate_config_value(:passwordenabled)
+      params['extractable'] = locate_config_value(:extractable) if locate_config_value(:extractable)
+      json = connection.send_request(params)
+
+      if ! json then
+        ui.error("Unable to create template")
+	exit 1
+      end
+
+      print "Template #{json['id']} is being created in the background\n";
+
+      return json['id']
+    end
+
+  end # class
+end

data/lib/chef/knife/cs_template_extract.rb

@@ -0,0 +1,104 @@
+#
+# Author:: Frank Breedijk (<fbreedijk@schubergphilis.com>)
+# Author:: Sander Botman (<sbotman@schubergphilis.com>)
+# Copyright:: Copyright (c) 2013
+# 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/cs_base'
+
+module KnifeCloudstack
+  class CsTemplateExtract < Chef::Knife
+
+    include Chef::Knife::KnifeCloudstackBase
+
+    deps do
+      require 'knife-cloudstack/connection'
+      Chef::Knife.load_deps
+    end
+
+    banner "knife cs template extract NAME (options)"
+
+    option :name,
+           :long => "--name NAME",
+           :description => "Name of template to extract (without format checking)"
+
+    option :zone,
+           :long => "--zone NAME",
+	   :description => "Name of the zone to extract the template in"
+
+    def run
+      validate_base_options
+
+      Chef::Log.debug("Validate template name")
+      if  locate_config_value(:name)
+        templatename = locate_config_value(:name)
+      else
+        templatename = @name_args.first
+        unless /^[a-zA-Z0-9][a-zA-Z0-9_\-# ]*$/.match templatename then
+          ui.error "Invalid templatename."
+          exit 1
+        end
+      end
+
+      zonename = locate_config_value(:zone)
+      if ! zonename
+      then
+        ui.error "No zone specified"
+	exit 1
+      end
+
+      print "#{ui.color("Extracting template: #{templatename}", :magenta)}\n"
+
+      Chef::Log.debug("Getting zone")
+
+      zone = connection.get_zone(
+        zonename,
+      )
+      if ! zone then
+        ui.error "Zone #{zonename} not found"
+	exit 1
+      end
+
+      Chef::Log.debug("Getting template")
+
+      template = connection.get_template(
+        templatename,
+      )
+      if ! template then
+        ui.error "Template #{templatename} not found"
+	exit 1
+      end
+
+      Chef::Log.debug("Extracting template")
+      params = {
+        'command' => 'extractTemplate',
+	'id' => template["id"],
+	'mode' => "HTTP_DOWNLOAD",
+	'zoneid' => zone["id"]
+      }
+      json = connection.send_async_request(params)
+
+      if json then
+      	url = json["template"]["url"]
+        print "\n#{url}\n"
+      else
+	ui.error "Template extraction failed.\n"
+	exit 1
+      end
+    end
+
+  end # class
+end

data/lib/chef/knife/cs_template_list.rb

@@ -1,6 +1,8 @@
 #
 # Author:: Ryan Holmes (<rholmes@edmunds.com>)
+# Author:: Sander Botman (<sbotman@schubergphilis.com>)
 # Copyright:: Copyright (c) 2011 Edmunds, Inc.
+# Copyright:: Copyright (c) 2013 Sander Botman.
 # License:: Apache License, Version 2.0
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -16,85 +18,90 @@
 # limitations under the License.
 #
 
-require 'chef/knife'
+require 'chef/knife/cs_base'
+require 'chef/knife/cs_baselist'
 
 module KnifeCloudstack
   class CsTemplateList < Chef::Knife
 
-    MEGABYTES = 1024 * 1024
+    include Chef::Knife::KnifeCloudstackBase
+    include Chef::Knife::KnifeCloudstackBaseList
 
     deps do
       require 'knife-cloudstack/connection'
+      require 'chef/knife'
+      Chef::Knife.load_deps
     end
 
     banner "knife cs template list (options)"
 
-    option :filter,
-           :short => "-L FILTER",
-           :long => "--filter FILTER",
-           :description => "The template search filter. Default is 'featured'",
-           :default => "featured"
+    option :listall,
+           :long => "--listall",
+           :description => "List all templates",
+           :boolean => true
+
+    option :index,
+           :long => "--index",
+           :description => "Add index numbers to the output",
+           :boolean => true
 
-    option :cloudstack_url,
-           :short => "-U URL",
-           :long => "--cloudstack-url URL",
-           :description => "The CloudStack endpoint URL",
-           :proc => Proc.new { |url| Chef::Config[:knife][:cloudstack_url] = url }
-
-    option :cloudstack_api_key,
-           :short => "-A KEY",
-           :long => "--cloudstack-api-key KEY",
-           :description => "Your CloudStack API key",
-           :proc => Proc.new { |key| Chef::Config[:knife][:cloudstack_api_key] = key }
-
-    option :cloudstack_secret_key,
-           :short => "-K SECRET",
-           :long => "--cloudstack-secret-key SECRET",
-           :description => "Your CloudStack secret key",
-           :proc => Proc.new { |key| Chef::Config[:knife][:cloudstack_secret_key] = key }
-
-    option :cloudstack_project,
-           :short => "-P PROJECT_NAME",
-           :long => '--cloudstack-project PROJECT_NAME',
-           :description => "Cloudstack Project in which to create server",
-           :proc => Proc.new { |v| Chef::Config[:knife][:cloudstack_project] = v },
-           :default => nil
-
-    option :use_http_ssl,
-          :long => '--[no-]use-http-ssl',
-          :description => 'Support HTTPS',
-          :boolean => true,
-          :default => true       
+    option :templatefilter,
+           :long => "--templatefilter FILTER",
+           :description => "Default: 'featured'. Options: 'self','self-executable','executable','community'",
+           :default => "featured"
 
     def run
+      validate_base_options
 
-      connection = CloudstackClient::Connection.new(
-          locate_config_value(:cloudstack_url),
-          locate_config_value(:cloudstack_api_key),
-          locate_config_value(:cloudstack_secret_key),
-          locate_config_value(:cloudstack_project),
-          locate_config_value(:use_http_ssl)
-      )
+      object_list = []
+      object_list << ui.color('Index', :bold) if locate_config_value(:index)
 
-      template_list = [
+      if locate_config_value(:fields)
+        locate_config_value(:fields).split(',').each { |n| object_list << ui.color(("#{n}").strip, :bold) }
+      else
+       [ 
           ui.color('Name', :bold),
           ui.color('Size', :bold),
           ui.color('Zone', :bold),
           ui.color('Public', :bold),
-          ui.color('Created', :bold),
-      ]
-
-      filter = config['filter']
-      templates = connection.list_templates(filter)
-      templates.each do |t|
-        template_list << t['name']
-        #template_list << (human_file_size(t['size']) || 'Unknown')
-        template_list << t['zonename']
-        template_list << t['ispublic'].to_s
-        template_list << t['created']
+          ui.color('Created', :bold)
+        ].each { |field| object_list << field }
       end
-      puts ui.list(template_list, :columns_across, 5)
 
+      columns = object_list.count
+      object_list = [] if locate_config_value(:noheader)
+
+      connection_result = connection.list_object(
+        "listTemplates",
+        "template",
+        locate_config_value(:filter),
+        locate_config_value(:listall),
+        nil,
+        nil,
+        locate_config_value(:templatefilter)
+      )
+
+      output_format(connection_result)
+
+      index_num = 0
+      connection_result.each do |r|
+        if locate_config_value(:index)
+          index_num += 1 
+          object_list << index_num.to_s
+        end
+
+        if locate_config_value(:fields)
+          locate_config_value(:fields).downcase.split(',').each { |n| object_list << ((r[("#{n}").strip]).to_s || 'N/A') }
+        else
+          object_list << r['name'].to_s
+          object_list << (r['size'] ? human_file_size(r['size']) : 'Unknown')
+          object_list << r['zonename'].to_s
+          object_list << r['ispublic'].to_s
+          object_list << r['created']
+        end
+      end
+      puts ui.list(object_list, :uneven_columns_across, columns)
+      list_object_fields(connection_result) if locate_config_value(:fieldlist)
     end
 
     def human_file_size n
@@ -103,12 +110,7 @@ module KnifeCloudstack
         n /= 1024.0
         count += 1
       end
-      format("%.2f", n) + %w(B KB MB GB TB)[count]
-    end
-
-    def locate_config_value(key)
-      key = key.to_sym
-      Chef::Config[:knife][key] || config[key]
+      format("%.0f", n) + %w(B KB MB GB TB)[count]
     end
 
   end

data/lib/chef/knife/cs_template_register.rb

@@ -0,0 +1,180 @@
+#
+# Author:: Frank Breedijk (<fbreedijk@schubergphilis.com>)
+# Author:: Sander Botman (<sbotman@schubergphilis.com>)
+# Copyright:: Copyright (c) 2013 
+# 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/cs_base'
+
+module KnifeCloudstack
+  class CsTemplateRegister < Chef::Knife
+
+    include Chef::Knife::KnifeCloudstackBase
+
+    deps do
+      require 'knife-cloudstack/connection'
+      Chef::Knife.load_deps
+    end
+
+    banner "knife cs template register NAME (options)"
+
+    option :name,
+           :long => "--name NAME",
+           :description => "Name of template to register (without format checking)"
+    
+    option :displaytext,
+           :long => "--displaytext DESCRIPTION",
+	   :description => "Description of the template as shown in CloudStack"
+
+    option :format,
+           :long => "--format FORMAT",
+	   :description => "Format of the template file QCOW2, RAW or VHD (default)",
+	   :default => "VHD"
+
+    option :hypervisor,
+           :long => "--hypervisor NAME",
+	   :description => "Target hypervisor for the template (default XEN)",
+	   :default => "XenServer"
+
+    option :ostypeid,
+	   :long => '--ostypeid OSTYPEID',
+           :description => "The ID of the OS Type that best represents the OS of this template"
+
+    option :url,
+           :long => '--url URL',
+           :description => "The URL of where the template is hosted. Including http:// and https://"
+
+    option :zone,
+           :long => "--zone NAME",
+	   :description => "Name of the zone to register the template in. Default: All zones",
+	   :default => -1
+
+    option :bits,
+           :long => "--bits 32|64",
+	   :description => "32 or 64 bits support, defaults to 64",
+	   :default => 64
+
+    option :extractable,
+           :long => "--[no-]extractable",
+	   :description => "Is the template extracable. Default: NO",
+	   :boolean => true,
+	   :default => false
+
+    option :featured,
+           :long => "--[no-]featured",
+	   :description => "Is the tempalte featured? Default: NO",
+	   :boolean => true,
+	   :default => false
+
+    option :public,
+           :long => "--[no-]public",
+	   :description => "Is the template public? Default: NO",
+	   :boolean => true,
+	   :default => false
+
+    option :passwordenabled,
+           :long => "--[no-]passwordenabled",
+	   :description => "Is the password reset feature enabled, Default: YES",
+	   :boolean => true,
+	   :default => true
+
+    option :requireshvm,
+           :long => "--[no-]requireshvm",
+	   :description => "Does the template require HVM? Default: NO",
+	   :boolean => true,
+	   :default => false
+
+    option :sshkeyenabled,
+           :long => "--[no-]sshkeyenabled",
+	   :description => "Does this tempalte support the sshkey upload feature? Default: NO",
+	   :boolean => true,
+	   :default => false
+
+    def run
+      validate_base_options
+
+      Chef::Log.debug("Validate template name")
+      if  locate_config_value(:name)
+        templatename = locate_config_value(:name)
+      else
+        templatename = @name_args.first
+        unless /^[a-zA-Z0-9][a-zA-Z0-9_\-# ]*$/.match templatename then
+          ui.error "Invalid templatename."
+          exit 1
+        end
+      end
+
+      unless locate_config_value(:ostypeid) then
+        ui.error "No os type id specified"
+	exit 1
+      end
+      
+      unless /^http(s)?\:\/\//.match locate_config_value(:url) then
+        ui.error "URL (#{locate_config_value(:url)}) is not a well formatted url"
+	exit 1
+      end
+
+      unless (locate_config_value(:bits) == 64 or locate_config_value(:bits) == 32 ) then
+        ui.error "Bits must be 32 or 64"
+	exit 1
+      end
+
+      if (locate_config_value(:zone) == -1)
+        zoneid = -1
+      else
+      	Chef::Log.debug("Resolving zone #{locate_config_value(:zone)}\n")
+
+	zone = connection.get_zone(locate_config_value(:zone))
+
+	if ! zone then
+	  ui.error "Unable to resolve zone #{locate_config_value(:zone)}\n"
+	  exit 1
+	end
+	zoneid = zone['id']
+      end
+
+      print "#{ui.color("Registring template: #{templatename}", :magenta)}\n"
+
+      params = {
+        'command' => 'registerTemplate',
+	'name' => templatename,
+        'displaytext' => locate_config_value(:displaytext),
+        'format' => locate_config_value(:format),
+        'hypervisor' => locate_config_value(:hypervisor),
+        'ostypeid' => locate_config_value(:ostypeid),
+        'url' => locate_config_value(:url),
+        'zoneid' => zoneid,
+        'bits' => locate_config_value(:bits),
+      }
+      params['extracable'] = locate_config_value(:extractable) if locate_config_value(:extractable)
+      params['ispublic'] = locate_config_value(:public) if locate_config_value(:public)
+      params['isfeatured'] = locate_config_value(:featured) if locate_config_value(:featured)
+      params['passwordenabled'] = locate_config_value(:passwordenabled) if locate_config_value(:passwordenabled)
+      params['sshkeyenabled'] = locate_config_value(:sshkeyenabled) if locate_config_value(:sshkeyenabled)
+      params['requireshvm'] = locate_config_value(:requireshvm) if locate_config_value(:requireshvm)
+
+      json = connection.send_request(params)
+
+      if ! json then
+        ui.error "Template #{templatename} not registered\n"
+	exit 1
+      end
+
+      print "TemplateId #{json['template'][0]['id']} is being created\n"
+    end
+
+  end # class
+end