A 3rd-party driver plugin for Docker machine to manage your containers on the servers of Scaleway
# 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
# 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
docker compose up -d
docker compose exec driver-scaleway bash
docker#> go build -buildvcs=false -o build/docker-machine-driver-scaleway-v2
You can find your ACCESS KEY
, SECRET KEY
and PROJECT_ID
in section API Keys
$ docker-machine create -d scaleway-v2 --help
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
--scaleway-accesskey Scaleway accesskey (required) [$SCALEWAY_ACCESSKEY]
--scaleway-bootscript Specifies the bootscript [$SCALEWAY_BOOTSCRIPT]
--scaleway-commercial-type "DEV1-S" Specifies the commercial type [$SCALEWAY_COMMERCIAL_TYPE]
--scaleway-debug Enables Scaleway client debugging [$SCALEWAY_DEBUG]
--scaleway-image "ubuntu-focal" Specifies the image [$SCALEWAY_IMAGE]
--scaleway-ip Specifies the Public IP address [$SCALEWAY_IP]
--scaleway-ipv6 Enable ipv6 [$SCALEWAY_IPV6]
--scaleway-name Assign a name [$SCALEWAY_NAME]
--scaleway-project-id Scaleway project id (required) [$SCALEWAY_PROJECT_ID]
--scaleway-secretkey Scaleway secretkey (required) [$SCALEWAY_SECREYKEY]
--scaleway-zone "fr-par-2" Specifies the location (fr-par-1, fr-par-2, nl-ams-1, pl-waw-1) [$SCALEWAY_ZONE]
--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
$ docker-machine create -d scaleway-v2 --scaleway-accesskey ACCESS_KEY --scaleway-secretkey SECRET_KEY --scaleway-project-id PROJECT_ID --scaleway-name cloud-scaleway-1 cloud-scaleway
Running pre-create checks...
Creating machine...
(cloud-scaleway) Create Scaleway Server ...
(cloud-scaleway) Creating SSH key...
(cloud-scaleway) Server created: cloud-scaleway-1 (<INSTANCE UUID>)
(cloud-scaleway) Start 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(systemd)...
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
$ eval $(docker-machine env cloud-scaleway) # loads environment variables to use your machine
$ docker-machine ls
NAME ACTIVE DRIVER STATE URL SWARM DOCKER ERRORS
cloud-scaleway - scaleway(DEV1-S) Running tcp://IP_ADDRESS:2376 v19.03.13
$ 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://IP_ADDRESS | head -n1 # you can also open your browser with your IP
<!DOCTYPE html>
Option Name | Description | Default Value | required |
---|---|---|---|
--scaleway-porject-id or $SCALEWAY_PROJECT_ID |
Project UUID | none | yes |
--scaleway-accesskey or $SCALEWAY_ACCESSKEY |
Access Key UUID | none | yes |
--scaleway-secretkey or $SCALEWAY_SECREYKEY |
Secret Key UUID | none | yes |
--scaleway-name or $SCALEWAY_NAME |
Server name | none | no |
--scaleway-commercial-type or $SCALEWAY_COMMERCIAL_TYPE |
Commercial type | DEV1-S | no |
--scaleway-image or $SCALEWAY_IMAGE |
Server image | ubuntu-focal | no |
--scaleway-zone or $SCALEWAY_ZONE |
Specify the location | fr-par-2 | no |
--scaleway-debug or $SCALEWAY_DEBUG |
Toggle debugging | false | no |
--scaleway-ip or $SCALEWAY_IP |
Server IP | "" | no |
# create a Scaleway docker host
docker-machine create -d scaleway my-scaleway-docker-machine
# create a DEV1-M server, name it my-docker-machine-1 on Scaleway and my-docker1 in the local Docker machine, with debug enabled
docker-machine --debug create -d scaleway \
--scaleway-name="my-docker-machine-1" --scaleway-debug \
--scaleway-commercial-type="DEV1-M" \
my-docker1
# create a swarm master on a DEV1-M
docker-machine create -d scaleway \
--scaleway-commercial-type="DEV1-M" \
--swarm --swarm-master --swarm-discovery="XXX"
my-swarm-manager
# create a swarm slave on a DEV1-M
docker-machine create -d scaleway \
--scaleway-commercial-type="DEV1-M" \
--swarm --swarm-discovery="XXX"
my-swarm-node
# remove a machine
docker-machine rm cloud-scaleway
About to remove cloud-scaleway
WARNING: This action will delete both local reference and remote instance.
Are you sure? (y/n): y
(cloud-scaleway) Stop Server ...
(cloud-scaleway) Delete server: SERVER_UUID
(cloud-scaleway) Delete volume: VOLUME_UUID
(cloud-scaleway) Delete public IP: IP_ADDRESS (IP_UUID)
Successfully removed cloud-scaleway
# force remove a machine
docker-machine rm -f cloud-scaleway
About to remove cloud-scaleway
WARNING: This action will delete both local reference and remote instance.
(cloud-scaleway) Stop Server ...
(cloud-scaleway) Delete server: SERVER_UUID
(cloud-scaleway) Delete volume: VOLUME_UUID
(cloud-scaleway) Delete public IP: IP_ADDRESS (IP_UUID)
Successfully removed cloud-scaleway
More examples.
- Use Ubuntu Jammy
- Add volume extension
- Update Go to 1.20
- Update scaleway-sdk-go to v1.0.0-beta.21
- Use scaleway-sdk-go instead go-scaleway ( quick and dirty but functional :) )
- Fix remove instance with wrong state issue #99
- Migrate from Godeps to dep
- Upgrade scaleway-cli dependency
- Add scripts to help release the project
View full commits list
- Revert "Remove VC product line"
- Use xenial image id directly
- Use default image's bootscript
View full commits list
- Change default bootscript
- Remove VC product line
- Allow the bootscript to be specified using it's unique id.
- Vendor update
- Remove IP adress if machine didn't exist (#64)
View full commits list
- Add
--scaleway-region
to start server on different location e.g.ams1
(Amsterdam) - Fix
user-agent
format - Add
--scaleway-ipv6
(#50) - Add
--scaleway-port
- Add
--scaleway-user
View full commits list
- Delete IP only when she has been created by docker-machine
View full commits list
View full commits list
- 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
View full commits list
- Bump dependencies
View full commits list
- 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
$ SCALEWAY_DEBUG=1 MACHINE_DEBUG=1 docker-machine ...
Feel free to contribute ππ»
You can easily build for all supported platforms using build-dmds-packages.sh
script
located in ./scripts
- 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