ocisurrogate

Documentation

Overview

Package oci contains a packer.Builder implementation that builds Oracle Bare Metal Cloud Services (OCI) images.

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) Cancel()
  • 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 Config
  • func (c *Config) ConfigProvider() ocicommon.ConfigurationProvider
  • func (*Config) FlatMapstructure() interface{ ... }
  • func (c *Config) Prepare(raws ...interface{}) error
• type Driver
  • func NewDriverOCI(cfg *Config) (Driver, error)
• type FlatConfig
  • func (*FlatConfig) HCL2Spec() map[string]hcldec.Spec
• type FlatFlexShapeConfig
  • func (*FlatFlexShapeConfig) HCL2Spec() map[string]hcldec.Spec
• type FlexShapeConfig
  • func (*FlexShapeConfig) FlatMapstructure() interface{ ... }

Constants

const BuilderId = "mattiarossi.ocisurrogate"

BuilderId uniquely identifies the builder

Types

type Artifact

type Artifact struct {
	Image  core.Image
	Region string

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

Artifact is an artifact implementation that contains a built Custom Image.

func (*Artifact) BuilderId

func (a *Artifact) BuilderId() string

BuilderId uniquely identifies the builder.

func (*Artifact) Destroy

func (a *Artifact) Destroy() error

Destroy deletes the custom image associated with the artifact.

func (*Artifact) Files

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

Files lists the files associated with an artifact. We don't have any files as the custom image is stored server side.

func (*Artifact) Id

func (a *Artifact) Id() string

Id returns the OCID of the associated Image.

func (*Artifact) State

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

State ...

func (*Artifact) String

func (a *Artifact) String() string

type Builder

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

Builder is a builder implementation that creates Oracle OCI custom images.

func (*Builder) Cancel

func (b *Builder) Cancel()

Cancel terminates a running build.

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 Config

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

	// Instance Principals (OPTIONAL)
	// If set to true the following can't have non empty values
	// - AccessCfgFile
	// - AccessCfgFileAccount
	// - UserID
	// - TenancyID
	// - Region
	// - Fingerprint
	// - KeyFile
	// - PassPhrase
	InstancePrincipals bool `mapstructure:"use_instance_principals"`

	AccessCfgFile        string `mapstructure:"access_cfg_file"`
	AccessCfgFileAccount string `mapstructure:"access_cfg_file_account"`

	// Access config overrides
	UserID       string `mapstructure:"user_ocid"`
	TenancyID    string `mapstructure:"tenancy_ocid"`
	Region       string `mapstructure:"region"`
	Fingerprint  string `mapstructure:"fingerprint"`
	KeyFile      string `mapstructure:"key_file"`
	PassPhrase   string `mapstructure:"pass_phrase"`
	UsePrivateIP bool   `mapstructure:"use_private_ip"`

	AvailabilityDomain string `mapstructure:"availability_domain"`
	CompartmentID      string `mapstructure:"compartment_ocid"`

	// Image
	BaseImageID   string `mapstructure:"base_image_ocid"`
	BaseImageName string `mapstructure:"base_image_name"`
	ImageName     string `mapstructure:"image_name"`

	// Instance
	InstanceName        string          `mapstructure:"instance_name"`
	Shape               string          `mapstructure:"shape"`
	ShapeConfig         FlexShapeConfig `mapstructure:"shape_config"`
	BootVolumeSizeInGBs int64           `mapstructure:"bootvolumesize"`

	// Metadata optionally contains custom metadata key/value pairs provided in the
	// configuration. While this can be used to set metadata["user_data"] the explicit
	// "user_data" and "user_data_file" values will have precedence.
	// An instance's metadata can be obtained from at http://169.254.169.254 on the
	// launched instance.
	Metadata map[string]string `mapstructure:"metadata"`

	// UserData and UserDataFile file are both optional and mutually exclusive.
	UserData     string `mapstructure:"user_data"`
	UserDataFile string `mapstructure:"user_data_file"`

	// Networking
	SubnetID string `mapstructure:"subnet_ocid"`

	// Tagging
	Tags        map[string]string                 `mapstructure:"tags"`
	DefinedTags map[string]map[string]interface{} `mapstructure:"defined_tags"`
	// contains filtered or unexported fields
}

func (*Config) ConfigProvider

func (c *Config) ConfigProvider() ocicommon.ConfigurationProvider

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{}) error

type Driver

type Driver interface {
	CreateInstance(ctx context.Context, publicKey string, surrogateVolumeId string) (string, error)
	CreateBootClone(ctx context.Context, InstanceId string) (string, error)
	AttachBootClone(ctx context.Context, InstanceId string, VolumeId string) (string, error)
	DetachBootClone(ctx context.Context, VolumeId string) (string, error)
	CreateImage(ctx context.Context, id string) (core.Image, error)
	DeleteImage(ctx context.Context, id string) error
	GetInstanceIP(ctx context.Context, id string) (string, error)
	TerminateInstance(ctx context.Context, id string) error
	DeleteBootVolume(ctx context.Context, id string) error
	WaitForImageCreation(ctx context.Context, id string) error
	WaitForInstanceState(ctx context.Context, id string, waitStates []string, terminalState string) error
	WaitForBootVolumeState(ctx context.Context, id string, waitStates []string, terminalState string) error
	WaitForVolumeAttachmentState(ctx context.Context, id string, waitStates []string, terminalState string) error
}

Driver interfaces between the builder steps and the OCI SDK.

func NewDriverOCI

func NewDriverOCI(cfg *Config) (Driver, error)

NewDriverOCI Creates a new driverOCI with a connected compute client and a connected vcn client.

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"`
	SSHBastionInteractive     *bool                `mapstructure:"ssh_bastion_interactive" cty:"ssh_bastion_interactive"`
	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"`
	AccessCfgFile             *string              `mapstructure:"access_cfg_file" cty:"access_cfg_file"`
	AccessCfgFileAccount      *string              `mapstructure:"access_cfg_file_account" cty:"access_cfg_file_account"`
	UserID                    *string              `mapstructure:"user_ocid" cty:"user_ocid"`
	TenancyID                 *string              `mapstructure:"tenancy_ocid" cty:"tenancy_ocid"`
	Region                    *string              `mapstructure:"region" cty:"region"`
	Fingerprint               *string              `mapstructure:"fingerprint" cty:"fingerprint"`
	KeyFile                   *string              `mapstructure:"key_file" cty:"key_file"`
	PassPhrase                *string              `mapstructure:"pass_phrase" cty:"pass_phrase"`
	UsePrivateIP              *bool                `mapstructure:"use_private_ip" cty:"use_private_ip"`
	AvailabilityDomain        *string              `mapstructure:"availability_domain" cty:"availability_domain"`
	CompartmentID             *string              `mapstructure:"compartment_ocid" cty:"compartment_ocid"`
	BaseImageID               *string              `mapstructure:"base_image_ocid" cty:"base_image_ocid"`
	BaseImageName             *string              `mapstructure:"base_image_name" cty:"base_image_name"`
	Shape                     *string              `mapstructure:"shape" cty:"shape"`
	ShapeConfig               *FlatFlexShapeConfig `mapstructure:"shape_config" cty:"shape_config" hcl:"shape_config"`
	ImageName                 *string              `mapstructure:"image_name" cty:"image_name"`
	BootVolumeSizeInGBs       *int64               `mapstructure:"bootvolumesize" cty:"bootvolumesize"`
	InstanceName              *string              `mapstructure:"instance_name" cty:"instance_name"`
	Metadata                  map[string]string    `mapstructure:"metadata" cty:"metadata"`
	UserData                  *string              `mapstructure:"user_data" cty:"user_data"`
	UserDataFile              *string              `mapstructure:"user_data_file" cty:"user_data_file"`
	SubnetID                  *string              `mapstructure:"subnet_ocid" cty:"subnet_ocid"`
	Tags                      map[string]string    `mapstructure:"tags" cty:"tags"`
}

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.

type FlatFlexShapeConfig

type FlatFlexShapeConfig struct {
	Ocpus       *float32 `mapstructure:"ocpus" required:"false" cty:"ocpus" hcl:"ocpus"`
	MemoryInGBs *float32 `mapstructure:"memory_in_gbs" required:"false" cty:"memory_in_gbs" hcl:"memory_in_gbs"`
}

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

func (*FlatFlexShapeConfig) HCL2Spec

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

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

type FlexShapeConfig

type FlexShapeConfig struct {
	Ocpus       *float32 `mapstructure:"ocpus" required:"false"`
	MemoryInGBs *float32 `mapstructure:"memory_in_gbs" required:"false"`
}

func (*FlexShapeConfig) FlatMapstructure

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

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