Merge pull request #2 from monochromata/master

Restructure packages for development builds and document building

Author: JonasProgrammer

README.md

@@ -1,21 +1,43 @@
----
-description: Hetzner Cloud driver for machine
-keywords: machine, hetzner, Hetzner Cloud, driver
-title: Hetzner Cloud
----
+# Hetzner Cloud Docker machine driver
 
-Create Docker machines on [Hetzner Cloud](https://docs.hetzner.cloud/).
+[![Go Report Card](https://goreportcard.com/badge/github.com/JonasProgrammer/docker-machine-driver-hetzner)](https://goreportcard.com/report/github.com/JonasProgrammer/docker-machine-driver-hetzner)
+[![License](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)
+
+> This library adds the support for creating [Docker machines](https://github.com/docker/machine) hosted on the [Hetzner Cloud](hetzner.de/cloud). 
 
 You need to create a project-sepcific access token under `Access` > `API Tokens` in the project control panel
 and pass that to `docker-machine create` with the `--hetzner-api-token` option.
 
+
+## Building
+
+Use an up-to-date version of [go](https://golang.org/dl)
+
+To use the driver, you can download the sources and build it locally:
+
+    # Get sources and build the binary at ~/go/bin/docker-machine-driver-hetzner
+    go get github.com/jonasprogrammer/docker-machine-driver-hetzner
+
+    # Make the binary accessible to docker-machine
+    export GOPATH=$(go env GOPATH)
+    export GOBIN=$GOPATH/bin
+    export PATH="$PATH:$GOBIN"
+
+
 ## Usage
 
-    $ docker-machine create --driver hetzner --hetzner-api-token=QJhoRT38JfAUO037PWJ5Zt9iAABIxdxdh4gPqNkUGKIrUMd6I3cPIsfKozI513sy some-machine
+    $ docker-machine create \
+	--driver hetzner \
+	--hetzner-api-token=QJhoRT38JfAUO037PWJ5Zt9iAABIxdxdh4gPqNkUGKIrUMd6I3cPIsfKozI513sy \
+	some-machine
 
 ### Using environment variables
 
-    $ HETZNER_API_TOKEN=QJhoRT38JfAUO037PWJ5Zt9iAABIxdxdh4gPqNkUGKIrUMd6I3cPIsfKozI513sy HETZNER_IMAGE=centos-7 docker-machine create --driver hetzner some-machine
+    $ HETZNER_API_TOKEN=QJhoRT38JfAUO037PWJ5Zt9iAABIxdxdh4gPqNkUGKIrUMd6I3cPIsfKozI513sy \
+      && HETZNER_IMAGE=centos-7 \
+      && docker-machine create \
+	--driver hetzner \
+        some-machine
 
 
 ## Options
@@ -57,3 +79,30 @@ was used during creation.
 | `--hetzner-server-location`         | `HETZNER_LOCATION`                | - *(let Hetzner choose)*   |
 | `--hetzner-existing-key-path`       | `HETZNER_EXISTING_KEY_PATH`       | - *(generate new keypair)* |
 | `--hetzner-existing-key-id`         | `HETZNER_EXISTING_KEY_ID`         | 0 *(upload new key)*       |
+
+
+## Development
+
+Fork this repository, yielding `github.com/<yourAccount>/docker-machine-driver-hetzner`.
+
+    # Get the sources of your fork and build it locally
+    go get github.com/<yourAccount>/docker-machine-driver-hetzner
+
+    # * This integrates your fork into the $GOPATH (typically pointing at ~/go)
+    # * Your sources are at $GOPATH/src/github.com/<yourAccount>/docker-machine-driver-hetzner
+    # * That folder is a local Git repository. You can pull, commit and push from there.
+    # * The binary will typically be at $GOPATH/bin/docker-machine-driver-hetzner
+    # * In the source directory $GOPATH/src/github.com/<yourAccount>/docker-machine-driver-hetzner
+    #   you may use go get to re-build the binary.
+    # * Note: when you build the driver from different repositories, e.g. from your fork
+    #   as well as github.com/jonasprogrammer/docker-machine-driver-hetzner,
+    #   the binary files generated by these builds are all called the same
+    #   and will hence override each other.
+
+    # Make the binary accessible to docker-machine
+    export GOPATH=$(go env GOPATH)
+    export GOBIN=$GOPATH/bin
+    export PATH="$PATH:$GOBIN"
+
+    # Make docker-machine output help including hetzner-specific options
+    docker-machine create --driver hetzner

driver/driver.go driver.godriver/driver.go renamed to driver.go

@@ -1,4 +1,4 @@
-package driver
+package main
 
 import (
 	"fmt"
@@ -128,7 +128,7 @@ func (d *Driver) SetConfigFromFlags(opts drivers.DriverOptions) error {
 	d.SetSwarmConfigFromFlags(opts)
 
 	if d.AccessToken == "" {
-		return fmt.Errorf("hetnzer erquires --%v to be set", flagApiToken)
+		return fmt.Errorf("hetzner requires --%v to be set", flagApiToken)
 	}
 
 	return nil
@@ -159,7 +159,7 @@ func (d *Driver) PreCreateCheck() error {
 
 		if key.Fingerprint != ssh.FingerprintLegacyMD5(pubk) &&
 			key.Fingerprint != ssh.FingerprintSHA256(pubk) {
-			return fmt.Errorf("remote key %d does not fit with local key %s", d.KeyID, d.originalKey)
+			return fmt.Errorf("remote key %d does not match local key %s", d.KeyID, d.originalKey)
 		}
 	}
 

main.go

@@ -2,9 +2,8 @@ package main
 
 import (
 	"github.com/docker/machine/libmachine/drivers/plugin"
-	"github.com/jonasprogrammer/docker-machine-driver-hetzner/driver"
 )
 
 func main() {
-	plugin.RegisterDriver(driver.NewDriver())
+	plugin.RegisterDriver(NewDriver())
 }