upcloud

package
v1.5.3 Latest Latest
Warning

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

 Go to latest Published: Jan 3, 2024 License: MIT Imports: 26 Imported by: 0

Documentation

Index

Constants

View Source 
const (
	DefaultTemplatePrefix               = "custom-image"
	DefaultSSHUsername                  = "root"
	DefaultCommunicator                 = "ssh"
	DefaultStorageSize                  = 25
	DefaultTimeout                      = 5 * time.Minute
	InterfaceTypePublic   InterfaceType = upcloud.IPAddressAccessPublic
	InterfaceTypeUtility  InterfaceType = upcloud.IPAddressAccessUtility
	InterfaceTypePrivate  InterfaceType = upcloud.IPAddressAccessPrivate
)
View Source 
const (
	BuilderId = "upcloud.builder"
)

Variables

View Source 
var (
	DefaultNetworking = []request.CreateServerInterface{
		{
			IPAddresses: []request.CreateServerIPAddress{
				{
					Family: upcloud.IPAddressFamilyIPv4,
				},
			},
			Type: upcloud.IPAddressAccessPublic,
		},
	}
)

Functions

This section is empty.

Types

type Artifact 

type Artifact struct {
	Templates []*upcloud.Storage

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

packersdk.Artifact implementation

func (*Artifact) BuilderId 

func (*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{}) (generatedVars []string, warnings []string, err 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"`

	// The username to use when interfacing with the UpCloud API.
	Username string `mapstructure:"username" required:"true"`

	// The password to use when interfacing with the UpCloud API.
	Password string `mapstructure:"password" required:"true"`

	// The zone in which the server and template should be created (e.g. nl-ams1).
	Zone string `mapstructure:"zone" required:"true"`

	// The UUID of the storage you want to use as a template when creating the server.
	//
	// Optionally use `storage_name` parameter to find matching storage
	StorageUUID string `mapstructure:"storage_uuid" required:"true"`

	// The name of the storage that will be used to find the first matching storage in the list of existing templates.
	//
	// Note that `storage_uuid` parameter has higher priority. You should use either `storage_uuid` or `storage_name` for not strict matching (e.g "ubuntu server 20.04").
	StorageName string `mapstructure:"storage_name"`

	// The prefix to use for the generated template title. Defaults to `custom-image`.
	// You can use this option to easily differentiate between different templates.
	TemplatePrefix string `mapstructure:"template_prefix"`

	// Similarly to `template_prefix`, but this will allow you to set the full template name and not just the prefix.
	// Defaults to an empty string, meaning the name will be the storage title.
	// You can use this option to easily differentiate between different templates.
	// It cannot be used in conjunction with the prefix setting.
	TemplateName string `mapstructure:"template_name"`

	// The storage size in gigabytes. Defaults to `25`.
	// Changing this value is useful if you aim to build a template for larger server configurations where the preconfigured server disk is larger than 25 GB.
	// The operating system disk can also be later extended if needed. Note that Windows templates require large storage size, than default 25 Gb.
	StorageSize int `mapstructure:"storage_size"`

	// The amount of time to wait for resource state changes. Defaults to `5m`.
	Timeout time.Duration `mapstructure:"state_timeout_duration"`

	// The amount of time to wait after booting the server. Defaults to '0s'
	BootWait time.Duration `mapstructure:"boot_wait"`

	// The array of extra zones (locations) where created templates should be cloned.
	// Note that default `state_timeout_duration` is not enough for cloning, better to increase a value depending on storage size.
	CloneZones []string `mapstructure:"clone_zones"`

	// The array of network interfaces to request during the creation of the server for building the packer image.
	NetworkInterfaces []NetworkInterface `mapstructure:"network_interfaces"`

	// Path to SSH Private Key that will be used for provisioning and stored in the template.
	SSHPrivateKeyPath string `mapstructure:"ssh_private_key_path"`

	// Path to SSH Public Key that will be used for provisioning.
	SSHPublicKeyPath string `mapstructure:"ssh_public_key_path"`
	// contains filtered or unexported fields
}

func (*Config) DefaultIPaddress added in v1.3.0 

func (c *Config) DefaultIPaddress() (*IPAddress, InterfaceType)

DefaultIPaddress returns default IP address and its type (public,private,utility)

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" hcl:"packer_build_name"`
	PackerBuilderType         *string                `mapstructure:"packer_builder_type" cty:"packer_builder_type" hcl:"packer_builder_type"`
	PackerCoreVersion         *string                `mapstructure:"packer_core_version" cty:"packer_core_version" hcl:"packer_core_version"`
	PackerDebug               *bool                  `mapstructure:"packer_debug" cty:"packer_debug" hcl:"packer_debug"`
	PackerForce               *bool                  `mapstructure:"packer_force" cty:"packer_force" hcl:"packer_force"`
	PackerOnError             *string                `mapstructure:"packer_on_error" cty:"packer_on_error" hcl:"packer_on_error"`
	PackerUserVars            map[string]string      `mapstructure:"packer_user_variables" cty:"packer_user_variables" hcl:"packer_user_variables"`
	PackerSensitiveVars       []string               `mapstructure:"packer_sensitive_variables" cty:"packer_sensitive_variables" hcl:"packer_sensitive_variables"`
	Type                      *string                `mapstructure:"communicator" cty:"communicator" hcl:"communicator"`
	PauseBeforeConnect        *string                `mapstructure:"pause_before_connecting" cty:"pause_before_connecting" hcl:"pause_before_connecting"`
	SSHHost                   *string                `mapstructure:"ssh_host" cty:"ssh_host" hcl:"ssh_host"`
	SSHPort                   *int                   `mapstructure:"ssh_port" cty:"ssh_port" hcl:"ssh_port"`
	SSHUsername               *string                `mapstructure:"ssh_username" cty:"ssh_username" hcl:"ssh_username"`
	SSHPassword               *string                `mapstructure:"ssh_password" cty:"ssh_password" hcl:"ssh_password"`
	SSHKeyPairName            *string                `mapstructure:"ssh_keypair_name" undocumented:"true" cty:"ssh_keypair_name" hcl:"ssh_keypair_name"`
	SSHTemporaryKeyPairName   *string                `mapstructure:"temporary_key_pair_name" undocumented:"true" cty:"temporary_key_pair_name" hcl:"temporary_key_pair_name"`
	SSHTemporaryKeyPairType   *string                `mapstructure:"temporary_key_pair_type" cty:"temporary_key_pair_type" hcl:"temporary_key_pair_type"`
	SSHTemporaryKeyPairBits   *int                   `mapstructure:"temporary_key_pair_bits" cty:"temporary_key_pair_bits" hcl:"temporary_key_pair_bits"`
	SSHCiphers                []string               `mapstructure:"ssh_ciphers" cty:"ssh_ciphers" hcl:"ssh_ciphers"`
	SSHClearAuthorizedKeys    *bool                  `mapstructure:"ssh_clear_authorized_keys" cty:"ssh_clear_authorized_keys" hcl:"ssh_clear_authorized_keys"`
	SSHKEXAlgos               []string               `mapstructure:"ssh_key_exchange_algorithms" cty:"ssh_key_exchange_algorithms" hcl:"ssh_key_exchange_algorithms"`
	SSHPrivateKeyFile         *string                `mapstructure:"ssh_private_key_file" undocumented:"true" cty:"ssh_private_key_file" hcl:"ssh_private_key_file"`
	SSHCertificateFile        *string                `mapstructure:"ssh_certificate_file" cty:"ssh_certificate_file" hcl:"ssh_certificate_file"`
	SSHPty                    *bool                  `mapstructure:"ssh_pty" cty:"ssh_pty" hcl:"ssh_pty"`
	SSHTimeout                *string                `mapstructure:"ssh_timeout" cty:"ssh_timeout" hcl:"ssh_timeout"`
	SSHWaitTimeout            *string                `mapstructure:"ssh_wait_timeout" undocumented:"true" cty:"ssh_wait_timeout" hcl:"ssh_wait_timeout"`
	SSHAgentAuth              *bool                  `mapstructure:"ssh_agent_auth" undocumented:"true" cty:"ssh_agent_auth" hcl:"ssh_agent_auth"`
	SSHDisableAgentForwarding *bool                  `mapstructure:"ssh_disable_agent_forwarding" cty:"ssh_disable_agent_forwarding" hcl:"ssh_disable_agent_forwarding"`
	SSHHandshakeAttempts      *int                   `mapstructure:"ssh_handshake_attempts" cty:"ssh_handshake_attempts" hcl:"ssh_handshake_attempts"`
	SSHBastionHost            *string                `mapstructure:"ssh_bastion_host" cty:"ssh_bastion_host" hcl:"ssh_bastion_host"`
	SSHBastionPort            *int                   `mapstructure:"ssh_bastion_port" cty:"ssh_bastion_port" hcl:"ssh_bastion_port"`
	SSHBastionAgentAuth       *bool                  `mapstructure:"ssh_bastion_agent_auth" cty:"ssh_bastion_agent_auth" hcl:"ssh_bastion_agent_auth"`
	SSHBastionUsername        *string                `mapstructure:"ssh_bastion_username" cty:"ssh_bastion_username" hcl:"ssh_bastion_username"`
	SSHBastionPassword        *string                `mapstructure:"ssh_bastion_password" cty:"ssh_bastion_password" hcl:"ssh_bastion_password"`
	SSHBastionInteractive     *bool                  `mapstructure:"ssh_bastion_interactive" cty:"ssh_bastion_interactive" hcl:"ssh_bastion_interactive"`
	SSHBastionPrivateKeyFile  *string                `mapstructure:"ssh_bastion_private_key_file" cty:"ssh_bastion_private_key_file" hcl:"ssh_bastion_private_key_file"`
	SSHBastionCertificateFile *string                `mapstructure:"ssh_bastion_certificate_file" cty:"ssh_bastion_certificate_file" hcl:"ssh_bastion_certificate_file"`
	SSHFileTransferMethod     *string                `mapstructure:"ssh_file_transfer_method" cty:"ssh_file_transfer_method" hcl:"ssh_file_transfer_method"`
	SSHProxyHost              *string                `mapstructure:"ssh_proxy_host" cty:"ssh_proxy_host" hcl:"ssh_proxy_host"`
	SSHProxyPort              *int                   `mapstructure:"ssh_proxy_port" cty:"ssh_proxy_port" hcl:"ssh_proxy_port"`
	SSHProxyUsername          *string                `mapstructure:"ssh_proxy_username" cty:"ssh_proxy_username" hcl:"ssh_proxy_username"`
	SSHProxyPassword          *string                `mapstructure:"ssh_proxy_password" cty:"ssh_proxy_password" hcl:"ssh_proxy_password"`
	SSHKeepAliveInterval      *string                `mapstructure:"ssh_keep_alive_interval" cty:"ssh_keep_alive_interval" hcl:"ssh_keep_alive_interval"`
	SSHReadWriteTimeout       *string                `mapstructure:"ssh_read_write_timeout" cty:"ssh_read_write_timeout" hcl:"ssh_read_write_timeout"`
	SSHRemoteTunnels          []string               `mapstructure:"ssh_remote_tunnels" cty:"ssh_remote_tunnels" hcl:"ssh_remote_tunnels"`
	SSHLocalTunnels           []string               `mapstructure:"ssh_local_tunnels" cty:"ssh_local_tunnels" hcl:"ssh_local_tunnels"`
	SSHPublicKey              []byte                 `mapstructure:"ssh_public_key" undocumented:"true" cty:"ssh_public_key" hcl:"ssh_public_key"`
	SSHPrivateKey             []byte                 `mapstructure:"ssh_private_key" undocumented:"true" cty:"ssh_private_key" hcl:"ssh_private_key"`
	WinRMUser                 *string                `mapstructure:"winrm_username" cty:"winrm_username" hcl:"winrm_username"`
	WinRMPassword             *string                `mapstructure:"winrm_password" cty:"winrm_password" hcl:"winrm_password"`
	WinRMHost                 *string                `mapstructure:"winrm_host" cty:"winrm_host" hcl:"winrm_host"`
	WinRMNoProxy              *bool                  `mapstructure:"winrm_no_proxy" cty:"winrm_no_proxy" hcl:"winrm_no_proxy"`
	WinRMPort                 *int                   `mapstructure:"winrm_port" cty:"winrm_port" hcl:"winrm_port"`
	WinRMTimeout              *string                `mapstructure:"winrm_timeout" cty:"winrm_timeout" hcl:"winrm_timeout"`
	WinRMUseSSL               *bool                  `mapstructure:"winrm_use_ssl" cty:"winrm_use_ssl" hcl:"winrm_use_ssl"`
	WinRMInsecure             *bool                  `mapstructure:"winrm_insecure" cty:"winrm_insecure" hcl:"winrm_insecure"`
	WinRMUseNTLM              *bool                  `mapstructure:"winrm_use_ntlm" cty:"winrm_use_ntlm" hcl:"winrm_use_ntlm"`
	Username                  *string                `mapstructure:"username" required:"true" cty:"username" hcl:"username"`
	Password                  *string                `mapstructure:"password" required:"true" cty:"password" hcl:"password"`
	Zone                      *string                `mapstructure:"zone" required:"true" cty:"zone" hcl:"zone"`
	StorageUUID               *string                `mapstructure:"storage_uuid" required:"true" cty:"storage_uuid" hcl:"storage_uuid"`
	StorageName               *string                `mapstructure:"storage_name" cty:"storage_name" hcl:"storage_name"`
	TemplatePrefix            *string                `mapstructure:"template_prefix" cty:"template_prefix" hcl:"template_prefix"`
	TemplateName              *string                `mapstructure:"template_name" cty:"template_name" hcl:"template_name"`
	StorageSize               *int                   `mapstructure:"storage_size" cty:"storage_size" hcl:"storage_size"`
	Timeout                   *string                `mapstructure:"state_timeout_duration" cty:"state_timeout_duration" hcl:"state_timeout_duration"`
	BootWait                  *string                `mapstructure:"boot_wait" cty:"boot_wait" hcl:"boot_wait"`
	CloneZones                []string               `mapstructure:"clone_zones" cty:"clone_zones" hcl:"clone_zones"`
	NetworkInterfaces         []FlatNetworkInterface `mapstructure:"network_interfaces" cty:"network_interfaces" hcl:"network_interfaces"`
	SSHPrivateKeyPath         *string                `mapstructure:"ssh_private_key_path" cty:"ssh_private_key_path" hcl:"ssh_private_key_path"`
	SSHPublicKeyPath          *string                `mapstructure:"ssh_public_key_path" cty:"ssh_public_key_path" hcl:"ssh_public_key_path"`
}

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 FlatIPAddress added in v1.3.0 

type FlatIPAddress struct {
	Default *bool   `mapstructure:"default" cty:"default" hcl:"default"`
	Family  *string `mapstructure:"family" cty:"family" hcl:"family"`
	Address *string `mapstructure:"address,omitempty" cty:"address" hcl:"address"`
}

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

func (*FlatIPAddress) HCL2Spec added in v1.3.0 

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

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

type FlatNetworkInterface added in v1.3.0 

type FlatNetworkInterface struct {
	IPAddresses []FlatIPAddress `mapstructure:"ip_addresses" cty:"ip_addresses" hcl:"ip_addresses"`
	Type        *InterfaceType  `mapstructure:"type" cty:"type" hcl:"type"`
	Network     *string         `mapstructure:"network,omitempty" cty:"network" hcl:"network"`
}

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

func (*FlatNetworkInterface) HCL2Spec added in v1.3.0 

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

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

type IPAddress added in v1.3.0 

type IPAddress struct {
	// Default IP address. When set to `true` SSH communicator will connect to this IP after boot.
	Default bool `mapstructure:"default"`

	// IP address family (IPv4 or IPv6)
	Family string `mapstructure:"family"`

	// IP address. Note that at the moment using floating IPs is not supported.
	Address string `mapstructure:"address,omitempty"`
}

func (*IPAddress) FlatMapstructure added in v1.3.0 

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

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

type InterfaceType added in v1.3.0 

type InterfaceType string

type NetworkInterface added in v1.3.0 

type NetworkInterface struct {
	// List of IP Addresses
	IPAddresses []IPAddress `mapstructure:"ip_addresses"`

	// Network type (e.g. public, utility, private)
	Type InterfaceType `mapstructure:"type"`

	// Network UUID when connecting private network
	Network string `mapstructure:"network,omitempty"`
}

for config type convertion

func (*NetworkInterface) FlatMapstructure added in v1.3.0 

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

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

type StepCreateSSHKey 

type StepCreateSSHKey struct {
	Debug        bool
	DebugKeyPath string
}

StepCreateSSHKey represents the step that creates ssh private and public keys

func (*StepCreateSSHKey) Cleanup 

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

func (*StepCreateSSHKey) Run 

func (s *StepCreateSSHKey) Run(_ context.Context, state multistep.StateBag) multistep.StepAction

Run runs the actual step

type StepCreateServer 

type StepCreateServer struct {
	Config        *Config
	GeneratedData *packerbuilderdata.GeneratedData
}

StepCreateServer represents the step that creates a server

func (*StepCreateServer) Cleanup 

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

Cleanup stops and destroys the server if server details are found in the state

func (*StepCreateServer) Run 

func (s *StepCreateServer) Run(ctx context.Context, state multistep.StateBag) multistep.StepAction

Run runs the actual step

type StepCreateTemplate 

type StepCreateTemplate struct {
	Config        *Config
	GeneratedData *packerbuilderdata.GeneratedData
}

StepCreateTemplate represents the step that creates a storage template from the newly created server

func (*StepCreateTemplate) Cleanup 

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

Cleanup cleans up after the step

func (*StepCreateTemplate) Run 

func (s *StepCreateTemplate) Run(ctx context.Context, state multistep.StateBag) multistep.StepAction

Run runs the actual step

type StepTeardownServer 

type StepTeardownServer struct{}

StepTeardownServer represents the step that stops the server before creating the image

func (*StepTeardownServer) Cleanup 

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

func (*StepTeardownServer) Run 

func (s *StepTeardownServer) Run(ctx context.Context, state multistep.StateBag) multistep.StepAction

Run runs the actual step

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.