Skip to content

Latest commit

 

History

History
60 lines (39 loc) · 3.12 KB

RELEASING.md

File metadata and controls

60 lines (39 loc) · 3.12 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, e.g. 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 e.g. quay.io/datawire/ambassador:0.33.0-rc1 and also as e.g. 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, sync up the docs!

    • make pull-docs to pull updates from the docs repo
    • Handle conflicts as needed.
    • Commit any conflict-resolution changes to master.

  6. After the docs are synced, use make release-prep to update CHANGELOG.md and docs/versions.yml.

    • It will commit, but not push, the updated files. Make sure the diffs it shows you look correct!
    • Do a manual git push to update the world with your new files.

  7. Now for the time-critical bit.

    • 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.
    • make docs-push after the retag to push new docs out to the website.

    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.

  8. Finally, go submit a PR into the helm/charts repo to update things in stable/ambassador:

    • in Chart.yaml, update appVersion with the new Ambassador version, and bump version.
    • in README.md, update the default value of image.tag.
    • in values.yaml, update tag.

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 git@github.com: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.