Tidy up code.

Author: tintoy

client.go

@@ -1,5 +1,10 @@
 package main
 
+/*
+ * Driver support for the CloudControl API client
+ * ----------------------------------------------
+ */
+
 import (
 	"errors"
 	"fmt"
@@ -9,6 +14,33 @@ import (
 	"time"
 )
 
+// CloudControl client retry
+const (
+	// The maximum number of times the client will retry in the case of a network error connecting to the CloudContron API.
+	clientMaxRetry = 5
+
+	// The period of time between retries against the CloudControl API.
+	clientRetryPeriod = 5 * time.Second
+)
+
+// Timeouts
+const (
+	// CloudControl server deployment timeout.
+	serverCreateTimeout = 15 * time.Minute
+
+	// CloudControl resource deletion timeout.
+	serverDeleteTimeout = 10 * time.Minute
+
+	// CloudControl server startup timeout.
+	serverStartTimeout = 3 * time.Minute
+
+	// CloudControl server shutdown timeout.
+	serverStopTimeout = 3 * time.Minute
+
+	// CloudControl server power-off timeout.
+	serverPowerOffTimeout = 2 * time.Minute
+)
+
 // Get the CloudControl API client used by the driver.
 func (driver *Driver) getCloudControlClient() (client *compute.Client, err error) {
 	client = driver.client
@@ -35,7 +67,7 @@ func (driver *Driver) getCloudControlClient() (client *compute.Client, err error
 	}
 
 	client = compute.NewClient(driver.CloudControlRegion, driver.CloudControlUser, driver.CloudControlPassword)
-	client.ConfigureRetry(10, 5*time.Second)
+	client.ConfigureRetry(clientMaxRetry, clientRetryPeriod)
 
 	driver.client = client
 
@@ -218,7 +250,7 @@ func (driver *Driver) deployServer() (*compute.Server, error) {
 
 	log.Debugf("Deploying server '%s' ('%s')...", driver.ServerID, driver.MachineName)
 
-	resource, err := client.WaitForDeploy(compute.ResourceTypeServer, driver.ServerID, 15*time.Minute)
+	resource, err := client.WaitForDeploy(compute.ResourceTypeServer, driver.ServerID, serverCreateTimeout)
 	if err != nil {
 		return nil, err
 	}
@@ -266,6 +298,93 @@ func (driver *Driver) buildDeploymentConfiguration() (deploymentConfiguration co
 	return
 }
 
+// Start the target server.
+func (driver *Driver) startServer() error {
+	server, err := driver.getServer()
+	if err != nil {
+		return err
+	}
+	if server == nil {
+		return fmt.Errorf("Server '%s' not found.", driver.ServerID)
+	}
+
+	if !server.Started {
+		return nil
+	}
+
+	client, err := driver.getCloudControlClient()
+	if err != nil {
+		return err
+	}
+
+	err = client.StartServer(driver.ServerID)
+	if err != nil {
+		return err
+	}
+
+	_, err = client.WaitForChange(compute.ResourceTypeServer, driver.ServerID, "Start server", serverStartTimeout)
+
+	return err
+}
+
+// Stop the target server.
+func (driver *Driver) stopServer() error {
+	server, err := driver.getServer()
+	if err != nil {
+		return err
+	}
+	if server == nil {
+		return fmt.Errorf("Server '%s' not found.", driver.ServerID)
+	}
+
+	if !server.Started {
+		return nil
+	}
+
+	client, err := driver.getCloudControlClient()
+	if err != nil {
+		return err
+	}
+
+	err = client.ShutdownServer(driver.ServerID)
+	if err != nil {
+		return err
+	}
+
+	_, err = client.WaitForChange(compute.ResourceTypeServer, driver.ServerID, "Shut down server", serverStopTimeout)
+
+	return err
+}
+
+// Stop the target server.
+func (driver *Driver) powerOffServer() error {
+	server, err := driver.getServer()
+	if err != nil {
+		return err
+	}
+	if server == nil {
+		return fmt.Errorf("Server '%s' not found.", driver.ServerID)
+	}
+
+	if !server.Started {
+		return nil
+	}
+
+	client, err := driver.getCloudControlClient()
+	if err != nil {
+		return err
+	}
+
+	err = client.PowerOffServer(driver.ServerID)
+	if err != nil {
+		return err
+	}
+
+	_, err = client.WaitForChange(compute.ResourceTypeServer, driver.ServerID, "Power off server", serverPowerOffTimeout)
+
+	return err
+}
+
 // Has a NAT rule been created for the server?
 func (driver *Driver) isNATRuleCreated() bool {
 	return driver.NATRuleID != ""

client_public_ip.go

@@ -1,5 +1,12 @@
 package main
 
+/*
+ * Detect the client machine's external IPv4 address
+ * -------------------------------------------------
+ *
+ * Uses http://ifconfig.co/json
+ */
+
 import (
 	"encoding/json"
 	"io/ioutil"

driver.go

@@ -1,5 +1,10 @@
 package main
 
+/*
+ * Driver implementation
+ * ---------------------
+ */
+
 import (
 	"errors"
 	"fmt"
@@ -9,7 +14,7 @@ import (
 	"github.com/docker/machine/libmachine/mcnflag"
 	"github.com/docker/machine/libmachine/state"
 	"net"
-	"time"
+	"os"
 )
 
 // DefaultImageName is the name of the default OS image used to create machines.
@@ -137,7 +142,7 @@ func (driver *Driver) GetCreateFlags() []mcnflag.Flag {
 		},
 		mcnflag.BoolFlag{
 			Name:  "ddcloud-create-ssh-firewall-rule",
-			Usage: "Create a firewall rule to allow SSH access to the taret server? Default: false",
+			Usage: "Create a firewall rule to allow SSH access to the target server? Default: false",
 		},
 	}
 }
@@ -225,6 +230,7 @@ func (driver *Driver) Create() error {
 		return err
 	}
 
+	log.Infof("Exposing server '%s'...", driver.MachineName)
 	err = driver.createNATRuleForServer()
 	if err != nil {
 		return err
@@ -239,15 +245,22 @@ func (driver *Driver) Create() error {
 		if err != nil {
 			return err
 		}
-		log.Infof("Local machine's public IP address is '%s'.", clientPublicIPAddress)
+
+		log.Infof("Creating firewall rule to enable inbound SSH traffic from local machine '%s' ('%s') to '%s' ('%s':%d)...",
+			os.Getenv("HOST"),
+			clientPublicIPAddress,
+			driver.MachineName,
+			driver.IPAddress,
+			driver.SSHPort,
+		)
 
 		err = driver.createSSHFirewallRule(clientPublicIPAddress)
 		if err != nil {
 			return err
 		}
 	}
 
-	log.Infof("Configuring SSH key for server '%s' ('%s')...", driver.MachineName, driver.IPAddress)
+	log.Infof("Installing SSH key for server '%s' ('%s')...", driver.MachineName, driver.IPAddress)
 	err = driver.installSSHKey()
 	if err != nil {
 		return err
@@ -258,7 +271,7 @@ func (driver *Driver) Create() error {
 	return nil
 }
 
-// GetState retrieves the status of a Docker Machine instance in CloudControl.
+// GetState retrieves the status of the target Docker Machine instance in CloudControl.
 func (driver *Driver) GetState() (state.State, error) {
 	server, err := driver.getServer()
 	if err != nil {
@@ -335,7 +348,7 @@ func (driver *Driver) Remove() error {
 		return err
 	}
 
-	err = client.WaitForDelete(compute.ResourceTypeServer, driver.ServerID, 10*time.Minute)
+	err = client.WaitForDelete(compute.ResourceTypeServer, driver.ServerID, serverDeleteTimeout)
 	if err != nil {
 		return err
 	}
@@ -347,60 +360,12 @@ func (driver *Driver) Remove() error {
 
 // Start the target machine.
 func (driver *Driver) Start() error {
-	server, err := driver.getServer()
-	if err != nil {
-		return err
-	}
-	if server == nil {
-		return fmt.Errorf("Server '%s' not found.", driver.ServerID)
-	}
-
-	if !server.Started {
-		return nil
-	}
-
-	client, err := driver.getCloudControlClient()
-	if err != nil {
-		return err
-	}
-
-	err = client.StartServer(driver.ServerID)
-	if err != nil {
-		return err
-	}
-
-	_, err = client.WaitForChange(compute.ResourceTypeServer, driver.ServerID, "Start server", 3*time.Minute)
-
-	return err
+	return driver.startServer()
 }
 
 // Stop the target machine (gracefully).
 func (driver *Driver) Stop() error {
-	server, err := driver.getServer()
-	if err != nil {
-		return err
-	}
-	if server == nil {
-		return fmt.Errorf("Server '%s' not found.", driver.ServerID)
-	}
-
-	if !server.Started {
-		return nil
-	}
-
-	client, err := driver.getCloudControlClient()
-	if err != nil {
-		return err
-	}
-
-	err = client.ShutdownServer(driver.ServerID)
-	if err != nil {
-		return err
-	}
-
-	_, err = client.WaitForChange(compute.ResourceTypeServer, driver.ServerID, "Shut down server", 3*time.Minute)
-
-	return err
+	return driver.stopServer()
 }
 
 // Restart the target machine.
@@ -415,31 +380,7 @@ func (driver *Driver) Restart() error {
 
 // Kill the target machine (hard shutdown).
 func (driver *Driver) Kill() error {
-	server, err := driver.getServer()
-	if err != nil {
-		return err
-	}
-	if server == nil {
-		return fmt.Errorf("Server '%s' not found.", driver.ServerID)
-	}
-
-	if !server.Started {
-		return nil
-	}
-
-	client, err := driver.getCloudControlClient()
-	if err != nil {
-		return err
-	}
-
-	err = client.PowerOffServer(driver.ServerID)
-	if err != nil {
-		return err
-	}
-
-	_, err = client.WaitForChange(compute.ResourceTypeServer, driver.ServerID, "Power off server", 3*time.Minute)
-
-	return err
+	return driver.powerOffServer()
 }
 
 // GetSSHHostname returns the hostname for SSH

main.go

@@ -1,5 +1,10 @@
 package main
 
+/*
+ * Main program entry-point
+ * ------------------------
+ */
+
 import (
 	"fmt"
 	"github.com/docker/machine/libmachine/drivers"

ssh_bootstrap.go

@@ -1,5 +1,14 @@
 package main
 
+/*
+ * SSH key bootstrapper
+ * --------------------
+ *
+ * Installs an SSH key onto the target machine so the rest of docker-machine can do its stuff (then disables password authentication).
+ *
+ * This is required because CloudControl only supports specifying passwords during server deployment (not SSH keys).
+ */
+
 import (
 	"errors"
 	"fmt"