vagrant-kubevirt 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 13a3b9fb5dbac6f1fbb7774ad9d2a0232bd7a33ee17ab52ea41bf2f7079f1a63
+  data.tar.gz: 3259c02f3b97c69a59ed1bc76db83b07ce4d476eec7977f250d87e13d67efdb5
+SHA512:
+  metadata.gz: 7a04ca4cc72aa446a003d9edbe3df6dbde20624ba3d8dbbdd3ee7e3dc113245fb780242c86b610203769dc862ceae0d504237a3e62dae5d682cdb5ee603582ad
+  data.tar.gz: b5a1d70120aa19c1fd311ed623f8f6948d07abe279ef1cddb097672d6a00a8c3e0560004927440e3f1b365c4e539582d70febd1a181c488e6feb1ac1dc6675b3

data/.gitignore

@@ -0,0 +1,20 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+Vagrantfile
+!example_box/Vagrantfile
+.vagrant

data/.travis.yml

@@ -0,0 +1,12 @@
+language: ruby
+before_install:
+  - gem update --system
+  - gem install bundler
+install: bundle install
+script: bundle exec rspec
+rvm:
+  - 2.3
+  - 2.4
+  - 2.5
+notifications:
+  email: false

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+# 0.1.0 (In progress)
+
+* Initial release.

data/Gemfile

@@ -0,0 +1,12 @@
+source "https://rubygems.org"
+
+gemspec
+
+group :development do
+  # We depend on Vagrant for development, but we don't add it as a
+  # gem dependency because we expect to be installed within the
+  # Vagrant environment itself using `vagrant plugin`.
+  gem "vagrant", :git => "https://github.com/hashicorp/vagrant.git"
+
+  gem 'vagrant-spec', :github => 'hashicorp/vagrant-spec'
+end

data/LICENSE

@@ -0,0 +1,13 @@
+Copyright (c) 2018 Red Hat, Inc.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

data/README.md

@@ -0,0 +1,109 @@
+# Vagrant KubeVirt Provider
+
+
+This is a [Vagrant](http://www.vagrantup.com) 1.2+ plugin that adds an [KubeVirt](http://kubevirt.io)
+provider to Vagrant, allowing Vagrant to control and provision virtual machines using Kubernetes add-on.
+
+**NOTE:** This plugin requires Vagrant 2.2.3+. Due to the issue in net-ssh fixed [here](https://github.com/net-ssh/net-ssh/pull/641).
+
+## Features
+* Vagrant `up`, `halt`, `status` and `destroy` commands.
+* Create and boot virtual machines using templates, registry image or pvc.
+* Provision the virtual machines with any built-in Vagrant provisioner.
+* SSH into the VMIs
+* Synced folder support
+
+## Future work
+* Package running virtual machines into new vagrant-kubevirt friendly boxes
+* Manage networks for virtual machines
+
+## Usage
+
+Install using standard Vagrant 1.2+ plugin installation methods. After
+installing, `vagrant up` and specify the `kubevirt` provider. An example is
+shown below.
+
+```
+$ vagrant plugin install vagrant-kubevirt
+...
+$ vagrant up --provider=kubevirt
+...
+```
+
+## Quick Start
+
+After installing the plugin (instructions above), the quickest way to get
+started is to actually use a Kubevirt box and specify all the details
+manually within a `config.vm.provider` block. So first, add the box using
+any name you want:
+
+```
+$ vagrant box add kubevirt https://raw.githubusercontent.com/pkliczewski/vagrant-kubevirt/master/example_box/kubevirt.box
+...
+```
+
+And then make a Vagrantfile that looks like the following, filling in
+your information where necessary.
+
+```ruby
+Vagrant.configure("2") do |config|
+  config.vm.box = 'kubevirt'
+  config.vm.boot_timeout = 30
+
+  config.vm.provision "shell" do |s|
+    s.inline = "touch example.txt"
+  end
+
+  config.vm.provider :kubevirt do |kubevirt|
+    # kubevirt.template = 'working'
+    kubevirt.cpus = 2
+    kubevirt.memory = 512
+    kubevirt.image = 'kubevirt/fedora-cloud-registry-disk-demo'
+    # kubevirt.pvc = 'my_pvc'
+
+    # kubevirt.hostname = '<kubevirt-host>'
+    # kubevirt.port = '<kubevirt port>'
+    # kubevirt.token = '<token>'
+  end
+
+  config.ssh.username = 'vagrant'
+  config.ssh.password = 'vagrant'
+  config.ssh.private_key_path = ['~/.ssh/id_rsa']
+end
+```
+
+And then run `vagrant up --provider=kubevirt`.
+
+## Box Format
+
+Every provider in Vagrant must introduce a custom box format. This
+provider introduces `kubevirt` boxes. You can view an example box in
+the [example_box/ directory](https://github.com/pkliczewski/vagrant-kubevirt/tree/master/example_box).
+That directory also contains instructions on how to build a box.
+
+The box format is basically just the required `metadata.json` file
+along with a `Vagrantfile` that does default settings for the
+provider-specific configuration for this provider.
+
+## Configuration
+
+There are 2 options to configure provider:
+
+# Kubevirt provider configuration options:
+
+* `hostname` - Hostname where Kubevirt is deployed
+* `port` - Port on which Kubevirt is listening
+* `token` - Token used to authenticate any requests
+
+# kubeconfig file
+
+User can provide path to config file using `KUBECONFIG` environemnt variable or have it in
+well known location such as `~/.kube/config`.
+
+### Domain Specific Options
+
+* `cpus` - Number of virtual cpus. Defaults to 1 if not set.
+* `memory` - Amount of memory in MBytes. Defaults to 512 if not set.
+* `template` -  Name of template from which new VM will be created.
+* `image` - Name of image which will be used to create new VM.
+* `pvc` - Name of persistent volume claim which will be used to create new VM.

data/Rakefile

@@ -0,0 +1,22 @@
+require 'rubygems'
+require 'bundler/setup'
+require 'rspec/core/rake_task'
+
+# Immediately sync all stdout so that tools like buildbot can
+# immediately load in the output.
+$stdout.sync = true
+$stderr.sync = true
+
+# Change to the directory of this file.
+Dir.chdir(File.expand_path("../", __FILE__))
+
+# This installs the tasks that help with gem creation and
+# publishing.
+Bundler::GemHelper.install_tasks
+
+# Install the `spec` task so that we can run tests.
+RSpec::Core::RakeTask.new(:spec) do |t|
+  t.rspec_opts = "--order defined"
+end
+# Default task is to run the unit tests
+task :default => :spec

data/example_box/README.md

@@ -0,0 +1,9 @@
+# Vagrant Kubevirt Example Box
+
+Vagrant providers each require a custom provider-specific box format.
+This folder shows the example contents of a box for the `kubevirt` provider.
+To turn this into a box:
+
+```
+$ tar cvzf kubevirt.box ./metadata.json ./Vagrantfile
+```	

data/example_box/Vagrantfile

@@ -0,0 +1,20 @@
+Vagrant.configure("2") do |config|
+  config.vm.box = 'kubevirt'
+
+  # config.vm.synced_folder ".", "/vagrant", disabled: true
+  # config.vm.synced_folder "/home/pkliczewski/git/vagrant-kubevirt/example_box/src", "/srv/website", type: "rsync"
+
+  # config.vm.provision "shell" do |s|
+  #   s.inline = "touch example.txt"
+  # end
+
+  config.vm.provider :kubevirt do |kubevirt|
+    kubevirt.cpus = 2
+    kubevirt.memory = 512
+    kubevirt.image = 'kubevirt/fedora-cloud-registry-disk-demo'
+  end
+
+  config.ssh.username = 'vagrant'
+  config.ssh.password = 'vagrant'
+  config.ssh.private_key_path = ['~/.ssh/id_rsa']
+end

data/example_box/metadata.json

@@ -0,0 +1,3 @@
+{
+    "provider": "kubevirt"
+}

data/lib/vagrant-kubevirt.rb

@@ -0,0 +1,18 @@
+require "pathname"
+
+require "vagrant-kubevirt/plugin"
+
+module VagrantPlugins
+  module Kubevirt
+    lib_path = Pathname.new(File.expand_path("../vagrant-kubevirt", __FILE__))
+    autoload :Action, lib_path.join("action")
+    autoload :Errors, lib_path.join("errors")
+
+    # This returns the path to the source of this plugin.
+    #
+    # @return [Pathname]
+    def self.source_root
+      @source_root ||= Pathname.new(File.expand_path("../../", __FILE__))
+    end
+  end
+end

data/lib/vagrant-kubevirt/action.rb

@@ -0,0 +1,176 @@
+require "pathname"
+
+require "vagrant/action/builder"
+
+module VagrantPlugins
+  module Kubevirt
+    module Action
+      # Include the built-in modules so we can use them as top-level things.
+      include Vagrant::Action::Builtin
+
+      # This action is called to bring the box up from nothing.
+      def self.action_up
+        Vagrant::Action::Builder.new.tap do |b|
+          b.use ConfigValidate
+          b.use ConnectKubevirt
+          b.use Call, IsCreated do |env1, b1|
+          	b1.use SetDomainName
+
+            if env1[:result]
+              b1.use Message,
+                I18n.t("vagrant_kubevirt.already_status", :status => "created")
+            else
+              b1.use CreateVM
+            end
+          end
+
+          b.use Provision
+          b.use SyncedFolders
+
+          b.use Call, IsStopped do |env2, b2|
+            if env2[:result]
+              b2.use StartVM
+              b2.use Call, WaitForState, :running, 120 do |env3, b3|
+                unless env3[:result]
+                  b3.use Message,
+                    I18n.t("vagrant_kubevirt.action_failed", :action => 'Up')
+                end
+              end
+            end
+          end
+        end
+      end
+
+      # This action is called to halt the remote machine.
+      def self.action_halt
+        Vagrant::Action::Builder.new.tap do |b|
+          b.use ConfigValidate
+          b.use Call, IsCreated do |env, b2|
+            unless env[:result]
+              b2.use Message,
+                I18n.t("vagrant_kubevirt.not_created")
+              next
+            end
+
+            b2.use ConnectKubevirt
+            b2.use SetDomainName
+            b2.use StopVM
+            b2.use Call, WaitForState, :stopped, 120 do |env2, b3|
+              unless env2[:result]
+                b2.use Message,
+                  I18n.t("vagrant_kubevirt.action_failed", :action => 'Halt')
+              end
+            end
+          end
+        end
+      end
+
+      # This action is called to terminate the remote machine.
+      def self.action_destroy
+        Vagrant::Action::Builder.new.tap do |b|
+          b.use ConfigValidate
+          b.use Call, IsCreated do |env, b2|
+            unless env[:result]
+              b2.use Message,
+                I18n.t("vagrant_kubevirt.not_created")
+              next
+            end
+
+            b2.use ConnectKubevirt
+            b2.use DestroyVM
+          end
+        end
+      end
+
+      # This action is called to read the state of the machine. The
+      # resulting state is expected to be put into the `:machine_state_id`
+      # key.
+      def self.action_read_state
+        Vagrant::Action::Builder.new.tap do |b|
+          b.use ConfigValidate
+          b.use ConnectKubevirt
+          b.use ReadState
+        end
+      end
+
+      # This action is called to read the SSH info of the machine. The
+      # resulting state is expected to be put into the `:machine_ssh_info`
+      # key.
+      def self.action_read_ssh_info
+        Vagrant::Action::Builder.new.tap do |b|
+          b.use ConfigValidate
+          b.use ConnectKubevirt
+          b.use ReadSSHInfo
+        end
+      end
+
+
+      # This action is called to SSH into the machine.
+      def self.action_ssh
+        Vagrant::Action::Builder.new.tap do |b|
+          b.use ConfigValidate
+          b.use Call, IsCreated do |env, b2|
+            unless env[:result]
+              b2.use Message,
+                I18n.t("vagrant_kubevirt.not_created")
+              next
+            end
+
+            b2.use SSHExec
+          end
+        end
+      end
+
+      def self.action_ssh_run
+        Vagrant::Action::Builder.new.tap do |b|
+          b.use ConfigValidate
+          b.use Call, IsCreated do |env, b2|
+            unless env[:result]
+              b2.use Message,
+                I18n.t("vagrant_kubevirt.not_created")
+              next
+            end
+
+            b2.use SSHRun
+          end
+        end
+      end
+
+      def self.action_provision
+        Vagrant::Action::Builder.new.tap do |b|
+          b.use ConfigValidate
+          b.use Call, IsCreated do |env, b2|
+            unless env[:result]
+              b2.use Message,
+                I18n.t("vagrant_kubevirt.not_created")
+              next
+            end
+
+            b2.use Call, IsStopped do |env2, b3|
+              if env2[:result]
+                I18n.t("vagrant_kubevirt.not_running")
+                next
+              end
+
+              b3.use Provision
+            end
+          end
+        end
+      end
+
+      # The autoload farm
+      action_root = Pathname.new(File.expand_path("../action", __FILE__))
+      autoload :ConnectKubevirt, action_root.join("connect_kubevirt")
+      autoload :CreateVM, action_root.join("create_vm")
+      autoload :DestroyVM, action_root.join("destroy_vm")
+      autoload :IsCreated, action_root.join("is_created")
+      autoload :IsStopped, action_root.join("is_stopped")
+      autoload :ReadState, action_root.join("read_state")
+      autoload :ReadSSHInfo, action_root.join("read_ssh_info")
+      autoload :SetDomainName, action_root.join("set_domain_name")
+      autoload :StartVM, action_root.join("start_vm")
+      autoload :StopVM, action_root.join("stop_vm")
+      autoload :WaitForState, action_root.join("wait_for_state")
+    end
+  end
+end

data/lib/vagrant-kubevirt/action/connect_kubevirt.rb

@@ -0,0 +1,37 @@
+require 'fog/kubevirt'
+
+require "log4r"
+
+module VagrantPlugins
+  module Kubevirt
+    module Action
+      class ConnectKubevirt
+
+      	def initialize(app, env)
+          @app    = app
+          @logger = Log4r::Logger.new("vagrant_kubevirt::action::connect_kubevirt")
+        end
+
+
+        def call(env)
+          # Get config options for kubevirt provider.
+          config = env[:machine].provider_config
+
+          # Build the fog config
+          fog_config = {
+            :kubevirt_hostname  => config.hostname,
+            :kubevirt_port      => config.port,
+            :kubevirt_token     => config.token,
+            :kubevirt_namespace => config.namespace,
+            :kubevirt_log       => @logger
+          }
+
+          @logger.info("Connecting to Kubevirt...")
+          env[:kubevirt_compute] = Fog::Kubevirt::Compute.new(fog_config)
+
+          @app.call(env)
+        end
+      end
+    end
+  end
+end