This is documentation for Tenzir v4.19, which is no longer actively maintained.
For up-to-date documentation, see the latest version (v4.21).
Version: v4.19
Deploy the platform
The Tenzir Platform manages nodes and the pipelines running on them, offering
a visual interface to explore data, manage nodes, and pipelines, and create
dashboards.
Sovereign Edition Required
Tenzir offers a free and cloud-hosted version of the Tenzir Platform on
app.tenzir.com for all users of the Community Edition.
This guide explains how to run the platform on your own premises as a user of
the Sovereign Edition.
The platform uses four URLs that require a HTTP reverse proxy to be set
up. These URLs may be mapped to the same or different hostnames.
The URL that the user's browser connects to, e.g.,
app.platform.example.org. This serves a web frontend where the user can
interact with the platform.
The URL that the nodes connect to, e.g., nodes.platform.example.org. Tenzir
Nodes connect to this URL to establish long-running WebSocket connections.
The URL that the platform's S3-compatible blob storage is accessible at,
e.g., downloads.platform.example.org. When using the 'Download' button
the platform generates download links under this URL.
The URL that the Tenzir Platform CLI connects to, e.g.,
api.platform.example.org.
You must provide the following environment variables for the platform:
The platform requires an external Identity Provider (IdP) supporting the OIDC
protocol. The IdP must provide valid RS256 ID tokens. The platform must be able
to access the IdP's issuer URL.
You must provide the following environment variables for the OIDC provider
configuration used for logging into the platform:
You must provide the following environment variable containing a JSON object
containing the OIDC issuer and audiences that should be accepted by the
platform.
You must provide the following environment variable containing a JSON list of
rules granting access to the admin API. The example rule grants admin access to
all users with a valid and signed id_token containing the fields
{"connection": "google-oauth2", "tenzir/org": "TenzirPlatformAdmins"}.
The Tenzir Platform is shipped as a Docker Compose file. To run it, Docker and
Docker Compose must be installed.
As part of your distribution, you were provided an authentication token to be
able to fetch the Docker images. On the machine on which you want to run the
Docker Compose stack, log in with the token like this:
Once you went through all the prerequisites, and have filled in the required
variables in your .env file, you should be in a directory with the following
files:
From one of these directories, run docker compose up to start the platform in
the foreground, or docker compose up --detach to run it in the background:
It takes up to a minute for all services to be fully available.