Update os builders readme - #169
Open
khalford wants to merge 5 commits into
Open
Conversation
khalford
added
documentation
khalford
force-pushed
the
update_os_builders_readme
branch
from
July 24, 2026 14:23
85c5156 to
e8f6f13
Compare
AQ images are not made public. The rename_images.sh script will not work for them in it's current form. This updates the script to share any image ending in "aq" with all of it's members in the current image to the new one.
Update the CHANGELOG file extension to .md so it renders in GitHub. Add dates to the releases as these are missing. Add a link to the next version branch. Unreleased changes will not show in the main branch, only the feature branch.
We must build images with the flavor that has the smallest disk size. If you build an image with a flavor disk size bigger than the smallest flavor, then you will not be able to spawn a VM using that smaller flavor and that image. On dev our smallest flavor is l3.nano. On prod our smallest flavor is l6.c2. Rather than change the flavor each time we build on prod or dev, or create an environment variables file. We can just use the existing l3.imagecreate flavor that exists on prod and dev. It has the smallest disk size so will work for any flavor. Update the build names for all images to reflect the actual OpenStack image name. This makes it clearer when specifying the build command. You won't need to check the build file that ubuntu-jammy-22.04-nogui is called ubuntu-jammy. For example, packer build -only openstack.ubuntu-jammy build.pkr.hcl become packer build -only openstack.ubuntu-jammy-22.04-nogui build.pkr
Re-writing the instructions for: - Building images - Testing images - Updating the playbooks - Releasing a new version This should improve the clarity of the instructions. The recent Ghostlock CVE has required all images to be rebuilt. This rebuild campaign exposed flaws in the build process. There were issues with the playbooks and the documentation. This increased the time to build images by a large and considerable factor. To streamline the process I have made the instructions more detailed and provided better explanations of the process. This is done by the sequence diagrams at the top of the README.md and at each step.
Using an input variable and conditional check we can set either the dev or prod network ID at runtime. Rather than the user edit the file or input it on the command line. Before users had to edit build.pkr.hcl and update the network ID and set it to either prod or dev. Now users can just provide the flag --var env=prod when running packer build and it will use the dev or prod ID depending on the value of the variable. The variable defaults to dev if not specified as a saftey catch.
khalford
force-pushed
the
update_os_builders_readme
branch
from
July 27, 2026 09:38
e8f6f13 to
6395c27
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
During the Januscape CVE patching campaign, the image build process was stress tested by multiple people which exposed flaws in the process. This was mostly around the documentation being unclear which could have been avoided had it been peer reviewed.
This PR is to re-write the documentation to improve the clarity and ease of understanding. It should be easier for anyone to build images without prior knowledge.
See details in commits