Skip to content

Commit 7077fd0

Browse files
solidnerddhiltgen
authored andcommitted
Refactor README (#25)
* Refactor README README is now newly formatted and has all available parameters in it. * Fix context of images to make it more comprehensible
1 parent 9fb6d24 commit 7077fd0

File tree

1 file changed

+26
-8
lines changed

1 file changed

+26
-8
lines changed

README.md

Lines changed: 26 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -31,19 +31,37 @@ your account to the `libvirtd` group.
3131

3232

3333
# Capabilities
34-
* **boot2docker.iso** based images
35-
* **Dual Network**
36-
* **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.
37-
* **eth0** - You can specify any libvirt named network. If you don't specify one, the "default" named network will be used.
34+
35+
## Images
36+
By default `docker-machine-kvm` uses a [boot2docker.iso](https://github.com/boot2docker/boot2docker) as guest os for the kvm hypervisior. It's also possible to use every guest os image that is derived from [boot2docker.iso](https://github.com/boot2docker/boot2docker) as well.
37+
For using another image use the `--kvm-boot2docker-url` parameter.
38+
39+
Community Members did some tests and it works with [rancher/os](https://github.com/rancher/os) as guest os too.
40+
41+
## Dual Network
42+
43+
* **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.
44+
* **eth0** - You can specify any libvirt named network. If you don't specify one, the "default" named network will be used.
3845
* 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.
3946
* Typically this would be your "public" network accessible from external systems
4047
* To retrieve the IP address of this network, you can run a command like the following:
4148
```bash
4249
docker-machine ssh mymachinename "ip -one -4 addr show dev eth0|cut -f7 -d' '"
4350
```
4451

45-
* **Other Tunables**
46-
* Virtual CPU count via --kvm-cpu-count
47-
* Disk size via --kvm-disk-size
48-
* RAM via --kvm-memory
52+
## Driver Parameters
53+
54+
Here are all currently driver parameters listed that you can use.
55+
56+
| Parameter | Description|
57+
| ------------- | ------------- |
58+
| **--kvm-cpu-count** | Sets the used CPU Cores for the KVM Machine. Defaults to `1` . |
59+
| **--kvm-disk-size** | Sets the kvm machine Disk size in MB. Defaults to `20000` . |
60+
| **--kvm-memory** | Sets the Memory of the kvm machine in MB. Defaults to `1024`. |
61+
| **--kvm-network** | Sets the Network of the kvm machinee which it should connect to. Defaults to `default`. |
62+
| **--kvm-boot2docker-url** | Sets the url from which host the image is loaded. By default it's not set. |
63+
| **--kvm-cache-mode** | Sets the caching mode of the kvm machine. Defaults to `default`. |
64+
| **--kvm-io-mode-url** | Sets the disk io mode of the kvm machine. Defaults to `threads`. |
65+
66+
4967

0 commit comments

Comments
 (0)