foreman_kubevirt 0.1.0

data/README.md

@@ -0,0 +1,156 @@
+
+# Foreman Kubevirt Plugin
+
+The ```foreman_kubevirt ``` plugin enables managing of [KubeVirt](https://kubevirt.io) as a Compute Resource in Foreman.
+
+* Website: [TheForeman.org](http://theforeman.org)
+* Wiki: [Foreman wiki](http://projects.theforeman.org/projects/foreman/wiki/About)
+* Community and support: #theforeman for general support, #theforeman-dev for development chat in [Freenode](irc.freenode.net)
+* Mailing lists:
+    * [foreman-users](https://groups.google.com/forum/?fromgroups#!forum/foreman-users)
+    * [foreman-dev](https://groups.google.com/forum/?fromgroups#!forum/foreman-dev)
+
+
+## Installation
+
+Please see the Foreman manual for appropriate instructions:
+
+* [Foreman: How to Install a Plugin](https://theforeman.org/plugins/#2.Installation)
+
+
+### Building the plugin from source
+    # git clone https://github.com/masayag/foreman_kubevirt.git
+    # cd foreman_kubevirt
+    # gem build foreman_kubevirt.gemspec # the output will be gem named foreman_kubevirt-x.y.z.gem, where x.y.z should be replaced with the actual version
+
+### Installing the plugin
+
+#### Installing on Red Hat, CentOS, Fedora, Scientific Linux (rpm)
+    # sudo -i
+    # scl enable tfm bash
+    # yum -y install gcc-c++ redhat-rpm-config gcc rubygems rh-ruby25-ruby-devel-2.5 # or a matching version according to the installed ruby
+    # gem install foreman_kubevirt-x.y.z.gem # replace x.y.z with the actual version
+
+### Bundle (gem)
+
+Add the following to bundler.d/Gemfile.local.rb in your Foreman installation directory (/usr/share/foreman by default)
+
+    $ gem 'foreman_kubevirt'
+
+Or simply:
+
+    $ echo "gem 'foreman_kubevirt'" > /usr/share/foreman/bundler.d/Gemfile.local.rb
+
+Then run `bundle install` from the same directory
+
+#### Developing the plugin
+Add the following to bundler.d/Gemfile.local.rb in your Foreman development directory
+
+    $ gem 'foreman_kubevirt', :path => 'path to foreman_kubevirt directory'
+
+Then run `bundle install` from the same directory
+
+-------------------
+To verify that the installation was successful, go to Foreman, top bar **Administer > About** and check *foreman_kubevirt* shows up in the **System Status** menu under the **Plugins** tab.
+
+## Compatibility
+
+| Foreman Version | Plugin Version |
+| --------------- | --------------:|
+| >= 1.21.x       | ~> 0.1.x       |
+
+## Usage
+Go to **Infrastructure > Compute Resources** and click on **New Compute Resource**.
+Choose the **KubeVirt provider**, and fill in all the fields.
+
+Here is a short description of some of the fields:
+* *Namespace* - the virtual cluster on kubernetes to which the user has permissions as cluster-admin.
+* *Token* - a bearer token authentication for HTTP(s) calls.
+* *X509 Certification Authorities* - enables client certificate authentication for API server calls.
+
+### How to get values of *Token* and *X509 CA* ?
+
+#### Kubernetes
+##### *Token*:
+
+Either list the secrets and pick the one that contains the relevant token, or select a service account:
+
+List of secrets that contain the tokens and set secret name instead of *YOUR_SECRET*:
+```
+# kubectl get secrets
+# kubectl get secrets YOUR_SECRET -o jsonpath='{.data.token}' | base64 -d | xargs
+```
+
+Or obtain token for a service account named 'foreman-account':
+```
+# KUBE_SECRET=`kubectl get sa foreman-account -o jsonpath='{.secrets[0].name}'`
+# kubectl get secrets $KUBE_SECRET -o jsonpath='{.data.token}' | base64 -d | xargs
+```
+
+##### *X509 CA*:
+
+Taken from kubernetes admin config file:
+```
+# cat /etc/kubernetes/admin.conf | grep certificate-authority-data: | cut -d: -f2 | tr -d " " | base64 -d
+```
+
+Or by retrieving from the secret, via the service account (in this example assuming its name is *foreman-account*):
+```
+# KUBE_SECRET=`kubectl get sa foreman-account -o jsonpath='{.secrets[0].name}'`
+# kubectl get secret $KUBE_SECRET  -o jsonpath='{.data.ca\.crt}' | base64 -d
+```
+
+#### OpenShift
+##### *Token*:
+
+Create a privileged account named *my-account*:
+```
+# oc create -f https://raw.githubusercontent.com/ManageIQ/manageiq-providers-kubevirt/master/manifests/account-openshift.yml
+```
+Use *oc* tool for reading the token of the *my-account* service account under *default* namespace:
+`# oc sa get-token my-account -n default`
+
+##### *X509 CA*:
+
+Taken from OpenShift admin config file:
+```
+# cat /etc/origin/master/openshift-master.kubeconfig | grep certificate-authority-data: | cut -d: -f2 | tr -d " " | base64 -d
+```
+
+Or by retrieving from the secret of service account *my-account* under the *default* namespace:
+```
+# KUBE_SECRET=`oc get sa my-account -n default -o jsonpath='{.secrets[0].name}'`
+# kubectl get secret $KUBE_SECRET -n default -o jsonpath='{.data.ca\.crt}' | base64 -d
+```
+
+## Tests
+
+Tests should be invoked from the *foreman* directory by:
+```
+# bundle exec rake test:foreman_kubevirt
+```
+
+## TODO
+
+* Implement VM Console
+
+## Contributing
+
+Fork and send a Pull Request. Thanks!
+
+## Copyright
+
+Copyright (c) 2018 Red Hat, Inc.
+
+This program is free software: you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation, either version 3 of the License, or
+(at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License
+along with this program.  If not, see <http://www.gnu.org/licenses/>.

data/Rakefile

@@ -0,0 +1,44 @@
+#!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+begin
+  require 'rdoc/task'
+rescue LoadError
+  require 'rdoc/rdoc'
+  require 'rake/rdoctask'
+  RDoc::Task = Rake::RDocTask
+end
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'ForemanKubevirt'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path('test/dummy/Rakefile', __dir__)
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+begin
+  require 'rubocop/rake_task'
+  RuboCop::RakeTask.new
+rescue StandardError => _
+  puts 'Rubocop not loaded.'
+end
+
+task :default do
+  Rake::Task['rubocop'].execute
+end

data/app/assets/javascripts/foreman_kubevirt/kubevirt.js

@@ -0,0 +1,31 @@
+bootableRadio = function (item) {
+  const disabled = $('[id$=_bootable_true]:disabled:checked:visible');
+
+  $('[id$=_bootable_true]').prop('checked', false);
+  if (disabled.length > 0) {
+    disabled.prop('checked', true);
+  } else {
+    $(item).prop('checked', true);
+  }
+}
+
+cniProviderSelected = function (item) {
+  const selected = $(item).val().toLowerCase();
+  podSelected = selected == "pod";
+  changeNetworkElementVisibility(!podSelected);
+}
+
+function changeNetworkElementVisibility(toggle) {
+  if (toggle) {
+    $('.kubevirt-network').parents('.form-group').css('display', '');
+  } else {
+    $('.kubevirt-network').parents('.form-group').css('display', 'none');
+  }
+}
+
+function changeNetworkElementVisibilityOnLoad() {
+  selected = $('select.kubevirt-cni-provider').val().toLowerCase();
+  changeNetworkElementVisibility(selected != "pod");
+}
+
+$(document).ready(changeNetworkElementVisibilityOnLoad);

data/app/assets/javascripts/foreman_kubevirt/nic_info.js

@@ -0,0 +1,9 @@
+providerSpecificNICInfo = function(form) {
+  cni_provider = form.find('select.kubevirt-cni-provider :selected').text();
+  if (cni_provider === 'pod') {
+    network = '';
+  } else {
+    network = form.find('select.kubevirt-network').val();
+  }
+  return network + ' @ ' + cni_provider;
+}

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

@@ -0,0 +1,26 @@
+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
+          end
+        end
+      end
+
+      extend ActiveSupport::Concern
+
+      included do
+        include ApiPieExtensions
+      end
+    end
+  end
+end

data/app/models/concerns/fog_extensions/kubevirt/network.rb

@@ -0,0 +1,11 @@
+module FogExtensions
+  module Kubevirt
+    module Network
+      extend ActiveSupport::Concern
+
+      def id
+        name
+      end
+    end
+  end
+end

data/app/models/concerns/fog_extensions/kubevirt/server.rb

@@ -0,0 +1,55 @@
+module FogExtensions
+  module Kubevirt
+    module Server
+      extend ActiveSupport::Concern
+
+      include ActionView::Helpers::NumberHelper
+
+      attr_accessor :image_id
+
+      def to_s
+        name
+      end
+
+      def state
+        status
+      end
+
+      def interfaces_attributes=(attrs)
+      end
+
+      def volumes_attributes=(attrs)
+      end
+
+      def uuid
+        name
+      end
+
+      def mac
+        interfaces.map(&:mac_address).compact.min
+      end
+
+      # TODO: Update once new API for reporting IP_ADRESSSES is set
+      def ip_addresses
+        [interfaces&.first&.ip_address]
+      end
+
+      def poweroff
+        stop
+      end
+
+      def reset
+        stop
+        start
+      end
+
+      def vm_description
+        _("%{cpu_cores} Cores and %{memory} memory") % { :cpu_cores => cpu_cores, :memory => number_to_human_size(memory.to_i) }
+      end
+
+      def select_nic(fog_nics, _nic)
+        fog_nics.select { |iface| !iface.mac.nil? }[0]
+      end
+    end
+  end
+end

data/app/models/concerns/fog_extensions/kubevirt/vmnic.rb

@@ -0,0 +1,12 @@
+module FogExtensions
+  module Kubevirt
+    module VmNic
+      extend ActiveSupport::Concern
+      attr_writer :id
+
+      def id
+        name
+      end
+    end
+  end
+end

data/app/models/concerns/fog_extensions/kubevirt/volume.rb

@@ -0,0 +1,26 @@
+module FogExtensions
+  module Kubevirt
+    module Volume
+      extend ActiveSupport::Concern
+
+      attr_writer :storage_class
+      attr_writer :capacity
+
+      def capacity
+        pvc.requests[:storage] unless pvc.nil?
+      end
+
+      def storage_class
+        pvc&.storage_class
+      end
+
+      def bootable
+        boot_order == 1
+      end
+
+      def id
+        name
+      end
+    end
+  end
+end