hyperone

Documentation

Overview

Code generated by "mapstructure-to-hcl2 -type Config"; DO NOT EDIT.

Index

• Constants
• type Artifact
  • func (a *Artifact) BuilderId() string
  • func (a *Artifact) Destroy() error
  • func (a *Artifact) Files() []string
  • func (a *Artifact) Id() string
  • func (a *Artifact) State(name string) interface{}
  • func (a *Artifact) String() string
• type Builder
  • func (b *Builder) ConfigSpec() hcldec.ObjectSpec
  • func (b *Builder) Prepare(raws ...interface{}) ([]string, []string, error)
  • func (b *Builder) Run(ctx context.Context, ui packer.Ui, hook packer.Hook) (packer.Artifact, error)
• type ChrootCommunicator
  • func (c *ChrootCommunicator) Download(src string, w io.Writer) error
  • func (c *ChrootCommunicator) DownloadDir(src string, dst string, exclude []string) error
  • func (c *ChrootCommunicator) Start(ctx context.Context, cmd *packer.RemoteCmd) error
  • func (c *ChrootCommunicator) Upload(dst string, r io.Reader, fi *os.FileInfo) error
  • func (c *ChrootCommunicator) UploadDir(dst string, src string, exclude []string) error
• type CommandWrapper
• type Config
  • func (*Config) FlatMapstructure() interface{ ... }
  • func (c *Config) Prepare(raws ...interface{}) ([]string, error)
• type FlatConfig
  • func (*FlatConfig) HCL2Spec() map[string]hcldec.Spec

Constants

const BuilderID = "hyperone.builder"

Types

type Artifact

type Artifact struct {

	// StateData should store data such as GeneratedData
	// to be shared with post-processors
	StateData map[string]interface{}
	// contains filtered or unexported fields
}

func (*Artifact) BuilderId

func (a *Artifact) BuilderId() string

func (*Artifact) Destroy

func (a *Artifact) Destroy() error

func (*Artifact) Files

func (a *Artifact) Files() []string

func (*Artifact) Id

func (a *Artifact) Id() string

func (*Artifact) State

func (a *Artifact) State(name string) interface{}

func (*Artifact) String

func (a *Artifact) String() string

type Builder

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

func (*Builder) ConfigSpec

func (b *Builder) ConfigSpec() hcldec.ObjectSpec

func (*Builder) Prepare

func (b *Builder) Prepare(raws ...interface{}) ([]string, []string, error)

func (*Builder) Run

func (b *Builder) Run(ctx context.Context, ui packer.Ui, hook packer.Hook) (packer.Artifact, error)

type ChrootCommunicator

type ChrootCommunicator struct {
	Chroot     string
	CmdWrapper CommandWrapper
	Wrapped    packer.Communicator
}

ChrootCommunicator works as a wrapper on SSHCommunicator, modyfing paths in flight to be run in a chroot.

func (*ChrootCommunicator) Download

func (c *ChrootCommunicator) Download(src string, w io.Writer) error

func (*ChrootCommunicator) DownloadDir

func (c *ChrootCommunicator) DownloadDir(src string, dst string, exclude []string) error

func (*ChrootCommunicator) Start

func (c *ChrootCommunicator) Start(ctx context.Context, cmd *packer.RemoteCmd) error

func (*ChrootCommunicator) Upload

func (c *ChrootCommunicator) Upload(dst string, r io.Reader, fi *os.FileInfo) error

func (*ChrootCommunicator) UploadDir

func (c *ChrootCommunicator) UploadDir(dst string, src string, exclude []string) error

type CommandWrapper

type CommandWrapper func(string) (string, error)

type Config

type Config struct {
	common.PackerConfig `mapstructure:",squash"`
	Comm                communicator.Config `mapstructure:",squash"`
	// Custom API endpoint URL, compatible with HyperOne.
	// It can also be specified via environment variable HYPERONE_API_URL.
	APIURL string `mapstructure:"api_url" required:"false"`
	// The authentication token used to access your account.
	// This can be either a session token or a service account token.
	// If not defined, the builder will attempt to find it in the following order:
	Token string `mapstructure:"token" required:"true"`
	// The id or name of the project. This field is required
	// only if using session tokens. It should be skipped when using service
	// account authentication.
	Project string `mapstructure:"project" required:"true"`
	// Login (an e-mail) on HyperOne platform. Set this
	// if you want to fetch the token by SSH authentication.
	TokenLogin string `mapstructure:"token_login" required:"false"`
	// Timeout for waiting on the API to complete
	// a request. Defaults to 5m.
	StateTimeout time.Duration `mapstructure:"state_timeout" required:"false"`
	// ID or name of the image to launch server from.
	SourceImage string `mapstructure:"source_image" required:"true"`
	// The name of the resulting image. Defaults to
	// "packer-{{timestamp}}"
	// (see configuration templates for more info).
	ImageName string `mapstructure:"image_name" required:"false"`
	// The description of the resulting image.
	ImageDescription string `mapstructure:"image_description" required:"false"`
	// Key/value pair tags to
	// add to the created image.
	ImageTags map[string]string `mapstructure:"image_tags" required:"false"`
	// The service of the resulting image.
	ImageService string `mapstructure:"image_service" required:"false"`
	// ID or name of the type this server should be created with.
	VmType string `mapstructure:"vm_type" required:"true"`
	// The name of the created server.
	VmName string `mapstructure:"vm_name" required:"false"`
	// Key/value pair tags to
	// add to the created server.
	VmTags map[string]string `mapstructure:"vm_tags" required:"false"`
	// The name of the created disk.
	DiskName string `mapstructure:"disk_name" required:"false"`
	// The type of the created disk. Defaults to ssd.
	DiskType string `mapstructure:"disk_type" required:"false"`
	// Size of the created disk, in GiB.
	DiskSize float32 `mapstructure:"disk_size" required:"true"`
	// The ID of the network to attach to the created server.
	Network string `mapstructure:"network" required:"false"`
	// The ID of the private IP within chosen network
	// that should be assigned to the created server.
	PrivateIP string `mapstructure:"private_ip" required:"false"`
	// The ID of the public IP that should be assigned to
	// the created server. If network is chosen, the public IP will be associated
	// with server's private IP.
	PublicIP string `mapstructure:"public_ip" required:"false"`
	// Custom service of public network adapter.
	// Can be useful when using custom api_url. Defaults to public.
	PublicNetAdpService string `mapstructure:"public_netadp_service" required:"false"`

	ChrootDisk           bool       `mapstructure:"chroot_disk"`
	ChrootDiskSize       float32    `mapstructure:"chroot_disk_size"`
	ChrootDiskType       string     `mapstructure:"chroot_disk_type"`
	ChrootMountPath      string     `mapstructure:"chroot_mount_path"`
	ChrootMounts         [][]string `mapstructure:"chroot_mounts"`
	ChrootCopyFiles      []string   `mapstructure:"chroot_copy_files"`
	ChrootCommandWrapper string     `mapstructure:"chroot_command_wrapper"`

	MountOptions      []string `mapstructure:"mount_options"`
	MountPartition    string   `mapstructure:"mount_partition"`
	PreMountCommands  []string `mapstructure:"pre_mount_commands"`
	PostMountCommands []string `mapstructure:"post_mount_commands"`
	// List of SSH keys by name or id to be added
	// to the server on launch.
	SSHKeys []string `mapstructure:"ssh_keys" required:"false"`
	// User data to launch with the server. Packer will not
	// automatically wait for a user script to finish before shutting down the
	// instance, this must be handled in a provisioner.
	UserData string `mapstructure:"user_data" required:"false"`
	// contains filtered or unexported fields
}

func (*Config) FlatMapstructure

func (*Config) FlatMapstructure() interface{ HCL2Spec() map[string]hcldec.Spec }

FlatMapstructure returns a new FlatConfig. FlatConfig is an auto-generated flat version of Config. Where the contents a fields with a `mapstructure:,squash` tag are bubbled up.

func (*Config) Prepare

func (c *Config) Prepare(raws ...interface{}) ([]string, error)

type FlatConfig

type FlatConfig struct {
	PackerBuildName           *string           `mapstructure:"packer_build_name" cty:"packer_build_name"`
	PackerBuilderType         *string           `mapstructure:"packer_builder_type" cty:"packer_builder_type"`
	PackerDebug               *bool             `mapstructure:"packer_debug" cty:"packer_debug"`
	PackerForce               *bool             `mapstructure:"packer_force" cty:"packer_force"`
	PackerOnError             *string           `mapstructure:"packer_on_error" cty:"packer_on_error"`
	PackerUserVars            map[string]string `mapstructure:"packer_user_variables" cty:"packer_user_variables"`
	PackerSensitiveVars       []string          `mapstructure:"packer_sensitive_variables" cty:"packer_sensitive_variables"`
	Type                      *string           `mapstructure:"communicator" cty:"communicator"`
	PauseBeforeConnect        *string           `mapstructure:"pause_before_connecting" cty:"pause_before_connecting"`
	SSHHost                   *string           `mapstructure:"ssh_host" cty:"ssh_host"`
	SSHPort                   *int              `mapstructure:"ssh_port" cty:"ssh_port"`
	SSHUsername               *string           `mapstructure:"ssh_username" cty:"ssh_username"`
	SSHPassword               *string           `mapstructure:"ssh_password" cty:"ssh_password"`
	SSHKeyPairName            *string           `mapstructure:"ssh_keypair_name" cty:"ssh_keypair_name"`
	SSHTemporaryKeyPairName   *string           `mapstructure:"temporary_key_pair_name" cty:"temporary_key_pair_name"`
	SSHClearAuthorizedKeys    *bool             `mapstructure:"ssh_clear_authorized_keys" cty:"ssh_clear_authorized_keys"`
	SSHPrivateKeyFile         *string           `mapstructure:"ssh_private_key_file" cty:"ssh_private_key_file"`
	SSHPty                    *bool             `mapstructure:"ssh_pty" cty:"ssh_pty"`
	SSHTimeout                *string           `mapstructure:"ssh_timeout" cty:"ssh_timeout"`
	SSHAgentAuth              *bool             `mapstructure:"ssh_agent_auth" cty:"ssh_agent_auth"`
	SSHDisableAgentForwarding *bool             `mapstructure:"ssh_disable_agent_forwarding" cty:"ssh_disable_agent_forwarding"`
	SSHHandshakeAttempts      *int              `mapstructure:"ssh_handshake_attempts" cty:"ssh_handshake_attempts"`
	SSHBastionHost            *string           `mapstructure:"ssh_bastion_host" cty:"ssh_bastion_host"`
	SSHBastionPort            *int              `mapstructure:"ssh_bastion_port" cty:"ssh_bastion_port"`
	SSHBastionAgentAuth       *bool             `mapstructure:"ssh_bastion_agent_auth" cty:"ssh_bastion_agent_auth"`
	SSHBastionUsername        *string           `mapstructure:"ssh_bastion_username" cty:"ssh_bastion_username"`
	SSHBastionPassword        *string           `mapstructure:"ssh_bastion_password" cty:"ssh_bastion_password"`
	SSHBastionPrivateKeyFile  *string           `mapstructure:"ssh_bastion_private_key_file" cty:"ssh_bastion_private_key_file"`
	SSHFileTransferMethod     *string           `mapstructure:"ssh_file_transfer_method" cty:"ssh_file_transfer_method"`
	SSHProxyHost              *string           `mapstructure:"ssh_proxy_host" cty:"ssh_proxy_host"`
	SSHProxyPort              *int              `mapstructure:"ssh_proxy_port" cty:"ssh_proxy_port"`
	SSHProxyUsername          *string           `mapstructure:"ssh_proxy_username" cty:"ssh_proxy_username"`
	SSHProxyPassword          *string           `mapstructure:"ssh_proxy_password" cty:"ssh_proxy_password"`
	SSHKeepAliveInterval      *string           `mapstructure:"ssh_keep_alive_interval" cty:"ssh_keep_alive_interval"`
	SSHReadWriteTimeout       *string           `mapstructure:"ssh_read_write_timeout" cty:"ssh_read_write_timeout"`
	SSHRemoteTunnels          []string          `mapstructure:"ssh_remote_tunnels" cty:"ssh_remote_tunnels"`
	SSHLocalTunnels           []string          `mapstructure:"ssh_local_tunnels" cty:"ssh_local_tunnels"`
	SSHPublicKey              []byte            `mapstructure:"ssh_public_key" cty:"ssh_public_key"`
	SSHPrivateKey             []byte            `mapstructure:"ssh_private_key" cty:"ssh_private_key"`
	WinRMUser                 *string           `mapstructure:"winrm_username" cty:"winrm_username"`
	WinRMPassword             *string           `mapstructure:"winrm_password" cty:"winrm_password"`
	WinRMHost                 *string           `mapstructure:"winrm_host" cty:"winrm_host"`
	WinRMPort                 *int              `mapstructure:"winrm_port" cty:"winrm_port"`
	WinRMTimeout              *string           `mapstructure:"winrm_timeout" cty:"winrm_timeout"`
	WinRMUseSSL               *bool             `mapstructure:"winrm_use_ssl" cty:"winrm_use_ssl"`
	WinRMInsecure             *bool             `mapstructure:"winrm_insecure" cty:"winrm_insecure"`
	WinRMUseNTLM              *bool             `mapstructure:"winrm_use_ntlm" cty:"winrm_use_ntlm"`
	APIURL                    *string           `mapstructure:"api_url" required:"false" cty:"api_url"`
	Token                     *string           `mapstructure:"token" required:"true" cty:"token"`
	Project                   *string           `mapstructure:"project" required:"true" cty:"project"`
	TokenLogin                *string           `mapstructure:"token_login" required:"false" cty:"token_login"`
	StateTimeout              *string           `mapstructure:"state_timeout" required:"false" cty:"state_timeout"`
	SourceImage               *string           `mapstructure:"source_image" required:"true" cty:"source_image"`
	ImageName                 *string           `mapstructure:"image_name" required:"false" cty:"image_name"`
	ImageDescription          *string           `mapstructure:"image_description" required:"false" cty:"image_description"`
	ImageTags                 map[string]string `mapstructure:"image_tags" required:"false" cty:"image_tags"`
	ImageService              *string           `mapstructure:"image_service" required:"false" cty:"image_service"`
	VmType                    *string           `mapstructure:"vm_type" required:"true" cty:"vm_type"`
	VmName                    *string           `mapstructure:"vm_name" required:"false" cty:"vm_name"`
	VmTags                    map[string]string `mapstructure:"vm_tags" required:"false" cty:"vm_tags"`
	DiskName                  *string           `mapstructure:"disk_name" required:"false" cty:"disk_name"`
	DiskType                  *string           `mapstructure:"disk_type" required:"false" cty:"disk_type"`
	DiskSize                  *float32          `mapstructure:"disk_size" required:"true" cty:"disk_size"`
	Network                   *string           `mapstructure:"network" required:"false" cty:"network"`
	PrivateIP                 *string           `mapstructure:"private_ip" required:"false" cty:"private_ip"`
	PublicIP                  *string           `mapstructure:"public_ip" required:"false" cty:"public_ip"`
	PublicNetAdpService       *string           `mapstructure:"public_netadp_service" required:"false" cty:"public_netadp_service"`
	ChrootDisk                *bool             `mapstructure:"chroot_disk" cty:"chroot_disk"`
	ChrootDiskSize            *float32          `mapstructure:"chroot_disk_size" cty:"chroot_disk_size"`
	ChrootDiskType            *string           `mapstructure:"chroot_disk_type" cty:"chroot_disk_type"`
	ChrootMountPath           *string           `mapstructure:"chroot_mount_path" cty:"chroot_mount_path"`
	ChrootMounts              [][]string        `mapstructure:"chroot_mounts" cty:"chroot_mounts"`
	ChrootCopyFiles           []string          `mapstructure:"chroot_copy_files" cty:"chroot_copy_files"`
	ChrootCommandWrapper      *string           `mapstructure:"chroot_command_wrapper" cty:"chroot_command_wrapper"`
	MountOptions              []string          `mapstructure:"mount_options" cty:"mount_options"`
	MountPartition            *string           `mapstructure:"mount_partition" cty:"mount_partition"`
	PreMountCommands          []string          `mapstructure:"pre_mount_commands" cty:"pre_mount_commands"`
	PostMountCommands         []string          `mapstructure:"post_mount_commands" cty:"post_mount_commands"`
	SSHKeys                   []string          `mapstructure:"ssh_keys" required:"false" cty:"ssh_keys"`
	UserData                  *string           `mapstructure:"user_data" required:"false" cty:"user_data"`
}

FlatConfig is an auto-generated flat version of Config. Where the contents of a field with a `mapstructure:,squash` tag are bubbled up.

func (*FlatConfig) HCL2Spec

func (*FlatConfig) HCL2Spec() map[string]hcldec.Spec

HCL2Spec returns the hcl spec of a Config. This spec is used by HCL to read the fields of Config. The decoded values from this spec will then be applied to a FlatConfig.