RFD 574 Packer Plugin

acctest.TestPlugin(t, &acctest.PluginTestCase{
	Name: "TestPlugin",
	Type: "oxide-instance",
	Setup: func() error {
        // Set up testing resources.
	},
	Check: func(*exec.Cmd, string) error {
        // Assert Packer plugin functionality.
	},
	Teardown: func() error {,
        // Clean up testing resources.
    }
	Template: renderPackerTemplate("template.pkr.hcl.tmpl"),
})

type Config struct {
    // Common Packer configuration that applies to all builders.
	common.PackerConfig `mapstructure:",squash"`

	// Packer communicator configuration to configure how Packer connects to the
	// instance for provisioning.
	Comm communicator.Config `mapstructure:",squash"`

	// Oxide API URL (e.g., `https://oxide.sys.example.com`). If not specified, this
	// defaults to the value of the `OXIDE_HOST` environment variable.
	Host string `mapstructure:"host" required:"true"`

	// Oxide API token. If not specified, this defaults to the value of the
	// `OXIDE_TOKEN` environment variable.
	Token string `mapstructure:"token" required:"true"`

	// Image ID to use for the instance's boot disk. This can be obtained from the
	// `oxide-image` data source.
	BootDiskImageID string `mapstructure:"boot_disk_image_id" required:"true"`

	// Name or ID of the project where the temporary instance and resulting image
	// will be created.
	Project string `mapstructure:"project" required:"true"`
}

var _ packer.Builder = (*Builder)(nil)

type Builder struct{}

func (b *Builder) ConfigSpec() hcldec.ObjectSpec {
  // Generate the builder configuration specification.
}

func (b *Builder) Prepare(...interface{}) ([]string, []string, error) {
  // Prepare the builder configuration.
}

func (b *Builder) Run(context.Context, packer.Ui, packer.Hook) (packer.Artifact, error) {
  // Run the steps necessary to create an Oxide image.
}

pluginSet.RegisterBuilder("instance", new(instance.Builder))

type Config struct {
	// Oxide API URL (e.g., `https://oxide.sys.example.com`). If not specified, this
	// defaults to the value of the `OXIDE_HOST` environment variable.
	Host string `mapstructure:"host" required:"true"`

	// Oxide API token. If not specified, this defaults to the value of the
	// `OXIDE_TOKEN` environment variable.
	Token string `mapstructure:"token" required:"true"`

	// Name of the image to fetch.
	Name string `mapstructure:"name" required:"true"`

	// Name or ID of the project containing the image to fetch. Leave blank to fetch
	// a silo image instead of a project image.
	Project string `mapstructure:"project"`
}

var _ packer.Datasource = (*Datasource)(nil)

type Datasource struct{}

func (d *DatasourceV2) ConfigSpec() hcldec.ObjectSpec {
  // Generate the data source configuration specification.
}

func (d *DatasourceV2) Configure(...interface{}) error {
  // Configure the data source configuration.
}

func (d *DatasourceV2) Execute() (cty.Value, error) {
  // Run the steps necessary to retrieve Oxide image information.
}

func (d *DatasourceV2) OutputSpec() hcldec.ObjectSpec {
  // Generate the data source output specification.
}

pluginSet.RegisterDatasource("image", new(image.Datasource))

packer {
  required_plugins {
    oxide = {
      version = ">= 0.1.0"
      source  = "github.com/oxidecomputer/oxide"
    }
  }
}

# Data source component.
data "oxide-image" "ubuntu" {
  name = "noble"
}

# Builder component.
source "oxide-instance" "example" {
  project            = "packer-acc-test"
  boot_disk_image_id = data.oxide-image.ubuntu.image_id

  # SSH communicator configuration.
  ssh_username = "ubuntu"
}

# Build pipeline definition.
build {
  sources = [
    "source.oxide-instance.example",
  ]
}

# Bash
export OXIDE_HOST='https://oxide.sys.example.com'
export OXIDE_TOKEN='oxide-token-XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX'

# Fish
set --export OXIDE_HOST 'https://oxide.sys.example.com'
set --export OXIDE_TOKEN 'oxide-token-XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX'

> packer init template.pkr.hcl
Installed plugin github.com/oxidecomputer/oxide v0.1.0 in "/home/oxide/.config/packer/plugins/github.com/oxidecomputer/oxide/packer-plugin-oxide_v0.1.0_x5.0_linux_amd64"

> packer build template.pkr.hcl
oxide-instance.example: output will be in this color.
# ...
Build 'oxide-instance.example' finished after 38 seconds 976 milliseconds.

==> Wait completed after 38 seconds 976 milliseconds

==> Builds finished. The artifacts of successful builds are:
--> oxide-instance.example: packer-1751062438

source "oxide-instance" "example" {}
source "vmware-iso" "example" {}
source "amazon-ebs" "example" {}

build {
  sources = [
    "source.oxide-instance.example",
    "source.vmware-iso.example",
    "source.amazon-ebs.example",
  ]
}

data "oxide-image" "ubuntu" {
  name = "noble"
}

source "oxide-instance" "example" {
  project            = "packer-acc-test"
  boot_disk_image_id = data.oxide-image.ubuntu.image_id

  # SSH communicator configuration.
  ssh_username = "ubuntu"
}

build {
  sources = [
    "source.oxide-instance.example",
  ]

  # Install packages.
  provisioner "shell" {
    inline = [
	  "sudo apt-get update",
	  "sudo apt-get install -y ca-certificates",
	]
  }

  # Packer recommends using a 2-step workflow for uploading files.

  # 1) Upload the file to a location the provisioning user has access to.
  provisioner "file" {
    content     = "Hello from Packer!"
    destination = "/tmp/hello.txt"
  }

  # 2) Use the shell provisioner to move the files and set permissions.
  provisioner "shell" {
    inline = [
      "sudo cp /tmp/hello.txt /opt/hello.txt",
      "sudo chmod 0644 /opt/hello.txt",
    ]
  }
}