build: documentation for the new docker image release process

At the time of commit this file contains some things that are not yet true
due to the dockerhub configuration not having been updated. This therefore
remains aspirational until merged, after which the docherhub configuration
will be updated.
This commit is contained in:
Martin Atkins 2017-07-19 13:02:39 -07:00
parent 0f9af4dfa9
commit 2b3b62dab5
1 changed files with 18 additions and 5 deletions

View File

@ -15,10 +15,23 @@ a Terraform release already on releases.hashicorp.com, the build will fail.
## What it produces ## What it produces
This configuration is used to produce the "latest", "light" and "beta" tags This configuration is used to produce the "latest", "light", and "beta"
in Dockerhub, as well as specific version tags. tags in Dockerhub, as well as specific version tags.
"latest" and "light" are synonyms, and are built from a branch in this * "latest" and "light" are synonyms, and are built from a branch in this
repository called "stable". "beta" is built from a branch called "beta". Both repository called "stable".
of these branches should be updated only to _tagged_ commits, and only when * "beta" is built from a branch called "beta".
All of these branches should be updated only to _tagged_ commits, and only when
it is desirable to create a new release image. it is desirable to create a new release image.
## The `full` and `master` images image
This configuration does not produce the "full" image. That is instead produced
by the `Dockerfile` in the repository root, driven by updates to the "stable"
branch.
The "master" tag is updated for _every_ commit to the master branch of
the Terraform core repository. It is not recommended to use these images for
any production use, but they can be useful for testing bleeding-edge features
that are not yet included in a release.