linode

package
v1.8.1 Latest Latest
Warning

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

Go to latest
Published: Jan 6, 2026 License: MPL-2.0 Imports: 25 Imported by: 0

Documentation

Overview

The linode package contains a packersdk.Builder implementation that builds Linode images.

Index

Constants

View Source
const BuilderID = "packer.linode"

The unique ID for this builder.

Variables

This section is empty.

Functions

This section is empty.

Types

type Artifact

type Artifact struct {
	ImageID    string
	ImageLabel string

	Driver *linodego.Client

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

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
}

Builder represents a Packer Builder.

func (*Builder) ConfigSpec

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

func (*Builder) Prepare

func (b *Builder) Prepare(raws ...any) ([]string, []string, error)

func (*Builder) Run

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

type Config

type Config struct {
	common.PackerConfig `mapstructure:",squash"`
	helper.LinodeCommon `mapstructure:",squash"`

	Comm communicator.Config `mapstructure:",squash"`

	// Legacy Config Network Interfaces to add to this Linode’s Configuration Profile. Singular repeatable
	// block containing a `purpose`, a `label`, and an `ipam_address` field.
	Interfaces []Interface `mapstructure:"interface" required:"false"`

	// Newer Linode Network Interfaces to add to this Linode.
	LinodeInterfaces []LinodeInterface `mapstructure:"linode_interface" required:"false"`

	// The id of the region to launch the Linode instance in. Images are available in all
	// regions, but there will be less delay when deploying from the region where the image
	// was taken. See [regions](https://api.linode.com/v4/regions) for more information on
	// the available regions. Examples are `us-east`, `us-central`, `us-west`, `ap-south`,
	// `ca-east`, `ap-northeast`, `eu-central`, and `eu-west`.
	Region string `mapstructure:"region" required:"true"`

	// Public SSH keys need to be appended to the Linode instance.
	AuthorizedKeys []string `mapstructure:"authorized_keys" required:"false"`

	// Users whose SSH keys need to be appended to the Linode instance.
	AuthorizedUsers []string `mapstructure:"authorized_users" required:"false"`

	// The Linode type defines the pricing, CPU, disk, and RAM specs of the instance. See
	// [instance types](https://api.linode.com/v4/linode/types) for more information on the
	// available Linode instance types. Examples are `g6-nanode-1`, `g6-standard-2`,
	// `g6-highmem-16`, and `g6-dedicated-16`.
	InstanceType string `mapstructure:"instance_type" required:"true"`

	// The name assigned to the Linode Instance.
	Label string `mapstructure:"instance_label" required:"false"`

	// Tags to apply to the instance when it is created.
	Tags []string `mapstructure:"instance_tags" required:"false"`

	// An Image ID to deploy the Disk from. Official Linode Images start with `linode/`,
	// while user Images start with `private/`. See [images](https://api.linode.com/v4/images)
	// for more information on the Images available for use. Examples are `linode/debian9`,
	// `linode/fedora28`, `linode/ubuntu18.04`, `linode/arch`, and `private/12345`.
	Image string `mapstructure:"image" required:"true"`

	// The disk size (MiB) allocated for swap space.
	SwapSize int `mapstructure:"swap_size" required:"false"`

	// If true, the created Linode will have private networking enabled and assigned
	// a private IPv4 address.
	PrivateIP bool `mapstructure:"private_ip" required:"false"`

	// The root password of the Linode instance for building the image. Please note that when
	// you create a new Linode instance with a private image, you will be required to setup a
	// new root password.
	RootPass string `mapstructure:"root_pass" required:"false"`

	// The name of the resulting image that will appear
	// in your account. Defaults to `packer-{{timestamp}}` (see [configuration
	// templates](/packer/docs/templates/legacy_json_templates/engine) for more info).
	ImageLabel string `mapstructure:"image_label" required:"false"`

	// The description of the resulting image that will appear in your account. Defaults to "".
	Description string `mapstructure:"image_description" required:"false"`

	// The time to wait, as a duration string, for the Linode instance to enter a desired state
	// (such as "running") before timing out. The default state timeout is "5m".
	StateTimeout time.Duration `mapstructure:"state_timeout" required:"false"`

	// This attribute is required only if the StackScript being deployed requires input data from
	// the User for successful completion. See User Defined Fields (UDFs) for more details.
	//
	// This attribute is required to be valid JSON.
	StackScriptData map[string]string `mapstructure:"stackscript_data" required:"false"`

	// A StackScript ID that will cause the referenced StackScript to be run during deployment
	// of this Linode. A compatible image is required to use a StackScript. To get a list of
	// available StackScript and their permitted Images see /stackscripts. This field cannot
	// be used when deploying from a Backup or a Private Image.
	StackScriptID int `mapstructure:"stackscript_id" required:"false"`

	// The time to wait, as a duration string, for the disk image to be created successfully
	// before timing out. The default image creation timeout is "10m".
	ImageCreateTimeout time.Duration `mapstructure:"image_create_timeout" required:"false"`

	// Whether the newly created image supports cloud-init.
	CloudInit bool `mapstructure:"cloud_init" required:"false"`

	// An object containing user-defined data relevant to the creation of Linodes.
	Metadata Metadata `mapstructure:"metadata" required:"false"`

	// The ID of the Firewall to attach this Linode to upon creation.
	FirewallID int `mapstructure:"firewall_id" required:"false"`

	// The regions where the outcome image will be replicated to.
	ImageRegions []string `mapstructure:"image_regions" required:"false"`

	// Specifies the interface type for the Linode. The value can be either
	// `legacy_config` or `linode`. The default value is determined by the
	// `interfaces_for_new_linodes` setting in the account settings.
	InterfaceGeneration string `mapstructure:"interface_generation" 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 ...any) ([]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"`
	PersonalAccessToken       *string               `mapstructure:"linode_token" cty:"linode_token" hcl:"linode_token"`
	APICAPath                 *string               `mapstructure:"api_ca_path" cty:"api_ca_path" hcl:"api_ca_path"`
	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"`
	Interfaces                []FlatInterface       `mapstructure:"interface" required:"false" cty:"interface" hcl:"interface"`
	LinodeInterfaces          []FlatLinodeInterface `mapstructure:"linode_interface" required:"false" cty:"linode_interface" hcl:"linode_interface"`
	Region                    *string               `mapstructure:"region" required:"true" cty:"region" hcl:"region"`
	AuthorizedKeys            []string              `mapstructure:"authorized_keys" required:"false" cty:"authorized_keys" hcl:"authorized_keys"`
	AuthorizedUsers           []string              `mapstructure:"authorized_users" required:"false" cty:"authorized_users" hcl:"authorized_users"`
	InstanceType              *string               `mapstructure:"instance_type" required:"true" cty:"instance_type" hcl:"instance_type"`
	Label                     *string               `mapstructure:"instance_label" required:"false" cty:"instance_label" hcl:"instance_label"`
	Tags                      []string              `mapstructure:"instance_tags" required:"false" cty:"instance_tags" hcl:"instance_tags"`
	Image                     *string               `mapstructure:"image" required:"true" cty:"image" hcl:"image"`
	SwapSize                  *int                  `mapstructure:"swap_size" required:"false" cty:"swap_size" hcl:"swap_size"`
	PrivateIP                 *bool                 `mapstructure:"private_ip" required:"false" cty:"private_ip" hcl:"private_ip"`
	RootPass                  *string               `mapstructure:"root_pass" required:"false" cty:"root_pass" hcl:"root_pass"`
	ImageLabel                *string               `mapstructure:"image_label" required:"false" cty:"image_label" hcl:"image_label"`
	Description               *string               `mapstructure:"image_description" required:"false" cty:"image_description" hcl:"image_description"`
	StateTimeout              *string               `mapstructure:"state_timeout" required:"false" cty:"state_timeout" hcl:"state_timeout"`
	StackScriptData           map[string]string     `mapstructure:"stackscript_data" required:"false" cty:"stackscript_data" hcl:"stackscript_data"`
	StackScriptID             *int                  `mapstructure:"stackscript_id" required:"false" cty:"stackscript_id" hcl:"stackscript_id"`
	ImageCreateTimeout        *string               `mapstructure:"image_create_timeout" required:"false" cty:"image_create_timeout" hcl:"image_create_timeout"`
	CloudInit                 *bool                 `mapstructure:"cloud_init" required:"false" cty:"cloud_init" hcl:"cloud_init"`
	Metadata                  *FlatMetadata         `mapstructure:"metadata" required:"false" cty:"metadata" hcl:"metadata"`
	FirewallID                *int                  `mapstructure:"firewall_id" required:"false" cty:"firewall_id" hcl:"firewall_id"`
	ImageRegions              []string              `mapstructure:"image_regions" required:"false" cty:"image_regions" hcl:"image_regions"`
	InterfaceGeneration       *string               `mapstructure:"interface_generation" required:"false" cty:"interface_generation" hcl:"interface_generation"`
}

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 FlatInterface added in v1.1.0

type FlatInterface struct {
	Label       *string            `mapstructure:"label" cty:"label" hcl:"label"`
	IPAMAddress *string            `mapstructure:"ipam_address" cty:"ipam_address" hcl:"ipam_address"`
	SubnetID    *int               `mapstructure:"subnet_id" cty:"subnet_id" hcl:"subnet_id"`
	IPv4        *FlatInterfaceIPv4 `mapstructure:"ipv4" cty:"ipv4" hcl:"ipv4"`
	IPRanges    []string           `mapstructure:"ip_ranges" cty:"ip_ranges" hcl:"ip_ranges"`
	Purpose     *string            `mapstructure:"purpose" required:"true" cty:"purpose" hcl:"purpose"`
	Primary     *bool              `mapstructure:"primary" cty:"primary" hcl:"primary"`
}

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

func (*FlatInterface) HCL2Spec added in v1.1.0

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

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

type FlatInterfaceDefaultRoute added in v1.8.0

type FlatInterfaceDefaultRoute struct {
	IPv4 *bool `mapstructure:"ipv4" required:"false" cty:"ipv4" hcl:"ipv4"`
	IPv6 *bool `mapstructure:"ipv6" required:"false" cty:"ipv6" hcl:"ipv6"`
}

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

func (*FlatInterfaceDefaultRoute) HCL2Spec added in v1.8.0

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

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

type FlatInterfaceIPv4 added in v1.2.0

type FlatInterfaceIPv4 struct {
	VPC     *string `mapstructure:"vpc" cty:"vpc" hcl:"vpc"`
	NAT1To1 *string `mapstructure:"nat_1_1" cty:"nat_1_1" hcl:"nat_1_1"`
}

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

func (*FlatInterfaceIPv4) HCL2Spec added in v1.2.0

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

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

type FlatLinodeInterface added in v1.8.0

type FlatLinodeInterface struct {
	FirewallID   *int                       `mapstructure:"firewall_id" required:"false" cty:"firewall_id" hcl:"firewall_id"`
	DefaultRoute *FlatInterfaceDefaultRoute `mapstructure:"default_route" required:"false" cty:"default_route" hcl:"default_route"`
	Public       *FlatPublicInterface       `mapstructure:"public" required:"false" cty:"public" hcl:"public"`
	VPC          *FlatVPCInterface          `mapstructure:"vpc" required:"false" cty:"vpc" hcl:"vpc"`
	VLAN         *FlatVLANInterface         `mapstructure:"vlan" required:"false" cty:"vlan" hcl:"vlan"`
}

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

func (*FlatLinodeInterface) HCL2Spec added in v1.8.0

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

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

type FlatMetadata added in v1.5.0

type FlatMetadata struct {
	UserData *string `mapstructure:"user_data" cty:"user_data" hcl:"user_data"`
}

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

func (*FlatMetadata) HCL2Spec added in v1.5.0

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

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

type FlatPublicInterface added in v1.8.0

type FlatPublicInterface struct {
	IPv4 *FlatPublicInterfaceIPv4 `mapstructure:"ipv4" required:"false" cty:"ipv4" hcl:"ipv4"`
	IPv6 *FlatPublicInterfaceIPv6 `mapstructure:"ipv6" required:"false" cty:"ipv6" hcl:"ipv6"`
}

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

func (*FlatPublicInterface) HCL2Spec added in v1.8.0

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

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

type FlatPublicInterfaceIPv4 added in v1.8.0

type FlatPublicInterfaceIPv4 struct {
	Addresses []FlatPublicInterfaceIPv4Address `mapstructure:"address" required:"false" cty:"address" hcl:"address"`
}

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

func (*FlatPublicInterfaceIPv4) HCL2Spec added in v1.8.0

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

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

type FlatPublicInterfaceIPv4Address added in v1.8.0

type FlatPublicInterfaceIPv4Address struct {
	Address *string `mapstructure:"address" required:"true" cty:"address" hcl:"address"`
	Primary *bool   `mapstructure:"primary" required:"false" cty:"primary" hcl:"primary"`
}

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

func (*FlatPublicInterfaceIPv4Address) HCL2Spec added in v1.8.0

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

type FlatPublicInterfaceIPv6 added in v1.8.0

type FlatPublicInterfaceIPv6 struct {
	Ranges []FlatPublicInterfaceIPv6Range `mapstructure:"ranges" required:"false" cty:"ranges" hcl:"ranges"`
}

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

func (*FlatPublicInterfaceIPv6) HCL2Spec added in v1.8.0

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

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

type FlatPublicInterfaceIPv6Range added in v1.8.0

type FlatPublicInterfaceIPv6Range struct {
	Range *string `mapstructure:"range" required:"true" cty:"range" hcl:"range"`
}

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

func (*FlatPublicInterfaceIPv6Range) HCL2Spec added in v1.8.0

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

type FlatVLANInterface added in v1.8.0

type FlatVLANInterface struct {
	VLANLabel   *string `mapstructure:"vlan_label" required:"true" cty:"vlan_label" hcl:"vlan_label"`
	IPAMAddress *string `mapstructure:"ipam_address" required:"false" cty:"ipam_address" hcl:"ipam_address"`
}

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

func (*FlatVLANInterface) HCL2Spec added in v1.8.0

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

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

type FlatVPCInterface added in v1.8.0

type FlatVPCInterface struct {
	SubnetID *int                  `mapstructure:"subnet_id" required:"true" cty:"subnet_id" hcl:"subnet_id"`
	IPv4     *FlatVPCInterfaceIPv4 `mapstructure:"ipv4" required:"false" cty:"ipv4" hcl:"ipv4"`
}

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

func (*FlatVPCInterface) HCL2Spec added in v1.8.0

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

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

type FlatVPCInterfaceIPv4 added in v1.8.0

type FlatVPCInterfaceIPv4 struct {
	Addresses []FlatVPCInterfaceIPv4Address `mapstructure:"addresses" required:"false" cty:"addresses" hcl:"addresses"`
	Ranges    []FlatVPCInterfaceIPv4Range   `mapstructure:"ranges" required:"false" cty:"ranges" hcl:"ranges"`
}

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

func (*FlatVPCInterfaceIPv4) HCL2Spec added in v1.8.0

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

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

type FlatVPCInterfaceIPv4Address added in v1.8.0

type FlatVPCInterfaceIPv4Address struct {
	Address        *string `mapstructure:"address" required:"true" cty:"address" hcl:"address"`
	Primary        *bool   `mapstructure:"primary" required:"false" cty:"primary" hcl:"primary"`
	NAT1To1Address *string `mapstructure:"nat_1_1_address" required:"false" cty:"nat_1_1_address" hcl:"nat_1_1_address"`
}

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

func (*FlatVPCInterfaceIPv4Address) HCL2Spec added in v1.8.0

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

type FlatVPCInterfaceIPv4Range added in v1.8.0

type FlatVPCInterfaceIPv4Range struct {
	Range *string `mapstructure:"range" required:"true" cty:"range" hcl:"range"`
}

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

func (*FlatVPCInterfaceIPv4Range) HCL2Spec added in v1.8.0

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

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

type Interface added in v1.1.0

type Interface struct {
	VLANInterfaceAttributes `mapstructure:",squash"`
	VPCInterfaceAttributes  `mapstructure:",squash"`

	// The purpose of this interface. (public, vlan, vpc)
	Purpose string `mapstructure:"purpose" required:"true"`

	// Whether this interface is a primary interface.
	Primary bool `mapstructure:"primary"`
}

func (*Interface) FlatMapstructure added in v1.1.0

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

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

type InterfaceDefaultRoute added in v1.8.0

type InterfaceDefaultRoute struct {
	// Whether this interface is used for the IPv4 default route.
	IPv4 *bool `mapstructure:"ipv4" required:"false"`

	// Whether this interface is used for the IPv6 default route.
	IPv6 *bool `mapstructure:"ipv6" required:"false"`
}

func (*InterfaceDefaultRoute) FlatMapstructure added in v1.8.0

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

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

type InterfaceIPv4 added in v1.2.0

type InterfaceIPv4 struct {
	// The IPv4 address from the VPC subnet to use for this interface.
	VPC string `mapstructure:"vpc"`

	// The public IPv4 address assigned to this Linode to be 1:1 NATed with the VPC IPv4 address.
	NAT1To1 *string `mapstructure:"nat_1_1"`
}

func (*InterfaceIPv4) FlatMapstructure added in v1.2.0

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

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

type LinodeInterface added in v1.8.0

type LinodeInterface struct {
	// The enabled firewall to secure a VPC or public interface. Not allowed for VLAN interfaces.
	FirewallID *int `mapstructure:"firewall_id" required:"false"`

	// Indicates if the interface serves as the default route when multiple interfaces are
	// eligible for this role.
	DefaultRoute *InterfaceDefaultRoute `mapstructure:"default_route" required:"false"`

	// Public interface settings. A Linode can have only one public interface.
	// A public interface can have both IPv4 and IPv6 configurations.
	Public *PublicInterface `mapstructure:"public" required:"false"`

	// VPC interface settings.
	VPC *VPCInterface `mapstructure:"vpc" required:"false"`

	// VLAN interface settings.
	VLAN *VLANInterface `mapstructure:"vlan" required:"false"`
}

func (*LinodeInterface) FlatMapstructure added in v1.8.0

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

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

type Metadata added in v1.5.0

type Metadata struct {
	// Base64-encoded (cloud-config)[https://www.linode.com/docs/products/compute/compute-instances/guides/metadata-cloud-config/] data.
	UserData string `mapstructure:"user_data"`
}

func (*Metadata) FlatMapstructure added in v1.5.0

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

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

type PublicInterface added in v1.8.0

type PublicInterface struct {
	// IPv4 address settings for this public interface. If omitted,
	// a public IPv4 address is automatically allocated.
	IPv4 *PublicInterfaceIPv4 `mapstructure:"ipv4" required:"false"`

	// IPv6 address settings for the public interface.
	IPv6 *PublicInterfaceIPv6 `mapstructure:"ipv6" required:"false"`
}

func (*PublicInterface) FlatMapstructure added in v1.8.0

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

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

type PublicInterfaceIPv4 added in v1.8.0

type PublicInterfaceIPv4 struct {
	// Blocks of IPv4 addresses to assign to this interface. Setting any to auto
	// allocates a public IPv4 address.
	Addresses []PublicInterfaceIPv4Address `mapstructure:"address" required:"false"`
}

func (*PublicInterfaceIPv4) FlatMapstructure added in v1.8.0

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

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

type PublicInterfaceIPv4Address added in v1.8.0

type PublicInterfaceIPv4Address struct {
	// The interface's public IPv4 address. You can specify which public IPv4
	// address to configure for the interface. Setting this to auto automatically
	// allocates a public address.
	Address *string `mapstructure:"address" required:"true"`

	// The IPv4 primary address configures the source address for routes within
	// the Linode on the corresponding network interface.
	//
	// - Don't set this to false if there's only one address in the addresses array.
	// - If more than one address is provided, primary can be set to true for one address.
	// - If only one address is present in the addresses array, this address is automatically set as the primary address.
	Primary *bool `mapstructure:"primary" required:"false"`
}

func (*PublicInterfaceIPv4Address) FlatMapstructure added in v1.8.0

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

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

type PublicInterfaceIPv6 added in v1.8.0

type PublicInterfaceIPv6 struct {
	// IPv6 address ranges to assign to this interface. If omitted, no ranges are assigned.
	Ranges []PublicInterfaceIPv6Range `mapstructure:"ranges" required:"false"`
}

func (*PublicInterfaceIPv6) FlatMapstructure added in v1.8.0

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

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

type PublicInterfaceIPv6Range added in v1.8.0

type PublicInterfaceIPv6Range struct {
	// Your assigned IPv6 range in CIDR notation (2001:0db8::1/64) or prefix (/64).
	//
	// - The prefix of /64 or /56 block of IPv6 addresses.
	// - If provided in CIDR notation, the prefix must be within the assigned ranges for the Linode.
	Range string `mapstructure:"range" required:"true"`
}

func (*PublicInterfaceIPv6Range) FlatMapstructure added in v1.8.0

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

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

type StepCreateSSHKey

type StepCreateSSHKey struct {
	Debug        bool
	DebugKeyPath string
}

StepCreateSSHKey represents a Packer build step that generates SSH key pairs.

func (*StepCreateSSHKey) Cleanup

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

Nothing to clean up. SSH keys are associated with a single Linode instance.

func (*StepCreateSSHKey) Run

Run executes the Packer build step that generates SSH key pairs. The key pairs are added to the ssh config

type VLANInterface added in v1.8.0

type VLANInterface struct {
	// The VLAN's unique label. VLAN interfaces on the same Linode must have a unique `vlan_label`.
	VLANLabel string `mapstructure:"vlan_label" required:"true"`

	// This VLAN interface's private IPv4 address in classless inter-domain routing (CIDR) notation.
	IPAMAddress *string `mapstructure:"ipam_address" required:"false"`
}

func (*VLANInterface) FlatMapstructure added in v1.8.0

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

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

type VLANInterfaceAttributes added in v1.5.1

type VLANInterfaceAttributes struct {
	// The label of the VLAN this interface relates to.
	Label string `mapstructure:"label"`

	// This Network Interface’s private IP address in CIDR notation.
	IPAMAddress string `mapstructure:"ipam_address"`
}

type VPCInterface added in v1.8.0

type VPCInterface struct {
	// The VPC subnet identifier for this interface. Your subnet’s VPC must be in
	// the same data center (region) as the Linode.
	SubnetID int `mapstructure:"subnet_id" required:"true"`

	// Interfaces can be configured with IPv4 addresses or ranges.
	IPv4 *VPCInterfaceIPv4 `mapstructure:"ipv4" required:"false"`
}

func (*VPCInterface) FlatMapstructure added in v1.8.0

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

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

type VPCInterfaceAttributes added in v1.5.1

type VPCInterfaceAttributes struct {
	// The ID of the VPC Subnet this interface references.
	SubnetID *int `mapstructure:"subnet_id"`

	// The IPv4 configuration of this VPC interface.
	IPv4 *InterfaceIPv4 `mapstructure:"ipv4"`

	// The IPv4 ranges of this VPC interface.
	IPRanges []string `mapstructure:"ip_ranges"`
}

type VPCInterfaceIPv4 added in v1.8.0

type VPCInterfaceIPv4 struct {
	// IPv4 address settings for this VPC interface.
	Addresses []VPCInterfaceIPv4Address `mapstructure:"addresses" required:"false"`

	// VPC IPv4 ranges.
	Ranges []VPCInterfaceIPv4Range `mapstructure:"ranges" required:"false"`
}

func (*VPCInterfaceIPv4) FlatMapstructure added in v1.8.0

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

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

type VPCInterfaceIPv4Address added in v1.8.0

type VPCInterfaceIPv4Address struct {
	// Specifies which IPv4 address to use in the VPC subnet. You can specify which
	// VPC Ipv4 address in the subnet to configure for the interface. You can't use
	// an IPv4 address taken from another Linode or interface, or the first two or
	// last two addresses in the VPC subnet. When address is set to `auto`, an IP
	// address from the subnet is automatically assigned.
	Address *string `mapstructure:"address" required:"true"`

	// The IPv4 primary address is used to configure the source address for routes
	// within the Linode on the corresponding network interface.
	Primary *bool `mapstructure:"primary" required:"false"`

	// The 1:1 NAT IPv4 address used to associate a public IPv4 address with the
	// interface's VPC subnet IPv4 address.
	NAT1To1Address *string `mapstructure:"nat_1_1_address" required:"false"`
}

func (*VPCInterfaceIPv4Address) FlatMapstructure added in v1.8.0

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

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

type VPCInterfaceIPv4Range added in v1.8.0

type VPCInterfaceIPv4Range struct {
	// VPC IPv4 ranges.
	Range string `mapstructure:"range" required:"true"`
}

func (*VPCInterfaceIPv4Range) FlatMapstructure added in v1.8.0

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

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

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL