README ¶
Overview
A 3rd-party driver plugin for Docker machine to manage your containers on the servers of Scaleway
Setup
Homebrew
# install latest release of docker-machine-driver-scaleway and docker-machine using homebrew
$ brew tap scaleway/scaleway
$ brew install scaleway/scaleway/docker-machine-driver-scaleway
# install latest (git) version of docker-machine-driver-scaleway
$ brew tap scaleway/scaleway
$ brew install scaleway/scaleway/docker-machine-driver-scaleway --HEAD
Go
# install latest (git) version of docker-machine-driver-scaleway in your $GOPATH/bin (depends on Golang and docker-machine)
$ go get -u github.com/scaleway/docker-machine-driver-scaleway
Binary
You can find sources and pre-compiled binaries here
Usage
1. Get your Scaleway credentials
You can find your ACCESS KEY
and generate your TOKEN
here
2. Scaleway driver helper
$ docker-machine create -d scaleway -h
Usage: docker-machine create [OPTIONS] [arg...]
Create a machine
Description:
Run 'docker-machine create --driver name' to include the create flags for that driver in the help text.
Options:
--driver, -d "none" 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
--scaleway-commercial-type "VC1S" Specifies the commercial type [$SCALEWAY_COMMERCIAL_TYPE]
--scaleway-debug Enables Scaleway client debugging [$SCALEWAY_DEBUG]
--scaleway-image "ubuntu-xenial" Specifies the image [$SCALEWAY_IMAGE]
--scaleway-name Assign a name [$SCALEWAY_NAME]
--scaleway-organization Scaleway organization [$SCALEWAY_ORGANIZATION]
--scaleway-token Scaleway token [$SCALEWAY_TOKEN]
--swarm Configure Machine with Swarm
--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-master Configure Machine to be a Swarm master
--swarm-opt [--swarm-opt option --swarm-opt option] Define arbitrary flags for swarm
--swarm-strategy "spread" Define a default scheduling strategy for Swarm
--tls-san [--tls-san option --tls-san option] Support extra SANs for TLS certs
3. Create your machine
You need to configure your ACCESS_KEY
and TOKEN
, we suggest you to install scw and create a credential file using scw login
.
In the following example, authentication is done without any other dependencies using the --scaleway-token=TOKEN
and --scaleway-organization=ACCESS_KEY
parameters.
$ docker-machine create -d scaleway --scaleway-token=TOKEN --scaleway-organization=ACCESS_KEY --scaleway-name="cloud-scaleway-1" cloud-scaleway
Running pre-create checks...
Creating machine...
(cloud-scaleway) Creating SSH key...
(cloud-scaleway) Creating server...
(cloud-scaleway) Starting server...
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 ubuntu(upstart)...
Installing Docker...
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 cloud-scaleway
Note that you can store these parameters in the environment variables SCALEWAY_TOKEN
and SCALEWAY_ORGANIZATION
.
4. Test your machine
$ eval $(docker-machine env cloud-scaleway) # loads environment variables to use your machine
$ docker-machine ls # cloud-scaleway is now activated
NAME ACTIVE DRIVER STATE URL SWARM DOCKER ERRORS
cloud-scaleway * scaleway Running tcp://212.47.248.251:2376 v1.10.3
dev - virtualbox Running tcp://192.168.99.100:2376 v1.9.1
$ docker run -d -p 80:80 owncloud:8.1 # starts a owncloud image
Unable to find image 'owncloud:8.1' locally
8.1: Pulling from library/owncloud
...
$ docker ps # displays your containers
CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES
ebdd86fcd18b owncloud:8.1 "/entrypoint.sh apach" 22 seconds ago Up 20 seconds 0.0.0.0:80->80/tcp elegant_shirley
$ curl --silent http://212.47.248.251 | head -n1 # you can also open your browser with your IP
<!DOCTYPE html>
Options
Option Name | Description | Default Value | required |
---|---|---|---|
--scaleway-organization or $SCALEWAY_ORGANIZATION |
Organization UUID | none | yes |
--scaleway-token or $SCALEWAY_TOKEN |
Token UUID | none | yes |
--scaleway-name or $SCALEWAY_NAME |
Server name | none | no |
--scaleway-commercial-type or $SCALEWAY_COMMERCIAL_TYPE |
Commercial type | VC1S | no |
--scaleway-image or $SCALEWAY_IMAGE |
Server image | ubuntu-xenial | no |
--scaleway-debug or $SCALEWAY_DEBUG |
Toggle debugging | false | no |
Changelog
v1.1.0 (2016-04-28)
- Fix provisionning error with xenial
docker-machine ls
displays the commercial-type- Switch default image to Ubuntu Xenial
- Add
--scaleway-image
(#22) - Add
--scaleway-debug
View full commits list
v1.0.2 (2016-04-20)
View full commits list
v1.0.1 (2016-04-19)
- Bump dependencies
View full commits list
v1.0.0 (2016-04-19)
- Sleep only when we stop an host (#4)
- Loads credentials from
~/.scwrc
if available (#2) - Support of
create
- Support of
start
- Support of
stop
- Support of
rm
- Support of
restart
- Support of
--scaleway-commercial-type
- Support of
--scaleway-name
Debugging
$ SCALEWAY_DEBUG=1 MACHINE_DEBUG=1 docker-machine ...
Development
Feel free to contribute 😃🍻
Links
- Scaleway console: https://cloud.scaleway.com/
- Scaleway cli: https://github.com/scaleway/scaleway-cli
- Scaleway github: https://github.com/scaleway
- Scaleway github-community: https://github.com/scaleway-community
- Docker Machine: https://docs.docker.com/machine/
- Report bugs: https://github.com/scaleway/docker-machine-driver-scaleway/issues
License
Documentation ¶
There is no documentation for this package.
Click to show internal directories.
Click to hide internal directories.