Skip to content

Commit ed695f0

Browse files
committed
update packer README for modified image vars
1 parent 300fbfa commit ed695f0

File tree

1 file changed

+5
-7
lines changed

1 file changed

+5
-7
lines changed

packer/README.md

Lines changed: 5 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -25,11 +25,9 @@ The steps for building site-specific fat images or extending an existing fat ima
2525
flavor = "general.v1.small" # VM flavor to use for builder VMs
2626
networks = ["26023e3d-bc8e-459c-8def-dbd47ab01756"] # List of network UUIDs to attach the VM to
2727
```
28-
29-
- The network used for the Packer VM must provide outbound internet access but does not need to provide access to resources which the final cluster nodes require (e.g. Slurm control node, network filesystem servers etc.).
30-
28+
Note that:
29+
- The network used for the Packer VM must provide outbound internet access but does not need to provide access to resources which the final cluster nodes require (e.g. Slurm control node, network filesystem servers etc.).
3130
- For additional options such as non-default private key locations or jumphost configuration see the variable descriptions in `./openstack.pkr.hcl`.
32-
3331
- For an example of configuration for extending an existing fat image see below.
3432
3533
3. Activate the venv and the relevant environment.
@@ -51,10 +49,10 @@ The steps for building site-specific fat images or extending an existing fat ima
5149
An "extra" image build starts with an existing fat image (e.g. one provided by StackHPC) rather than a RockyLinux GenericCloud image, and only runs a specific subset of the
5250
Ansible in the appliance. This allows adding additional functionality into site-specific images, without modifying the existing functionality in the base fat image. This is the recommended way to build site-specific images.
5351
54-
To configure an "extra" image build, prepare a Packer variable definition file as described above. However this must additionally include:
52+
To configure an "extra" image build, prepare a Packer variable definition file as described above but also including:
5553
56-
- `extra_image_name`: A string to add into the final image name
57-
- `source_image` (or `source_image_name`): A map of strings keyed by RockyLinux variant, defining the base image.
54+
- `extra_image_name`: A string to add into the final image name.
55+
- `source_image` (or `source_image_name`): The UUID or name of the fat image to start from (which must already be present in OpenStack).
5856
- `groups`: A mapping with a key "openhpc-extra" (i.e. the name of this Packer build) with a list of Ansible inventory groups to put the build VM into.
5957
This defines the roles/functionality which are added to the image.
6058

0 commit comments

Comments
 (0)