foreman_azure_rm 2.1.2 → 2.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 04afcc03f8710a4e02d4f540342ff9e1ec9188fc8c83734065eecc6956327341
-  data.tar.gz: 20b3d6cbfd6346270fb9fe335ae0ebde9181751ffd61b6c4bb98868cacf82ab4
+  metadata.gz: 66582a70ada6bb3f6b1fc712b3e608b51011c30a1984fec8eedd4668c73e4354
+  data.tar.gz: 1e6bd7f047048ac2ce3fe11bacd0d58d0789283fb4a282f45afbb56acf32d6bf
 SHA512:
-  metadata.gz: c6dc0580218a0bb8e37c734a669931d1fd6c02d37170b77d50a11afdaaee0c7675ee0cb3897eb8c05aa7e8d58af519a8e1b3e09521b6e1344a78cda1f5e3f456
-  data.tar.gz: 2aea8c30cc2c29bea406c17471bffbf029311616137e964564e236d1b8caee737f8afc644c5b6e52969f4a0eaff59d420bf4a0de7159229b424475e5797da6ba
+  metadata.gz: 113776b3d93fdafecc995f33baea6b405d103ad0b07805be982243d14a324541b1d8ee88707bd2277a4b86b199a360a4a4ef7153cdddabc8d489b70c75f98c46
+  data.tar.gz: 91049cb9fd99a32afb1bee9cf607610323fceff5281ede64caefd57b3762ffcc72e071ebd974fdd743c568305f9fa9a48a5c6d5ab65fb6c755a68a726eab31b0

data/README.md

@@ -67,6 +67,7 @@ Then run `bundle install` from the same directory
 * Limited extension support
     * Microsoft's custom script extension
     * Puppet Lab's Puppet agent extension for Windows
+* Azure Gov Cloud Support
 
 ## Configuration
 Go to **Infrastructure > Compute Resources** and click on "New Compute Resource".
@@ -86,7 +87,6 @@ That's it. You're now ready to create and manage Azure resources in your new Azu
 
     
 ## Planned Features
-* Azure Gov Cloud Support
 * Support for http_proxy
     
 ## Known Limitations

data/app/controllers/foreman_azure_rm/concerns/compute_resources_controller_extensions.rb

@@ -10,6 +10,7 @@ module ForemanAzureRm
           param :app_ident, String, :desc => N_("Client ID for AzureRm")
           param :secret_key, String, :desc => N_("Client Secret for AzureRm")
           param :sub_id, String, :desc => N_("Subscription ID for AzureRm")
+          param :cloud, String, :desc => N_("Cloud")
         end
       end
 

data/app/helpers/azure_compute_resource_helper.rb

@@ -10,4 +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_version
+    doc_version = Foreman::Plugin.find(:foreman_azure_rm).version.scan(/\d+\.\d+/).first + '.x'
+  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,11 +239,22 @@ 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 = {

data/app/models/foreman_azure_rm/azure_rm.rb

@@ -11,6 +11,7 @@ module ForemanAzureRm
     alias_attribute :secret_key, :password
     alias_attribute :region, :url
     alias_attribute :tenant, :uuid
+    alias_attribute :azure_environment, :cloud
 
     validates :user, :password, :uuid, :app_ident, :presence => true
 
@@ -41,8 +42,16 @@ module ForemanAzureRm
       attrs[:app_ident] = name
     end
 
+    def cloud
+      attrs[:cloud]
+    end
+
+    def cloud=(name)
+      attrs[:cloud] = name
+    end
+
     def sdk
-      @sdk ||= ForemanAzureRm::AzureSdkAdapter.new(tenant, app_ident, secret_key, sub_id)
+      @sdk ||= ForemanAzureRm::AzureSdkAdapter.new(tenant, app_ident, secret_key, sub_id, azure_environment)
     end
     
     def to_label
@@ -81,7 +90,7 @@ module ForemanAzureRm
 
     def test_connection(options = {})
       super
-      errors[:user].empty? && errors[:password].empty? && errors[:uuid].empty? && errors[:app_ident].empty? && regions
+      errors[:user].empty? && errors[:password].empty? && errors[:uuid].empty? && errors[:app_ident].empty? && errors[:cloud].empty? && regions
     rescue StandardError => e
       errors[:base] << e.message
     rescue Excon::Error::Socket => e
@@ -106,7 +115,8 @@ 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]
                             )
       if opts[:interfaces].present?
         ifaces = []
@@ -259,23 +269,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(
@@ -292,6 +305,7 @@ 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],

data/app/models/foreman_azure_rm/azure_rm_compute.rb

@@ -10,7 +10,7 @@ module ForemanAzureRm
     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: [],
@@ -179,6 +179,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

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

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

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

@@ -1,6 +1,12 @@
-<%= text_f f, :app_ident, :label => _('Client ID'), :required => true %>
+<%= selectable_f f, :cloud, [
+  ['Public / Standard', 'azure'],  
+  ['US Government', 'azureusgovernment'],
+  ['China', 'azurechina'],
+  ['Germany', 'azuregermancloud'],
+], {}, { :label => _('Cloud'), :required => true } %>
+<%= 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 %>
 
-<%= regions_list(@compute_resource, f) %>
+<%= regions_list(@compute_resource, f) %>

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

@@ -154,6 +154,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") },
                {

data/lib/foreman_azure_rm/azure_sdk_adapter.rb

@@ -1,46 +1,87 @@
 module ForemanAzureRm
   class AzureSdkAdapter
-    def initialize(tenant, app_ident, secret_key, sub_id)
-      @tenant           = tenant
-      @app_ident        = app_ident
-      @secret_key       = secret_key
-      @sub_id           = sub_id
+    def initialize(tenant, app_ident, secret_key, sub_id, azure_environment)
+      @tenant               = tenant
+      @app_ident            = app_ident
+      @secret_key           = secret_key
+      @sub_id               = sub_id
+      @azure_environment    = azure_environment
+      @ad_settings          = ad_environment_settings(azure_environment)
+      @environment_settings = environment_settings(azure_environment)
     end
 
     def resource_client
-      @resource_client ||= Resources::Client.new(azure_credentials)
+      #resource_manager_endpoint_url
+      @resource_client ||= Resources::Client.new(azure_credentials(@environment_settings.resource_manager_endpoint_url))
     end
 
     def compute_client
-      @compute_client ||= Compute::Client.new(azure_credentials)
+      @compute_client ||= Compute::Client.new(azure_credentials(@environment_settings.resource_manager_endpoint_url))
     end
 
     def network_client
-      @network_client ||= Network::Client.new(azure_credentials)
+      @network_client ||= Network::Client.new(azure_credentials(@environment_settings.resource_manager_endpoint_url))
     end
 
     def storage_client
-      @storage_client ||= Storage::Client.new(azure_credentials)
+      @storage_client ||= Storage::Client.new(azure_credentials(@environment_settings.resource_manager_endpoint_url))
     end
 
     def subscription_client
-      @subscription_client ||= Subscriptions::Client.new(azure_credentials)
+      @subscription_client ||= Subscriptions::Client.new(azure_credentials(@environment_settings.resource_manager_endpoint_url))
     end
 
-    def azure_credentials
+    def azure_credentials(base_url)
       provider = MsRestAzure::ApplicationTokenProvider.new(
       @tenant,
       @app_ident,
-      @secret_key)
+      @secret_key,
+      @ad_settings)
       
       credentials = MsRest::TokenCredentials.new(provider)
 
       {
         credentials: credentials,
-        subscription_id: @sub_id
+        tenant_id: @tenant,
+        client_id: @app_ident,
+        client_secret: @secret_key,
+        subscription_id: @sub_id,
+        base_url: base_url
       }
     end
 
+    # https://github.com/Azure/azure-sdk-for-ruby/issues/850
+    # Retrieves a [MsRestAzure::ActiveDirectoryServiceSettings] object representing the settings for the given cloud.
+    # @param azure_environment [String] The Azure environment to retrieve settings for.
+    #
+    # @return [MsRestAzure::ActiveDirectoryServiceSettings] Settings to be used for subsequent requests
+    #
+    def ad_environment_settings(azure_environment)
+      case azure_environment.downcase
+      when 'azureusgovernment'
+        MsRestAzure::ActiveDirectoryServiceSettings.get_azure_us_government_settings
+      when 'azurechina'
+        MsRestAzure::ActiveDirectoryServiceSettings.get_azure_china_settings
+      when 'azuregermancloud'
+        MsRestAzure::ActiveDirectoryServiceSettings.get_azure_german_settings
+      when 'azure'
+        MsRestAzure::ActiveDirectoryServiceSettings.get_azure_settings
+      end
+    end
+
+    def environment_settings(azure_environment)
+      case azure_environment.downcase
+      when 'azureusgovernment'
+        MsRestAzure::AzureEnvironments::AzureUSGovernment
+      when 'azurechina'
+        MsRestAzure::AzureEnvironments::AzureChinaCloud
+      when 'azuregermancloud'
+        MsRestAzure::AzureEnvironments::AzureGermanCloud
+      when 'azure'
+        MsRestAzure::AzureEnvironments::AzureCloud
+      end
+    end
+
     def list_regions(subscription_id)
       subscription_client.subscriptions.list_locations(subscription_id)
     end

data/lib/foreman_azure_rm/engine.rb

@@ -11,7 +11,7 @@ module ForemanAzureRm
       Foreman::Plugin.register :foreman_azure_rm do
         requires_foreman '>= 1.17'
         compute_resource ForemanAzureRm::AzureRm
-        parameter_filter ComputeResource, :azure_vm, :tenant, :app_ident, :secret_key, :sub_id, :region
+        parameter_filter ComputeResource, :azure_vm, :tenant, :app_ident, :secret_key, :sub_id, :region, :cloud
       end
     end
 

data/lib/foreman_azure_rm/version.rb

@@ -1,3 +1,3 @@
 module ForemanAzureRm
-  VERSION = '2.1.2'.freeze
+  VERSION = '2.2.3'.freeze
 end

metadata

@@ -1,101 +1,87 @@
 --- !ruby/object:Gem::Specification
 name: foreman_azure_rm
 version: !ruby/object:Gem::Version
-  version: 2.1.2
+  version: 2.2.3
 platform: ruby
 authors:
 - Aditi Puntambekar
 - Shimon Shtein
 - Tyler Gregory
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-07-13 00:00:00.000000000 Z
+date: 2021-05-04 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: deface
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '2.0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: azure_mgmt_resources
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.17.6
+        version: 0.18.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.17.6
+        version: 0.18.1
 - !ruby/object:Gem::Dependency
   name: azure_mgmt_network
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.19.0
+        version: 0.26.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.19.0
+        version: 0.26.1
 - !ruby/object:Gem::Dependency
   name: azure_mgmt_storage
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.17.10
+        version: 0.23.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.17.10
+        version: 0.23.0
 - !ruby/object:Gem::Dependency
   name: azure_mgmt_compute
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.18.7
+        version: 0.22.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.18.7
+        version: 0.22.0
 - !ruby/object:Gem::Dependency
   name: azure_mgmt_subscriptions
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.18.1
+        version: 0.18.5
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.18.1
+        version: 0.18.5
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
@@ -215,7 +201,7 @@ homepage: https://github.com/theforeman/foreman_azure_rm
 licenses:
 - GPL-3.0
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -230,9 +216,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6.2
-signing_key: 
+rubygems_version: 3.1.6
+signing_key:
 specification_version: 4
 summary: Azure Resource Manager as a compute resource for The Foreman
 test_files: []