A template for quickly getting a new packer AWS AMI project started.
Note: The files in this template are specifically to build a Ubuntu distribution. You may need to modify it slightly to work with other distros (redhat, aws linux, windows, etc..)
IMPORTANT: Our naming convention is packer-<image name> (i.e. packer-base-ubuntu-bionic).
Please name your repo accordingly. This naming convention helps us locate packer repos and
their corresponding builds in github and travis.
- Install packer with provided script. General install instructions are in packer docs
- Install ansible
Choose an ImageName such as "my-test-image" and run
cd src
packer validate -var 'AmiImageName=my-test-image' template.json
To run a build you must have an AWS account and access to EC2.
- Request an IAM account in Imagecentral
- Change password and set up MFA
- Create an Access Key
- Add your access code and secret key to
~/.aws/credentials, using a profile such as "imagecentral.jsmith" - Authenticate with
awsmfa, for exampleawsmfa -i imagecentral.jsmith -t jsmith@imagecentral - Finally, get the correct role ARN for the PackerServiceRole then add the following:
[profile packer-service-imagecentral]
region = us-east-1
role_arn = *****
source_profile = jsmith@imagecentral
Now you will be able to build an image and deploy it to Imagecentral.
If you would like to test building an AMI run:
cd src
AWS_PROFILE=packer-service-imagecentral AWS_DEFAULT_REGION=us-east-1 packer build -var AmiImageName=my-test-image -var PACKER_LOG=1 template.json
Packer will do the following:
- Create a temporary EC2 instance, configure it with shell/ansible/puppet/etc. scripts.
- Create an AMI from the EC2
- Delete the EC2
Notes:
- Packer deploys a new AMI to the AWS account specified by the AwsProfile
- Subsequent builds may require the -force flag
This project is setup to build publicly accessible images. To change it to
build private images please refer to the packer documentation
for ami_users and snapshot_usersoptions.
As a pre-deployment step we syntatically validate our packer json files with pre-commit.
Please install pre-commit, once installed the file validations will
automatically run on every commit. Alternatively you can manually
execute the validations by running pre-commit run --all-files.
The workflow to provision AWS AMI is done using pull requests. Just make changes with PRs and when th PR is merged a packer build will kick off which will build the image and deploys it to AWS.
Packer will do the following:
- Create a temporary EC2 instance, configure it with shell/ansible/puppet/etc. scripts.
- Create an AMI from the EC2
- Delete the EC2
Note: The image will automatically be named gitrepo-branch (i.e. MyRepo-master)
Versions are managed by git tags. When a tag is pushed travis will build an AMI for that tag. Tag builds are immutable for downstream dependencies. Once a tag build is generated the AMI for that build will never go away.
Note: The image will automatically be named gitrepo-tag (i.e. MyRepo-v1.0.0)
List the built images by using the AWS CLI:
aws ec2 describe-images --owners 867686887310 --filters Name=tag:Name,Values=my-test-image
Building an AMI will create the AMI and one or more snapshots for the AMI. When deleting the AMI remember to also delete its snapshots. Use the provided bash script to remove the AMI and its snapshots.
Contributions are welcome.
Requirements:
- Install pre-commit app
- Clone this repo
- Run
pre-commit installto install the git hook.
Travis runs packer which temporarily deploys an EC2 to create an AMI.
We have configured Travis to deploy updates.
We use travis CI to automatically build and deploy images. Setup a travis ci build and add the AWS deployment credentials to the travis environment variables.
- We use the AWS SSM to store secrets for this project.