Skip to content

Latest commit

 

History

History
128 lines (96 loc) · 5.91 KB

README.md

File metadata and controls

128 lines (96 loc) · 5.91 KB
Raw

docker-machine-driver-hyperone

Build Status Go Report Card

A Docker Machine driver for HyperOne. It can be used provision multiple remote Docker hosts on Virtual Machine.

Requirements

Installation

Go tools

# install latest (git) version of docker-machine-driver-hyperone in your $GOPATH/bin (depends on Golang and docker-machine)
$ go get -u github.com/hyperonecom/docker-machine-driver-hyperone

pre-compiled binaries

You can find sources and pre-compiled binaries on the "Releases" page.

Download the binary (this example downloads the binary for darwin amd64):

$ wget https://github.com/hyperonecom/docker-machine-driver-hyperone/releases/latest/download/docker-machine-driver-hyperone-darwin_amd64.zip
$ unzip docker-machine-driver-hyperone-darwin_amd64.zip

Make it executable and copy the binary in a directory accessible on your $PATH:

$ chmod +x docker-machine-driver-hyperone
$ sudo cp docker-machine-driver-hyperone /usr/local/bin/

Usage

Official documentation for Docker Machine is available on website.

To create a HyperOne Virtual Machine for Docker purposes just run this command:

$ docker-machine create --driver hyperone --hyperone-access-token-secret TOKEN --hyperone-project PROJECT vm
Running pre-create checks...
Creating machine...
(vm) Creating HyperOne VM...
Waiting for machine to be running, this may take a few minutes...
Detecting operating system of created instance...
Waiting for SSH to be available...
Detecting the provisioner...
Provisioning with debian...
Copying certs to the local machine directory...
Copying certs to the remote machine...
Setting Docker configuration on the remote daemon...
Checking connection to Docker...
Docker is up and running!
To see how to connect your Docker Client to the Docker Engine running on this virtual machine, run: docker-machine env vm

Available options:

Usage: docker-machine create [OPTIONS] [arg...]

Create a machine

Description:
   Run 'docker-machine create --driver name --help' to include the create flags for that driver in the help text.

Options:

   --driver, -d "virtualbox"										Driver to create machine with. [$MACHINE_DRIVER]
   --engine-env [--engine-env option --engine-env option]						Specify environment variables to set in the engine
   --engine-insecure-registry [--engine-insecure-registry option --engine-insecure-registry option]	Specify insecure registries to allow with the created engine
   --engine-install-url "https://get.docker.com"							Custom URL to use for engine installation [$MACHINE_DOCKER_INSTALL_URL]
   --engine-label [--engine-label option --engine-label option]						Specify labels for the created engine
   --engine-opt [--engine-opt option --engine-opt option]						Specify arbitrary flags to include with the created engine in the form flag=value
   --engine-registry-mirror [--engine-registry-mirror option --engine-registry-mirror option]		Specify registry mirrors to use [$ENGINE_REGISTRY_MIRROR]
   --engine-storage-driver 										Specify a storage driver to use with the engine
   --hyperone-access-token-secret 									HyperOne Access Token Secret [$HYPERONE_ACCESS_TOKEN_SECRET]
   --hyperone-disk-name "os-disk"									HyperOne VM OS Disk Name [$HYPERONE_DISK_NAME]
   --hyperone-disk-size "20"										HyperOne VM OS Disk Size [$HYPERONE_DISK_SIZE]
   --hyperone-disk-type "ssd"										HyperOne VM OS Disk Type [$HYPERONE_DISK_TYPE]
   --hyperone-image "debian"										HyperOne Image [$HYPERONE_IMAGE]
   --hyperone-project 											HyperOne Project [$HYPERONE_PROJECT]
   --hyperone-ssh-user "guru"										SSH Username [$HYPERONE_SSH_USER]
   --hyperone-type "a1.micro"										HyperOne VM Type [$HYPERONE_TYPE]
   --swarm												Configure Machine to join a Swarm cluster
   --swarm-addr 											addr to advertise for Swarm (default: detect and use the machine IP)
   --swarm-discovery 											Discovery service to use with Swarm
   --swarm-experimental											Enable Swarm experimental features
   --swarm-host "tcp://0.0.0.0:3376"									ip/socket to listen on for Swarm master
   --swarm-image "swarm:latest"										Specify Docker image to use for Swarm [$MACHINE_SWARM_IMAGE]
   --swarm-join-opt [--swarm-join-opt option --swarm-join-opt option]					Define arbitrary flags for Swarm join
   --swarm-master											Configure Machine to be a Swarm master
   --swarm-opt [--swarm-opt option --swarm-opt option]							Define arbitrary flags for Swarm master
   --swarm-strategy "spread"										Define a default scheduling strategy for Swarm
   --tls-san [--tls-san option --tls-san option]							Support extra SANs for TLS certs

Development

Build from source

If you wish to work on this driver, you will first need Go installed. Make sure Go is properly installed, including setting up a GOPATH.

Clone the repository:

$ git clone [email protected]:hyperonecom/docker-machine-driver-hyperone.git
$ cd docker-machine-driver-hyperone

Run these commands in root of repository to build the plugin binary:

$ go build

After the build is complete, docker-machine-driver-hyperone binary will be created. Put it in the PATH.

Running tests

For details how to run tests read the contents of the .travis.yml file.