vmwareappcatalyst

README

Usage

To build and install, make sure you have a Go 1.5 environment and Docker Machine greater than or equal to 0.5.0. Then, just run:

$ make && make install

Note that the AppCatalyst driver uses Photon OS as underlying OS, this requires a specific libmachine provisioner that is currently being reviewed as PR docker/machine#2344, make sure you have that support compiled in before testing the plugin.

Documentation

Index

• func NewDriver(hostName, storePath string) drivers.Driver
• type Client
  • func NewClient(e string) (*Client, error)
  • func (c *Client) AddVMSharedFolder(ID string, gp string, hp string, flags int) (*SharedFolder, error)
  • func (c *Client) CloneVM(ID, name, tag string) (*CloneVM, error)
  • func (c *Client) DeleteVM(ID string) error
  • func (c *Client) GetPowerVM(ID string) (*Response, error)
  • func (c *Client) GetVM(ID string) (*VM, error)
  • func (c *Client) GetVMIPAddress(ID string) (*Response, error)
  • func (c *Client) GetVMSharedFolder(ID, folderID string) (*SharedFolder, error)
  • func (c *Client) GetVMSharedFolders(ID string) ([]string, error)
  • func (c *Client) ListVMs() ([]string, error)
  • func (c *Client) NewRequest(params map[string]string, method string, u url.URL, body io.Reader) *http.Request
  • func (c *Client) PowerVM(ID, operation string) (*Response, error)
  • func (c *Client) SetVMSharedFolders(ID, operation string) (*Response, error)
• type CloneVM
• type Driver
  • func (d *Driver) Create() error
  • func (d *Driver) DriverName() string
  • func (d *Driver) GetCreateFlags() []mcnflag.Flag
  • func (d *Driver) GetIP() (string, error)
  • func (d *Driver) GetMachineName() string
  • func (d *Driver) GetSSHHostname() (string, error)
  • func (d *Driver) GetSSHPort() (int, error)
  • func (d *Driver) GetSSHUsername() string
  • func (d *Driver) GetState() (state.State, error)
  • func (d *Driver) GetURL() (string, error)
  • func (d *Driver) Kill() error
  • func (d *Driver) PreCreateCheck() error
  • func (d *Driver) Remove() error
  • func (d *Driver) Restart() error
  • func (d *Driver) SetConfigFromFlags(flags drivers.DriverOptions) error
  • func (d *Driver) Start() error
  • func (d *Driver) Stop() error
• type Response
• type SharedFolder
• type VM
• type VMDelete
• type VMInfo

Functions

func NewDriver

func NewDriver(hostName, storePath string) drivers.Driver

Types

type Client

type Client struct {
	Endpoint url.URL     // Endpoint is the REST api endpoint AppCatalyst is listening on
	HTTP     http.Client // HttpClient is the client to use. Default will be used if not provided.
}

Client is the struct that holds information on the AppCatalyst endpoint

func NewClient

func NewClient(e string) (*Client, error)

NewClient returns a new client to be used with every AppCatalyst interaction

func (*Client) AddVMSharedFolder

func (c *Client) AddVMSharedFolder(ID string, gp string, hp string, flags int) (*SharedFolder, error)

CloneVM creates a clone starting from an existing VM

func (*Client) CloneVM

func (c *Client) CloneVM(ID, name, tag string) (*CloneVM, error)

CloneVM creates a clone starting from an existing VM

func (*Client) DeleteVM

func (c *Client) DeleteVM(ID string) error

func (*Client) GetPowerVM

func (c *Client) GetPowerVM(ID string) (*Response, error)

func (*Client) GetVM

func (c *Client) GetVM(ID string) (*VM, error)

GetVM gets information for a specific VM

func (*Client) GetVMIPAddress

func (c *Client) GetVMIPAddress(ID string) (*Response, error)

func (*Client) GetVMSharedFolder

func (c *Client) GetVMSharedFolder(ID, folderID string) (*SharedFolder, error)

GetVM gets information for a specific VM

func (*Client) GetVMSharedFolders

func (c *Client) GetVMSharedFolders(ID string) ([]string, error)

GetVMSharedFolders gets shared folders information for a specific VM

func (*Client) ListVMs

func (c *Client) ListVMs() ([]string, error)

ListVMs lists all the VMs available on AppCatalyst.

func (*Client) NewRequest

func (c *Client) NewRequest(params map[string]string, method string, u url.URL, body io.Reader) *http.Request

NewRequest creates a new HTTP request and applies necessary auth headers if set.

func (*Client) PowerVM

func (c *Client) PowerVM(ID, operation string) (*Response, error)

func (*Client) SetVMSharedFolders

func (c *Client) SetVMSharedFolders(ID, operation string) (*Response, error)

type CloneVM

type CloneVM struct {
	ID   string `json:"id"`
	Name string `json:"name"`
	Tag  string `json:"tag"`
}

type Driver

type Driver struct {
	*drivers.BaseDriver
	Memory     int
	DiskSize   int
	CPU        int
	CPUS       int
	VMLocation string
	APIPort    int
}

Driver for VMware AppCatalyst

func (*Driver) Create

func (d *Driver) Create() error

func (*Driver) DriverName

func (d *Driver) DriverName() string

DriverName returns the name of the driver

func (*Driver) GetCreateFlags

func (d *Driver) GetCreateFlags() []mcnflag.Flag

GetCreateFlags registers the flags this driver adds to "docker hosts create"

func (*Driver) GetIP

func (d *Driver) GetIP() (string, error)

func (*Driver) GetMachineName

func (d *Driver) GetMachineName() string

func (*Driver) GetSSHHostname

func (d *Driver) GetSSHHostname() (string, error)

func (*Driver) GetSSHPort

func (d *Driver) GetSSHPort() (int, error)

func (*Driver) GetSSHUsername

func (d *Driver) GetSSHUsername() string

func (*Driver) GetState

func (d *Driver) GetState() (state.State, error)

func (*Driver) GetURL

func (d *Driver) GetURL() (string, error)

func (*Driver) Kill

func (d *Driver) Kill() error

func (*Driver) PreCreateCheck

func (d *Driver) PreCreateCheck() error

func (*Driver) Remove

func (d *Driver) Remove() error

func (*Driver) Restart

func (d *Driver) Restart() error

func (*Driver) SetConfigFromFlags

func (d *Driver) SetConfigFromFlags(flags drivers.DriverOptions) error

func (*Driver) Start

func (d *Driver) Start() error

func (*Driver) Stop

func (d *Driver) Stop() error

type Response

type Response struct {
	Code    int    `json:"code"`    // HTTP Return code
	Message string `json:"message"` // Response message
}

type SharedFolder

type SharedFolder struct {
	GuestPath string `json:"guestPath"`
	HostPath  string `json:"hostPath"`
	Flags     int    `json:"flags"`
}

type VM

type VM struct {
	ID   string `json:"id"`
	Name string `json:"name"`
	Tag  string `json:"tag"`
}

type VMDelete

type VMDelete struct {
	ID string `json:"id"`
}

type VMInfo

type VMInfo struct {
	ID   string `json:"id"`
	Name string `json:"name"`
	Tag  string `json:"tag"`
}