knife-azure 1.6.0.rc.0 → 1.6.0

data/lib/chef/knife/azurerm_server_create.rb

@@ -0,0 +1,393 @@
+#
+# Author:: Aliasgar Batterywala (aliasgar.batterywala@clogeny.com)
+#
+# Copyright:: Copyright (c) 2016 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/azurerm_base'
+require 'securerandom'
+require 'chef/knife/bootstrap/common_bootstrap_options'
+require 'chef/knife/bootstrap/bootstrapper'
+
+class Chef
+  class Knife
+    class AzurermServerCreate < Knife
+
+      include Knife::AzurermBase
+      include Knife::Bootstrap::CommonBootstrapOptions
+      include Knife::Bootstrap::Bootstrapper
+
+      banner "knife azurerm server create (options)"
+
+      attr_accessor :initial_sleep_delay
+
+      option :ssh_user,
+        :short => "-x USERNAME",
+        :long => "--ssh-user USERNAME",
+        :description => "The ssh username",
+        :default => "root"
+
+      option :ssh_password,
+        :short => "-P PASSWORD",
+        :long => "--ssh-password PASSWORD",
+        :description => "The ssh password"
+
+      option :ssh_port,
+        :long => "--ssh-port PORT",
+        :description => "The ssh port. Default is 22."
+
+      option :winrm_user,
+        :short => "-x USERNAME",
+        :long => "--winrm-user USERNAME",
+        :description => "The WinRM username",
+        :default => "Administrator",
+        :proc => Proc.new { |key| Chef::Config[:knife][:winrm_user] = key }
+
+      option :winrm_password,
+        :short => "-P PASSWORD",
+        :long => "--winrm-password PASSWORD",
+        :description => "The WinRM password",
+        :proc => Proc.new { |key| Chef::Config[:knife][:winrm_password] = key }
+
+      option :azure_storage_account,
+        :short => "-a NAME",
+        :long => "--azure-storage-account NAME",
+        :description => "Required for advanced server-create option.
+                                      A name for the storage account that is unique within Windows Azure. Storage account names must be
+                                      between 3 and 24 characters in length and use numbers and lower-case letters only.
+                                      This name is the DNS prefix name and can be used to access blobs, queues, and tables in the storage account.
+                                      For example: http://ServiceName.blob.core.windows.net/mycontainer/"
+
+      option :azure_storage_account_type,
+        :long => "--azure-storage-account-type TYPE",
+        :description => "Optional. One of the following account types (case-sensitive):
+                                      Standard_LRS (Standard Locally-redundant storage)
+                                      Standard_ZRS (Standard Zone-redundant storage)
+                                      Standard_GRS (Standard Geo-redundant storage)
+                                      Standard_RAGRS (Standard Read access geo-redundant storage)
+                                      Premium_LRS (Premium Locally-redundant storage)",
+        :default => 'Standard_GRS'
+
+      option :azure_vm_name,
+        :long => "--azure-vm-name NAME",
+        :description => "Required. Specifies the name for the virtual machine.
+                        The name must be unique within the ResourceGroup.
+                        The azure vm name cannot be more than 15 characters long"
+
+      option :azure_service_location,
+        :short => "-m LOCATION",
+        :long => "--azure-service-location LOCATION",
+        :description => "Required if not using an Affinity Group. Specifies the geographic location - the name of the data center location that is valid for your subscription.
+                                      Eg: westus, eastus, eastasia, southeastasia, northeurope, westeurope",
+        :proc        => Proc.new { |lo| Chef::Config[:knife][:azure_service_location] = lo }
+
+      option :azure_os_disk_name,
+        :short => "-o DISKNAME",
+        :long => "--azure-os-disk-name DISKNAME",
+        :description => "Optional. Specifies the friendly name of the disk containing the guest OS image in the image repository."
+
+      option :azure_image_reference_publisher,
+        :long => "--azure-image-reference-publisher PUBLISHER_NAME",
+        :description => "Optional. Specifies the publisher of the image used to create the virtual machine.
+                          eg. OpenLogic, Canonical, MicrosoftWindowsServer"
+
+      option :azure_image_reference_offer,
+        :long => "--azure-image-reference-offer OFFER",
+        :description => "Optional. Specifies the offer of the image used to create the virtual machine.
+                          eg. CentOS, UbuntuServer, WindowsServer"
+
+      option :azure_image_reference_sku,
+        :long => "--azure-image-reference-sku SKU",
+        :description => "Optional. Specifies the SKU of the image used to create the virtual machine."
+
+      option :azure_image_reference_version,
+        :long => "--azure-image-reference-version VERSION",
+        :description => "Optional. Specifies the version of the image used to create the virtual machine.
+                          Default value is 'latest'",
+        :default => 'latest'
+
+      option :azure_image_os_type,
+        :long => "--azure-image-os-type OSTYPE",
+        :description => "Optional. Specifies the image OS Type for which server needs to be created. Accepted values ubuntu|centos|rhel|debian|windows"
+
+      option :azure_vm_size,
+        :short => "-z SIZE",
+        :long => "--azure-vm-size SIZE",
+        :description => "Optional. Size of virtual machine (ExtraSmall, Small, Medium, Large, ExtraLarge)",
+        :default => 'Small',
+        :proc => Proc.new { |si| Chef::Config[:knife][:azure_vm_size] = si }
+
+      option :azure_vnet_name,
+        :long => "--azure-vnet-name VNET_NAME",
+        :description => "Optional. Specifies the virtual network name
+                        If this is an existing vnet then it must exists under the current resource group identified by resource-group
+                        If this is an existing vnet then vnet-subnet-name is required"
+
+      option :azure_vnet_subnet_name,
+        :long => "--azure-vnet-subnet-name VNET_SUBNET_NAME",
+        :description => "Optional. Specifies the virtual network subnet name."
+
+      option :identity_file,
+        :long => "--identity-file FILENAME",
+        :description => "SSH identity file for authentication, optional. It is the RSA private key path. Specify either ssh-password or identity-file"
+
+      option :thumbprint,
+        :long => "--thumbprint THUMBPRINT",
+        :description => "The thumprint of the ssl certificate"
+
+      option :cert_passphrase,
+        :long => "--cert-passphrase PASSWORD",
+        :description => "SSL Certificate Password"
+
+      option :cert_path,
+        :long => "--cert-path PATH",
+        :description => "SSL Certificate Path"
+
+      option :server_count,
+        :long => "--server-count COUNT",
+        :description => "Number of servers to create with same configuration.
+                                    Maximum count is 5. Default value is 1.",
+        :default => 1
+
+      option :ohai_hints,
+        :long => "--ohai-hints HINT_OPTIONS",
+        :description => "Hint option names to be set in Ohai configuration of the target node.
+                                     Supported values are: vm_name, public_fqdn and platform.
+                                     User can pass any comma separated combination of these values like 'vm_name,public_fqdn'.
+                                     Default value is 'default' which corresponds to the supported values list mentioned here.",
+        :default => 'default'
+
+      def run
+        $stdout.sync = true
+
+        validate_arm_keys!(
+          :azure_resource_group_name,
+          :azure_vm_name,
+          :azure_service_location
+        )
+
+        begin
+          validate_params!
+
+          set_default_image_reference!
+
+          ssh_override_winrm if !is_image_windows?
+
+          vm_details = service.create_server(create_server_def)
+        rescue => error
+          if error.class == MsRestAzure::AzureOperationError && error.body
+            if error.response.body['error']['code'] == 'DeploymentFailed'
+              ui.error("#{error.body['error']['message']}")
+            else
+              ui.error(error.response.body)
+            end
+          else
+            ui.error("#{error.message}")
+          end
+          Chef::Log.debug("#{error.backtrace.join("\n")}")
+          exit
+        end
+      end
+
+      def create_server_def
+        server_def = {
+          :azure_resource_group_name => locate_config_value(:azure_resource_group_name),
+          :azure_storage_account => locate_config_value(:azure_storage_account),
+          :azure_storage_account_type => locate_config_value(:azure_storage_account_type),
+          :azure_vm_name => locate_config_value(:azure_vm_name),
+          :azure_service_location => locate_config_value(:azure_service_location),
+          :azure_os_disk_name => locate_config_value(:azure_os_disk_name),
+          :azure_os_disk_caching => locate_config_value(:azure_os_disk_caching),
+          :azure_os_disk_create_option => locate_config_value(:azure_os_disk_create_option),
+          :azure_vm_size => locate_config_value(:azure_vm_size),
+          :azure_image_reference_publisher => locate_config_value(:azure_image_reference_publisher),
+          :azure_image_reference_offer => locate_config_value(:azure_image_reference_offer),
+          :azure_image_reference_sku => locate_config_value(:azure_image_reference_sku),
+          :azure_image_reference_version => locate_config_value(:azure_image_reference_version),
+          :winrm_user => locate_config_value(:winrm_user),
+          :azure_vnet_name => locate_config_value(:azure_vnet_name),
+          :azure_vnet_subnet_name => locate_config_value(:azure_vnet_subnet_name),
+          :ssl_cert_fingerprint => locate_config_value(:thumbprint),
+          :cert_path => locate_config_value(:cert_path),
+          :cert_password => locate_config_value(:cert_passphrase),
+          :vnet_subnet_address_prefix => locate_config_value(:vnet_subnet_address_prefix),
+          :server_count => locate_config_value(:server_count)
+        }
+
+        server_def[:azure_storage_account] = locate_config_value(:azure_vm_name) if server_def[:azure_storage_account].nil?
+        server_def[:azure_storage_account] = server_def[:azure_storage_account].gsub(/[!@#$%^&*()_-]/,'')
+
+        server_def[:azure_os_disk_name] = locate_config_value(:azure_vm_name) if server_def[:azure_os_disk_name].nil?
+        server_def[:azure_os_disk_name] = server_def[:azure_os_disk_name].gsub(/[!@#$%^&*()_-]/,'')
+
+        server_def[:azure_vnet_name] = locate_config_value(:azure_vm_name) if server_def[:azure_vnet_name].nil?
+        server_def[:azure_vnet_subnet_name] = locate_config_value(:azure_vm_name) if locate_config_value(:azure_vnet_subnet_name).nil? && locate_config_value(:azure_vnet_name).nil?
+
+        server_def[:chef_extension] = get_chef_extension_name
+        server_def[:chef_extension_publisher] = get_chef_extension_publisher
+        server_def[:chef_extension_version] = locate_config_value(:azure_chef_extension_version)
+        server_def[:chef_extension_public_param] = get_chef_extension_public_params
+        server_def[:chef_extension_private_param] = get_chef_extension_private_params
+        server_def[:auto_upgrade_minor_version] = false
+
+        if is_image_windows?
+          server_def[:admin_password] = locate_config_value(:winrm_password)
+        else
+          server_def[:ssh_user] = locate_config_value(:ssh_user)
+          server_def[:ssh_password] = locate_config_value(:ssh_password)
+          server_def[:disablePasswordAuthentication] = "false"
+          if locate_config_value(:identity_file)
+            server_def[:disablePasswordAuthentication] = "true"
+            server_def[:ssh_key] = File.read(locate_config_value(:identity_file))
+          end
+        end
+
+        server_def
+      end
+
+      def supported_ohai_hints
+        [
+          'vm_name',
+          'public_fqdn',
+          'platform'
+        ]
+      end
+
+      def format_ohai_hints(ohai_hints)
+        ohai_hints = ohai_hints.split(',').each { |hint| hint.strip! }
+        ohai_hints.join(',')
+      end
+
+      def is_supported_ohai_hint?(hint)
+        supported_ohai_hints.any? { |supported_ohai_hint| hint.eql? supported_ohai_hint }
+      end
+
+      def validate_ohai_hints
+        hint_values = locate_config_value(:ohai_hints).split(',')
+        hint_values.each do |hint|
+          if ! is_supported_ohai_hint?(hint)
+            raise ArgumentError, "Ohai Hint name #{hint} passed is not supported. Please run the command help to see the list of supported values."
+          end
+        end
+      end
+
+      def validate_params!
+        if locate_config_value(:azure_vnet_name) && !locate_config_value(:azure_vnet_subnet_name)
+          raise ArgumentError,  "When a --azure-vnet-name is specified, the --azure-vnet-subnet-name must also be specified."
+        end
+
+        if locate_config_value(:azure_vnet_subnet_name) && !locate_config_value(:azure_vnet_name)
+          raise ArgumentError, "When --azure-vnet-subnet-name is specified, the --azure-vnet-name must also be specified."
+        end
+
+        if is_image_windows?
+          if locate_config_value(:winrm_user).nil? ||  locate_config_value(:winrm_password).nil?
+            raise ArgumentError, "Please provide --winrm-user and --winrm-password options for Windows option."
+          end
+        end
+
+        if !is_image_windows?
+          if (locate_config_value(:azure_vm_name).match /^(?=.*[a-zA-Z-])([a-zA-z0-9-]{1,64})$/).nil?
+            raise ArgumentError, "VM name can only contain alphanumeric and hyphen(-) characters and maximun length cannot exceed 64 charachters."
+          end
+        elsif (locate_config_value(:azure_vm_name).match /^(?=.*[a-zA-Z-])([a-zA-z0-9-]{1,15})$/).nil?
+          raise ArgumentError, "VM name can only contain alphanumeric and hyphen(-) characters and maximun length cannot exceed 15 charachters."
+        end
+
+        if locate_config_value(:server_count).to_i > 5
+          raise ArgumentError, "Maximum allowed value of --server-count is 5."
+        end
+
+        config[:ohai_hints] = format_ohai_hints(locate_config_value(:ohai_hints))
+        validate_ohai_hints if ! locate_config_value(:ohai_hints).casecmp('default').zero?
+      end
+
+      private
+
+      def ssh_override_winrm
+        # unchanged ssh_user and changed winrm_user, override ssh_user
+        if locate_config_value(:ssh_user).eql?(options[:ssh_user][:default]) &&
+            !locate_config_value(:winrm_user).eql?(options[:winrm_user][:default])
+          config[:ssh_user] = locate_config_value(:winrm_user)
+        end
+
+        if locate_config_value(:ssh_password).nil? &&
+            !locate_config_value(:winrm_password).nil?
+          config[:ssh_password] = locate_config_value(:winrm_password)
+        end
+      end
+
+      def set_default_image_reference!
+        begin
+          if locate_config_value(:azure_image_os_type)
+            if (locate_config_value(:azure_image_reference_publisher) || locate_config_value(:azure_image_reference_offer))
+              # if azure_image_os_type is given and any of the other image reference parameters like publisher or offer are also given,
+              # raise error
+              raise ArgumentError, 'Please specify either --azure-image-os-type OR --azure-image-os-type with --azure-image-reference-sku or 4 image reference parameters i.e.
+                --azure-image-reference-publisher, --azure-image-reference-offer, --azure-image-reference-sku, --azure-image-reference-version."'
+            else
+              ## if azure_image_os_type is given (with or without azure-image-reference-sku) and other image reference parameters are not given,
+              # set default image reference parameters
+              case locate_config_value(:azure_image_os_type)
+              when "ubuntu"
+                config[:azure_image_reference_publisher] = "Canonical"
+                config[:azure_image_reference_offer] = "UbuntuServer"
+                config[:azure_image_reference_sku] = locate_config_value(:azure_image_reference_sku) ? locate_config_value(:azure_image_reference_sku) : "14.04.2-LTS"
+              when "centos"
+                config[:azure_image_reference_publisher] = "OpenLogic"
+                config[:azure_image_reference_offer] = "CentOS"
+                config[:azure_image_reference_sku] = locate_config_value(:azure_image_reference_sku) ? locate_config_value(:azure_image_reference_sku) : "7.1"
+              when "rhel"
+                config[:azure_image_reference_publisher] = "RedHat"
+                config[:azure_image_reference_offer] = "RHEL"
+                config[:azure_image_reference_sku] = locate_config_value(:azure_image_reference_sku) ? locate_config_value(:azure_image_reference_sku) : "7.2"
+              when "debian"
+                config[:azure_image_reference_publisher] = "credativ"
+                config[:azure_image_reference_offer] = "Debian"
+                config[:azure_image_reference_sku] = locate_config_value(:azure_image_reference_sku) ? locate_config_value(:azure_image_reference_sku) : "7"
+              when "windows"
+                config[:azure_image_reference_publisher] = "MicrosoftWindowsServer"
+                config[:azure_image_reference_offer] = "WindowsServer"
+                config[:azure_image_reference_sku] = locate_config_value(:azure_image_reference_sku) ? locate_config_value(:azure_image_reference_sku) : "2012-R2-Datacenter"
+              else
+                raise ArgumentError, 'Invalid value of --azure-image-os-type. Accepted values ubuntu|centos|windows'
+              end
+            end
+          else
+            if (locate_config_value(:azure_image_reference_publisher) && locate_config_value(:azure_image_reference_offer) && locate_config_value(:azure_image_reference_sku) && locate_config_value(:azure_image_reference_version))
+              # if azure_image_os_type is not given and other image reference parameters are given,
+              # do nothing
+            else
+              # if azure_image_os_type is not given and other image reference parameters are also not given,
+              # throw error for azure_image_os_type
+              validate_arm_keys!(:azure_image_os_type)
+            end
+          end
+        rescue => error
+          ui.error("#{error.message}")
+          Chef::Log.debug("#{error.backtrace.join("\n")}")
+          exit
+        end
+
+        # final verification for image reference parameters
+        validate_arm_keys!(:azure_image_reference_publisher,
+            :azure_image_reference_offer,
+            :azure_image_reference_sku,
+            :azure_image_reference_version)
+      end
+    end
+  end
+end

data/lib/chef/knife/azurerm_server_delete.rb

@@ -0,0 +1,121 @@
+#
+# Author:: Barry Davis (barryd@jetstreamsoftware.com)
+# Author:: Adam Jacob (<adam@opscode.com>)
+# Author:: Seth Chisamore (<schisamo@opscode.com>)
+# Copyright:: Copyright (c) 2009-2011 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 File.expand_path('../azure_base', __FILE__)
+
+# These two are needed for the '--purge' deletion case
+require 'chef/node'
+require 'chef/api_client'
+
+class Chef
+  class Knife
+    class AzurermServerDelete < Knife
+
+      include Knife::AzurermBase
+
+      banner "knife azurerm server delete SERVER [SERVER] (options)"
+
+      option :purge,
+        :short => "-P",
+        :long => "--purge",
+        :boolean => true,
+        :default => false,
+        :description => "Destroy corresponding node and client on the Chef Server, in addition to destroying the Windows Azure node itself.  Assumes node and client have the same name as the server (if not, add the '--node-name' option)."
+
+      option :chef_node_name,
+        :short => "-N NAME",
+        :long => "--node-name NAME",
+        :description => "The name of the node and client to delete, if it differs from the server name. Only has meaning when used with the '--purge' option."
+
+      option :delete_resource_group,
+        :long => "--delete-resource-group",
+        :boolean => true,
+        :default => false,
+        :description => "Deletes corresponding resource group along with Vitual Machine."
+
+      # Extracted from Chef::Knife.delete_object, because it has a
+      # confirmation step built in... By specifying the '--purge'
+      # flag (and also explicitly confirming the server destruction!)
+      # the user is already making their intent known.  It is not
+      # necessary to make them confirm two more times.
+
+      def destroy_item(klass, name, type_name)
+        begin
+          object = klass.load(name)
+          object.destroy
+          ui.warn("Deleted #{type_name} #{name}")
+        rescue Net::HTTPServerException
+          ui.warn("Could not find a #{type_name} named #{name} to delete!")
+        end
+      end
+
+      def run
+        begin
+          $stdout.sync = true
+          validate_arm_keys!(:azure_resource_group_name)
+
+          vm_name = @name_args[0]
+          resource_group_name = locate_config_value(:azure_resource_group_name)
+
+          if locate_config_value(:delete_resource_group)
+            ui.warn "Deleting resource group will delete all the virtual_machines inside it."
+            begin
+              ui.confirm('Do you really want to delete resource group')
+            rescue SystemExit   # Need to handle this as confirming with N/n raises SystemExit exception
+              server = nil      # Cleanup is implicitly performed in other cloud plugins
+              ui.warn "Resource group not deleted. Proceeding for server delete ..."
+              service.delete_server(locate_config_value(:azure_resource_group_name), vm_name)
+              exit
+            end
+
+            ui.info 'Deleting Resource Group '+resource_group_name+' and Virtual Machine '+vm_name+' ..'
+            service.delete_resource_group(locate_config_value(:azure_resource_group_name))
+            ui.warn "Deleted resource_group_name #{resource_group_name} and #{vm_name}"
+          else
+            service.delete_server(locate_config_value(:azure_resource_group_name), vm_name)
+          end
+
+          if config[:purge]
+            node_to_delete = config[:chef_node_name] || vm_name
+            if node_to_delete
+              destroy_item(Chef::Node, node_to_delete, 'node')
+              destroy_item(Chef::ApiClient, node_to_delete, 'client')
+            else
+              ui.warn("Node name to purge not provided. Corresponding client node will remain on Chef Server.")
+            end
+          else
+            ui.warn("Corresponding node and client for the #{vm_name} server were not deleted and remain registered with the Chef Server")
+          end
+        rescue => error
+          if error.class == MsRestAzure::AzureOperationError && error.body
+            if error.body['error']['code'] == 'ResourceNotFound'
+              ui.error("#{error.body['error']['message']}")
+            else
+              ui.error(error.body)
+            end
+          else
+            ui.error("#{error.message}")
+            Chef::Log.debug("#{error.backtrace.join("\n")}")
+          end
+        end
+      end
+    end
+  end
+end