Cisco UCS InfraKit plugin (#743)

- Vendoring for UCS pkg requirements
- Simple plugin code (only login implemented, whilst waiting for a
environment)

Signed-off-by: Dan Finneran <[email protected]>

Author: thebsdbox

cmd/infrakit/main.go

@@ -63,6 +63,7 @@ import (
 	_ "github.com/docker/infrakit/pkg/run/v0/tailer"
 	_ "github.com/docker/infrakit/pkg/run/v0/terraform"
 	_ "github.com/docker/infrakit/pkg/run/v0/time"
+	_ "github.com/docker/infrakit/pkg/run/v0/ucs"
 	_ "github.com/docker/infrakit/pkg/run/v0/vagrant"
 	_ "github.com/docker/infrakit/pkg/run/v0/vanilla"
 	_ "github.com/docker/infrakit/pkg/run/v0/vars"

pkg/provider/ucs/plugin.go

@@ -0,0 +1,145 @@
+package ucs
+
+import (
+	"fmt"
+	"math/rand"
+	"os"
+	"time"
+
+	logutil "github.com/docker/infrakit/pkg/log"
+	"github.com/docker/infrakit/pkg/spi"
+	"github.com/docker/infrakit/pkg/spi/instance"
+	"github.com/docker/infrakit/pkg/types"
+	"github.com/micdoher/terraform-provider-ucs/ucsclient"
+)
+
+var log = logutil.New("module", "cli/x")
+
+// Options capture the config parameters required to create the plugin
+type Options struct {
+	UCSUrl    string
+	UCSUser   string
+	UCSPass   string
+	UCSCookie string
+}
+
+//miniFSM for managing the provisioning -> provisioned state
+type provisioningFSM struct {
+	countdown    int64             // ideally will be a counter of minutes / seconds
+	tags         map[string]string // tags that will be passed back per a describe function
+	instanceName string            // name that we will use as a lookup to the actual backend that is privisioning
+}
+
+// Spec is just whatever that can be unmarshalled into a generic JSON map
+type Spec map[string]interface{}
+
+// This contains the the details for the oneview instance
+type plugin struct {
+	fsm    []provisioningFSM
+	client *ucsclient.UCSClient
+}
+
+func init() {
+	rand.Seed(time.Now().UTC().UnixNano())
+}
+
+// NewUCSInstancePlugin will take the cmdline/env configuration
+func NewUCSInstancePlugin(ucsOptions Options) instance.Plugin {
+
+	ucsConfig := ucsclient.Config{
+		AppName:               "UCS",
+		IpAddress:             ucsOptions.UCSUrl,
+		Username:              ucsOptions.UCSUser,
+		Password:              ucsOptions.UCSPass,
+		TslInsecureSkipVerify: true, // TODO - Make configurable
+		LogFilename:           "./ucs.log",
+		LogLevel:              0,
+	}
+
+	client := ucsConfig.Client()
+	err := client.Login()
+	// Exit with an error if we can't connect to Cisco UCS Domain
+	if err != nil {
+		log.Crit("Error Logging into Cisco UCS Domain")
+		os.Exit(-1)
+	}
+
+	log.Info("Succesfully logged in to UCS Domain")
+
+	return &plugin{
+		client: client,
+	}
+}
+
+// Info returns a vendor specific name and version
+func (p *plugin) VendorInfo() *spi.VendorInfo {
+	return &spi.VendorInfo{
+		InterfaceSpec: spi.InterfaceSpec{
+			Name:    "infrakit-instance-ucs",
+			Version: "0.6.0",
+		},
+		URL: "https://github.com/docker/infrakit",
+	}
+}
+
+// ExampleProperties returns the properties / config of this plugin
+func (p *plugin) ExampleProperties() *types.Any {
+	any, err := types.AnyValue(Spec{
+		"exampleString": "a_string",
+		"exampleBool":   true,
+		"exampleInt":    1,
+	})
+	if err != nil {
+		return nil
+	}
+	return any
+}
+
+// Validate performs local validation on a provision request.
+func (p *plugin) Validate(req *types.Any) error {
+	log.Debug("validate", req.String())
+
+	spec := Spec{}
+	if err := req.Decode(&spec); err != nil {
+		return err
+	}
+
+	log.Debug("Validated:", spec)
+	return nil
+}
+
+// Provision creates a new instance based on the spec.
+func (p *plugin) Provision(spec instance.Spec) (*instance.ID, error) {
+
+	var properties map[string]interface{}
+
+	if spec.Properties != nil {
+		if err := spec.Properties.Decode(&properties); err != nil {
+			return nil, fmt.Errorf("Invalid instance properties: %s", err)
+		}
+	}
+
+	instanceName := instance.ID(fmt.Sprintf("InfraKit-%d", rand.Int63()))
+
+	return &instanceName, nil
+}
+
+// Label labels the instance
+func (p *plugin) Label(instance instance.ID, labels map[string]string) error {
+	return fmt.Errorf("Cisco UCS label updates are not implemented yet")
+}
+
+// Destroy terminates an existing instance.
+func (p *plugin) Destroy(instance instance.ID, context instance.Context) error {
+	log.Info("Currently running %s on instance: %v", context, instance)
+	return nil
+}
+
+// DescribeInstances returns descriptions of all instances matching all of the provided tags.
+// TODO - need to define the fitlering of tags => AND or OR of matches?
+func (p *plugin) DescribeInstances(tags map[string]string, properties bool) ([]instance.Description, error) {
+	log.Debug("describe-instances", tags)
+	results := []instance.Description{}
+
+	return results, nil
+}

pkg/run/v0/ucs/ucs.go

@@ -0,0 +1,105 @@
+package ucs
+
+import (
+	"strings"
+
+	"github.com/docker/infrakit/pkg/launch/inproc"
+	logutil "github.com/docker/infrakit/pkg/log"
+	"github.com/docker/infrakit/pkg/plugin"
+	"github.com/docker/infrakit/pkg/provider/ucs"
+	"github.com/docker/infrakit/pkg/run"
+	"github.com/docker/infrakit/pkg/run/local"
+	"github.com/docker/infrakit/pkg/run/scope"
+	"github.com/docker/infrakit/pkg/spi/instance"
+	"github.com/docker/infrakit/pkg/types"
+)
+
+var log = logutil.New("module", "cli/x")
+
+const (
+	// Kind is the canonical name of the plugin for starting up, etc.
+	Kind = "ucs"
+
+	// EnvNamespaceTags is the env to set for namespace tags. It's k=v,...
+	EnvNamespaceTags = "INFRAKIT_UCS_NAMESPACE_TAGS"
+
+	// EnvUCSURL is the env for setting the Cisco UCS URL to connect to
+	EnvUCSURL = "INFRAKIT_UCS_URL"
+
+	// EnvUCSUser is the Cisco UCS Username
+	EnvUCSUser = "INFRAKIT_UCS_USER"
+
+	// EnvUCSPass is the Cisco UCS Password
+	EnvUCSPass = "INFRAKIT_UCS_PASS"
+
+	// EnvUCSCookie is the Cisco UCS Auth Cookie
+	EnvUCSCookie = "INFRAKIT_UCS_UCSCOOKIE"
+)
+
+func init() {
+	inproc.Register(Kind, Run, DefaultOptions)
+}
+
+// Options capture the options for starting up the plugin.
+type Options struct {
+	// Namespace is a set of kv pairs for tags that namespaces the resource instances
+	// TODO - this is currently implemented in AWS and other cloud providers but not
+	// in UCS
+	Namespace map[string]string
+
+	// UCSs is a collection of UCS Domains - each corresponds to config of a plugin instance
+	UCSs []ucs.Options
+}
+
+func defaultNamespace() map[string]string {
+	t := map[string]string{}
+	list := local.Getenv(EnvNamespaceTags, "")
+	for _, v := range strings.Split(list, ",") {
+		p := strings.Split(v, "=")
+		if len(p) == 2 {
+			t[p[0]] = p[1]
+		}
+	}
+	return t
+}
+
+func defaultUCSOptions() ucs.Options {
+	return ucs.Options{
+		UCSUrl:    local.Getenv(EnvUCSURL, "https://username:password@VCaddress/sdk"),
+		UCSUser:   local.Getenv(EnvUCSUser, ""),
+		UCSPass:   local.Getenv(EnvUCSPass, ""),
+		UCSCookie: local.Getenv(EnvUCSCookie, ""),
+	}
+}
+
+// DefaultOptions return an Options with default values filled in.
+var DefaultOptions = Options{
+	Namespace: defaultNamespace(),
+	UCSs: []ucs.Options{
+		defaultUCSOptions(),
+	},
+}
+
+// Run runs the plugin, blocking the current thread.  Error is returned immediately
+// if the plugin cannot be started.
+func Run(scope scope.Scope, name plugin.Name,
+	config *types.Any) (transport plugin.Transport, impls map[run.PluginCode]interface{}, onStop func(), err error) {
+
+	options := DefaultOptions
+	err = config.Decode(&options)
+	if err != nil {
+		return
+	}
+
+	bareMetal := map[string]instance.Plugin{}
+
+	for _, ucsDomain := range options.UCSs {
+		bareMetal[ucsDomain.UCSUrl] = ucs.NewUCSInstancePlugin(ucsDomain)
+	}
+
+	transport.Name = name
+	impls = map[run.PluginCode]interface{}{
+		run.Instance: bareMetal,
+	}
+	return
+}

vendor.conf

@@ -172,3 +172,8 @@ github.com/thebsdbox/go-tftp/server                     b3e1ec2
 github.com/whyrusleeping/go-tftp/packet                 454ade9
 github.com/HewlettPackard/oneview-golang		d0f1e96
 github.com/docker/machine/libmachine/log		f10584e
+github.com/micdoher/terraform-provider-ucs/ucsclient	50940f9
+github.com/micdoher/terraform-provider-ucs/ucsclient/ucsinternal	e82c113
+github.com/micdoher/GoUtils	 799bb49
+gopkg.in/xmlpath.v2					860cbec
+