Skip to content

Commit

Permalink
Updated docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Daniel Hiltgen committed Sep 17, 2015
1 parent 4852a3e commit 4f583a0
Showing 1 changed file with 30 additions and 0 deletions.
30 changes: 30 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,32 @@
# docker-machine-kvm
KVM driver for docker-machine

This driver leverages the new [plugin architecture](https://github.com/docker/machine/issues/1626) being
developed for Docker Machine.

# Dependencies

This driver leverages [libvirt](http://libvirt.org/) and the [libvirt-go
library](https://github.com/alexzorin/libvirt-go) to create and manage
KVM based virtual machines. It has been tested with Ubuntu 12.04 through 15.04
and should work on most platforms with KVM/libvirt support. If you run into
compatibility problems, please file an [issue](https://github.com/dhiltgen/docker-machine-kvm/issues).


# Capabilities
* **boot2docker.iso** based images
* **Dual Network**
* **eth1** - A host private network called **docker-machines** is automatically created to ensure we always have connectivity to the VMs. The `docker-machine ip` command will always return this IP address which is only accessible from your local system.
* **eth0** - You can specify any libvirt named network. If you don't specify one, the "default" named network will be used.
* If you have exotic networking topolgies (openvswitch, etc.), you can use `virsh edit mymachinename` after creation, modify the first network definition by hand, then reboot the VM for the changes to take effect.
* Typically this would be your "public" network accessible from external systems
* To retrieve the IP address of this network, you can run a command like the following:
```bash
docker-machine ssh mymachinename "ip -one -4 addr show dev eth0|cut -f7 -d' '"
```

* **Other Tunables**
* Virtual CPU count via --kvm-cpu-count
* Disk size via --kvm-disk-size
* RAM via --kvm-memory

0 comments on commit 4f583a0

Please sign in to comment.