virtlet's Introduction

virtlet

Virtlet is a Kubernetes runtime server which allows you to run VM workloads, based on QCOW2 images.

At this stage (pre-alpha), it's possible to run Virtlet by following the instructions from either Running local environment or Deploy using DaemonSets documents.

See here for the description of Virtlet architecture.

Getting started with Virtlet

To try out Virtlet follow the instructions from Running local environment and try out examples documents.

Virtlet introduction video

You can watch and listen to Virtlet introduction and description video that was recorded on Kubernetes Community Meeting here.

Virtlet usage demo

You can watch sample usage session under this link.

You can also give Virtlet a quick try using our demo script (requires Docker 1.12+):

wget https://raw.githubusercontent.com/Mirantis/virtlet/master/deploy/demo.sh
chmod +x demo.sh
# './demo.sh --help' displays the description
./demo.sh

The demo will start a test cluster, deploy Virtlet on it and then boot a CirrOS VM there. You may access sample nginx server via curl http://nginx.default.svc.cluster.local from inside the VM. To detach from VM console, press Ctrl-]. After you detach from the VM you can remove the test cluster with ./dind-cluster-v1.5.sh clean.

The demo is based on kubeadm-dind-cluster project. Docker btrfs storage driver is currently unsupported. Please refer to kubeadm-dind-cluster documentation for more info.

Need any help with Virtlet?

If you will encounter any issue when using Virtlet please look into our issue tracker on github. If your case is not mentioned there - please fill new issue for it.

Contributing

Virtlet is an open source project and any contributions are welcomed. Look into Contributing guidelines document for our guidelines and further instructions on how to set up Virtlet development environment.