common

package
v1.0.0-rc2 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Mar 30, 2017 License: MPL-2.0 Imports: 29 Imported by: 0

Documentation

Overview

These functions are compatible with WS 9 and 10 on *NIX

These functions are compatible with WS 9 and 10 on *NIX

Index

Constants

View Source 
const BuilderId = "mitchellh.vmware"

BuilderId for the local artifacts

View Source 
const KeyLeftShift uint32 = 0xFFE1
View Source 
const VMWARE_FUSION_VERSION = "6"
View Source 
const VMWARE_PLAYER_VERSION = "6"
View Source 
const VMWARE_WS_VERSION = "10"

Variables

View Source 
var KeepFileExtensions = []string{".nvram", ".vmdk", ".vmsd", ".vmx", ".vmxf"}

These are the extensions of files that are important for the function of a VMware virtual machine. Any other file is discarded as part of the build.

Functions

func CommHost added in v0.8.0 

func CommHost(config *SSHConfig) func(multistep.StateBag) (string, error)

func EncodeVMX 

func EncodeVMX(contents map[string]string) string

EncodeVMX takes a map and turns it into valid VMX contents.

func NewLocalArtifact 

func NewLocalArtifact(dir string) (packer.Artifact, error)

NewLocalArtifact returns a VMware artifact containing the files in the given directory.

func ParseVMX 

func ParseVMX(contents string) map[string]string

ParseVMX parses the keys and values from a VMX file and returns them as a Go map.

func ReadVMX 

func ReadVMX(path string) (map[string]string, error)

ReadVMX takes a path to a VMX file and reads it into a k/v mapping.

func SSHConfigFunc 

func SSHConfigFunc(config *SSHConfig) func(multistep.StateBag) (*gossh.ClientConfig, error)

func VNCPassword added in v0.11.0 

func VNCPassword(skipPassword bool) string

func WriteVMX 

func WriteVMX(path string, data map[string]string) (err error)

WriteVMX takes a path to a VMX file and contents in the form of a map and writes it out.

Types

type DHCPLeaseGuestLookup 

type DHCPLeaseGuestLookup struct {
	// Driver that is being used (to find leases path)
	Driver Driver

	// Device that the guest is connected to.
	Device string

	// MAC address of the guest.
	MACAddress string
}

DHCPLeaseGuestLookup looks up the IP address of a guest using DHCP lease information from the VMware network devices.

func (*DHCPLeaseGuestLookup) GuestIP 

func (f *DHCPLeaseGuestLookup) GuestIP() (string, error)

type Driver 

type Driver interface {
	// Clone clones the VMX and the disk to the destination path. The
	// destination is a path to the VMX file. The disk will be copied
	// to that same directory.
	Clone(dst string, src string) error

	// CompactDisk compacts a virtual disk.
	CompactDisk(string) error

	// CreateDisk creates a virtual disk with the given size.
	CreateDisk(string, string, string) error

	// Checks if the VMX file at the given path is running.
	IsRunning(string) (bool, error)

	// CommHost returns the host address for the VM that is being
	// managed by this driver.
	CommHost(multistep.StateBag) (string, error)

	// Start starts a VM specified by the path to the VMX given.
	Start(string, bool) error

	// Stop stops a VM specified by the path to the VMX given.
	Stop(string) error

	// SuppressMessages modifies the VMX or surrounding directory so that
	// VMware doesn't show any annoying messages.
	SuppressMessages(string) error

	// Get the path to the VMware ISO for the given flavor.
	ToolsIsoPath(string) string

	// Attach the VMware tools ISO
	ToolsInstall() error

	// Get the path to the DHCP leases file for the given device.
	DhcpLeasesPath(string) string

	// Verify checks to make sure that this driver should function
	// properly. This should check that all the files it will use
	// appear to exist and so on. If everything is okay, this doesn't
	// return an error. Otherwise, this returns an error.
	Verify() error
}

A driver is able to talk to VMware, control virtual machines, etc.

func NewDriver 

func NewDriver(dconfig *DriverConfig, config *SSHConfig) (Driver, error)

NewDriver returns a new driver implementation for this operating system, or an error if the driver couldn't be initialized.

type DriverConfig 

type DriverConfig struct {
	FusionAppPath string `mapstructure:"fusion_app_path"`
}

func (*DriverConfig) Prepare 

func (c *DriverConfig) Prepare(ctx *interpolate.Context) []error

type DriverMock 

type DriverMock struct {
	sync.Mutex

	CloneCalled bool
	CloneDst    string
	CloneSrc    string
	CloneErr    error

	CompactDiskCalled bool
	CompactDiskPath   string
	CompactDiskErr    error

	CreateDiskCalled bool
	CreateDiskOutput string
	CreateDiskSize   string
	CreateDiskTypeId string
	CreateDiskErr    error

	IsRunningCalled bool
	IsRunningPath   string
	IsRunningResult bool
	IsRunningErr    error

	CommHostCalled bool
	CommHostState  multistep.StateBag
	CommHostResult string
	CommHostErr    error

	StartCalled   bool
	StartPath     string
	StartHeadless bool
	StartErr      error

	StopCalled bool
	StopPath   string
	StopErr    error

	SuppressMessagesCalled bool
	SuppressMessagesPath   string
	SuppressMessagesErr    error

	ToolsIsoPathCalled bool
	ToolsIsoPathFlavor string
	ToolsIsoPathResult string

	ToolsInstallCalled bool
	ToolsInstallErr    error

	DhcpLeasesPathCalled bool
	DhcpLeasesPathDevice string
	DhcpLeasesPathResult string

	VerifyCalled bool
	VerifyErr    error
}

func (*DriverMock) Clone 

func (d *DriverMock) Clone(dst string, src string) error

func (*DriverMock) CommHost added in v0.8.0 

func (d *DriverMock) CommHost(state multistep.StateBag) (string, error)

func (*DriverMock) CompactDisk 

func (d *DriverMock) CompactDisk(path string) error

func (*DriverMock) CreateDisk 

func (d *DriverMock) CreateDisk(output string, size string, typeId string) error

func (*DriverMock) DhcpLeasesPath 

func (d *DriverMock) DhcpLeasesPath(device string) string

func (*DriverMock) IsRunning 

func (d *DriverMock) IsRunning(path string) (bool, error)

func (*DriverMock) Start 

func (d *DriverMock) Start(path string, headless bool) error

func (*DriverMock) Stop 

func (d *DriverMock) Stop(path string) error

func (*DriverMock) SuppressMessages 

func (d *DriverMock) SuppressMessages(path string) error

func (*DriverMock) ToolsInstall added in v0.6.0 

func (d *DriverMock) ToolsInstall() error

func (*DriverMock) ToolsIsoPath 

func (d *DriverMock) ToolsIsoPath(flavor string) string

func (*DriverMock) Verify 

func (d *DriverMock) Verify() error

type Fusion5Driver 

type Fusion5Driver struct {
	// This is the path to the "VMware Fusion.app"
	AppPath string

	// SSHConfig are the SSH settings for the Fusion VM
	SSHConfig *SSHConfig
}

Fusion5Driver is a driver that can run VMware Fusion 5.

func (*Fusion5Driver) Clone 

func (d *Fusion5Driver) Clone(dst, src string) error

func (*Fusion5Driver) CommHost added in v0.8.0 

func (d *Fusion5Driver) CommHost(state multistep.StateBag) (string, error)

func (*Fusion5Driver) CompactDisk 

func (d *Fusion5Driver) CompactDisk(diskPath string) error

func (*Fusion5Driver) CreateDisk 

func (d *Fusion5Driver) CreateDisk(output string, size string, type_id string) error

func (*Fusion5Driver) DhcpLeasesPath 

func (d *Fusion5Driver) DhcpLeasesPath(device string) string

func (*Fusion5Driver) IsRunning 

func (d *Fusion5Driver) IsRunning(vmxPath string) (bool, error)

func (*Fusion5Driver) Start 

func (d *Fusion5Driver) Start(vmxPath string, headless bool) error

func (*Fusion5Driver) Stop 

func (d *Fusion5Driver) Stop(vmxPath string) error

func (*Fusion5Driver) SuppressMessages 

func (d *Fusion5Driver) SuppressMessages(vmxPath string) error

func (*Fusion5Driver) ToolsInstall added in v0.6.0 

func (d *Fusion5Driver) ToolsInstall() error

func (*Fusion5Driver) ToolsIsoPath 

func (d *Fusion5Driver) ToolsIsoPath(k string) string

func (*Fusion5Driver) Verify 

func (d *Fusion5Driver) Verify() error

type Fusion6Driver 

type Fusion6Driver struct {
	Fusion5Driver
}

Fusion6Driver is a driver that can run VMware Fusion 6.

func (*Fusion6Driver) Clone 

func (d *Fusion6Driver) Clone(dst, src string) error

func (*Fusion6Driver) Verify 

func (d *Fusion6Driver) Verify() error

type GuestIPFinder 

type GuestIPFinder interface {
	GuestIP() (string, error)
}

Interface to help find the IP address of a running virtual machine.

type HostIPFinder added in v0.7.0 

type HostIPFinder interface {
	HostIP() (string, error)
}

Interface to help find the host IP that is available from within the VMware virtual machines.

type IfconfigIPFinder added in v0.7.0 

type IfconfigIPFinder struct {
	Device string
}

IfconfigIPFinder finds the host IP based on the output of `ip address` or `ifconfig`.

func (*IfconfigIPFinder) HostIP added in v0.7.0 

func (f *IfconfigIPFinder) HostIP() (string, error)

type LocalOutputDir 

type LocalOutputDir struct {
	// contains filtered or unexported fields
}

LocalOutputDir is an OutputDir implementation where the directory is on the local machine.

func (*LocalOutputDir) DirExists 

func (d *LocalOutputDir) DirExists() (bool, error)

func (*LocalOutputDir) ListFiles 

func (d *LocalOutputDir) ListFiles() ([]string, error)

func (*LocalOutputDir) MkdirAll 

func (d *LocalOutputDir) MkdirAll() error

func (*LocalOutputDir) Remove 

func (d *LocalOutputDir) Remove(path string) error

func (*LocalOutputDir) RemoveAll 

func (d *LocalOutputDir) RemoveAll() error

func (*LocalOutputDir) SetOutputDir 

func (d *LocalOutputDir) SetOutputDir(path string)

func (*LocalOutputDir) String 

func (d *LocalOutputDir) String() string

type OutputConfig 

type OutputConfig struct {
	OutputDir string `mapstructure:"output_directory"`
}

func (*OutputConfig) Prepare 

func (c *OutputConfig) Prepare(ctx *interpolate.Context, pc *common.PackerConfig) []error

type OutputDir 

type OutputDir interface {
	DirExists() (bool, error)
	ListFiles() ([]string, error)
	MkdirAll() error
	Remove(string) error
	RemoveAll() error
	SetOutputDir(string)
	String() string
}

OutputDir is an interface type that abstracts the creation and handling of the output directory for VMware-based products. The abstraction is made so that the output directory can be properly made on remote (ESXi) based VMware products as well as local.

type Player5Driver added in v0.7.0 

type Player5Driver struct {
	AppPath          string
	VdiskManagerPath string
	QemuImgPath      string
	VmrunPath        string

	// SSHConfig are the SSH settings for the Fusion VM
	SSHConfig *SSHConfig
}

Player5Driver is a driver that can run VMware Player 5 on Linux.

func (*Player5Driver) Clone added in v0.7.0 

func (d *Player5Driver) Clone(dst, src string) error

func (*Player5Driver) CommHost added in v0.8.0 

func (d *Player5Driver) CommHost(state multistep.StateBag) (string, error)

func (*Player5Driver) CompactDisk added in v0.7.0 

func (d *Player5Driver) CompactDisk(diskPath string) error

func (*Player5Driver) CreateDisk added in v0.7.0 

func (d *Player5Driver) CreateDisk(output string, size string, type_id string) error

func (*Player5Driver) DhcpLeasesPath added in v0.7.0 

func (d *Player5Driver) DhcpLeasesPath(device string) string

func (*Player5Driver) IsRunning added in v0.7.0 

func (d *Player5Driver) IsRunning(vmxPath string) (bool, error)

func (*Player5Driver) Start added in v0.7.0 

func (d *Player5Driver) Start(vmxPath string, headless bool) error

func (*Player5Driver) Stop added in v0.7.0 

func (d *Player5Driver) Stop(vmxPath string) error

func (*Player5Driver) SuppressMessages added in v0.7.0 

func (d *Player5Driver) SuppressMessages(vmxPath string) error

func (*Player5Driver) ToolsInstall added in v0.7.0 

func (d *Player5Driver) ToolsInstall() error

func (*Player5Driver) ToolsIsoPath added in v0.7.0 

func (d *Player5Driver) ToolsIsoPath(flavor string) string

func (*Player5Driver) Verify added in v0.7.0 

func (d *Player5Driver) Verify() error

func (*Player5Driver) VmnetnatConfPath added in v0.7.0 

func (d *Player5Driver) VmnetnatConfPath() string

type Player6Driver added in v0.7.0 

type Player6Driver struct {
	Player5Driver
}

func (*Player6Driver) Clone added in v0.7.0 

func (d *Player6Driver) Clone(dst, src string) error

func (*Player6Driver) Verify added in v0.7.0 

func (d *Player6Driver) Verify() error

type RunConfig 

type RunConfig struct {
	Headless    bool   `mapstructure:"headless"`
	RawBootWait string `mapstructure:"boot_wait"`

	VNCBindAddress     string `mapstructure:"vnc_bind_address"`
	VNCPortMin         uint   `mapstructure:"vnc_port_min"`
	VNCPortMax         uint   `mapstructure:"vnc_port_max"`
	VNCDisablePassword bool   `mapstructure:"vnc_disable_password"`

	BootWait time.Duration ``
}

func (*RunConfig) Prepare 

func (c *RunConfig) Prepare(ctx *interpolate.Context) []error

type SSHConfig 

type SSHConfig struct {
	Comm communicator.Config `mapstructure:",squash"`

	// These are deprecated, but we keep them around for BC
	// TODO(@mitchellh): remove
	SSHSkipRequestPty bool          `mapstructure:"ssh_skip_request_pty"`
	SSHWaitTimeout    time.Duration `mapstructure:"ssh_wait_timeout"`
}

func (*SSHConfig) Prepare 

func (c *SSHConfig) Prepare(ctx *interpolate.Context) []error

type ShutdownConfig 

type ShutdownConfig struct {
	ShutdownCommand    string `mapstructure:"shutdown_command"`
	RawShutdownTimeout string `mapstructure:"shutdown_timeout"`

	ShutdownTimeout time.Duration ``
}

func (*ShutdownConfig) Prepare 

func (c *ShutdownConfig) Prepare(ctx *interpolate.Context) []error

type StepCleanFiles 

type StepCleanFiles struct{}

This step removes unnecessary files from the final result.

Uses: 

dir    OutputDir
ui     packer.Ui

Produces: 

<nothing>

func (StepCleanFiles) Cleanup 

func (StepCleanFiles) Cleanup(multistep.StateBag)

func (StepCleanFiles) Run 

func (StepCleanFiles) Run(state multistep.StateBag) multistep.StepAction

type StepCleanVMX 

type StepCleanVMX struct{}

This step cleans up the VMX by removing or changing this prior to being ready for use.

Uses: 

ui     packer.Ui
vmx_path string

Produces: 

<nothing>

func (StepCleanVMX) Cleanup 

func (StepCleanVMX) Cleanup(multistep.StateBag)

func (StepCleanVMX) Run 

func (s StepCleanVMX) Run(state multistep.StateBag) multistep.StepAction

type StepCompactDisk 

type StepCompactDisk struct {
	Skip bool
}

This step compacts the virtual disk for the VM unless the "skip_compaction" boolean is true.

Uses: 

driver Driver
full_disk_path string
ui     packer.Ui

Produces: 

<nothing>

func (StepCompactDisk) Cleanup 

func (StepCompactDisk) Cleanup(multistep.StateBag)

func (StepCompactDisk) Run 

func (s StepCompactDisk) Run(state multistep.StateBag) multistep.StepAction

type StepConfigureVMX 

type StepConfigureVMX struct {
	CustomData map[string]string
	SkipFloppy bool
}

This step configures a VMX by setting some default settings as well as taking in custom data to set, attaching a floppy if it exists, etc.

Uses: 

vmx_path string

func (*StepConfigureVMX) Cleanup 

func (s *StepConfigureVMX) Cleanup(state multistep.StateBag)

func (*StepConfigureVMX) Run 

func (s *StepConfigureVMX) Run(state multistep.StateBag) multistep.StepAction

type StepConfigureVNC added in v0.7.0 

type StepConfigureVNC struct {
	VNCBindAddress     string
	VNCPortMin         uint
	VNCPortMax         uint
	VNCDisablePassword bool
}

This step configures the VM to enable the VNC server.

Uses: 

ui     packer.Ui
vmx_path string

Produces: 

vnc_port uint - The port that VNC is configured to listen on.

func (StepConfigureVNC) Cleanup added in v0.7.0 

func (StepConfigureVNC) Cleanup(multistep.StateBag)

func (*StepConfigureVNC) Run added in v0.7.0 

func (s *StepConfigureVNC) Run(state multistep.StateBag) multistep.StepAction

func (StepConfigureVNC) UpdateVMX added in v0.11.0 

func (StepConfigureVNC) UpdateVMX(address, password string, port uint, data map[string]string)

func (StepConfigureVNC) VNCAddress added in v0.7.0 

func (StepConfigureVNC) VNCAddress(vncBindAddress string, portMin, portMax uint) (string, uint, error)

type StepOutputDir 

type StepOutputDir struct {
	Force bool
	// contains filtered or unexported fields
}

StepOutputDir sets up the output directory by creating it if it does not exist, deleting it if it does exist and we're forcing, and cleaning it up when we're done with it.

func (*StepOutputDir) Cleanup 

func (s *StepOutputDir) Cleanup(state multistep.StateBag)

func (*StepOutputDir) Run 

func (s *StepOutputDir) Run(state multistep.StateBag) multistep.StepAction

type StepPrepareTools added in v0.6.1 

type StepPrepareTools struct {
	RemoteType        string
	ToolsUploadFlavor string
}

func (*StepPrepareTools) Cleanup added in v0.6.1 

func (c *StepPrepareTools) Cleanup(multistep.StateBag)

func (*StepPrepareTools) Run added in v0.6.1 

func (c *StepPrepareTools) Run(state multistep.StateBag) multistep.StepAction

type StepRun 

type StepRun struct {
	BootWait           time.Duration
	DurationBeforeStop time.Duration
	Headless           bool
	// contains filtered or unexported fields
}

This step runs the created virtual machine.

Uses: 

driver Driver
ui     packer.Ui
vmx_path string

Produces: 

<nothing>

func (*StepRun) Cleanup 

func (s *StepRun) Cleanup(state multistep.StateBag)

func (*StepRun) Run 

func (s *StepRun) Run(state multistep.StateBag) multistep.StepAction

type StepShutdown 

type StepShutdown struct {
	Command string
	Timeout time.Duration

	// Set this to true if we're testing
	Testing bool
}

This step shuts down the machine. It first attempts to do so gracefully, but ultimately forcefully shuts it down if that fails.

Uses: 

communicator packer.Communicator
dir OutputDir
driver Driver
ui     packer.Ui
vmx_path string

Produces: 

<nothing>

func (*StepShutdown) Cleanup 

func (s *StepShutdown) Cleanup(state multistep.StateBag)

func (*StepShutdown) Run 

func (s *StepShutdown) Run(state multistep.StateBag) multistep.StepAction

type StepSuppressMessages 

type StepSuppressMessages struct{}

This step suppresses any messages that VMware product might show.

func (*StepSuppressMessages) Cleanup 

func (s *StepSuppressMessages) Cleanup(state multistep.StateBag)

func (*StepSuppressMessages) Run 

func (s *StepSuppressMessages) Run(state multistep.StateBag) multistep.StepAction

type StepTypeBootCommand added in v0.7.0 

type StepTypeBootCommand struct {
	BootCommand []string
	VMName      string
	Ctx         interpolate.Context
}

This step "types" the boot command into the VM over VNC.

Uses: 

http_port int
ui     packer.Ui
vnc_port uint

Produces: 

<nothing>

func (*StepTypeBootCommand) Cleanup added in v0.7.0 

func (*StepTypeBootCommand) Cleanup(multistep.StateBag)

func (*StepTypeBootCommand) Run added in v0.7.0 

func (s *StepTypeBootCommand) Run(state multistep.StateBag) multistep.StepAction

type StepUploadTools added in v0.6.1 

type StepUploadTools struct {
	RemoteType        string
	ToolsUploadFlavor string
	ToolsUploadPath   string
	Ctx               interpolate.Context
}

func (*StepUploadTools) Cleanup added in v0.6.1 

func (c *StepUploadTools) Cleanup(multistep.StateBag)

func (*StepUploadTools) Run added in v0.6.1 

func (c *StepUploadTools) Run(state multistep.StateBag) multistep.StepAction

type ToolsConfig added in v0.6.1 

type ToolsConfig struct {
	ToolsUploadFlavor string `mapstructure:"tools_upload_flavor"`
	ToolsUploadPath   string `mapstructure:"tools_upload_path"`
}

func (*ToolsConfig) Prepare added in v0.6.1 

func (c *ToolsConfig) Prepare(ctx *interpolate.Context) []error

type VMXConfig 

type VMXConfig struct {
	VMXData     map[string]string `mapstructure:"vmx_data"`
	VMXDataPost map[string]string `mapstructure:"vmx_data_post"`
}

func (*VMXConfig) Prepare 

func (c *VMXConfig) Prepare(ctx *interpolate.Context) []error

type VMnetNatConfIPFinder added in v0.7.0 

type VMnetNatConfIPFinder struct{}

VMnetNatConfIPFinder finds the IP address of the host machine by retrieving the IP from the vmnetnat.conf. This isn't a full proof technique but so far it has not failed.

func (*VMnetNatConfIPFinder) HostIP added in v0.7.0 

func (*VMnetNatConfIPFinder) HostIP() (string, error)

type VNCAddressFinder added in v0.7.0 

type VNCAddressFinder interface {
	VNCAddress(string, uint, uint) (string, uint, error)

	// UpdateVMX, sets driver specific VNC values to VMX data.
	UpdateVMX(vncAddress, vncPassword string, vncPort uint, vmxData map[string]string)
}

type Workstation10Driver added in v0.6.0 

type Workstation10Driver struct {
	Workstation9Driver
}

func (*Workstation10Driver) Clone added in v0.6.0 

func (d *Workstation10Driver) Clone(dst, src string) error

func (*Workstation10Driver) Verify added in v0.6.0 

func (d *Workstation10Driver) Verify() error

type Workstation9Driver 

type Workstation9Driver struct {
	AppPath          string
	VdiskManagerPath string
	VmrunPath        string

	// SSHConfig are the SSH settings for the Fusion VM
	SSHConfig *SSHConfig
}

Workstation9Driver is a driver that can run VMware Workstation 9

func (*Workstation9Driver) Clone 

func (d *Workstation9Driver) Clone(dst, src string) error

func (*Workstation9Driver) CommHost added in v0.8.0 

func (d *Workstation9Driver) CommHost(state multistep.StateBag) (string, error)

func (*Workstation9Driver) CompactDisk 

func (d *Workstation9Driver) CompactDisk(diskPath string) error

func (*Workstation9Driver) CreateDisk 

func (d *Workstation9Driver) CreateDisk(output string, size string, type_id string) error

func (*Workstation9Driver) DhcpLeasesPath 

func (d *Workstation9Driver) DhcpLeasesPath(device string) string

func (*Workstation9Driver) IsRunning 

func (d *Workstation9Driver) IsRunning(vmxPath string) (bool, error)

func (*Workstation9Driver) Start 

func (d *Workstation9Driver) Start(vmxPath string, headless bool) error

func (*Workstation9Driver) Stop 

func (d *Workstation9Driver) Stop(vmxPath string) error

func (*Workstation9Driver) SuppressMessages 

func (d *Workstation9Driver) SuppressMessages(vmxPath string) error

func (*Workstation9Driver) ToolsInstall added in v0.6.0 

func (d *Workstation9Driver) ToolsInstall() error

func (*Workstation9Driver) ToolsIsoPath 

func (d *Workstation9Driver) ToolsIsoPath(flavor string) string

func (*Workstation9Driver) Verify 

func (d *Workstation9Driver) Verify() error

func (*Workstation9Driver) VmnetnatConfPath 

func (d *Workstation9Driver) VmnetnatConfPath() string

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.