Skip to content

Latest commit

 

History

History
59 lines (36 loc) · 3.14 KB

RELEASING.md

File metadata and controls

59 lines (36 loc) · 3.14 KB
Raw

Releasing Ambassador

If you just want to use Ambassador, check out https://www.getambassador.io/! You don't need to build - much less release! - anything, and in fact you shouldn't.

If you don't work at Datawire, this document is probably not going to help you. Maybe check out the developer guide instead.

If you're still reading, you must be at Datawire. Congrats, you picked a fine place to work! To release Ambassador, you'll need credentials for our Github repos.

  1. PRs will pile up on master. Don't accept PRs for which CI doesn't show passing tests.

  2. Once master has all the release drivers, tag master with an RC tag, eg 0.33.0-rc1.

  3. The RC tag will trigger CI to run a new build and new tests. It had better pass: if not, figure out why.

  4. The RC build will be available as quay.io/datawire/ambassador:0.33.0-rc1 and also as quay.io/datawire/ambassador:0.33.0-rc-latest. Any other testing you want to do against this image, rock on.

  5. When you're happy with everything, then on master -

    • Run make release-prep, it will update CHANGELOG.md and docs/index.html. Make sure the diff looks right.
    • You don't need to do anything with the Helm chart; CI will tackle that later.
    • Tag master with a GA tag like 0.33.0 and let CI do its thing.
    • CI will retag the latest RC image as the GA image.
    • CI will update the Helm chart during the GA deploy.

    Note that there must be at least one RC build before a GA, since the GA tag does not rebuild the docker images -- it retags the ones built by the RC build. This is intentional, to allow for testing to happen on the actual artifacts that will be released.

    Note that after this CI build, helm install will refer to the new GA release, but the docs will not have been updated yet! So try to minimize the time you spend between this step and the next.

    Note On the GA tag, a special build of the website from master is pushed to production. This updates the version number on the website, but it does not update the blog post URL.

  6. PR master into stable.

    • CI will update the docs at this point.

  7. Update the stable branch with a link to a blog post announcing the new release.

  8. PR stable into master with the website changes.

Updating Ambassador's Envoy

Ambassador currently relies on a custom Envoy build which includes the Ambassador extauth filter. This build lives in https://github.com/datawire/envoy, which is a fork of https://github.com/envoyproxy/envoy, and it'll need to be updated at least as often as Envoy releases happen. To do that:

  1. Clone the datawire/envoy repo and get to the datawire/extauth-build-automation branch:

    git clone [email protected]:datawire/envoy.git
cd envoy
git checkout datawire/extauth-build-automation

  2. Follow the directions in DATAWIRE/README.md to get everything built and tested and pushed.

  3. Once the new ambassador-envoy image has been pushed, get back to your clone of the Ambassador repo and update the FROM line in ambassador/Dockerfile to use the new image.

  4. Build and test Ambassador as normal.