Merge branch 'stackscript' into stackscript-merge

Author: displague

README.md

@@ -67,9 +67,11 @@ Successfully removed linode
 | `linode-image` | `LINODE_IMAGE` | `linode/ubuntu18.04` | The Linode Instance `image` which provides the Linux distribution (see [here](https://api.linode.com/v4/images)).
 | `linode-kernel` | `LINODE_KERNEL` | `linode/grub2` | The Linux Instance `kernel` to boot.  `linode/grub2` will defer to the distribution kernel. (see [here](https://api.linode.com/v4/linode/kernels) (`?page=N`))
 | `linode-ssh-port` | `LINODE_SSH_PORT` | `22` | The port that SSH is running on, needed for Docker Machine to provision the Linode.
+| `linode-ssh-user` | `LINODE_SSH_USER` | `root` | The user as which docker-machine should log in to the Linode instance to install Docker.  This user must have passwordless sudo.
 | `linode-docker-port` | `LINODE_DOCKER_PORT` | `2376` | The TCP port of the Linode that Docker will be listening on
 | `linode-swap-size` | `LINODE_SWAP_SIZE` | `512` | The amount of swap space provisioned on the Linode Instance
-
+| `linode-stackscript` | `LINODE_STACKSCRIPT` | None | Specifies the Linode StackScript to use to create the instance, either by numeric ID, or using the form *username*/*label*.
+| `linode-stackscript-data` | `LINODE_STACKSCRIPT_DATA` | None | A JSON string specifying data that is passed (via UDF) to the selected StackScript.
 
 ## Discussion / Help
 

pkg/drivers/linode/linode.go

@@ -8,6 +8,8 @@ import (
 	"net"
 	"net/http"
 	"strings"
+	"strconv"
+	"encoding/json"
 
 	"github.com/docker/machine/libmachine/drivers"
 	"github.com/docker/machine/libmachine/log"
@@ -37,6 +39,11 @@ type Driver struct {
 	InstanceImage  string
 	InstanceKernel string
 	SwapSize       int
+
+	StackScriptID    int
+	StackScriptUser  string
+	StackScriptLabel string
+	StackScriptData  map[string]string
 }
 
 const (
@@ -50,6 +57,8 @@ const (
 	defaultInstanceKernel = "linode/grub2"
 	defaultSwapSize       = 512
 	defaultDockerPort     = 2376
+
+	defaultContainerLinuxSSHUser = "core"
 )
 
 // NewDriver
@@ -124,7 +133,7 @@ func (d *Driver) GetCreateFlags() []mcnflag.Flag {
 			EnvVar: "LINODE_LABEL",
 			Name:   "linode-label",
 			Usage:  "Linode Instance Label",
-		},
+	},
 		mcnflag.StringFlag{
 			EnvVar: "LINODE_REGION",
 			Name:   "linode-region",
@@ -143,6 +152,12 @@ func (d *Driver) GetCreateFlags() []mcnflag.Flag {
 			Usage:  "Linode Instance SSH Port",
 			Value:  defaultSSHPort,
 		},
+		mcnflag.StringFlag{
+			EnvVar: "LINODE_SSH_USER",
+			Name:   "linode-ssh-user",
+			Usage:  "Specifies the user as which docker-machine should log in to the Linode instance to install Docker.",
+			Value:  "",
+		},
 		mcnflag.StringFlag{
 			EnvVar: "LINODE_IMAGE",
 			Name:   "linode-image",
@@ -167,13 +182,38 @@ func (d *Driver) GetCreateFlags() []mcnflag.Flag {
 			Usage:  "Linode Instance Swap Size (MB)",
 			Value:  defaultSwapSize,
 		},
+		mcnflag.StringFlag{
+			EnvVar: "LINODE_STACKSCRIPT",
+			Name:   "linode-stackscript",
+			Usage:  "Specifies the Linode StackScript to use to create the instance",
+			Value:  "",
+		},
+		mcnflag.StringFlag{
+			EnvVar: "LINODE_STACKSCRIPT_DATA",
+			Name:   "linode-stackscript-data",
+			Usage:  "A JSON string specifying data for the selected StackScript",
+			Value: "",
+		},
 	}
 }
 
+// GetSSHPort returns port for use with ssh
+func (d *Driver) GetSSHPort() (int, error) {
+	if d.SSHPort == 0 {
+		d.SSHPort = defaultSSHPort
+	}
+
+	return d.SSHPort, nil
+}
+
 // GetSSHUsername returns username for use with ssh
 func (d *Driver) GetSSHUsername() string {
 	if d.SSHUser == "" {
-		d.SSHUser = defaultSSHUser
+		if strings.Contains(d.InstanceImage, "linode/containerlinux") {
+			d.SSHUser = defaultContainerLinuxSSHUser
+		} else {
+			d.SSHUser = defaultSSHUser
+		}
 	}
 
 	return d.SSHUser
@@ -187,12 +227,15 @@ func (d *Driver) SetConfigFromFlags(flags drivers.DriverOptions) error {
 	d.InstanceType = flags.String("linode-instance-type")
 	d.RootPassword = flags.String("linode-root-pass")
 	d.SSHPort = flags.Int("linode-ssh-port")
+	d.SSHUser = flags.String("linode-ssh-user")
 	d.InstanceImage = flags.String("linode-image")
 	d.InstanceKernel = flags.String("linode-kernel")
 	d.InstanceLabel = flags.String("linode-label")
 	d.SwapSize = flags.Int("linode-swap-size")
 	d.DockerPort = flags.Int("linode-docker-port")
 
+	log.Infof("Using SSH port %d", d.SSHPort)
+	
 	d.SetSwarmConfigFromFlags(flags)
 
 	if d.APIToken == "" {
@@ -203,21 +246,84 @@ func (d *Driver) SetConfigFromFlags(flags drivers.DriverOptions) error {
 		return fmt.Errorf("linode driver requires the --linode-root-pass option")
 	}
 
+	stackScript := flags.String("linode-stackscript")
+	if stackScript != "" {
+		sid, err := strconv.Atoi(stackScript)
+		if err == nil {
+			d.StackScriptID = sid
+		} else {
+			ss := strings.SplitN(stackScript, "/", 2)
+			if len(ss) != 2 {
+				return fmt.Errorf("linode StackScripts must be specified using username/label syntax, or using their identifier")
+			}
+
+			d.StackScriptUser = ss[0]
+			d.StackScriptLabel = ss[1]
+
+			stackScriptData := flags.String("linode-stackscript-data")
+
+			err := json.Unmarshal([]byte(stackScriptData), &d.StackScriptData)
+			if err != nil {
+				return fmt.Errorf("linode StackScript data must be valid JSON: %v", err)
+			}
+		}
+	}
+
 	if len(d.InstanceLabel) == 0 {
 		d.InstanceLabel = d.GetMachineName()
 	}
-	if strings.Contains(d.InstanceImage, "linode/containerlinux") {
-		d.SSHUser = "core"
-	}
 
 	return nil
 }
 
 func (d *Driver) PreCreateCheck() error {
 	// TODO linode-stackscript-file should be read and uploaded (private), then used for boot.
 	// RevNote could be sha256 of file so the file can be referenced instead of reuploaded.
-	// linode-stackscript would let the user specify an existing id
-	// linode-stackscript-data would need to be a json input
+
+	client := d.getClient()
+
+	if d.StackScriptUser != "" {
+		/* N.B. username isn't on the list of filterable fields, however
+                        adding it doesn't make anything fail, so if it becomes
+                        filterable in future this will become more efficient */
+		options := map[string]string {
+			"username": d.StackScriptUser,
+			"label": d.StackScriptLabel,
+		}
+		b, err := json.Marshal(options)
+		if err != nil {
+			return err
+		}
+		opts := linodego.NewListOptions(0, string(b))
+		stackscripts, err := client.ListStackscripts(context.TODO(), opts)
+		if err != nil {
+			return err
+		}
+		var script *linodego.Stackscript = nil
+		for _, s := range stackscripts {
+			if s.Username == d.StackScriptUser {
+				script = &s
+				break
+			}
+		}
+		if script == nil {
+			return fmt.Errorf("StackScript not found: %s/%s", d.StackScriptUser, d.StackScriptLabel)
+		}
+
+		d.StackScriptUser = script.Username
+		d.StackScriptLabel = script.Label
+		d.StackScriptID = script.ID
+	} else if (d.StackScriptID != 0) {
+		script, err := client.GetStackscript(context.TODO(), d.StackScriptID)
+
+		if err != nil {
+			return fmt.Errorf("StackScript %d could not be used: %v", err)
+		}
+
+		d.StackScriptUser = script.Username
+		d.StackScriptLabel = script.Label
+	}
+
 	return nil
 }
 
@@ -233,7 +339,6 @@ func (d *Driver) Create() error {
 	client := d.getClient()
 
 	// Create a linode
-	log.Info("Creating linode instance")
 	createOpts := linodego.InstanceCreateOptions{
 		Region:         d.Region,
 		Type:           d.InstanceType,
@@ -244,6 +349,12 @@ func (d *Driver) Create() error {
 		SwapSize:       &d.SwapSize,
 	}
 
+	if d.StackScriptID != 0 {
+		createOpts.StackScriptID = d.StackScriptID
+		createOpts.StackScriptData = d.StackScriptData
+		log.Infof("Using StackScript %d: %s/%s", d.StackScriptID, d.StackScriptUser, d.StackScriptLabel)
+	}
+
 	linode, err := client.CreateInstance(context.TODO(), createOpts)
 	if err != nil {
 		return err