New Feature: docker#1342 Get an internal IP of cloud hosted machine (…

…implementation for GCE and VirtualBox, placeholders for the rest currently)

Signed-off-by: Andrew Grande <[email protected]>

commands/commands.go

@@ -302,6 +302,12 @@ var Commands = []cli.Command{
 		Usage:       "Get the IP address of a machine",
 		Description: "Argument(s) are one or more machine names.",
 		Action:      cmdIp,
+		Flags: []cli.Flag{
+			cli.BoolFlag{
+				Name:  "private, p",
+				Usage: "Return an instance's private IP address.",
+			},
+		},
 	},
 	{
 		Name:        "kill",
@@ -410,6 +416,7 @@ func machineCommand(actionName string, host *libmachine.Host, errorChan chan<- e
 		"kill":          host.Kill,
 		"upgrade":       host.Upgrade,
 		"ip":            host.PrintIP,
+		"privateIp":     host.PrintPrivateIP,
 	}
 
 	log.Debugf("command=%s machine=%s", actionName, host.Name)

commands/ip.go

@@ -6,7 +6,18 @@ import (
 )
 
 func cmdIp(c *cli.Context) {
-	if err := runActionWithContext("ip", c); err != nil {
+	if len(c.Args()) == 0 {
+		cli.ShowCommandHelp(c, "ip")
+		log.Fatal("You must specify a machine name")
+	}
+
+	ctx := "ip"
+
+	if c.Bool("private") {
+		ctx = "privateIp"
+	}
+
+	if err := runActionWithContext(ctx, c); err != nil {
 		log.Fatal(err)
 	}
 }

commands/scp_test.go

@@ -42,6 +42,10 @@ func (d ScpFakeDriver) GetIP() (string, error) {
 	return "12.34.56.78", nil
 }
 
+func (d ScpFakeDriver) GetPrivateIP() (string, error) {
+	return "", errors.New("not implemented")
+}
+
 func (d ScpFakeDriver) GetState() (state.State, error) {
 	return d.MockState, nil
 }

drivers/amazonec2/amazonec2.go

@@ -3,6 +3,7 @@ package amazonec2
 import (
 	"crypto/md5"
 	"crypto/rand"
+	"errors"
 	"fmt"
 	"io"
 	"io/ioutil"
@@ -442,6 +443,10 @@ func (d *Driver) GetIP() (string, error) {
 	return inst.IpAddress, nil
 }
 
+func (d *Driver) GetPrivateIP() (string, error) {
+	return "", errors.New("not implemented")
+}
+
 func (d *Driver) GetState() (state.State, error) {
 	inst, err := d.getInstance()
 	if err != nil {

drivers/azure/azure.go

@@ -263,6 +263,10 @@ func (d *Driver) GetIP() (string, error) {
 	return d.getHostname(), nil
 }
 
+func (d *Driver) GetPrivateIP() (string, error) {
+	return "", errors.New("not implemented")
+}
+
 func (d *Driver) GetState() (state.State, error) {
 	if err := d.setUserSubscription(); err != nil {
 		return state.Error, err

drivers/digitalocean/digitalocean.go

@@ -1,6 +1,7 @@
 package digitalocean
 
 import (
+	"errors"
 	"fmt"
 	"io/ioutil"
 	"path/filepath"
@@ -266,6 +267,10 @@ func (d *Driver) GetIP() (string, error) {
 	return d.IPAddress, nil
 }
 
+func (d *Driver) GetPrivateIP() (string, error) {
+	return "", errors.New("not implemented")
+}
+
 func (d *Driver) GetState() (state.State, error) {
 	droplet, _, err := d.getClient().Droplets.Get(d.DropletID)
 	if err != nil {

drivers/drivers.go

@@ -35,6 +35,9 @@ type Driver interface {
 	// e.g. 1.2.3.4 or docker-host-d60b70a14d3a.cloudapp.net
 	GetIP() (string, error)
 
+	// GetPrivateIP returns an internal host IP
+	GetPrivateIP() (string, error)
+
 	// GetMachineName returns the name of the machine
 	GetMachineName() string
 

drivers/exoscale/exoscale.go

@@ -2,6 +2,7 @@ package exoscale
 
 import (
 	"bytes"
+	"errors"
 	"fmt"
 	"io/ioutil"
 	"path/filepath"
@@ -173,6 +174,10 @@ func (d *Driver) GetIP() (string, error) {
 	return d.IPAddress, nil
 }
 
+func (d *Driver) GetPrivateIP() (string, error) {
+	return "", errors.New("not implemented")
+}
+
 func (d *Driver) GetState() (state.State, error) {
 	client := egoscale.NewClient(d.URL, d.ApiKey, d.ApiSecretKey)
 	vm, err := client.GetVirtualMachine(d.Id)

drivers/fakedriver/fakedriver.go

@@ -1,6 +1,7 @@
 package fakedriver
 
 import (
+	"errors"
 	"github.com/docker/machine/drivers"
 	"github.com/docker/machine/state"
 )
@@ -37,6 +38,10 @@ func (d *FakeDriver) GetIP() (string, error) {
 	return "1.2.3.4", nil
 }
 
+func (d *FakeDriver) GetPrivateIP() (string, error) {
+	return "", errors.New("not implemented")
+}
+
 func (d *FakeDriver) GetSSHHostname() (string, error) {
 	return "", nil
 }

drivers/generic/generic.go

@@ -1,6 +1,7 @@
 package generic
 
 import (
+	"errors"
 	"fmt"
 	"net"
 	"os"
@@ -164,6 +165,10 @@ func (d *Driver) GetIP() (string, error) {
 	return d.IPAddress, nil
 }
 
+func (d *Driver) GetPrivateIP() (string, error) {
+	return "", errors.New("not implemented")
+}
+
 func (d *Driver) GetState() (state.State, error) {
 	addr := fmt.Sprintf("%s:%d", d.IPAddress, d.SSHPort)
 	_, err := net.DialTimeout("tcp", addr, defaultTimeout)

drivers/google/compute_util.go

@@ -14,18 +14,19 @@ import (
 
 // ComputeUtil is used to wrap the raw GCE API code and store common parameters.
 type ComputeUtil struct {
-	zone          string
-	instanceName  string
-	userName      string
-	project       string
-	diskTypeURL   string
-	service       *raw.Service
-	zoneURL       string
-	authTokenPath string
-	globalURL     string
-	ipAddress     string
-	SwarmMaster   bool
-	SwarmHost     string
+	zone             string
+	instanceName     string
+	userName         string
+	project          string
+	diskTypeURL      string
+	service          *raw.Service
+	zoneURL          string
+	authTokenPath    string
+	globalURL        string
+	ipAddress        string
+	privateIpAddress string
+	SwarmMaster      bool
+	SwarmHost        string
 }
 
 const (
@@ -305,3 +306,15 @@ func (c *ComputeUtil) ip() (string, error) {
 	}
 	return c.ipAddress, nil
 }
+
+// returns an internal IP address of the instance.
+func (c *ComputeUtil) privateIp() (string, error) {
+	if c.privateIpAddress == "" {
+		instance, err := c.service.Instances.Get(c.project, c.zone, c.instanceName).Do()
+		if err != nil {
+			return "", err
+		}
+		c.privateIpAddress = instance.NetworkInterfaces[0].NetworkIP
+	}
+	return c.privateIpAddress, nil
+}

drivers/google/google.go

@@ -13,23 +13,24 @@ import (
 
 // Driver is a struct compatible with the docker.hosts.drivers.Driver interface.
 type Driver struct {
-	IPAddress      string
-	MachineName    string
-	SSHUser        string
-	SSHPort        int
-	Zone           string
-	MachineType    string
-	DiskType       string
-	Scopes         string
-	DiskSize       int
-	AuthTokenPath  string
-	storePath      string
-	Project        string
-	CaCertPath     string
-	PrivateKeyPath string
-	SwarmMaster    bool
-	SwarmHost      string
-	SwarmDiscovery string
+	IPAddress        string
+	PrivateIPAddress string
+	MachineName      string
+	SSHUser          string
+	SSHPort          int
+	Zone             string
+	MachineType      string
+	DiskType         string
+	Scopes           string
+	DiskSize         int
+	AuthTokenPath    string
+	storePath        string
+	Project          string
+	CaCertPath       string
+	PrivateKeyPath   string
+	SwarmMaster      bool
+	SwarmHost        string
+	SwarmDiscovery   string
 }
 
 func init() {
@@ -211,6 +212,15 @@ func (d *Driver) GetIP() (string, error) {
 	return c.ip()
 }
 
+// returns the internal IP address of the GCE instance.
+func (d *Driver) GetPrivateIP() (string, error) {
+	c, err := newComputeUtil(d)
+	if err != nil {
+		return "", err
+	}
+	return c.privateIp()
+}
+
 // GetState returns a docker.hosts.state.State value representing the current state of the host.
 func (d *Driver) GetState() (state.State, error) {
 	c, err := newComputeUtil(d)
@@ -250,6 +260,7 @@ func (d *Driver) Start() error {
 		return err
 	}
 	d.IPAddress, err = d.GetIP()
+	d.PrivateIPAddress, err = d.GetPrivateIP()
 	return err
 }
 

drivers/hyperv/hyperv_windows.go

@@ -3,6 +3,7 @@ package hyperv
 import (
 	"archive/tar"
 	"bytes"
+	"errors"
 	"fmt"
 	"io/ioutil"
 	"os"
@@ -436,6 +437,10 @@ func (d *Driver) GetIP() (string, error) {
 	return resp[0], nil
 }
 
+func (d *Driver) GetPrivateIP() (string, error) {
+	return "", errors.New("not implemented")
+}
+
 func (d *Driver) publicSSHKeyPath() string {
 	return d.GetSSHKeyPath() + ".pub"
 }

drivers/none/none.go

@@ -1,6 +1,7 @@
 package none
 
 import (
+	"errors"
 	"fmt"
 	neturl "net/url"
 
@@ -58,6 +59,10 @@ func (d *Driver) GetIP() (string, error) {
 	return d.IPAddress, nil
 }
 
+func (d *Driver) GetPrivateIP() (string, error) {
+	return "", errors.New("not implemented")
+}
+
 func (d *Driver) GetMachineName() string {
 	return ""
 }

drivers/openstack/openstack.go

@@ -1,6 +1,7 @@
 package openstack
 
 import (
+	"errors"
 	"fmt"
 	"io/ioutil"
 	"path/filepath"
@@ -312,6 +313,10 @@ func (d *Driver) GetIP() (string, error) {
 	return "", fmt.Errorf("No IP found for the machine")
 }
 
+func (d *Driver) GetPrivateIP() (string, error) {
+	return "", errors.New("not implemented")
+}
+
 func (d *Driver) GetState() (state.State, error) {
 	log.WithField("MachineId", d.MachineId).Debug("Get status for OpenStack instance...")
 	if err := d.initCompute(); err != nil {

drivers/softlayer/driver.go

@@ -1,6 +1,7 @@
 package softlayer
 
 import (
+	"errors"
 	"fmt"
 	"io/ioutil"
 	"os"
@@ -305,6 +306,11 @@ func (d *Driver) GetIP() (string, error) {
 	}
 }
 
+func (d *Driver) GetPrivateIP() (string, error) {
+	// TODO there's some private ip code in GetIP(), review for applicability
+	return "", errors.New("not implemented")
+}
+
 func (d *Driver) GetState() (state.State, error) {
 	s, err := d.getClient().VirtualGuest().PowerState(d.Id)
 	if err != nil {

drivers/virtualbox/virtualbox.go

@@ -496,6 +496,15 @@ func (d *Driver) setMachineNameIfNotSet() {
 }
 
 func (d *Driver) GetIP() (string, error) {
+	return d._getIp(false)
+}
+
+func (d *Driver) GetPrivateIP() (string, error) {
+	return d._getIp(true)
+}
+
+// helper function to get an external/internal IP based on the flag (true for private)
+func (d *Driver) _getIp(private bool) (string, error) {
 	// DHCP is used to get the IP, so virtualbox hosts don't have IPs unless
 	// they are running
 	s, err := d.GetState()
@@ -506,7 +515,14 @@ func (d *Driver) GetIP() (string, error) {
 		return "", drivers.ErrHostIsNotRunning
 	}
 
-	output, err := drivers.RunSSHCommandFromDriver(d, "ip addr show dev eth1")
+	// eth1 for public
+	network := "eth1"
+	if private {
+		network = "eth0"
+	}
+
+	sshCmd := fmt.Sprintf("ip addr show dev %s", network)
+	output, err := drivers.RunSSHCommandFromDriver(d, sshCmd)
 	if err != nil {
 		return "", err
 	}