Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
a-rmz committed Apr 12, 2019
1 parent 58b25f2 commit 2a26993
Showing 1 changed file with 24 additions and 12 deletions.
36 changes: 24 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,27 +1,40 @@
# docker-machine-driver-upcloud
# UpCloud Docker Machine Driver

A docker-machine driver for [UpCloud](https://www.upcloud.com/)
A `docker-machine` driver for [UpCloud](https://www.upcloud.com/)

Updated and maintained by [Montel Intergalactic](https://www.montel.fi)
Originally developed by [Hanzo Studio](https://hanzo.es/)

## How to get it

### The binary way

Download the latest
[binary](https://github.com/torras/docker-machine-driver-upcloud/releases/download/0/docker-machine-driver-upcloud) from the
[releases](https://github.com/torras/docker-machine-driver-upcloud/releases) page,
place it somewhere in your path, like `/usr/local/bin/` or the like and make
sure the binary is executable.
[binary](https://github.com/montel-ig/docker-machine-driver-upcloud/releases/download/0/docker-machine-driver-upcloud) from the
[releases](https://github.com/montel-ig/docker-machine-driver-upcloud/releases) page,
place it somewhere in your path, like `/usr/local/bin/` and make sure the binary is executable.

### The go way

_You must first have a working go development environment to get it this way._

1. Download the code
```bash
$ go get -u github.com/torras/docker-machine-driver-upcloud
$ git clone git@github.com:montel-ig/docker-machine-driver-upcloud
```

2. Make sure the dependencies are installed and everything is in order
```bash
$ dep ensure
```

3. Compile the code
```bash
$ make build
```

This will compile the file at `./bin/docker-machine-driver-upcloud` and create a symlink at `/usr/local/bin/` so the driver can be used. You can change that path to any directory which is available via `$PATH` on the `Makefile`.

### How to use it

_An UpCloud account with api access is needed to use this driver_
Expand All @@ -37,11 +50,12 @@ $ docker-machine create --driver upcloud
--upcloud-passwd upcloud api access user's password [$UPCLOUD_PASSWD]
--upcloud-plan "1xCPU-1GB" upcloud plan [$UPCLOUD_PLAN]
--upcloud-ssh-user "root" SSH username [$UPCLOUD_SSH_USER]
--upcloud-template "01000000-0000-4000-8000-000030030200" upcloud template [$UPCLOUD_TEMPLATE]
--upcloud-storage 25 specify the storage available for the server [$UPCLOUD_STORAGE]
--upcloud-template "01000000-0000-4000-8000-000030080200" upcloud template [$UPCLOUD_TEMPLATE]
--upcloud-use-private-network set this flag to use private networking [$UPCLOUD_USE_PRIVATE_NETWORK]
--upcloud-use-private-network-only set this flag to only use private networking [$UPCLOUD_USE_PRIVATE_NETWORK_ONLY]
--upcloud-userdata path to file with cloud-init user-data [$UPCLOUD_USERDATA]
--upcloud-zone "uk-lon1" upcloud zone [$UPCLOUD_ZONE]
--upcloud-zone "de-fra1" upcloud zone [$UPCLOUD_ZONE]
...
Expand All @@ -60,6 +74,4 @@ machine_name
### Issues, contributions and comments.
Feel free to address me the way you find the most convenient.
Issues, contributions, comments and such are always welcome.
Issues, contributions, and comments are always welcome. Feel free to submit an issue or pull request with your contributions.

0 comments on commit 2a26993

Please sign in to comment.