foreman_azure_rm 2.2.0 → 2.2.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 416621db4c525470113b126a84a30a5701999e6bc442f6e18beb0bdd6b3379a3
-  data.tar.gz: 6ec1793bc3394b0a19f92f5ad98a33c005e30fce89bd549ebde954529ab7d895
+  metadata.gz: 39f6ca7eb686ea697b8c9f506303f41e545e46e2ad5aeb72fe376edb9780ee64
+  data.tar.gz: bfd45c748455ba48ced60736ec4682708a223e862fc726e567eeb424c27fa874
 SHA512:
-  metadata.gz: f8a953836164727d9bba985be5d77b8211c73bc2cc20f45c7de563d49fb06cd32652695e6b4a0b42c19e0dcd5a5d86b51b347562b460f90eb33342f518044fd7
-  data.tar.gz: 79cbe567f0cb3556b046f208c6f7218876c4ab10fb8b74d4ae6e2d9df8a9f601b8a895cff46e236630c306f1f977a00c5976517af99c39744b6060a72b0cfda7
+  metadata.gz: cf021fdd847e111d38db05a4ace1070dd4bbaa4d03979405a424b55eb84b94da216b36883a6bc9957ba0c6041a0301e77586b687619a9ad23742dd26229d08b1
+  data.tar.gz: d8ff32ba98f6125b0a1200b4d93491c5735c355747aba3d5e951db72c58883879b7bab6021162f5979dda3fbac6bd325c1588881a9c000b3f1725677a8627f15

data/README.md

@@ -1,7 +1,7 @@
 # Foreman AzureRm Plugin
 
 ## Description
-```foreman_azure_rm``` adds [Microsoft Azure Resource Manager](http://azure.com/) as a compute resource for The Foreman
+```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)
@@ -11,7 +11,7 @@
 
 ### Bundle (Gem)
 
-Add the following to bundler.d/Gemfile.local.rb in your Foreman installation directory (/usr/share/foreman by default)
+Add the following to `bundler.d/Gemfile.local.rb` in your Foreman installation directory `/usr/share/foreman`
 
 ```console
 $ gem 'foreman_azure_rm'
@@ -55,7 +55,6 @@ 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 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
@@ -64,6 +63,7 @@ Then run `bundle install` from the same directory
     * 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
+    * Support for NVIDIA Drivers or CUDA on Linux and Windows
 * Limited extension support
     * Microsoft's custom script extension
     * Puppet Lab's Puppet agent extension for Windows
@@ -74,16 +74,16 @@ Go to **Infrastructure > Compute Resources** and click on "New Compute Resource"
 
 Choose the **Azure Resource Manager provider**, and fill in all the fields. You need a Subscription ID, Tenant ID, Client ID and a Client Secret which you can generate from your [Microsoft Azure subscription](https://docs.bmc.com/docs/cloudlifecyclemanagement/46/setting-up-a-tenant-id-client-id-and-client-secret-for-azure-resource-manager-provisioning-669202145.html#SettingupaTenantID,ClientID,andClientSecretforAzureResourceManagerprovisioning-SetupTenantIDPrereqPrerequisites)
 
-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:
+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/vsamP4G.png)
+![](https://i.imgur.com/yMGg3A6.png)
 
 
 ![](https://i.imgur.com/Ag9tH55.png)
 
 
-![](https://i.imgur.com/fNjlFci.png)
+![](https://i.imgur.com/OKoGgUY.png)
 
     
 ## Planned Features
@@ -91,7 +91,6 @@ That's it. You're now ready to create and manage Azure resources in your new Azu
     
 ## 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.
-* Unable to provision using Windows Images
 
 ## Links
 * [Issue tracker](https://projects.theforeman.org/projects/azurerm)

data/app/helpers/azure_compute_resource_helper.rb

@@ -10,8 +10,7 @@ module AzureComputeResourceHelper
     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
-  def azure_doc_url
+  def azure_doc_version
     doc_version = Foreman::Plugin.find(:foreman_azure_rm).version.scan(/\d+\.\d+/).first + '.x'
-    "https://theforeman.org/plugins/foreman_azure/#{doc_version}"
   end
 end

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

@@ -4,7 +4,7 @@ module ForemanAzureRm
     module ManagedVM
       extend ActiveSupport::Concern
 
-      def define_managed_storage_profile(vm_name, os_disk_caching, platform, premium_os_disk)
+      def define_managed_storage_profile(vm_name, os_disk_caching, platform, premium_os_disk, os_disk_size_gb)
         storage_profile = ComputeModels::StorageProfile.new
         os_disk = ComputeModels::OSDisk.new
         managed_disk_params = ComputeModels::ManagedDiskParameters.new
@@ -12,6 +12,7 @@ module ForemanAzureRm
         # Create OS disk
         os_disk.name = "#{vm_name}-osdisk"
         os_disk.os_type = platform
+        os_disk.disk_size_gb = os_disk_size_gb
         os_disk.create_option = ComputeModels::DiskCreateOptionTypes::FromImage
         os_disk.caching = disk_caching(os_disk_caching)
         managed_disk_params.storage_account_type = if premium_os_disk == 'true'
@@ -122,7 +123,7 @@ module ForemanAzureRm
       def create_nics(region, args = {})
         nics               = []
         args[:interfaces_attributes].each do |nic, attrs|
-          private_ip = (attrs[:private_ip] == 'false') ? false : true
+          private_ip = Foreman::Cast.to_bool(attrs[:private_ip])
           priv_ip_alloc       = if private_ip
                                   NetworkModels::IPAllocationMethod::Static
                                 else
@@ -187,21 +188,23 @@ module ForemanAzureRm
             os_profile.admin_password = vm_hash[:password]
 
             # Adding the ssh-key support for authentication
-            os_profile.linux_configuration = ComputeModels::LinuxConfiguration.new.tap do |linux|
-              linux.disable_password_authentication = vm_hash[:disable_password_authentication]
-              linux.ssh = ComputeModels::SshConfiguration.new.tap do |ssh_config|
-                ssh_config.public_keys = [
-                  ComputeModels::SshPublicKey.new.tap do |foreman_key|
-                    foreman_key.key_data = key_pair.public
-                    foreman_key.path = "/home/#{vm_hash[:username]}/.ssh/authorized_keys"
+            if vm_hash[:platform] == 'Linux'
+              os_profile.linux_configuration = ComputeModels::LinuxConfiguration.new.tap do |linux|
+                linux.disable_password_authentication = vm_hash[:disable_password_authentication]
+                linux.ssh = ComputeModels::SshConfiguration.new.tap do |ssh_config|
+                  ssh_config.public_keys = [
+                    ComputeModels::SshPublicKey.new.tap do |foreman_key|
+                      foreman_key.key_data = key_pair.public
+                      foreman_key.path = "/home/#{vm_hash[:username]}/.ssh/authorized_keys"
+                    end
+                  ]
+                  if vm_hash[:ssh_key_data].present?
+                    key_data = vm_hash[:ssh_key_data]
+                    pub_key = ComputeModels::SshPublicKey.new
+                    pub_key.key_data = key_data
+                    pub_key.path = "/home/#{vm_hash[:username]}/.ssh/authorized_keys"
+                    ssh_config.public_keys << pub_key
                   end
-                ]
-                if vm_hash[:ssh_key_data].present?
-                  key_data = vm_hash[:ssh_key_data]
-                  pub_key = ComputeModels::SshPublicKey.new
-                  pub_key.key_data = key_data
-                  pub_key.path = "/home/#{vm_hash[:username]}/.ssh/authorized_keys"
-                  ssh_config.public_keys << pub_key
                 end
               end
             end
@@ -212,7 +215,8 @@ module ForemanAzureRm
                                                                 vm_hash[:name],
                                                                 vm_hash[:os_disk_caching],
                                                                 vm_hash[:platform],
-                                                                vm_hash[:premium_os_disk]
+                                                                vm_hash[:premium_os_disk],
+                                                                vm_hash[:os_disk_size_gb]
                                                               )
           vm.hardware_profile = ComputeModels::HardwareProfile.new.tap do |hw_profile|
             hw_profile.vm_size = vm_hash[:vm_size]
@@ -235,23 +239,65 @@ module ForemanAzureRm
         if args[:script_command].present? || args[:script_uris].present?
           args[:script_uris] ||=  args[:script_uris].to_s
           extension = ComputeModels::VirtualMachineExtension.new
-          if args[:platform] == 'Linux'
+
+          case args[:platform]
+          # https://docs.microsoft.com/en-us/azure/virtual-machines/extensions/custom-script-linux
+          when 'Linux'
             extension.publisher = 'Microsoft.Azure.Extensions'
             extension.virtual_machine_extension_type = 'CustomScript'
             extension.type_handler_version = '2.0'
+          # https://docs.microsoft.com/en-us/azure/virtual-machines/extensions/custom-script-windows
+          when 'Windows'
+            extension.publisher = 'Microsoft.Compute'
+            extension.virtual_machine_extension_type = 'CustomScriptExtension'
+            extension.type_handler_version = '1.10'
+          else
+            raise RuntimeError, "Unsupported platform #{args[:platform]}"
           end
+
           extension.auto_upgrade_minor_version = true
           extension.location = region
           extension.settings = {
                 'commandToExecute' => args[:script_command],
                 'fileUris'         => args[:script_uris].split(',')
           }
+
+          extension_for_log = "#{extension.publisher}/#{extension.virtual_machine_extension_type}/#{extension.type_handler_version}"
+          Foreman::Logging.logger('app').info "Azure RM machine #{args[:name]}: creating #{extension_for_log} extension"
           sdk.create_or_update_vm_extensions(args[:resource_group],
                                              args[:vm_name],
                                              'ForemanCustomScript',
                                              extension)
         end
       end
+
+      def create_vm_nvidia_gpu_extension(region, args = {})
+        extension = ComputeModels::VirtualMachineExtension.new
+        extension.publisher = 'Microsoft.HpcCompute'
+        extension.type_handler_version = '1.3'
+        extension.auto_upgrade_minor_version = true
+        extension.location = region
+
+        case args[:platform]
+        # https://docs.microsoft.com/fr-fr/azure/virtual-machines/extensions/hpccompute-gpu-linux
+        when 'Linux'
+          extension_name = 'NvidiaGpuDriverLinux'
+        # https://docs.microsoft.com/fr-fr/azure/virtual-machines/extensions/hpccompute-gpu-windows
+        when 'Windows'
+          extension_name = 'NvidiaGpuDriverWindows'
+        else
+          raise RuntimeError, "Unsupported platform #{args[:platform]}"
+        end
+        extension.virtual_machine_extension_type = extension_name
+
+        extension_for_log = "#{extension.publisher}/#{extension.virtual_machine_extension_type}/#{extension.type_handler_version}"
+        Foreman::Logging.logger('app').info "Azure RM machine #{args[:name]}: creating #{extension_for_log} extension"
+        sdk.create_or_update_vm_extensions(args[:resource_group],
+                                           args[:vm_name],
+                                           extension_name,
+                                           extension)
+      end
+
     end
   end
 end

data/app/models/foreman_azure_rm/azure_rm.rb

@@ -43,7 +43,7 @@ module ForemanAzureRm
     end
 
     def cloud
-      attrs[:cloud]
+      attrs[:cloud] || 'azure'
     end
 
     def cloud=(name)
@@ -115,7 +115,9 @@ module ForemanAzureRm
                              platform:        opts[:platform],
                              ssh_key_data:    opts[:ssh_key_data],
                              os_disk_caching: opts[:os_disk_caching],
-                             premium_os_disk: opts[:premium_os_disk]
+                             premium_os_disk: opts[:premium_os_disk],
+                             os_disk_size_gb: opts[:os_disk_size_gb],
+                             nvidia_gpu_extension: opts[:nvidia_gpu_extension],
                             )
       if opts[:interfaces].present?
         ifaces = []
@@ -126,7 +128,16 @@ module ForemanAzureRm
 
       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])
+      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],
+        nvidia_gpu_extension: Foreman::Cast.to_bool(opts[:nvidia_gpu_extension]),
+      )
     end
 
     def provided_attributes
@@ -268,23 +279,26 @@ module ForemanAzureRm
       args = args.to_h.deep_symbolize_keys
       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
-          user_command = args[:script_command]
-          args[:script_command] =  sudoers_cmd + " ; su - \"#{args[:username]}\" -c \"#{user_command}\""
+
+      if args[:platform] == 'Linux'
+        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
+            user_command = args[:script_command]
+            args[:script_command] =  sudoers_cmd + " ; su - \"#{args[:username]}\" -c \"#{user_command}\""
+          else
+            args[:script_command] =  sudoers_cmd
+          end
+          disable_password_auth = false
+        elsif args[:ssh_key_data].present? && !args[:password].present?
+          disable_password_auth = true
         else
-          args[:script_command] =  sudoers_cmd
+          disable_password_auth = false
         end
-        disable_password_auth = false
-      elsif args[:ssh_key_data].present? && !args[:password].present?
-        disable_password_auth = true
-      else
-        disable_password_auth = false
       end
 
       vm             = create_managed_virtual_machine(
@@ -301,15 +315,31 @@ module ForemanAzureRm
         image_id:                        args[:image_id],
         os_disk_caching:                 args[:os_disk_caching],
         premium_os_disk:                 args[:premium_os_disk],
+        os_disk_size_gb:                 args[:os_disk_size_gb],
         data_disks:                      args[:volumes_attributes],
         custom_data:                     args[:user_data],
         script_command:                  args[:script_command],
         script_uris:                     args[:script_uris],
+        nvidia_gpu_extension:            args[:nvidia_gpu_extension],
       )
       logger.debug "Virtual Machine #{args[:vm_name]} Created Successfully."
+      # request NVIDIA GPU driver and CUDA stack
+      if Foreman::Cast.to_bool(args[:nvidia_gpu_extension])
+        create_vm_nvidia_gpu_extension(region, args)
+      end
+      # as this extension may contains postinstall script, call it after others
       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), volumes: vm_disks(vm), script_command: user_command, script_uris: args[:script_uris])
+      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],
+        nvidia_gpu_extension: Foreman::Cast.to_bool(args[:nvidia_gpu_extension]),
+      )
     rescue RuntimeError => e
       Foreman::Logging.exception('Unhandled AzureRm error', e)
       destroy_vm vm.id if vm

data/app/models/foreman_azure_rm/azure_rm_compute.rb

@@ -5,17 +5,19 @@ module ForemanAzureRm
     attr_accessor :resource_group
     attr_accessor :nics
     attr_accessor :script_command, :script_uris
+    attr_accessor :nvidia_gpu_extension
     attr_accessor :volumes
 
     delegate :name, to: :azure_vm, allow_nil: true
 
     def initialize(azure_vm: ComputeModels::VirtualMachine.new,
-                   sdk: sdk,
+                   sdk: nil,
                    resource_group: azure_vm.resource_group,
                    nics: [],
                    volumes: [],
                    script_command: nil,
-                   script_uris: nil)
+                   script_uris: nil,
+                   nvidia_gpu_extension: false)
 
       @azure_vm = azure_vm
       @sdk = sdk
@@ -24,6 +26,7 @@ module ForemanAzureRm
       @volumes ||= volumes
       @script_command ||= script_command
       @script_uris ||= script_uris
+      @nvidia_gpu_extension ||= nvidia_gpu_extension
       @azure_vm.hardware_profile ||= ComputeModels::HardwareProfile.new
       @azure_vm.os_profile ||= ComputeModels::OSProfile.new
       @azure_vm.os_profile.linux_configuration ||= ComputeModels::LinuxConfiguration.new
@@ -179,6 +182,10 @@ module ForemanAzureRm
       @azure_vm.storage_profile.os_disk.managed_disk.storage_account_type
     end
 
+    def os_disk_size_gb
+      @azure_vm.storage_profile.os_disk.disk_size_gb
+    end
+
     def os_disk_caching
       @azure_vm.storage_profile.os_disk.caching
     end
@@ -204,8 +211,24 @@ module ForemanAzureRm
     def vm_extension
       return nil unless @azure_vm.resources
       @vm_extension ||= begin
-        ext_name = @azure_vm.resources.first.id.split('/')[-1]
-        sdk.get_vm_extension(@azure_vm.resource_group, name, ext_name)
+        @azure_vm.resources.each do |ext|
+          ext_name = ext.id.split('/')[-1]
+          next unless ext_name == 'ForemanCustomScript'
+          return sdk.get_vm_extension(@azure_vm.resource_group, name, ext_name)
+        end
+        nil
+      end
+    end
+
+    def vm_nvidia_gpu_extension
+      return nil unless @azure_vm.resources
+      @vm_nvidia_gpu_extension ||= begin
+        @azure_vm.resources.each do |ext|
+          ext_name = ext.id.split('/')[-1]
+          next unless ['NvidiaGpuDriverLinux', 'NvidiaGpuDriverWindows'].include? ext_name
+          return sdk.get_vm_extension(@azure_vm.resource_group, name, ext_name)
+        end
+        nil
       end
     end
 
@@ -215,7 +238,7 @@ module ForemanAzureRm
         # Index is based on script_command that is being injected
         # from the code in #create_vm. It can be partly hard-coded
         # since the command shall no change frequently.
-        if ssh_key_data.nil?
+        if ssh_key_data.nil? && platform == 'Linux'
           user_cmd_index = (vm_extension.settings["commandToExecute"].index("-c"))+ 4
           script_command = vm_extension.settings["commandToExecute"][user_cmd_index..-2]
         else
@@ -234,5 +257,14 @@ module ForemanAzureRm
         @script_uris
       end
     end
+
+    def nvidia_gpu_extension
+      if vm_nvidia_gpu_extension.present?
+        true
+      else
+        @nvidia_gpu_extension
+      end
+    end
+
   end
 end

data/app/views/api/v2/compute_resources/azurerm.json.rabl

@@ -1 +1 @@
-attributes :azure_environment, :tenant, :app_ident, :sub_id, :region
+attributes :cloud, :tenant, :app_ident, :sub_id, :region

data/app/views/compute_resources/form/_azurerm.html.erb

@@ -4,8 +4,7 @@
   ['China', 'azurechina'],
   ['Germany', 'azuregermancloud'],
 ], {}, { :label => _('Cloud'), :required => true } %>
-<%= text_f f, :app_ident, :label => _('Client ID'), :required => true, :help_inline => link_to(icon_text('help', _('Documentation'), :kind => 'pficon'),
-  azure_doc_url, :rel => 'external', :class => 'btn btn-default btn-docs', :target => '_blank') %>
+<%= text_f f, :app_ident, :label => _('Client ID'), :required => true, :help_inline => link_to('Documentation', external_link_path(type: 'plugin_manual', name: 'foreman_azure', version: azure_doc_version), :kind => 'pficon', :rel => 'external', :class => 'btn btn-default btn-docs', :target => '_blank') %>
 <%= password_f f, :password, :label => _('Client Secret'), :keep_value => true, :required => true %>
 <%= text_f f, :user, :label => _('Subscription ID'), :required => true %>
 <%= text_f f, :uuid, :label => _('Tenant ID'), :required => true %>

data/app/views/compute_resources_vms/form/azurerm/_base.html.erb

@@ -132,7 +132,6 @@
 <%= password_f f, :password,
          {
              :label    => _('Password'),
-             :required => true,
              :placeholder => "********",
              :value => f.object.password
 
@@ -154,6 +153,16 @@
              'false'
 %>
 
+<%= number_f f, :os_disk_size_gb,
+         {
+             :label => _('Override OS Disk Size (GB)'),
+             :label_help => _("Leave empty to use default image size"),
+             :required => false,
+             :min => 1,
+             :class => "col-md-2",
+         }
+%>
+
 <%= selectable_f f, :os_disk_caching, %w(None ReadOnly ReadWrite),
                {   :include_blank => _("Azure's Default") },
                {
@@ -176,6 +185,16 @@
          }
 %>
 
+<%= checkbox_f f, :nvidia_gpu_extension,
+         {
+              :label => _('NVIDIA driver / CUDA'),
+              :label_size => "col-md-2",
+              :label_help => _("Deploy NVIDIA GPU driver and CUDA (Azure Extension Microsoft.HpcCompute/NvidiaGpuDriver{Linux,Windows}/1.3)"),
+         },
+         'true',
+         'false'
+%>
+
 <div id="image_selection">
   <%= select_f f, :image_id, images, :uuid, :name,
                { :include_blank => (images.empty? or images.size == 1) ? false : _('Please select an image') },