foreman_kubevirt 0.1.2 → 0.1.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: f2ab728beaf6449390b9686a3578738848ac1da3
-  data.tar.gz: dc79c8e150b8d7cb02c679c9e1ffd4cf63495e0b
+SHA256:
+  metadata.gz: b284e744d2f757d5493ff422214f54fd3247f50fc57cdcf3a64fe56f09c8cebe
+  data.tar.gz: c0468a5c9499fe9930d66efdba3519ea251963fdd07fa03b6cbd0ad2cebe28d6
 SHA512:
-  metadata.gz: 53d8317d77b47588d0b049ae083aa4e261ac4983c6a047870f4dc4eb899c77fa3b1b32d2edbe1f4e23201bec197a6c171708b9a77710fde52bf78a5805a612f9
-  data.tar.gz: d961f6dff0ebf22b0e8a326b08c7c20d555b9e2ce6aed4bae7e4b39c6922c512a1c3f04c2215371f55a13b461bc0d3836d5938a47e1bd65e2cb746877ef29655
+  metadata.gz: b4882fb3ac0e11da7bb342249518066df95202b87f906a487a82be829544d1a46a1512fa1b71ec2367ce55f8fbaacad40e42fadb2a6bd641581afcc3e88f6750
+  data.tar.gz: c1f5a09d792cebef6f12390f6aefae6c2b47cd7f1ed11bf39d4727208eec825ba7677cb77fe352a9a7ccdd1f1153b1a14463affd05ac0db60e712af60c5362c0

data/README.md

@@ -55,9 +55,11 @@ To verify that the installation was successful, go to Foreman, top bar **Adminis
 
 ## Compatibility
 
-| Foreman Version | Plugin Version |
-| --------------- | --------------:|
-| >= 1.21.x       | ~> 0.1.x       |
+
+
+| Foreman Version | Plugin Version |  Kubevirt API Version |
+| --------------- | --------------:|  -------------------- |
+| >= 1.21.x       | ~> 0.1.x       |  v1alpha3             |
 
 ## Usage
 Go to **Infrastructure > Compute Resources** and click on **New Compute Resource**.

data/app/assets/javascripts/bundle.js

@@ -0,0 +1 @@
+window.tfm = { kubevirt: { require('./foreman_kubevirt/kubevirt.js') };

data/app/controllers/foreman_kubevirt/concerns/api/compute_resources_controller_extensions.rb

@@ -2,25 +2,17 @@ module ForemanKubevirt
   module Concerns
     module Api
       module ComputeResourcesControllerExtensions
-        module ApiPieExtensions
-          extend ::Apipie::DSL::Concern
-          update_api(:create, :update) do
-            param :compute_resource, Hash do
-              param :token, String, :desc => N_("Token for KubeVirt only")
-              param :hostname, String, :desc => N_("Host name for KubeVirt only")
-              param :namespace, String, :desc => N_("Namespace for KubeVirt only")
-              param :ca_crt, String, :desc => N_("CA crt for KubeVirt only")
-              param :api_port, String, :desc => N_("API port for KubeVirt only")
-            end
+        extend ::Apipie::DSL::Concern
+        update_api(:create, :update) do
+          param :compute_resource, Hash do
+            param :token, String, :desc => N_("Token for KubeVirt only")
+            param :hostname, String, :desc => N_("Host name for KubeVirt only")
+            param :namespace, String, :desc => N_("Namespace for KubeVirt only")
+            param :ca_crt, String, :desc => N_("CA crt for KubeVirt only")
+            param :api_port, String, :desc => N_("API port for KubeVirt only")
           end
         end
       end
-
-      extend ActiveSupport::Concern
-
-      included do
-        include ApiPieExtensions
-      end
     end
   end
 end

data/app/models/foreman_kubevirt/compute_attribute_extensions.rb

@@ -0,0 +1,8 @@
+module ForemanKubevirt
+  module ComputeAttributeExtensions
+    extend ActiveSupport::Concern
+    included do
+      validates :vm_attrs, :volume => true
+    end
+  end
+end

data/app/models/foreman_kubevirt/kubevirt.rb

@@ -6,7 +6,7 @@ module ForemanKubevirt
     alias_attribute :token, :password
     alias_attribute :namespace, :user
     validates :hostname, :api_port, :namespace, :token, :presence => true
-    validate :test_connection
+    after_validation :validate_connectivity unless Rails.env.test?
 
     def ca_cert
       attrs[:ca_cert]
@@ -28,6 +28,10 @@ module ForemanKubevirt
       %i[build image new_volume]
     end
 
+    def user_data_supported?
+      true
+    end
+
     def provided_attributes
       { :uuid => :name, :mac => :mac }
     end
@@ -48,10 +52,29 @@ module ForemanKubevirt
       ComputeResource.model_name
     end
 
-    def test_connection(_options = {})
+    def test_connection(options = {})
+      super
+      validate_connectivity(options)
+    end
+
+    def caching_enabled
+      false
+    end
+
+    def validate_connectivity(options = {})
+      return unless connection_properties_valid?
+      return false if errors.any?
       client&.valid? && client&.virt_supported?
     rescue StandardError => e
-      errors[:base] << e.message
+      if e.message =~ /401/
+        errors[:base] << _('The compute resource could not be authenticated')
+      else
+        errors[:base] << e.message
+      end
+    end
+
+    def connection_properties_valid?
+      errors[:hostname].empty? && errors[:token].empty? && errors[:namespace].empty? && errors[:api_port].empty?
     end
 
     def networks
@@ -81,11 +104,12 @@ module ForemanKubevirt
       storage_classes.map { |sc| OpenStruct.new(id: sc.name, description: "#{sc.name} (#{sc.provisioner})") }
     end
 
-    def new_volume(attr = {})
+    def new_volume(attrs = {})
       return unless new_volume_errors.empty?
-
-      vol = Fog::Kubevirt::Compute::Volume.new(attr)
-      vol.boot_order = 1 if attr[:bootable] == "on" || attr[:bootable] == "true"
+      capacity = attrs.delete(:capacity)
+      args = {capacity: capacity}.merge(attrs)
+      vol = Fog::Kubevirt::Compute::Volume.new(args)
+      vol.boot_order = 1 if args[:bootable] == "on" || args[:bootable] == "true"
       vol
     end
 
@@ -135,24 +159,23 @@ module ForemanKubevirt
       options = vm_instance_defaults.merge(args.to_hash.deep_symbolize_keys)
       logger.debug("creating VM with the following options: #{options.inspect}")
 
-      volumes = create_volumes_for_vm(options)
-
-      # FIXME: Add cloud-init support
-      # init = { 'userData' => "#!/bin/bash\necho \"fedora\" | passwd fedora --stdin"}
-
-      interfaces, networks = create_network_devices_for_vm(options, volumes)
+      # Add clound init user data
+      user_data = { "userData" => options[:user_data] } if options[:user_data].present?
 
       begin
+        volumes = create_volumes_for_vm(options)
+        interfaces, networks = create_network_devices_for_vm(options, volumes)
         client.vms.create(:vm_name     => options[:name],
                           :cpus        => options[:cpu_cores].to_i,
-                          :memory_size => options[:memory].to_i / 2**20,
+                          :memory_size => convert_memory(options[:memory] + "b", :mi).to_s,
+                          :memory_unit => "Mi",
                           :volumes     => volumes,
-                          # :cloudinit   => init,
+                          :cloudinit   => user_data,
                           :networks    => networks,
                           :interfaces  => interfaces)
         client.servers.get(options[:name])
-      rescue Fog::Kubevirt::Errors::ClientError => e
-        delete_pvcs(volumes)
+      rescue Exception => e
+        delete_pvcs(volumes) if volumes
         raise e
       end
     end
@@ -177,7 +200,7 @@ module ForemanKubevirt
     # return 'false'
     def vm_instance_defaults
       {
-        :memory    => 1024.megabytes,
+        :memory    => 1024.megabytes.to_s,
         :cpu_cores => '1'
       }
     end
@@ -260,11 +283,41 @@ module ForemanKubevirt
       64.gigabytes
     end
 
+    # Converts a given memory to bytes
+    #
+    # @param memory - The memory of the VM to convert
+    #
+    def convert_memory_to_bytes(memory)
+      convert_memory(memory, :b)
+    end
+
+    def plain_kubevirt_protocol
+      "plain.kubevirt.io".freeze
+    end
+
+    def token_protocol(token)
+      "base64url.bearer.authorization.k8s.io.#{token}"
+    end
+
+    def console(uuid)
+      vm = find_vm_by_uuid(uuid)
+      vnc_details = client.vminstances.get_vnc_console_details(vm.name, namespace)
+      token = Base64.encode64(vnc_details[:token]).delete!("\n").delete("==")
+      {
+        :host => vnc_details[:host],
+        :port => vnc_details[:port],
+        :path => vnc_details[:path],
+        :token_protocol => token_protocol(token),
+        :plain_protocol => plain_kubevirt_protocol,
+        :type => 'vnc',
+        :encrypt => true
+      }
+    end
+
     protected
 
     def client
       return @client if @client
-
       @client ||= Fog::Kubevirt::Compute.new(
         :kubevirt_hostname   => hostname,
         :kubevirt_port       => api_port,
@@ -272,7 +325,8 @@ module ForemanKubevirt
         :kubevirt_token      => token,
         :kubevirt_log        => logger,
         :kubevirt_verify_ssl => ca_cert.present?,
-        :kubevirt_ca_cert    => ca_cert
+        :kubevirt_ca_cert    => ca_cert,
+        :kubevirt_version    => "v1alpha3"
       )
     rescue OpenSSL::X509::CertificateError
       raise_certification_failure_exception
@@ -304,7 +358,7 @@ module ForemanKubevirt
 
     def verify_booting_from_image_is_possible(volumes)
       raise ::Foreman::Exception.new N_('It is not possible to set a bootable volume and image based provisioning.') if
-        volumes.any? { |_, v| v[:bootable] == "true" }
+        volumes&.any? { |_, v| v[:bootable] == "true" }
     end
 
     def add_volume_for_image_provision(options)
@@ -321,11 +375,15 @@ module ForemanKubevirt
     end
 
     def validate_volume_capacity(volumes_attributes)
-      volumes_attributes.each { |_, v| raise ::Foreman::Exception.new N_('Capacity was not found') if v[:capacity].empty? }
+      volumes_attributes.each do |_, vol|
+        if vol[:capacity].to_s.empty? || /\A\d+G?\Z/.match(vol[:capacity].to_s).nil?
+          raise Foreman::Exception.new(N_("Volume size #{vol[:capacity]} is not valid"))
+        end
+      end
     end
 
     def validate_only_single_bootable_volume(volumes_attributes)
-      raise ::Foreman::Exception.new N_('Only one volume can be bootable') if volumes_attributes.select { |_, v| v[:bootable] == "true" }.count > 1
+      raise ::Foreman::Exception.new N_('Only one volume can be bootable') if volumes_attributes.count { |_, v| v[:bootable] == "true" } > 1
     end
 
     def create_new_pvc(pvc_name, capacity, storage_class)
@@ -410,8 +468,8 @@ module ForemanKubevirt
     def create_network_devices_for_vm(options, volumes)
       interfaces = []
       networks = []
-
       options[:interfaces_attributes].values.each do |iface|
+        raise ::Foreman::Exception.new N_('cni_provider or network are missing') unless (iface.key?(:cni_provider) && iface.key?(:network))
         if iface[:cni_provider] == 'pod'
           nic, net = create_pod_network_element
         else
@@ -428,5 +486,9 @@ module ForemanKubevirt
 
       [interfaces, networks]
     end
+
+    def convert_memory(memory, unit)
+      ::Fog::Kubevirt::Utils::UnitConverter.convert(memory, unit).to_i
+    end
   end
 end

data/app/validators/volume_validator.rb

@@ -0,0 +1,13 @@
+class VolumeValidator < ActiveModel::EachValidator
+  def validate_each(record, attribute, value)
+    if value[:volumes_attributes].present?
+      value[:volumes_attributes].each do |_, attrs|
+        if attrs.key?("capacity") && attrs.key?("storage_class")
+          if attrs["capacity"].to_s.empty? || /\A\d+G?\Z/.match(attrs["capacity"].to_s).nil?
+            record.errors.add(attribute, _("Volume size #{attrs['capacity']} is not valid"))
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -1,11 +1,13 @@
-<%= text_f f, :hostname, :label => _("Hostname") %>
+<%= text_f f, :hostname, :label => _("Hostname"), :required => true %>
 <%= text_f f, :api_port, :label => _("API Port"), :required => true %>
 <%= text_f f, :namespace, :label => _("Namespace"), :required => true %>
-<%= password_f f, :password, :label => _("Token"), :required => true,
+<%= password_f f, :token, :label => _("Token"), :required => true,
               :keep_value => true, :unset => unset_password?,
               :help_block => _("e.g. eyJhbGciOiJSUzI1NiIsImtpZCI6IiJ9..."),
               :help_inline => documentation_button('/foreman_kubevirt/0.x/index.html#4.1SettingComputeResourceTokenandX509CAvalues',
-                                                   root_url: 'https://theforeman.org/plugins') %>
+              :root_url => 'https://theforeman.org/plugins'),
+              :id => "compute_resource_password"
+%>
 
 <%= textarea_f f, :ca_cert, :label => _("X509 Certification Authorities"),
   :placeholder => _("Optionally provide a CA, or a correctly ordered CA chain or a path to a file. If left blank - insecure.") %>

data/app/views/compute_resources_vms/form/kubevirt/_volume.html.erb

@@ -1,6 +1,10 @@
 <% if f.object.type.nil? || f.object.type == 'persistentVolumeClaim' %>
+  <% if @set %>
+    <% @set.errors[:vm_attrs].each do | error| %>
+      <%= alert :class => 'alert-danger', :header => '', :text => error %>
+    <% end %>
+  <% end %>
   <% storage_classes = compute_resource.storage_classes %>
-
   <%= select_f f, :storage_class,
                   compute_resource.storage_classes_for_select,
                   :id,
@@ -10,7 +14,6 @@
                   :label_size => "col-md-2",
                   :disabled => !new_vm,
                   :class => "col-md-2" %>
-
   <%= text_f f,:capacity, :label => _('Size (GB)'), :label_size => "col-md-2", :disabled => !new_vm, :class => "col-md-2 pvc-size" %>
 
   <% bootable = f.object.boot_order.nil? ? false : f.object.bootable %>

data/app/views/compute_resources_vms/index/_kubevirt.html.erb

@@ -12,7 +12,7 @@
     <tr>
       <td><%= link_to_if_authorized vm.name, hash_for_compute_resource_vm_path(:compute_resource_id => @compute_resource, :id => vm.identity).merge(:auth_object => @compute_resource, :auth_action => 'view', :authorizer => authorizer) %></td>
       <td><%= vm.cpu_cores %></td>
-      <td><%= vm.memory %></td>
+      <td><%= number_to_human_size @compute_resource.convert_memory_to_bytes(vm.memory) %></td>
       <td>
         <span <%= vm_power_class(vm.ready?) %>>
           <%= vm_state(vm) %></span>

data/app/views/compute_resources_vms/show/_kubevirt.html.erb

@@ -20,8 +20,7 @@
       </tr>
       <tr>
         <td><%= _('Memory') %></td>
-        <td><%= number_to_human_size @vm.memory %>
-        </td>
+        <td><%= number_to_human_size @compute_resource.convert_memory_to_bytes(@vm.memory) %></td>
       </tr>
       <tr>
         <td><%= _('Namespace') %></td>

data/lib/foreman_kubevirt/engine.rb

@@ -44,6 +44,7 @@ module ForemanKubevirt
     config.to_prepare do
       begin
         require "fog/kubevirt"
+        require "fog/kubevirt/compute/utils/unit_converter"
         require "fog/kubevirt/compute/models/server"
         require File.expand_path("../../app/models/concerns/fog_extensions/kubevirt/server", __dir__)
 
@@ -61,6 +62,8 @@ module ForemanKubevirt
         require "fog/kubevirt/compute/models/networkattachmentdef"
         require File.expand_path("../../app/models/concerns/fog_extensions/kubevirt/network", __dir__)
         Fog::Kubevirt::Compute::Networkattachmentdef.send(:include, ::FogExtensions::Kubevirt::Network)
+        ComputeAttribute.send :include, ForemanKubevirt::ComputeAttributeExtensions
+
       rescue StandardError => e
         Rails.logger.warn "Foreman-Kubevirt: skipping engine hook (#{e})"
       end

data/lib/foreman_kubevirt/version.rb

@@ -1,3 +1,3 @@
 module ForemanKubevirt
-  VERSION = '0.1.2'.freeze
+  VERSION = '0.1.8'.freeze
 end

data/locale/action_names.rb

@@ -0,0 +1,5 @@
+# Autogenerated!
+_("Action with sub plans")
+_("Import facts")
+_("Import Puppet classes")
+_("Remote action:")

data/locale/ca/foreman_kubevirt.po

@@ -0,0 +1,170 @@
+# Catalan translations for foreman_kubevirt package.
+# Copyright (C) 2020 THE PACKAGE'S COPYRIGHT HOLDER
+# This file is distributed under the same license as the foreman_kubevirt package.
+# FIRST AUTHOR <EMAIL@ADDRESS>, 2020.
+#
+msgid ""
+msgstr ""
+"Project-Id-Version: foreman_kubevirt 1.0.0\n"
+"Report-Msgid-Bugs-To: \n"
+"PO-Revision-Date: 2020-05-26 13:16+0530\n"
+"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
+"Language-Team: Catalan\n"
+"Language: ca\n"
+"MIME-Version: 1.0\n"
+"Content-Type: text/plain; charset=UTF-8\n"
+"Content-Transfer-Encoding: 8bit\n"
+"Plural-Forms: nplurals=2; plural=n != 1;\n"
+"\n"
+
+msgid "%{cpu_cores} Cores and %{memory} memory"
+msgstr ""
+
+msgid "API Port"
+msgstr ""
+
+msgid "API port for KubeVirt only"
+msgstr ""
+
+msgid "Actions"
+msgstr ""
+
+msgid "Bootable"
+msgstr ""
+
+msgid "CA crt for KubeVirt only"
+msgstr ""
+
+msgid "CNI Provider"
+msgstr ""
+
+msgid "CPUs"
+msgstr ""
+
+msgid "Disk"
+msgstr ""
+
+msgid "Does this image support user data input (e.g. via cloud-init)?"
+msgstr ""
+
+msgid "Host name for KubeVirt only"
+msgstr ""
+
+msgid "Hostname"
+msgstr ""
+
+msgid "Image"
+msgstr ""
+
+msgid "It is not possible to set a bootable volume and image based provisioning."
+msgstr ""
+
+msgid "Memory"
+msgstr ""
+
+msgid "NIC"
+msgstr ""
+
+msgid "Name"
+msgstr ""
+
+msgid "Namespace"
+msgstr ""
+
+msgid "Namespace for KubeVirt only"
+msgstr ""
+
+msgid "Network"
+msgstr ""
+
+msgid "Only one volume can be bootable"
+msgstr ""
+
+msgid "Optionally provide a CA, or a correctly ordered CA chain or a path to a file. If left blank - insecure."
+msgstr ""
+
+msgid "Password to authenticate with - used for SSH finish step."
+msgstr ""
+
+msgid "Please select an image"
+msgstr ""
+
+msgid "Power"
+msgstr ""
+
+msgid "Power ON this machine"
+msgstr ""
+
+msgid "Properties"
+msgstr ""
+
+msgid "Provision and manage Kubevirt Virtual Machines from Foreman."
+msgstr ""
+
+msgid "Running on"
+msgstr ""
+
+msgid "Size (GB)"
+msgstr ""
+
+msgid "Start"
+msgstr ""
+
+msgid "Storage Class"
+msgstr ""
+
+msgid "The compute resource could not be authenticated"
+msgstr ""
+
+msgid "The name of the image in the registry."
+msgstr ""
+
+msgid ""
+"The remote system presented a public key signed by an unidentified certificate authority.\n"
+"           If you are sure the remote system is authentic, go to the compute resource edit page, press the 'Test Connection' button and submit"
+msgstr ""
+
+msgid "The user that is used to ssh into the instance, normally cloud-user, ec2-user, ubuntu, root etc"
+msgstr ""
+
+msgid "Token"
+msgstr ""
+
+msgid "Token for KubeVirt only"
+msgstr ""
+
+msgid "Type"
+msgstr ""
+
+msgid "UUID"
+msgstr ""
+
+msgid "VCPU(s)"
+msgstr ""
+
+msgid "VM should be created based on Persistent Volume Claim or Image"
+msgstr ""
+
+msgid "VM should be created based on an image"
+msgstr ""
+
+msgid "X509 Certification Authorities"
+msgstr ""
+
+msgid "cni_provider or network are missing"
+msgstr ""
+
+msgid "e.g. eyJhbGciOiJSUzI1NiIsImtpZCI6IiJ9..."
+msgstr ""
+
+msgid "genie"
+msgstr ""
+
+msgid "multus"
+msgstr ""
+
+msgid "no Storage Classes available on provider"
+msgstr ""
+
+msgid "pod"
+msgstr ""