From c469550014ab094832433d04af9057c6e1a0abdf Mon Sep 17 00:00:00 2001 From: Robert Breker Date: Tue, 22 Dec 2015 14:09:51 +0000 Subject: [PATCH] Slightly improve README.md Signed-off-by: Robert Breker --- README.md | 19 ++++++++++++------- 1 file changed, 12 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 1c57688..74469eb 100644 --- a/README.md +++ b/README.md @@ -1,16 +1,23 @@ [![Build Status](https://travis-ci.org/xenserver/docker-machine-driver-xenserver.svg?branch=master)](https://travis-ci.org/xenserver/docker-machine-driver-xenserver) # docker-machine-driver-xenserver -XenServer driver for Docker Machine +This is the XenServer driver plugin for Docker Machine. It allows the orchestration of machines on Citrix XenServer. -Creates machines on a [XenServer](http://xenserver.org/) Virtual Infrastructure. Requires a working XenServer installation. The XenServer driver depends on [`go-xenserver-client`](https://github.com/xenserver/go-xenserver-client) (must be in path). +# Installation +Following the installation of Docker Machine, you can install the docker-machine-xenserver-driver: +```bash +got get github.com/xenserver/docker-machine-driver-xenserver +cd $GOPATH/src/github.com/xenserver/docker-machine-driver-xenserver/bin +make +mv docker-machine-driver-xenserver $GOPATH/bin/ +``` -Options: +# CLI Options: - `--xenserver-vcpu-count`: vCPU number for docker VM. - `--xenserver-memory-size`: Size of memory for Docker VM (in MB). - `--xenserver-boot2docker-url`: URL for boot2docker ISO image. - - `--xenserver-server`: XenServer hostname/IP for docker VM. + - `--xenserver-server`: **required for create** XenServer hostname/IP for docker VM. - `--xenserver-disk-size`: Size of disk for Docker VM (in MB). - `--xenserver-username`: **required** XenServer Username. - `--xenserver-password`: **required** XenServer Password. @@ -20,9 +27,7 @@ Options: - `--xenserver-upload-timeout`: Timeout uploading VDI. - `--xenserver-wait-timeout`: Timeout wating for VM start. -The XenServer driver uses the latest boot2docker image. - -Environment variables and default values: +# Environment variables and default values: | CLI option | Environment variable | Default | |-----------------------------------|-----------------------------|------------------------------|