Documentation
¶
Index ¶
- Constants
- func NewArtifact(dir string) (packer.Artifact, error)
- func SSHAddress(state multistep.StateBag) (string, error)
- func SSHConfigFunc(config SSHConfig) func(multistep.StateBag) (*ssh.ClientConfig, error)
- type Driver
- type DriverMock
- func (d *DriverMock) Import(name, srcPath, dstPath string) error
- func (d *DriverMock) IpAddress(mac string) (string, error)
- func (d *DriverMock) IsRunning(name string) (bool, error)
- func (d *DriverMock) Mac(name string) (string, error)
- func (d *DriverMock) Prlctl(args ...string) error
- func (d *DriverMock) SendKeyScanCodes(name string, scancodes ...string) error
- func (d *DriverMock) Stop(name string) error
- func (d *DriverMock) Verify() error
- func (d *DriverMock) Version() (string, error)
- type FloppyConfig
- type HostIPFinder
- type IfconfigIPFinder
- type OutputConfig
- type Parallels9Driver
- func (d *Parallels9Driver) Import(name, srcPath, dstDir string) error
- func (d *Parallels9Driver) IpAddress(mac string) (string, error)
- func (d *Parallels9Driver) IsRunning(name string) (bool, error)
- func (d *Parallels9Driver) Mac(vmName string) (string, error)
- func (d *Parallels9Driver) Prlctl(args ...string) error
- func (d *Parallels9Driver) SendKeyScanCodes(vmName string, codes ...string) error
- func (d *Parallels9Driver) Stop(name string) error
- func (d *Parallels9Driver) Verify() error
- func (d *Parallels9Driver) Version() (string, error)
- type PrlctlConfig
- type PrlctlVersionConfig
- type RunConfig
- type SSHConfig
- type ShutdownConfig
- type StepAttachFloppy
- type StepAttachParallelsTools
- type StepOutputDir
- type StepPrlctl
- type StepRemoveDevices
- type StepRun
- type StepShutdown
- type StepTypeBootCommand
- type StepUploadParallelsTools
- type StepUploadVersion
Constants ¶
const ( ParallelsToolsModeDisable string = "disable" ParallelsToolsModeAttach = "attach" ParallelsToolsModeUpload = "upload" )
These are the different valid mode values for "parallels_tools_mode" which determine how guest additions are delivered to the guest.
const BuilderId = "packer.parallels"
This is the common builder ID to all of these artifacts.
const KeyLeftShift uint32 = 0xFFE1
Variables ¶
This section is empty.
Functions ¶
func NewArtifact ¶
NewArtifact returns a Parallels artifact containing the files in the given directory.
func SSHConfigFunc ¶
Types ¶
type Driver ¶
type Driver interface {
// Import a VM
Import(string, string, string) error
// Checks if the VM with the given name is running.
IsRunning(string) (bool, error)
// Stop stops a running machine, forcefully.
Stop(string) error
// Prlctl executes the given Prlctl command
Prlctl(...string) error
// Verify checks to make sure that this driver should function
// properly. If there is any indication the driver can't function,
// this will return an error.
Verify() error
// Version reads the version of Parallels that is installed.
Version() (string, error)
// Send scancodes to the vm using the prltype tool.
SendKeyScanCodes(string, ...string) error
// Finds the MAC address of the NIC nic0
Mac(string) (string, error)
// Finds the IP address of a VM connected that uses DHCP by its MAC address
IpAddress(string) (string, error)
}
A driver is able to talk to Parallels and perform certain operations with it. Some of the operations on here may seem overly specific, but they were built specifically in mind to handle features of the Parallels builder for Packer, and to abstract differences in versions out of the builder steps, so sometimes the methods are extremely specific.
type DriverMock ¶
type DriverMock struct {
sync.Mutex
ImportCalled bool
ImportName string
ImportSrcPath string
ImportDstPath string
ImportErr error
IsRunningName string
IsRunningReturn bool
IsRunningErr error
StopName string
StopErr error
PrlctlCalls [][]string
PrlctlErrs []error
VerifyCalled bool
VerifyErr error
VersionCalled bool
VersionResult string
VersionErr error
SendKeyScanCodesCalls [][]string
SendKeyScanCodesErrs []error
MacName string
MacReturn string
MacError error
IpAddressMac string
IpAddressReturn string
IpAddressError error
}
func (*DriverMock) Import ¶
func (d *DriverMock) Import(name, srcPath, dstPath string) error
func (*DriverMock) Prlctl ¶
func (d *DriverMock) Prlctl(args ...string) error
func (*DriverMock) SendKeyScanCodes ¶
func (d *DriverMock) SendKeyScanCodes(name string, scancodes ...string) error
func (*DriverMock) Stop ¶
func (d *DriverMock) Stop(name string) error
func (*DriverMock) Verify ¶
func (d *DriverMock) Verify() error
func (*DriverMock) Version ¶
func (d *DriverMock) Version() (string, error)
type FloppyConfig ¶
type FloppyConfig struct {
FloppyFiles []string `mapstructure:"floppy_files"`
}
FloppyConfig is configuration related to created floppy disks and attaching them to a Parallels virtual machine.
func (*FloppyConfig) Prepare ¶
func (c *FloppyConfig) Prepare(t *packer.ConfigTemplate) []error
type HostIPFinder ¶ added in v0.6.1
Interface to help find the host IP that is available from within the Parallels virtual machines.
type IfconfigIPFinder ¶ added in v0.6.1
type IfconfigIPFinder struct {
Devices []string
}
IfconfigIPFinder finds the host IP based on the output of `ifconfig`.
func (*IfconfigIPFinder) HostIP ¶ added in v0.6.1
func (f *IfconfigIPFinder) HostIP() (string, error)
type OutputConfig ¶
type OutputConfig struct {
OutputDir string `mapstructure:"output_directory"`
}
func (*OutputConfig) Prepare ¶
func (c *OutputConfig) Prepare(t *packer.ConfigTemplate, pc *common.PackerConfig) []error
type Parallels9Driver ¶
type Parallels9Driver struct {
// This is the path to the "prlctl" application.
PrlctlPath string
}
func (*Parallels9Driver) Import ¶
func (d *Parallels9Driver) Import(name, srcPath, dstDir string) error
func (*Parallels9Driver) IpAddress ¶
func (d *Parallels9Driver) IpAddress(mac string) (string, error)
Finds the IP address of a VM connected that uses DHCP by its MAC address
func (*Parallels9Driver) IsRunning ¶
func (d *Parallels9Driver) IsRunning(name string) (bool, error)
func (*Parallels9Driver) Prlctl ¶
func (d *Parallels9Driver) Prlctl(args ...string) error
func (*Parallels9Driver) SendKeyScanCodes ¶
func (d *Parallels9Driver) SendKeyScanCodes(vmName string, codes ...string) error
func (*Parallels9Driver) Stop ¶
func (d *Parallels9Driver) Stop(name string) error
func (*Parallels9Driver) Verify ¶
func (d *Parallels9Driver) Verify() error
func (*Parallels9Driver) Version ¶
func (d *Parallels9Driver) Version() (string, error)
type PrlctlConfig ¶
type PrlctlConfig struct {
Prlctl [][]string `mapstructure:"prlctl"`
}
func (*PrlctlConfig) Prepare ¶
func (c *PrlctlConfig) Prepare(t *packer.ConfigTemplate) []error
type PrlctlVersionConfig ¶
type PrlctlVersionConfig struct {
PrlctlVersionFile string `mapstructure:"prlctl_version_file"`
}
func (*PrlctlVersionConfig) Prepare ¶
func (c *PrlctlVersionConfig) Prepare(t *packer.ConfigTemplate) []error
type RunConfig ¶
type SSHConfig ¶
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(t *packer.ConfigTemplate) []error
type StepAttachFloppy ¶
type StepAttachFloppy struct {
// contains filtered or unexported fields
}
This step attaches a floppy to the virtual machine.
Uses:
driver Driver ui packer.Ui vmName string
Produces:
func (*StepAttachFloppy) Cleanup ¶
func (s *StepAttachFloppy) Cleanup(state multistep.StateBag)
func (*StepAttachFloppy) Run ¶
func (s *StepAttachFloppy) Run(state multistep.StateBag) multistep.StepAction
type StepAttachParallelsTools ¶
This step attaches the Parallels Tools as a inserted CD onto the virtual machine.
Uses:
driver Driver toolsPath string ui packer.Ui vmName string
Produces:
func (*StepAttachParallelsTools) Cleanup ¶
func (s *StepAttachParallelsTools) Cleanup(state multistep.StateBag)
func (*StepAttachParallelsTools) Run ¶
func (s *StepAttachParallelsTools) Run(state multistep.StateBag) multistep.StepAction
type StepOutputDir ¶
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 StepPrlctl ¶
type StepPrlctl struct {
Commands [][]string
Tpl *packer.ConfigTemplate
}
This step executes additional prlctl commands as specified by the template.
Uses:
driver Driver ui packer.Ui vmName string
Produces:
func (*StepPrlctl) Cleanup ¶
func (s *StepPrlctl) Cleanup(state multistep.StateBag)
func (*StepPrlctl) Run ¶
func (s *StepPrlctl) Run(state multistep.StateBag) multistep.StepAction
type StepRemoveDevices ¶
type StepRemoveDevices struct{}
This step removes any devices (floppy disks, ISOs, etc.) from the machine that we may have added.
Uses:
driver Driver ui packer.Ui vmName string
Produces:
func (*StepRemoveDevices) Cleanup ¶
func (s *StepRemoveDevices) Cleanup(state multistep.StateBag)
func (*StepRemoveDevices) Run ¶
func (s *StepRemoveDevices) Run(state multistep.StateBag) multistep.StepAction
type StepRun ¶
type StepRun struct {
BootWait time.Duration
Headless bool
// contains filtered or unexported fields
}
This step starts the virtual machine.
Uses:
driver Driver ui packer.Ui vmName string
Produces:
type StepShutdown ¶
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 driver Driver ui packer.Ui vmName 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 StepTypeBootCommand ¶ added in v0.6.1
type StepTypeBootCommand struct {
BootCommand []string
HostInterfaces []string
VMName string
Tpl *packer.ConfigTemplate
}
This step "types" the boot command into the VM via prltype, built on the Parallels Virtualization SDK - C API.
Uses:
driver Driver http_port int ui packer.Ui vmName string
Produces:
<nothing>
func (*StepTypeBootCommand) Cleanup ¶ added in v0.6.1
func (*StepTypeBootCommand) Cleanup(multistep.StateBag)
func (*StepTypeBootCommand) Run ¶ added in v0.6.1
func (s *StepTypeBootCommand) Run(state multistep.StateBag) multistep.StepAction
type StepUploadParallelsTools ¶
type StepUploadParallelsTools struct {
ParallelsToolsHostPath string
ParallelsToolsGuestPath string
ParallelsToolsMode string
Tpl *packer.ConfigTemplate
}
This step uploads the guest additions ISO to the VM.
func (*StepUploadParallelsTools) Cleanup ¶
func (s *StepUploadParallelsTools) Cleanup(state multistep.StateBag)
func (*StepUploadParallelsTools) Run ¶
func (s *StepUploadParallelsTools) Run(state multistep.StateBag) multistep.StepAction
type StepUploadVersion ¶
type StepUploadVersion struct {
Path string
}
This step uploads a file containing the Parallels version, which can be useful for various provisioning reasons.
func (*StepUploadVersion) Cleanup ¶
func (s *StepUploadVersion) Cleanup(state multistep.StateBag)
func (*StepUploadVersion) Run ¶
func (s *StepUploadVersion) Run(state multistep.StateBag) multistep.StepAction
Source Files
¶
- artifact.go
- driver.go
- driver_9.go
- driver_mock.go
- floppy_config.go
- host_ip.go
- host_ip_ifconfig.go
- output_config.go
- prlctl_config.go
- prlctl_version_config.go
- run_config.go
- shutdown_config.go
- ssh.go
- ssh_config.go
- step_attach_floppy.go
- step_attach_parallels_tools.go
- step_output_dir.go
- step_prlctl.go
- step_remove_devices.go
- step_run.go
- step_shutdown.go
- step_type_boot_command.go
- step_upload_parallels_tools.go
- step_upload_version.go
- tools_modes.go