Quickstart

The Ziti quickstart documentation is here: Ziti Network Quickstarts.

Releasing a new version of the Quickstart

Artifacts Produced by a Release

The enclosing project's GitHub releases are never updated and no Git tags are created for a quickstart release.

1. openziti/quickstart container image in Docker Hub
2. a CloudFront Function in AWS pointing the get.openziti.io reverse proxy to the GitHub SHA of the release

Release Process

A quickstart release is triggered automatically when a GitHub release of the enclosing project is published (i.e., the release: published event fires, after the release assets have been uploaded).

The release-quickstart workflow can also be invoked manually from the GitHub Actions UI (workflow_dispatch) with an explicit release tag (e.g., v1.6.7). Use this when:

• the automatic run failed for transient reasons and you want to rerun it, or
• you need to republish the quickstart artifacts for an existing release without cutting a new one.

Both jobs in the workflow are idempotent and independently re-runnable:

• The Docker image push step checks the registry first and skips if openziti/quickstart:vX.Y.Z already exists. The :latest tag is only moved when the input tag matches GitHub's "Latest release" flag (or you pass force_latest: true on a manual run).
• The CloudFront deploy is a re-publish each time; AWS handles repeated identical configurations cleanly.

If one job succeeds and the other fails, you can rerun the failed job alone from the Actions UI without redoing the work that already succeeded.

Release Machinery

The release process is encoded in a GitHub workflow. The bulk of the Docker logic lives in dist/scripts/release-quickstart-image.sh, which is runnable locally for testing.

GitHub Raw Reverse Proxy

The get.openziti.io reverse proxy is a CloudFront distribution that points to a CloudFront Function and serves as a shorter HTTP URL getter for raw GitHub source files, e.g. https://get.openziti.io/dock/simplified-docker-compose.yml. The CloudFront Function is a JavaScript function that looks at the URI path of the incoming request and forwards it to the appropriate GitHub raw download path. The CloudFront Function is updated by the release process, and the CloudFront Distribution itself is hand-maintained in the AWS Console. The Distribution has these characteristics:

• Viewer Domain Name: get.openziti.io (frontend)
• Route Origin: raw.githubusercontent.com (backend, upstream)
• Auto-renewing TLS certificate from ACM
• Cache Policy CachingOptimized (default)
• Routes to Origin based on Javascript Function deployed by quickstart release

You can add or change a GitHub raw shortcut route by modifying the routes.yml file.