HashiConf 2025 Don't miss the live stream of HashiConf Day 2 happening now View live stream
Packer
Packer Integrations
Linode

@linode

Create Linode Images for use with Linode.

  • Partner
  • HCP Ready

Updated 3 years ago

Linode

Type: linode Artifact BuilderId: packer.linode

The linode Packer builder is able to create Linode Images for use with Linode. The builder takes a source image, runs any provisioning necessary on the image after launching it, then snapshots it into a reusable image. This reusable image can then be used as the foundation of new servers that are launched within Linode.

The builder does not manage images. Once it creates an image, it is up to you to use it or delete it.

Configuration Reference

There are many configuration options available for the builder. They are segmented below into two categories: required and optional parameters. Within each category, the available configuration keys are alphabetized.

In addition to the options listed here, a communicator can be configured for this builder. In addition to the options defined there, a private key file can also be supplied to override the typical auto-generated key:

  • ssh_private_key_file (string) - Path to a PEM encoded private key file to use to authenticate with SSH. The ~ can be used in path and will be expanded to the home directory of current user.

Required

  • linode_token (string) - The Linode API token required for provision Linode resources. This can also be specified in LINODE_TOKEN environment variable. Saving the token in the environment or centralized vaults can reduce the risk of the token being leaked from the codebase. images:read_write, linodes:read_write, and events:read_only scopes are required for the API token.

  • api_ca_path (string) - The path to a CA file to trust when making API requests. It can also be specified using the LINODE_CA environment variable.

  • region (string) - 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 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.

  • instance_type (string) - The Linode type defines the pricing, CPU, disk, and RAM specs of the instance. See instance 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.

  • image (string) - An Image ID to deploy the Disk from. Official Linode Images start with linode/, while user Images start with private/. See images for more information on the Images available for use. Examples are linode/debian9, linode/fedora28, linode/ubuntu18.04, linode/arch, and private/12345.

Optional

  • interface ([]Interface) - 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.

  • linode_interface ([]LinodeInterface) - Newer Linode Network Interfaces to add to this Linode.

  • authorized_keys ([]string) - Public SSH keys need to be appended to the Linode instance.

  • authorized_users ([]string) - Users whose SSH keys need to be appended to the Linode instance.

  • instance_label (string) - The name assigned to the Linode Instance.

  • instance_tags ([]string) - Tags to apply to the instance when it is created.

  • swap_size (int) - The disk size (MiB) allocated for swap space.

  • private_ip (bool) - If true, the created Linode will have private networking enabled and assigned a private IPv4 address.

  • root_pass (string) - 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.

  • image_label (string) - The name of the resulting image that will appear in your account. Defaults to packer-{{timestamp}} (see configuration templates for more info).

  • image_description (string) - The description of the resulting image that will appear in your account. Defaults to "".

  • state_timeout (duration string | ex: "1h5m2s") - 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".

  • stackscript_data (map[string]string) - 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.

  • stackscript_id (int) - 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.

  • image_create_timeout (duration string | ex: "1h5m2s") - 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".

  • cloud_init (bool) - Whether the newly created image supports cloud-init.

  • metadata (Metadata) - An object containing user-defined data relevant to the creation of Linodes.

  • firewall_id (int) - The ID of the Firewall to attach this Linode to upon creation.

  • image_regions ([]string) - The regions where the outcome image will be replicated to.

  • interface_generation (string) - 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.

Linode Interface

This section outlines the fields configurable for a newer Linode interface object.

  • firewall_id (*int) - The enabled firewall to secure a VPC or public interface. Not allowed for VLAN interfaces.

  • default_route (*InterfaceDefaultRoute) - Indicates if the interface serves as the default route when multiple interfaces are eligible for this role.

  • public (*PublicInterface) - Public interface settings. A Linode can have only one public interface. A public interface can have both IPv4 and IPv6 configurations.

  • vpc (*VPCInterface) - VPC interface settings.

  • vlan (*VLANInterface) - VLAN interface settings.

Linode Interface Default Route configuration object (InterfaceDefaultRoute)
Optional

  • ipv4 (*bool) - Whether this interface is used for the IPv4 default route.

  • ipv6 (*bool) - Whether this interface is used for the IPv6 default route.

Public Linode Interface configuration object (PublicInterface)
Optional

  • ipv4 (*PublicInterfaceIPv4) - IPv4 address settings for this public interface. If omitted, a public IPv4 address is automatically allocated.

  • ipv6 (*PublicInterfaceIPv6) - IPv6 address settings for the public interface.

Public Linode Interface IPv4 configuration object (PublicInterfaceIPv4)
Optional
  • address ([]PublicInterfaceIPv4Address) - Blocks of IPv4 addresses to assign to this interface. Setting any to auto allocates a public IPv4 address.
Public Linode Interface IPv4 Address configuration object (PublicInterfaceIPv4Address)
Required
  • address (*string) - 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.
Optional

  • primary (*bool) - 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.
Public Linode Interface IPv6 configuration object (PublicInterfaceIPv6)
Optional
  • ranges ([]PublicInterfaceIPv6Range) - IPv6 address ranges to assign to this interface. If omitted, no ranges are assigned.
Public Linode Interface IPv6 Range configuration object (PublicInterfaceIPv6Range)
Required

  • range (string) - 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.
VPC Linode Interface configuration object (VPCInterface)
Required
  • subnet_id (int) - The VPC subnet identifier for this interface. Your subnet’s VPC must be in the same data center (region) as the Linode.
Optional
  • ipv4 (*VPCInterfaceIPv4) - Interfaces can be configured with IPv4 addresses or ranges.
VPC Linode Interface IPv4 configuration object (VPCInterfaceIPv4)
Optional

  • addresses ([]VPCInterfaceIPv4Address) - IPv4 address settings for this VPC interface.

  • ranges ([]VPCInterfaceIPv4Range) - VPC IPv4 ranges.

VPC Linode Interface IPv4 Address configuration object (VPCInterfaceIPv4Address)
Required
  • address (*string) - 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.
Optional

  • primary (*bool) - The IPv4 primary address is used to configure the source address for routes within the Linode on the corresponding network interface.

  • nat_1_1_address (*string) - The 1:1 NAT IPv4 address used to associate a public IPv4 address with the interface's VPC subnet IPv4 address.

VPC Linode Interface IPv4 Range configuration object (VPCInterfaceIPv4Range)
Required
  • range (string) - VPC IPv4 ranges.
VLAN Linode Interface configuration object (VLANInterface)
Required
  • vlan_label (string) - The VLAN's unique label. VLAN interfaces on the same Linode must have a unique vlan_label.
Optional
  • ipam_address (*string) - This VLAN interface's private IPv4 address in classless inter-domain routing (CIDR) notation.

Legacy Config Interface

This section outlines the fields configurable for a single legacy config interface object.

Required Config Interface Common Attributes
  • purpose (string) - The purpose of this interface. (public, vlan, vpc)
Optional Config Interface Common Attributes
  • primary (bool) - Whether this interface is a primary interface.
VLAN-specific Attributes

  • label (string) - The label of the VLAN this interface relates to.

  • ipam_address (string) - This Network Interface’s private IP address in CIDR notation.

VPC-specific Attributes

  • subnet_id (*int) - The ID of the VPC Subnet this interface references.

  • ipv4 (*InterfaceIPv4) - The IPv4 configuration of this VPC interface.

  • ip_ranges ([]string) - The IPv4 ranges of this VPC interface.

VPC Config Interface IPv4 configuration object (InterfaceIPv4)

  • vpc (string) - The IPv4 address from the VPC subnet to use for this interface.

  • nat_1_1 (*string) - The public IPv4 address assigned to this Linode to be 1:1 NATed with the VPC IPv4 address.

Metadata

This section outlines the fields configurable for a single metadata object.

  • user_data (string) - Base64-encoded (cloud-config)[https://www.linode.com/docs/products/compute/compute-instances/guides/metadata-cloud-config/] data.

Examples

Basic Example

Here is a Linode builder example. The linode_token should be replaced with an actual Linode Personal Access Token or in the config file or the environmental variable, LINODE_TOKEN.

HCL2


locals { timestamp = regex_replace(timestamp(), "[- TZ:]", "") }

source "linode" "example" {
  image             = "linode/debian11"
  image_description = "My Private Image"
  image_label       = "private-image-${local.timestamp}"
  instance_label    = "temporary-linode-${local.timestamp}"
  instance_type     = "g6-nanode-1"
  linode_token      = "YOUR API TOKEN"
  region            = "us-mia"
  ssh_username      = "root"
}

build {
  sources = ["source.linode.example"]
}

JSON

{
  "source": {
    "linode": {
      "example": {
        "image": "linode/debian11",
        "linode_token": "YOUR API TOKEN",
        "region": "us-mia",
        "instance_type": "g6-nanode-1",
        "instance_label": "temporary-linode-{{timestamp}}",
        "image_label": "private-image-{{timestamp}}",
        "image_description": "My Private Image",
        "ssh_username": "root"
      }
    }
  },
  "build": {
    "sources": [
      "source.linode.example"
    ]
  }
}

Complicated Example

HCL2


locals { timestamp = regex_replace(timestamp(), "[- TZ:]", "") }

source "linode" "example" {
  image             = "linode/debian11"
  image_description = "My Private Image"
  image_label       = "private-image-${local.timestamp}"
  instance_label    = "temporary-linode-${local.timestamp}"
  instance_type     = "g6-nanode-1"
  linode_token      = "YOUR API TOKEN"
  region            = "us-mia"
  ssh_username      = "root"
  private_ip        = true
  firewall_id       = 12345

  instance_tags     = ["abc", "foo=bar"]
  authorized_users  = ["your_authorized_username"]
  authorized_keys   = ["ssh-rsa AAAA_valid_public_ssh_key_123456785== user@their-computer"]
  stackscript_id    = 1177256
  stackscript_data  = {
    "test_key": "test_value_1"
  }

  interface {
    purpose       = "public"
  }

  interface {
    purpose       = "vpc"
    subnet_id     = 123
    ipv4 {
        vpc = "10.0.0.2"
        nat_1_1 = "any"
    }
  }

  metadata {
    user_data = base64encode(<<EOF
#cloud-config

write_files:
  - path: /root/helloworld.txt
    content: |
      Hello, world!
    owner: 'root:root'
    permissions: '0644'
EOF
)
  }
}

build {
  sources = ["source.linode.example"]
}

JSON

{
  "source": {
    "linode": {
      "example": {
        "image": "linode/debian11",
        "region": "us-southeast",
        "instance_type": "g6-nanode-1",
        "instance_label": "temporary-linode-{{timestamp}}",
        "private_ip": true,
        "image_label": "private-image-{{timestamp}}",
        "image_description": "My Private Image",
        "ssh_username": "root",
        "authorized_users": [
          "your_authorized_username"
        ],
        "authorized_keys": [
          "ssh-rsa AAAA_valid_public_ssh_key_123456785== user@their-computer"
        ],
        "stackscript_id": 123,
        "stackscript_data": {
          "test_data": "test_value"
        },
        "interface": [
          {
            "purpose": "public",
            "label": "",
            "ipam_address": ""
          },
          {
            "purpose": "vlan",
            "label": "vlan-1",
            "ipam_address": "10.0.0.1/24"
          },
          {
            "purpose": "vlan",
            "label": "vlan-2",
            "ipam_address": "10.0.0.2/24"
          }
        ]
      }
    }
  },
  "build": {
    "sources": [
      "source.linode.example"
    ]
  }
}

Linode Interface Example

HCL2

locals { timestamp = regex_replace(timestamp(), "[- TZ:]", "") }

source "linode" "example" {
  image             = "linode/ubuntu24.04"
  image_description = "My Private Image"
  image_label       = "private-image-${local.timestamp}"
  instance_label    = "temporary-linode-${local.timestamp}"
  instance_type     = "g6-standard-1"
  region            = "us-mia"
  ssh_username      = "root"
  interface_generation = "linode"

  linode_interface {
    firewall_id = 12345
    public {
      ipv4 {
        address {
          address = "auto"
          primary = true
        }
      }
    }
  }
}

build {
  sources = ["source.linode.example"]
}

JSON

{
  "source": {
    "linode": {
      "example": {
        "image": "linode/ubuntu24.04",
        "linode_token": "YOUR API TOKEN",
        "region": "us-mia",
        "instance_type": "g6-nanode-1",
        "instance_label": "temporary-linode-{{timestamp}}",
        "image_label": "private-image-{{timestamp}}",
        "image_description": "My Private Image",
        "ssh_username": "root",
        "interface_generation": "linode",
        "linode_interface": {
          "firewall_id": 2930969,
          "public": {
            "ipv4": {
              "addresses": [
                {
                  "address": "auto",
                  "primary": true
                }
              ]
            }
          }
        }
      }
    }
  },
  "build": {
    "sources": [
      "source.linode.example"
    ]
  }
}