Skip to content

Commit

Permalink
E2E: document how the AMIs are tagged and how those tags are used (#2…
Browse files Browse the repository at this point in the history
…2237)

The process by which we tag AMIs with the commit SHA of the Packer directory
isn't documented in this repository, which makes it easy to accidentally build
an AMI that will break nightly E2E.
  • Loading branch information
tgross committed May 24, 2024
1 parent ace3ccf commit 91d422e
Showing 1 changed file with 20 additions and 4 deletions.
24 changes: 20 additions & 4 deletions e2e/terraform/packer/README.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,30 @@
# Packer Builds

These builds are run as-needed to update the AMIs used by the end-to-end test infrastructure.

These builds are run as-needed to update the AMIs used by the end-to-end test
infrastructure.

## What goes here?

* steps that aren't specific to a given Nomad build: ex. all Linux instances need `jq` and `awscli`.
* steps that aren't specific to a given EC2 instance: nothing that includes an IP address.
* steps that aren't specific to a given Nomad build: ex. all Linux instances
need `jq` and `awscli`.
* steps that aren't specific to a given EC2 instance: nothing that includes an
IP address.
* steps that infrequently change: the version of Consul or Vault we ship.

## How is this used?

The AMIs built by these Packer configs are tagged with `BuilderSha`, which has
the value of the most recent commit that touched this directory.

The nightly E2E job runs a script to see if there are any AMIs that match the
most recent commit that touched this directory, and if there aren't it will then
build the AMIs. Then most recent AMI with a matching SHA is used for the nightly
E2E run.

If you are changing this directory to build an AMI for testing, it's recommended
that you change the name of the AMI or make sure that you've locally committed
your changes so that your test AMI doesn't get picked up in the next nightly E2E
run.

## Running Packer builds

Expand Down

0 comments on commit 91d422e

Please sign in to comment.