This is a Packer Plugin for building images that work with Veertu's Anka macOS Virtualization tool.
-
Note that this plugin does not manage VM templates. Once it creates a Template, it is up to you to use it or delete it.
-
For use with the post-processor, it's important to use
anka registry add
to set your default registry on the machine building your templates/tags.
-
Plugin will only work with Packer v1.7 or later.
-
Plugin has been renamed from
packer-builder-veertu-anka
topacker-plugin-veertu-anka
. -
Builder has been renamed from
veertu-anka
toveertu-anka-vm-clone
andveertu-anka-vm-create
. -
Pre-version-1.5 "legacy" Packer templates, which were exclusively JSON and follow a different format, are no longer compatible and must be updated to either HCL or the new JSON format: https://www.packer.io/docs/templates/hcl_templates/syntax-json
Packer Version | Veertu Anka Plugin Version |
---|---|
1.7.0 and above | >= 2.0.0 |
below 1.7.0 | < 2.0.0 |
-
Add a packer block to your .pkr.hcl like this:
packer { required_plugins { veertu-anka = { version = ">= v2.1.0" source = "github.com/veertuinc/veertu-anka" } } }
-
Then run
packer init {HCL file name}
-
Run your
packer build
command with your hcl template
- Install Packer v1.7 or newer
- Install Veertu Anka v2.3.1 or newer
- Download the latest release for your host environment
- Unzip the plugin binaries to a location where Packer will detect them at run-time, such as any of the following:
- The directory where the packer binary is.
- The
~/.packer.d/plugins
directory. - The current working directory.
- Rename the binary file to
packer-plugin-veertu-anka
- Run your
packer build
command with your hcl template
Builders | Post Processors |
---|---|
[ veertu-anka-vm-create ] | [ veertu-anka-registry-push ] |
[ veertu-anka-vm-clone ] |
Currently file provisioners do not support ~ or $HOME in the destination paths. Please use absolute or relative paths.
The most basic pkr.hcl file you can build from is:
source "veertu-anka-vm-create" "anka-packer-base-macos" {
installer_app = "/Applications/Install macOS Big Sur.app/"
vm_name = "anka-packer-base-macos"
}
build {
sources = [
"source.veertu-anka-vm-create.anka-packer-base-macos"
]
post-processor "veertu-anka-registry-push" {
tag = "veertu-registry-push-test"
}
}
This will create a "base" VM template using the .app
you specified in installer_app
with the name anka-packer-base-macos
. Once the VM has been successfully created, it will push that VM to your default registry with the veertu-registry-push-test
tag.
If you didn't specify
vm_name
, we would automatically pull it from the installer app and create a name likeanka-packer-base-11.4-16.6.01
.
When using
installer_app
, you can modify the base VM default resource values withdisk_size
,ram_size
, andvcpu_count
. Otherwise, defaults (see below) will be used.
However, hw_uuid, port_forwarding_rules, and several other configuration settings are ignored for the created "base" vm. We recommend using the
veertu-anka-vm-clone
builder to modify these values.
You can also skip the creation of the base VM template and use an existing VM template:
source "veertu-anka-vm-clone" "anka-packer-from-source" {
vm_name = "anka-packer-from-source"
source_vm_name = "anka-packer-base-macos"
}
build {
sources = [
"source.veertu-anka-vm-clone.anka-packer-from-source",
]
}
This will check to see if the VM template/tag exists locally, and if not, pull it from the registry:
โฏ PKR_VAR_source_vm_tag="v1" PACKER_LOG=1 packer build -var 'source_vm_name=anka-packer-base-macos' examples/clone-existing-with-port-forwarding-rules.pkr.hcl
. . .
2021/04/07 14:11:52 packer-plugin-veertu-anka plugin: 2021/04/07 14:11:52 Searching for anka-packer-base-macos locally...
2021/04/07 14:11:52 packer-plugin-veertu-anka plugin: 2021/04/07 14:11:52 Executing anka --machine-readable show anka-packer-base-macos
2021/04/07 14:11:53 packer-plugin-veertu-anka plugin: 2021/04/07 14:11:53 Could not find anka-packer-base-macos locally, looking in anka registry...
2021/04/07 14:11:53 packer-plugin-veertu-anka plugin: 2021/04/07 14:11:53 Executing anka --machine-readable registry pull --tag v1 anka-packer-base-macos
Within your
.pkrvars.hcl
files, you can utilizevariable
blocks and then assign them values using the command linepacker build -var 'foo=bar'
or as environment variablesPKR_VAR_foo=bar
https://www.packer.io/docs/templates/hcl_templates/variables#assigning-values-to-build-variables
This will clone anka-packer-base-macos
to a new VM and, if there are set configurations, make them.
Check out the examples directory to see how port-forwarding and other options are used
Packer allows for the exposure of build variables which connects information related to the artifact that was built. Those variables can then be accessed by post-processors
and provisioners
.
The variables we expose are:
VMName
: name of the artifact vmOSVersion
: OS version from which the artifact was created- eg. 10.15.7
DarwinVersion
: Darwin version that is compatible with the current OS version- eg. 19.6.0
locals {
source_vm_name = "anka-packer-base-11.2-16.4.06"
}
source "veertu-anka-vm-clone" "anka-macos-from-source" {
"source_vm_name": "${local.source_vm_name}",
"vm_name": "anka-macos-from-source"
}
build {
sources = [
"source.veertu-anka-vm-clone.anka-macos-from-source"
]
provisioner "shell" {
inline = [
"echo vm_name is ${build.VMName}",
"echo os_version is ${build.OSVersion}",
"echo darwin_version is ${build.DarwinVersion}"
]
}
}
You will need a recent golang installed and setup. See go.mod
for which version is expected.
We use gomock to quickly and reliably mock our interfaces for testing. This allows us to easily test when we expect logic to be called without having to rewrite golang standard library functions with custom mock logic. To generate one of these mocked interfaces, installed the mockgen binary by following the link provided and then run the make go.test
.
- You must install
packer-sdc
to generate docs and HCL2spec:
go install github.com/hashicorp/packer-plugin-sdk/cmd/packer-sdc@latest
We recommend using goreleaser to perform all of the building, linting, and testing:
PACKER_CI_PROJECT_API_VERSION=$(go run . describe 2>/dev/null | jq -r '.api_version') goreleaser build --single-target --snapshot --rm-dist
When testing with an example HCL:
export PACKER_LOG=1; packer build examples/create-from-installer.pkr.hcl
To test the post processor you will need an active vpn connection that can reach an anka registry. You can setup an anka registry by either adding the registry locally with:
anka registry add <registry_name> <registry_url>
-or-
You can setup the create-from-installer-with-post-processing.pkr.hcl
with the correct registry values and update the make target anka.test
to use that .pkr.hcl file and run:
make create-test