foreman_azure_rm 2.0.5 → 2.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1e741ec81cb86b9264c85d90144d72b977041fa7862719a2ffefb3ee0a08e091
-  data.tar.gz: 1f650dc025e09281b48651d5b51a67a90fa406dd94adaddc8fe0cff66a1aa30d
+  metadata.gz: cc75ad1df578bcc16ca37a67e323b1ff763ec6e6149db99a1056ae88c9248c5d
+  data.tar.gz: 3d8127cce9836f8f23c95947e5497b2c8f3c4d3fc10a7ad025c0d09fa805a06a
 SHA512:
-  metadata.gz: 87b2e1e4f809356ad3366b13b61e317f038b292e138431746f6d3360b45075326b3e220e2c53aa8f718985b18d9c414cd18a42ecdea4670ded22d41c741a6fd6
-  data.tar.gz: 560fd23c83eeef07f8669edd5380d5ee51312000640e3c31c7779e546d00288527bb6d38cc4c83e4693dae0edec268b01192047fc630d725d44a87225a5599b1
+  metadata.gz: a213f22eb2b08b07fe28b803a33136a4d3a977eb46a4b95bf926f48189137efef13aacf37a4d81cf2f47c6d710e5ac8a73d5f498431d7a06d3bf6e4d7567380f
+  data.tar.gz: c361b566af6b568899c60942826a6db92e973da00ac4d6a8641a2c3592090ceaf87fe6a57414b3f260f486b70ebc84c98966da1802477987f816baa19c99a4c1

data/README.md

@@ -4,6 +4,7 @@
 ```foreman_azure_rm``` adds [Microsoft Azure Resource Manager](http://azure.com/) as a compute resource for The Foreman
 
 * Website: [TheForeman.org](http://theforeman.org)
+* ForemanAzureRm: [Plugin manual](https://theforeman.org/plugins/foreman_azure)
 * Support: [Foreman support](http://theforeman.org/support.html)
 
 ## Installation
@@ -12,25 +13,25 @@
 
 Add the following to bundler.d/Gemfile.local.rb in your Foreman installation directory (/usr/share/foreman by default)
 
-```bash
+```console
 $ gem 'foreman_azure_rm'
 ```
 
 Or simply:
 
-```bash
+```console
 $ echo "gem 'foreman_azure_rm'" > /usr/share/foreman/bundler.d/Gemfile.local.rb
 ```
 
 Then run `bundle install` from the same directory
 
 ### Package
-```
+```console
 # yum install tfm-rubygem-foreman_azure_rm
 ```
 
 ### Foreman Installer
-```
+```console
 # foreman-installer --enable-foreman-plugin-azure
 ```
 
@@ -44,7 +45,7 @@ git clone https://github.com/theforeman/foreman_azure_rm.git
 Add the following to bundler.d/Gemfile.local.rb in your Foreman development directory
 
 ```ruby
-$ gem 'foreman_azure_rm', :path => 'path to foreman_azure_rm directory'
+gem 'foreman_azure_rm', :path => 'path to foreman_azure_rm directory'
 ```
 
 Then run `bundle install` from the same directory
@@ -54,10 +55,14 @@ Then run `bundle install` from the same directory
     * VM creation
     * Provisions using Finish and User data templates from Foreman
     * Supports cloud-config provisioning
-    * Currently supports single NIC
-    * Currently supports single default OS Disk
     * Currently supports only provisioning of Linux platforms
     * Provisioning using [Public Images](https://docs.microsoft.com/en-us/azure/virtual-machines/linux/cli-ps-findimage)
+    * Provision using custom images
+    * Provision using shared image galleries
+    * Provision using RHEL byos images
+    * Multiple NICs support
+    * Support to add multiple data disks/volumes (standard or premium)
+    * VM Extension with Custom Script and File URIs support
     * Static or dynamic addresses on a per NIC basis
 * Limited extension support
     * Microsoft's custom script extension
@@ -71,21 +76,18 @@ Choose the **Azure Resource Manager provider**, and fill in all the fields. You
 That's it. You're now ready to create and manage Azure resources in your new Azure Resource Manager compute resource. You should see something like this in the Compute Resource page:
 
 
-![](https://i.imgur.com/4ClZhTP.png)
+![](https://i.imgur.com/vsamP4G.png)
 
 
-![](https://i.imgur.com/eFHucdb.png)
+![](https://i.imgur.com/Ag9tH55.png)
 
 
-![](https://i.imgur.com/YjlRQIE.png)
+![](https://i.imgur.com/fNjlFci.png)
 
     
 ## Planned Features
-* Multiple NICs support
-* Support to add multiple data disks (standard or premium)
-* Provision using custom images
-* Provision using shared image galleries
-* Improved extension support    
+* Azure Gov Cloud Support
+* Support for http_proxy
     
 ## Known Limitations
 * Please note that currently username is expected to be the same on both Virtual Machine tab for Host creation and during Image creation for Compute Resource. The password field for Image creation is optional.

data/app/helpers/azure_compute_resource_helper.rb

@@ -0,0 +1,13 @@
+module AzureComputeResourceHelper
+  def regions_list(azurerm_cr, f)
+    begin
+      regions = azurerm_cr.regions || []
+    rescue StandardError
+      #do nothing
+      regions = []
+    rescue Exception => ex
+      return information_box("Regions could not be loaded due to exception: #{ex}")
+    end
+    selectable_f(f, :url, regions, {}, {:label => _('Azure Region'), :disabled => regions.empty?, :required => true, :help_inline_permanent => load_button_f(f, regions.present?, _("Load Regions")) })
+  end
+end

data/app/models/concerns/foreman_azure_rm/vm_extensions/managed_vm.rb

@@ -13,19 +13,7 @@ module ForemanAzureRm
         os_disk.name = "#{vm_name}-osdisk"
         os_disk.os_type = platform
         os_disk.create_option = ComputeModels::DiskCreateOptionTypes::FromImage
-        os_disk.caching = if os_disk_caching.present?
-                            case os_disk_caching
-                              when 'None'
-                                ComputeModels::CachingTypes::None
-                              when 'ReadOnly'
-                                ComputeModels::CachingTypes::ReadOnly
-                              when 'ReadWrite'
-                                ComputeModels::CachingTypes::ReadWrite
-                              else
-                                # ARM best practices stipulate RW caching on the OS disk
-                                ComputeModels::CachingTypes::ReadWrite
-                            end
-                          end
+        os_disk.caching = disk_caching(os_disk_caching)
         managed_disk_params.storage_account_type = if premium_os_disk == 'true'
                                                      ComputeModels::StorageAccountTypes::PremiumLRS
                                                    else
@@ -33,10 +21,59 @@ module ForemanAzureRm
                                                    end
         os_disk.managed_disk = managed_disk_params
         storage_profile.os_disk = os_disk
-
         storage_profile
       end
 
+      def disk_caching(disk_type_caching)
+        case disk_type_caching
+        when 'None'
+          ComputeModels::CachingTypes::None
+        when 'ReadOnly'
+          ComputeModels::CachingTypes::ReadOnly
+        when 'ReadWrite'
+          ComputeModels::CachingTypes::ReadWrite
+        when nil, ""
+          nil
+        else
+          raise RuntimeError, "Disk caching value must be either 'None', 'ReadOnly' or 'ReadWrite'."
+        end
+      end
+
+      def define_data_disks(vm_name, data_disks)
+        unless data_disks.nil?
+          disks = []
+          disk_count = 0
+          data_disks.each do |disk_num, attrs|
+            managed_data_disk = ComputeModels::ManagedDiskParameters.new
+            disk = ComputeModels::DataDisk.new
+            disk.name = "#{vm_name}-data-disk#{disk_count}"
+            disk.caching  = disk_caching(attrs[:data_disk_caching])
+            disk.disk_size_gb = attrs[:disk_size_gb]
+            disk.create_option = ComputeModels::DiskCreateOption::Empty
+            disk.lun = disk_count + 1
+            disk.managed_disk = managed_data_disk
+            disk_count += 1
+            disks << disk
+          end
+          disks
+        end
+      end
+
+      def marketplace_image_plan(image)
+        image_type, image_id = image.split('://')
+        return nil unless image_type == 'marketplace' && image_id.include?('byos')
+        urn = image_id.split(':')
+        publisher = urn[0]
+        offer     = urn[1]
+        sku       = urn[2]
+        version   = urn[3]
+        image_plan = ComputeModels::PurchasePlan.new
+        image_plan.publisher = publisher.downcase
+        image_plan.name = sku.downcase
+        image_plan.product = offer.downcase
+        image_plan
+      end
+
       def marketplace_image_reference(publisher, offer, sku, version)
         image_reference = ComputeModels::ImageReference.new
         image_reference.publisher = publisher
@@ -46,26 +83,25 @@ module ForemanAzureRm
         image_reference
       end
 
-      def define_image(vhd_path)
-        # If image UUID begins with / it is a custom managed image
-        # Otherwise it is a marketplace URN
-        unless vhd_path.start_with?('/')
-          urn = vhd_path.split(':')
+      def define_image(rg_name, image)
+        image_type, image_id = image.split('://')
+        case image_type
+        when 'marketplace'
+          urn = image_id.split(':')
           publisher = urn[0]
           offer     = urn[1]
           sku       = urn[2]
           version   = urn[3]
-          vhd_path = nil
-        end
-
-        if vhd_path.nil?
-          # For marketplace image
           image_reference = marketplace_image_reference(publisher, offer, sku, version)
+        when 'custom'
+          custom_image = sdk.get_custom_image(rg_name, image_id)
+          image_reference = ComputeModels::ImageReference.new
+          image_reference.id = custom_image.id
+        when 'gallery'
+          image_reference = ComputeModels::ImageReference.new
+          image_reference.id = sdk.fetch_gallery_image_id(rg_name, image_id)
         else
-          # For custom managed image
-          image_ref = ComputeModels::ImageReference.new
-          image_ref.id = vhd_path
-          image_reference = image_ref
+          image_reference = nil
         end
         image_reference
       end
@@ -188,8 +224,10 @@ module ForemanAzureRm
 
       def create_managed_virtual_machine(vm_hash)
         vm_params = initialize_vm(vm_hash)
+        vm_params.plan = marketplace_image_plan(vm_hash[:image_id])
         vm_params.network_profile = define_network_profile(vm_hash[:network_interface_card_ids])
-        vm_params.storage_profile.image_reference = define_image(vm_hash[:vhd_path])
+        vm_params.storage_profile.image_reference = define_image(vm_hash[:resource_group], vm_hash[:image_id])
+        vm_params.storage_profile.data_disks = define_data_disks(vm_hash[:name], vm_hash[:data_disks])
         sdk.create_or_update_vm(vm_hash[:resource_group], vm_hash[:name], vm_params)
       end
 

data/app/models/foreman_azure_rm/azure_rm.rb

@@ -12,12 +12,14 @@ module ForemanAzureRm
     alias_attribute :region, :url
     alias_attribute :tenant, :uuid
 
-    validates :user, :password, :url, :uuid, :app_ident, :presence => true
+    validates :user, :password, :uuid, :app_ident, :presence => true
 
     has_one :key_pair, :foreign_key => :compute_resource_id, :dependent => :destroy
 
     before_create :test_connection, :setup_key_pair
 
+    validate :ensure_attributes_and_values
+
     class VMContainer
       attr_accessor :virtualmachines
       delegate :each, to: :virtualmachines
@@ -47,6 +49,15 @@ module ForemanAzureRm
       "#{name} (#{provider_friendly_name})"
     end
 
+    def ensure_attributes_and_values
+      validate_region
+    end
+
+    def validate_region
+      return unless regions.present?
+      errors.add(:region, "is not valid, must be lowercase eg. 'eastus'. No special characters allowed.") unless regions.collect(&:second).include?(region)
+    end
+
     def self.model_name
       ComputeResource.model_name
     end
@@ -56,44 +67,35 @@ module ForemanAzureRm
     end
 
     def capabilities
-      [:image]
+      [:image, :new_volume]
     end
 
-    def self.regions
-      [
-          ['West Europe', 'westeurope'],
-          ['Central US', 'centralus'],
-          ['South Central US', 'southcentralus'],
-          ['North Central US', 'northcentralus'],
-          ['West Central US', 'westcentralus'],
-          ['East US', 'eastus'],
-          ['East US 2', 'eastus2'],
-          ['West US', 'westus'],
-          ['West US 2', 'westus2']
-      ]
+    def regions
+      return unless sub_id.present?
+      sdk.list_regions(sub_id).value.map { |loc| [loc.display_name, loc.name] }
     end
 
-    validates :region, inclusion: { in: regions.collect(&:second),
-    message: "%{value} must be lowercase eg. 'eastus'. No special characters allowed." }
-
     def resource_groups
       sdk.rgs
     end
 
     def test_connection(options = {})
-      sdk.rgs.each do |rg|
-        puts "#{rg}"
-      end
-      super(options)
+      super
+      errors[:user].empty? && errors[:password].empty? && errors[:uuid].empty? && errors[:app_ident].empty? && regions
+    rescue StandardError => e
+      errors[:base] << e.message
+    rescue Excon::Error::Socket => e
+      errors[:base] << e.message
     end
 
     def new_vm(args = {})
       return AzureRmCompute.new(sdk: sdk) if args.empty?
       opts = vm_instance_defaults.merge(args.to_h).deep_symbolize_keys
       # convert rails nested_attributes into a plain hash
-      nested_args = opts.delete(:interfaces_attributes)
-      opts[:interfaces] = nested_attributes_for(:interfaces, nested_args) if nested_args
-
+      [:interfaces, :volumes].each do |collection|
+        nested_args = opts.delete("#{collection}_attributes".to_sym)
+        opts[collection] = nested_attributes_for(collection, nested_args) if nested_args
+      end
       opts.reject! { |k, v| v.nil? }
 
       raw_vm = initialize_vm(location:        region,
@@ -112,13 +114,54 @@ module ForemanAzureRm
           ifaces << new_interface(iface_attrs)
         end
       end
-      AzureRmCompute.new(azure_vm: raw_vm ,sdk: sdk, resource_group: opts[:resource_group], nics: ifaces)
+
+      vols = opts.fetch(:volumes, []).map { |vols_attrs| new_volume(vols_attrs) } if opts[:volumes].present?
+
+      AzureRmCompute.new(azure_vm: raw_vm ,sdk: sdk, resource_group: opts[:resource_group], nics: ifaces, volumes: vols, script_command: opts[:script_command], script_uris: opts[:script_uris])
     end
 
     def provided_attributes
       super.merge({ :ip => :provisioning_ip_address })
     end
 
+    def image_exists?(image)
+      image_type, image_id = image.split('://')
+      case image_type
+      when 'marketplace'
+        begin
+          urn = image_id.split(':')
+          publisher = urn[0]
+          offer     = urn[1]
+          sku       = urn[2]
+          version   = urn[3]
+          if version == "latest"
+            all_versions = sdk.list_versions(region, publisher, offer, sku).map(&:name)
+            return true if all_versions.any?
+          end
+          sdk.get_marketplace_image(region, publisher, offer, sku, version).present?
+        rescue StandardError => e
+          return false
+        end
+      when 'gallery'
+        gallery_images_list = sdk.list_resources(filter: "resourceType eq 'Microsoft.Compute/galleries/images'")
+        gallery_image = gallery_images_list.detect { |gal_img| gal_img.id.split('/')[-1] == image_id }
+        if gallery_image.present?
+          rg_name = gallery_image.id.split('/')[4]
+          gallery_name = gallery_image.name.split('/')[0]
+          image_versions = sdk.list_gallery_image_versions(rg_name, gallery_name, image_id)
+          target_regions = image_versions.map do |image_version|
+            image_version.publishing_profile.target_regions.map(&:name)
+          end.flatten.uniq.map { |tgt_reg| tgt_reg.gsub(/\s+/, '').downcase }
+          return true if target_regions.include? region
+        end
+      when 'custom'
+        custom_image = sdk.list_custom_images.detect { |custom_img| custom_img.name == image_id && custom_img.location == region }
+        return custom_image.present?
+      else
+        false
+      end
+    end
+
     def available_vnets(attr = {})
       virtual_networks
     end
@@ -151,6 +194,11 @@ module ForemanAzureRm
       true
     end
 
+    def new_volume(attrs = {})
+      args = { :disk_size_gb => 0, :data_disk_caching => "", 'persisted?' => false }.merge(attrs.to_h)
+      OpenStruct.new(args)
+    end
+
     def vm_sizes
       sdk.list_vm_sizes(region)
     end
@@ -161,7 +209,8 @@ module ForemanAzureRm
 
     def vm_instance_defaults
       super.deep_merge(
-        interfaces: [new_interface]
+        interfaces: [new_interface],
+        volumes: [new_volume]
       )
     end
 
@@ -175,6 +224,10 @@ module ForemanAzureRm
       ifaces
     end
 
+    def vm_disks(vm)
+      vm.storage_profile.data_disks
+    end
+
     def vms(attrs = {})
       container = VMContainer.new
       # Load all vms of the region
@@ -207,10 +260,14 @@ module ForemanAzureRm
       args[:vm_name] = args[:name].split('.')[0]
       nics = create_nics(region, args)
       if args[:password].present? && !args[:ssh_key_data].present?
+        # Any change to sudoers_cmd and formation of new
+        # args[:script_command] must be accordingly changed
+        # in script_command method in AzureRmCompute class
         sudoers_cmd = "$echo #{args[:password]} | sudo -S echo '\"#{args[:username]}\" ALL=(ALL) NOPASSWD: ALL' > /etc/sudoers.d/waagent"
         if args[:script_command].present?
           # to run the script_cmd given through form as username
-          args[:script_command] =  sudoers_cmd + " ; su - \"#{args[:username]}\" -c \"#{args[:script_command]}\""
+          user_command = args[:script_command]
+          args[:script_command] =  sudoers_cmd + " ; su - \"#{args[:username]}\" -c \"#{user_command}\""
         else
           args[:script_command] =  sudoers_cmd
         end
@@ -232,9 +289,10 @@ module ForemanAzureRm
         disable_password_authentication: disable_password_auth,
         network_interface_card_ids:      nics.map(&:id),
         platform:                        args[:platform],
-        vhd_path:                        args[:image_id],
+        image_id:                        args[:image_id],
         os_disk_caching:                 args[:os_disk_caching],
         premium_os_disk:                 args[:premium_os_disk],
+        data_disks:                      args[:volumes_attributes],
         custom_data:                     args[:user_data],
         script_command:                  args[:script_command],
         script_uris:                     args[:script_uris],
@@ -242,7 +300,7 @@ module ForemanAzureRm
       logger.debug "Virtual Machine #{args[:vm_name]} Created Successfully."
       create_vm_extension(region, args)
       # return the vm object using azure_vm
-      AzureRmCompute.new(azure_vm: vm, sdk: sdk, resource_group: args[:resource_group], nics: vm_nics(vm))
+      AzureRmCompute.new(azure_vm: vm, sdk: sdk, resource_group: args[:resource_group], nics: vm_nics(vm), volumes: vm_disks(vm), script_command: user_command, script_uris: args[:script_uris])
     rescue RuntimeError => e
       Foreman::Logging.exception('Unhandled AzureRm error', e)
       destroy_vm vm.id if vm
@@ -269,10 +327,8 @@ module ForemanAzureRm
           end
         end
       end
-      if os_disk.present?
-        sdk.delete_disk(rg_name, os_disk.name)
-      end
-
+      sdk.delete_disk(rg_name, os_disk.name) if os_disk.present?
+      data_disks.each { |data_disk| sdk.delete_disk(rg_name, data_disk.name) } if data_disks.present?
       true
     rescue ActiveRecord::RecordNotFound
       logger.info "Could not find the selected vm."