Skip to content

Commit

Permalink
Bump Readme to v0.5.0
Browse files Browse the repository at this point in the history
  • Loading branch information
Jan Broer committed Nov 17, 2015
1 parent 80dc4a5 commit c712d43
Show file tree
Hide file tree
Showing 3 changed files with 25 additions and 20 deletions.
2 changes: 0 additions & 2 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -46,9 +46,7 @@ get-deps:
go get golang.org/x/crypto/ssh
go get golang.org/x/crypto/ssh/terminal
go get github.com/Azure/go-ansiterm
#go get github.com/Azure/go-ansiterm/winterm
go get github.com/Sirupsen/logrus
#go get github.com/docker/docker/pkg/term/windows

check-gofmt:
if [ -n "$(shell gofmt -l .)" ]; then \
Expand Down
26 changes: 14 additions & 12 deletions Readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ This plugin adds support for [Vultr](https://www.vultr.com/) cloud instances to

## Installation

Requirement: [Docker Machine 0.5.0-rc4](https://github.com/docker/machine)
Requirement: [Docker Machine 0.5.0](https://github.com/docker/machine)

Download the `docker-machine-driver-vultr` binary from the release page.
Extract the archive and copy the binary to a folder located in your `PATH` and make sure it's executable (e.g. `chmod +x /usr/local/bin/docker-machine-driver-vultr`).
Expand All @@ -25,7 +25,13 @@ Extract the archive and copy the binary to a folder located in your `PATH` and m

Grab your API key from the [Vultr control panel](https://my.vultr.com/settings/) and pass that to `docker-machine create` with the `--vultr-api-key` option.

$ docker-machine create --driver vultr --vultr-api-key=aa11bb22cc33 test-vps
**Example for creating a new machine running RancherOS:**

docker-machine create --driver vultr --vultr-api-key=abc123 rancheros-machine

**Example for creating a new machine running Ubuntu 14.04:**

docker-machine create --driver vultr --vultr-api-key=abc123 --vultr-os-id=160 ubuntu-machine

Command line flags:

Expand All @@ -40,25 +46,21 @@ Command line flags:
- `--vultr-backups`: Enable automatic backups for the VPS.
- `--vultr-userdata`: Path to file with cloud-init user-data

### PXE deployment
OS installation on Vultr can take several minutes. If you need low ETAs for your machines i recommend to use iPXE boot method by choosing the `OSID 159`. By default this will boot the latest stable version of [RancherOS](http://rancher.com/rancher-os/) with persistent storage on the disk.
When `--vultr-os-id` is not specified the current stable version of [RancherOS](http://rancher.com/rancher-os/) will be installed on the VPS.

**Example for creating a new machine running RancherOS:**

docker-machine create --driver vultr --vultr-api-key=aa11bb22cc33 --vultr-os-id=159 test-vps

Alternatively you can use any PXE boot script that you created in your Vultr account panel by supplying it's ID with the `--vultr-pxe-script` flag. The operating system booted by your script must have Cloud-init enabled and be configured to get user data from ec2 metadata datasource.
### PXE deployment
You can boot a custom OS using a PXE boot script that you created in your Vultr account panel by supplying it's ID with the `--vultr-pxe-script` flag and setting `--vultr-os-id` to `159`.
The operating system must support Cloud-init and be configured to use the `ec2` datasource type.

Environment variables and default values:

| CLI option | Environment variable | Default |
|---------------------------------|------------------------------|-----------------------------|
| **`--vultr-api-key`** | `VULTR_API_KEY` | - |
| `--vultr-ssh-user` | `VULTR_SSH_USER` | `root` |
| `--vultr-os-id` | `VULTR_OS` | 160 (*Ubuntu 14.04 x64*) |
| `--vultr-region-id` | `VULTR_REGION` | 1 (*New Jersey*) |
| `--vultr-plan-id` | `VULTR_PLAN` | 29 (*768 MB RAM,15 GB SSD*)|
| `--vultr-plan-id` | `VULTR_PLAN` | 29 (*768 MB RAM,15 GB SSD*) |
| `--vultr-os-id` | `VULTR_OS` | - |
| `--vultr-pxe-script` | `VULTR_PXE_SCRIPT` | - |
| `--vultr-ipv6` | `VULTR_IPV6` | `false` |
| `--vultr-private-networking` | `VULTR_PRIVATE_NETWORKING` | `false` |
Expand Down
17 changes: 11 additions & 6 deletions circle.yml
Original file line number Diff line number Diff line change
@@ -1,17 +1,22 @@
machine:
environment:
GOPATH: /home/ubuntu:$GOPATH
SRCDIR: /home/ubuntu$GOPATH/src/github.com/janeczku/docker-machine-vultr
#GOPATH: /home/ubuntu:$GOPATH
#SRCDIR: /home/ubuntu$GOPATH/src/github.com/janeczku/docker-machine-vultr
IMPORT_PATH: "github.com/$CIRCLE_PROJECT_USERNAME/$CIRCLE_PROJECT_REPONAME"

dependencies:
pre:
- go version
- test -d /home/ubuntu/.go_workspace/src/github.com/docker/ && rm -rf /home/ubuntu/.go_workspace/src/github.com/docker || true
- test -d /home/ubuntu/.go_workspace/src/github.com/janeczku/ || mkdir -p /home/ubuntu/.go_workspace/src/github.com/janeczku/
- test -e /home/ubuntu/.go_workspace/src/github.com/janeczku/docker-machine-vultr || ln -s /home/ubuntu/docker-machine-vultr/ /home/ubuntu/.go_workspace/src/github.com/janeczku/
- mkdir -p "$GOPATH/src/$IMPORT_PATH"
- rsync -azC --delete ./ "$GOPATH/src/$IMPORT_PATH/"
- test -d "$GOPATH/src/github.com/docker/" && rm -rf "$GOPATH/src/github.com/docker" || true
#- test -d /home/ubuntu/.go_workspace/src/github.com/janeczku/ || mkdir -p /home/ubuntu/.go_workspace/src/github.com/janeczku/
#- test -e /home/ubuntu/.go_workspace/src/github.com/janeczku/docker-machine-vultr || ln -s /home/ubuntu/docker-machine-vultr/ /home/ubuntu/.go_workspace/src/github.com/janeczku/
override:
- go get -u github.com/docker/machine
#- go get -u github.com/docker/machine
- make get-deps
- ls /usr/local/go_workspace/src/github.com
- ls /home/ubuntu/.go_workspace/src/github.com
- git --git-dir=/home/ubuntu/.go_workspace/src/github.com/docker/machine/.git --work-tree=/home/ubuntu/.go_workspace/src/github.com/docker/machine checkout tags/v0.5.0
- make build
post:
Expand Down

0 comments on commit c712d43

Please sign in to comment.