Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.macstadium.com/llms.txt

Use this file to discover all available pages before exploring further.

How to use Packer with your Orka environment The Orka Packer Plugin works with Packer and lets you automate the creation of Orka golden images. Tired of manually configuring and building your Orka images? The Orka Packer plugin is a great tool to use for automating your image builds. Not only is it easy to use and a great addition to any CI/CD pipeline, it can be used with additional plugins, such as Jenkins.
Orka 3.1.x and above requires version 3.0.0+ of the plugin.

​
Before You Begin

​
VPN connectivity

Make sure that your local environment is connected to your Orka environment through VPN. You can use a VPN client to establish temporary connectivity, or you can create a site-to-site VPN tunnel to keep the connection alive at all times.

​
Service account token

The plugin requires an orka_auth_token to authenticate with your Orka cluster. This must be a service account token. Personal user tokens expire after one hour, which is typically not enough time for a full image build, and will cause builds to fail mid-run. Step 1: Create a service account 
orka3 sa create packer-sa
You only need to do this once. Use a descriptive name that makes the purpose of the account clear. Step 2: Generate a token 
orka3 sa token packer-sa
By default, service account tokens are valid for one year. Copy the token value from the output. Step 3: Store the token as a secret Store the token in your CI/CD platform’s secret manager (for example, GitHub Actions secrets, GitLab CI/CD variables, or Jenkins credentials). Name it ORKA_AUTH_TOKEN. Never commit the token value to your repository. Step 4: Reference the token in your Packer template Declare the variable so Packer reads it from your environment at build time: 
variable "orka_auth_token" {
  default = env("ORKA_AUTH_TOKEN")
}

source "macstadium-orka" "image" {
  orka_auth_token = var.orka_auth_token
  # ...
}
Then pass the variable when running builds locally: 
ORKA_AUTH_TOKEN=<your-token> packer build template.pkr.hcl
In CI/CD, the secret is injected automatically as an environment variable — no extra steps needed if you’ve named it ORKA_AUTH_TOKEN.

​
Working with the Plugin

For latest information on installing the plugin, please visit Orka Packer Plugin Installation For latest information on using the plugin, please visit Orka Packer Plugin Usage For latest information on configuring the plugin, please visit Orka Packer Plugin Configuration
Looking for a working starting point? Ready-to-use Packer templates are available on OrkaHub — find them in the packer-plugin-macstadium-orka repository and copy or adapt them for your own image builds.
Contributing: The Orka Packer Plugin is open-sourced under the GNU GPL v3 license.To raise an issue with the plugin feel free to describe it by opening a new issue in the Github repository. To contribute to the source code by fixing a bug or adding a feature, review the CONTRIBUTING guidelines.