knife-cloudstack 0.0.14 → 0.0.15

data/CHANGES.rdoc

@@ -1,5 +1,20 @@
 = Changes
 
+== 2013-11-04 (0.0.15)
+* Bugfix: fixed the proxy with the option: --cloudstack-proxy http://username:password@yourproxy:8080 or use config file. (Sander Botman, 04 Nov 2013)
+* Added subcommand: <tt>cs publicip list</tt> (Sander Botman, 03 Nov 2013)
+* Bugfix: removed the chef rest dependency because this is changed in chef 11.8.0 (Sander Botman, 03 Nov 2013)
+* Bugfix: added the option --cloudstack-no-ssl-verify in order to ignore ssl verification (Sander Botman, 03 Nov 2013)
+* Added subcommand: <tt>cs forwardrule create</tt> (Sander Botman, 28 Aug 2013)
+* Added subcommand: <tt>cs firewallrule create</tt> (Sander Botman, 28 Aug 2013)
+* Added the option: <tt>--set-display-name</tt> to <tt>server create</tt> (Florin Stan, 5 Aug 2013)
+* Added the option: <tt>--keypair</tt> to <tt>server create</tt> (Florin Stan, 31 Jul 2013)
+* Added subcommand: <tt>cs volume create</tt> (Jeremy Baumont, 17 Jul 2013)
+* Added the option: <tt>--disk</tt> to <tt>server create</tt> (Stanislav Voroniy (voroniys) 13 Jun 2013)
+* Added subcommands: <tt>cs keypair list</tt>, <tt>cs keypair create</tt>, <tt>cs keypair delete</tt> and adding basic zone check. (Sebastian Goasguen (runseb) 29 May 2013)
+* Bugfix: changed output name to password (Warren Bain, 26 May 2013)
+* Bugfix: various bugfixes and fixing bootstrap context (bacoboy, 22 Apr 2013)
+
 == 2013-04-14 (0.0.14)
 * Added bash/addinstance.sh script in onder to ease instance creation from cli.
 

data/README.rdoc

@@ -36,7 +36,9 @@ Additionally the following options may be set in your <tt>knife.rb</tt>:
 * knife[:cloudstack_service]
 * knife[:cloudstack_template]
 * knife[:cloudstack_zone]
-* knife[:distro]
+* knife[:cloudstack_proxy]
+* knife[:cloudstack_no_ssl_verify]
+* knife[:distro] 
 * knife[:template_file]
 
 == Public Clouds (Tata InstaCompute, Ninefold etc):
@@ -97,10 +99,9 @@ single number when the start and end ports are the same. For example, a rule to
 ==== Create Firewall Rule for given ip address
 The <tt>-f, --fw-rules</tt> option takes a comma separated list of firewall rules which are applied to the public ip address assigned to the current server.
 
-Firewall rules have the syntax <tt>START_PORT[:END_PORT[:PROTOCOL[:CIDR_LIST]]]</tt>. <tt>END_PORT</tt>, <tt>PROTOCOL</tt> and <tt>CIDR_LIST</tt> are optional.
-The default value of <tt>END_PORT</tt> is <tt>START_PORT</tt>, the default <tt>PROTOCOL</tt> is 'TCP' and the default <tt>CIDR_LIST</tt> is '0.0.0.0/0'.
-For example, a rule to open firewall for port 80 to everyone would look like <tt>80:80:TCP:0.0.0.0/0</tt>.
-In this case ,it could even be shortened to <tt>80</tt>.
+Firewall rules have the syntax <tt>PROTOCOL[:CIDR_LIST[:START_PORT[:END_PORT]]]</tt>. <tt>START_PORT</tt> and <tt>END_PORT</tt> must not be specified when <tt>PROTOCOL</tt> is <tt>ICMP</tt>, <tt>CIDR_LIST</tt> is always optional.
+The default value of <tt>END_PORT</tt> is <tt>START_PORT</tt>, the default <tt>CIDR_LIST</tt> is '0.0.0.0/0'.
+For example, a rule to open firewall for port 80 to everyone would look like <tt>TCP::80</tt> and a rule to open ICMP to internal network would look like <tt>ICMP:10.0.0.0/8</tt>.
 
 === knife cs server delete
 
@@ -166,6 +167,9 @@ Returns a link where an extractable template can be downloaded
 === knife cs template register
 Creates a template based on a file
 
+=== knife cs volume create
+Creates a volume based on a name
+
 === knife cs zone list
 Displays a list of all zones available in the currently configured CloudStack account. A zone can be specified
 when creating a new server by passing the zone name as an argument to the -Z (or --zone) option of the
@@ -255,7 +259,7 @@ Displays all the pods that are currently available within the cloudstack environ
 
 <tt>--name</tt>                 Filters your output on the name that you specify.
 
-==== knife project list
+==== knife cs project list
 Displays all the projects that are within the cloudstack environment.
 
 <tt>--listall</tt>              This will list all the projects, depending on the account that you are using.
@@ -264,6 +268,11 @@ Displays all the projects that are within the cloudstack environment.
 
 <tt>--name</tt>                 Filters your output on the name that you specify.
 
+==== knife cs publicip list
+Displays all public ip's that are used within the cloudstack environment.
+
+<tt>--listall</tt>              This will list all the public ip's, depending on the account that you are using.
+
 ==== knife cs router list
 Displays all the routers that are within the cloudstack environment.
 
@@ -333,6 +342,7 @@ specifying one or more actions to be executed after a server (or group of server
             { "http_request": "http://${hadoop-master}:50070/index.jsp" }
           ]
         }
+      ]
     }
 
 ==== Stack Attributes
@@ -378,8 +388,9 @@ Author:: Ryan Holmes <rholmes@edmunds.com>
 Author:: KC Braunschweig <kcbraunschweig@gmail.com>
 Author:: John E. Vincent <lusis.org+github.com@gmail.com>
 Author:: Sander Botman <sbotman@schubergphilis.com>
+Author:: Frank Breedijk <fbreedijk@schubergphilis.com>
+Author:: Jeremy Baumont <jbaumont@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");

data/lib/chef/knife/cs_base.rb

@@ -55,12 +55,15 @@ class Chef
                  :proc => Proc.new { |v| Chef::Config[:knife][:cloudstack_project] = v },
                  :default => nil
 
-          option :use_http_ssl,
-                 :long => '--[no-]use-http-ssl',
-                 :description => 'Turn HTTPS support On/Off. Default is On',
-                 :boolean => true,
-                 :default => true
-        
+          option :cloudstack_no_ssl_verify,
+                 :long => '--cloudstack-no-ssl-verify',
+                 :description => "Disable certificate verify on SSL",
+                 :boolean => true
+
+          option :cloudstack_proxy,
+                 :long => '--cloudstack-proxy PROXY',
+                 :description => "Enable proxy configuration for cloudstack api access"
+
           def validate_base_options
             unless locate_config_value :cloudstack_url
               ui.error "Cloudstack URL not specified"
@@ -82,13 +85,14 @@ class Chef
               locate_config_value(:cloudstack_api_key),
               locate_config_value(:cloudstack_secret_key),
               locate_config_value(:cloudstack_project),
-              locate_config_value(:use_http_ssl)
+              locate_config_value(:cloudstack_no_ssl_verify),
+              locate_config_value(:cloudstack_proxy)
             )
           end
 
           def locate_config_value(key)
             key = key.to_sym
-            Chef::Config[:knife][key] || config[key]
+            config[key] || Chef::Config[:knife][key]
           end 
 
         end

data/lib/chef/knife/cs_firewallrule_create.rb

@@ -0,0 +1,115 @@
+#
+# Author:: Sander Botman (<sbotman@schubergphilis.com>)
+# Copyright:: Copyright (c) 2013 Sander Botman.
+# 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 CsFirewallruleCreate < Chef::Knife
+
+    include Chef::Knife::KnifeCloudstackBase
+
+    deps do
+      require 'knife-cloudstack/connection'
+      Chef::Knife.load_deps
+    end
+
+    banner "knife cs firewallrule create hostname 8080:8090:TCP:10.0.0.0/24"
+
+    option :syncrequest,
+           :long => "--sync",
+           :description => "Execute command as sync request",
+           :boolean => true
+
+    def run
+
+      hostname = @name_args.shift
+      unless /^[a-zA-Z0-9][a-zA-Z0-9-]*$/.match hostname then
+       ui.error "Invalid hostname. Please specify a short hostname, not an fqdn (e.g. 'myhost' instead of 'myhost.domain.com')."
+        exit 1
+      end
+
+      params = {}
+      locate_config_value(:openfirewall) ? params['openfirewall'] = 'true' : params['openfirewall'] = 'false'
+
+      # Lookup all server objects.
+      connection_result = connection.list_object(
+        "listVirtualMachines",
+        "virtualmachine"
+      )
+
+      # Lookup the hostname in the connection result
+      server = {}
+      connection_result.map { |n| server = n if n['name'].upcase == hostname.upcase }
+     
+      if server['name'].nil?
+        ui.error "Cannot find hostname: #{hostname}."
+        exit 1
+      end
+
+      # Lookup the public ip address of the server
+      server_public_address = connection.get_server_public_ip(server)
+      ip_address = connection.get_public_ip_address(server_public_address)
+
+      if ip_address.nil? || ip_address['id'].nil?
+        ui.error "Cannot find public ip address for hostname: #{hostname}."
+        exit 1
+      end
+ 
+      @name_args.each do |rule|
+        create_port_forwarding_rule(ip_address, server['id'], rule, connection, params)
+      end
+
+    end
+ 
+    def create_port_forwarding_rule(ip_address, server_id, rule, connection, other_params)
+      args = rule.split(':')
+      startport = args[0]
+      endport   = args[1] || args[0]
+      protocol  = args[2] || "TCP"
+      cidrlist  = args[3] || "0.0.0.0/0"      
+
+      # Required parameters
+      params = {
+        'command' => 'createFirewallRule',
+        'ipaddressId' => ip_address['id'],
+        'protocol' => protocol
+      }
+
+      # Optional parameters
+      opt_params = {
+        'startport' => startport,
+        'endport' => endport,
+        'cidrlist' => cidrlist
+      }
+  
+      params.merge!(opt_params)
+ 
+      Chef::Log.debug("Creating Firewall Rule for
+        #{ip_address['ipaddress']} with protocol: #{protocol}, start: #{startport} end: #{endport} cidr: #{cidrlist}")
+
+      if locate_config_value(:syncrequest) 
+        result = connection.send_request(params)
+        Chef::Log.debug("JobResult: #{result}")
+      else
+        result = connection.send_async_request(params)
+        Chef::Log.debug("AsyncJobResult: #{result}")
+      end
+    end
+
+  end
+end

data/lib/chef/knife/cs_forwardrule_create.rb

@@ -0,0 +1,113 @@
+#
+# Author:: Sander Botman (<sbotman@schubergphilis.com>)
+# Copyright:: Copyright (c) 2013 Sander Botman.
+# 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 CsForwardruleCreate < Chef::Knife
+
+    include Chef::Knife::KnifeCloudstackBase
+
+    deps do
+      require 'knife-cloudstack/connection'
+      Chef::Knife.load_deps
+    end
+
+    banner "knife cs forwardrule create hostname 8080:8090:TCP"
+
+    option :openfirewall,
+           :long => "--openfirewall",
+           :description => "Add rule also to firewall",
+           :boolean => true
+
+    option :syncrequest,
+           :long => "--sync",
+           :description => "Execute command as sync request",
+           :boolean => true
+
+    def run
+
+      hostname = @name_args.shift
+      unless /^[a-zA-Z0-9][a-zA-Z0-9-]*$/.match hostname then
+       ui.error "Invalid hostname. Please specify a short hostname, not an fqdn (e.g. 'myhost' instead of 'myhost.domain.com')."
+        exit 1
+      end
+
+      params = {}
+      locate_config_value(:openfirewall) ? params['openfirewall'] = 'true' : params['openfirewall'] = 'false'
+
+      # Lookup all server objects.
+      connection_result = connection.list_object(
+        "listVirtualMachines",
+        "virtualmachine"
+      )
+
+      # Lookup the hostname in the connection result
+      server = {}
+      connection_result.map { |n| server = n if n['name'].upcase == hostname.upcase }
+     
+      if server['name'].nil?
+        ui.error "Cannot find hostname: #{hostname}."
+        exit 1
+      end
+
+      # Lookup the public ip address of the server
+      server_public_address = connection.get_server_public_ip(server)
+      ip_address = connection.get_public_ip_address(server_public_address)
+
+      if ip_address.nil? || ip_address['id'].nil?
+        ui.error "Cannot find public ip address for hostname: #{hostname}."
+        exit 1
+      end
+ 
+      @name_args.each do |rule|
+        create_port_forwarding_rule(ip_address, server['id'], rule, connection, params)
+      end
+
+    end
+ 
+    def create_port_forwarding_rule(ip_address, server_id, rule, connection, other_params)
+      args = rule.split(':')
+      public_port = args[0]
+      private_port = args[1] || args[0]
+      protocol = args[2] || "TCP"
+
+      params = {
+        'ipaddressId' => ip_address['id'],
+        'protocol' => protocol
+      }
+
+      if ip_address['isstaticnat'] == 'true'
+        other_params['command'] = 'createIpForwardingRule'
+        other_params['startport'] = public_port
+        other_params['endport'] = public_port
+        Chef::Log.debug("Creating IP Forwarding Rule for
+          #{ip_address['ipaddress']} with protocol: #{protocol}, public port: #{public_port}")
+      else
+        other_params['command'] = 'createPortForwardingRule'
+        other_params['privatePort'] = private_port
+        other_params['publicPort'] = public_port
+        other_params['virtualMachineId'] = server_id
+        Chef::Log.debug("Creating Port Forwarding Rule for #{ip_address['id']} with protocol: #{protocol},
+          public port: #{public_port} and private port: #{private_port} and server: #{server_id}")
+      end
+      locate_config_value(:syncrequest) ? result = connection.send_request(params.merge(other_params)) : result = connection.send_async_request(params.merge(other_params))
+      Chef::Log.debug("AsyncJobResult: #{result}")
+    end
+  end
+end

data/lib/chef/knife/cs_hosts.rb

@@ -17,44 +17,26 @@
 # limitations under the License.
 #
 
+require 'chef/knife/cs_base'
+require 'chef/knife/cs_baselist'
+
 module KnifeCloudstack
   class CsHosts < 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 hosts"
 
-    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 }
-
     def run
-
-      connection = CloudstackClient::Connection.new(
-          locate_config_value(:cloudstack_url),
-          locate_config_value(:cloudstack_api_key),
-          locate_config_value(:cloudstack_secret_key)
-      )
+      validate_base_options
 
       host_list = [
           ui.color('#Public IP', :bold),
@@ -72,12 +54,5 @@ module KnifeCloudstack
       puts ui.list(host_list, :columns_across, 3)
 
     end
-
-
-    def locate_config_value(key)
-      key = key.to_sym
-      Chef::Config[:knife][key] || config[key]
-    end
-
   end
 end

data/lib/chef/knife/cs_keypair_create.rb

@@ -0,0 +1,72 @@
+# 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 CsKeypairCreate < Chef::Knife
+
+    include Chef::Knife::KnifeCloudstackBase
+
+    deps do
+      require 'knife-cloudstack/connection'
+      Chef::Knife.load_deps
+    end
+
+    banner "knife cs keypair create KEY_NAME (options)"
+
+    option :name,
+           :long => "--name NAME",
+           :description => "Specify the ssh keypair name"
+
+    option :noheader,
+           :long => "--noheader",
+           :description => "Removes header from output",
+           :boolean => true
+
+    def run
+      validate_base_options
+
+      Chef::Log.debug("Validate keypair name")
+      keypairname = locate_config_value(:name) || @name_args.first
+      unless /^[a-zA-Z0-9][a-zA-Z0-9\-\_]*$/.match(keypairname) then
+          ui.error "Invalid keypairname. Please specify a short name for the keypair"
+          exit 1
+      end
+
+      ui.info("#{ui.color("Creating SSH Keypair: #{keypairname}", :magenta)}") unless locate_config_value(:noheader)
+
+      params = {
+        'command' => 'createSSHKeyPair',
+        'name' => keypairname,
+      }
+
+      json = connection.send_request(params)
+
+      unless json then
+        ui.error("Unable to create SSH Keypair")
+        exit 1
+      end
+
+      fingerprint = json['keypair']['fingerprint'] 
+      privatekey  = json['keypair']['privatekey']
+      ui.info("Fingerprint: #{fingerprint}") unless locate_config_value(:noheader)
+      ui.info(privatekey)
+      puts "\n" unless locate_config_value(:noheader)
+    end
+
+  end # class
+end