Vagrant KubeVirt Provider
This is a Vagrant 1.2+ plugin that adds an KubeVirt 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.
Features
- Vagrant
up
,halt
,status
anddestroy
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.
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.
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 deployedport
- Port on which Kubevirt is listeningtoken
- 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.