Skip to content

Setup

1. Request a trial license

The orchestrator drives the ETL Engine, which is licensed software. You need a license with the ETL feature to run the Synthmas demo (it uses StoreIndexMap + StoreSequence rules that aren't available in the free tier).

To get a 5-day free trial license:

  1. Go to https://rook-it.com/licenses and create an account.
  2. Request your one-time 5-day trial. You'll receive a license.lic file by email.

If 5 days isn't enough — for example, you're evaluating a longer production pilot — write to licenses@rook-it.com. We'll arrange a short conversation about your use case first, then issue a longer license tailored to it. We don't issue extended licenses unattended, just so we can match the license terms to the work you're actually doing.

2. Install the orchestrator

Download the latest release tarball from your Rook IT release page (installer comes inside):

tar xzf etl-orchestrator-<version>.tar.gz
cd etl-orchestrator-<version>
sudo bin/install-etl-orchestrator.sh

The installer:

  • Probes your host for docker / podman + their sockets.
  • Loads the image from data/etl-orchestrator.docker.
  • Starts the container with --restart unless-stopped.
  • Waits for /healthz to come up.
  • Prints a randomly-generated initial admin password to stdout. This is shown once — copy it somewhere safe before closing the terminal.

Default URL: http://localhost:8000/. Log in as admin with the random password the installer printed.

Different host port

Set ORCHESTRATOR_LISTEN_PORT=8765 (or similar) in the environment before running install-etl-orchestrator.sh — both the container and the host port mapping pick it up.

3. Upload the license

This is the last install step before you can do anything else — without a license, the orchestrator boots and lets you in, but every engine spawn will fail with a clear "no valid license" error.

In the UI: Settings → License → Upload license.lic.

A valid license with the ETL feature unlocks the StoreIndexMap / StoreSequence rules every Synthmas RiaH uses. The license page shows the licensed-to name + expiry once it's installed.

4. Import the Synthmas pipeline

Download the pipeline bundle:

⤓ synthmas-pipeline-1.0.0.etlopipeline

In the UI: Pipelines → Import → select the .etlopipeline file → Import.

You should now see a "Synthmas" pipeline on the Pipelines page with 14 etl_map steps wired into a DAG of cross-step StoreIndexMap / StoreSequence edges.

5. (Optional) Switch on TLS

If the orchestrator is reachable beyond localhost, Settings → TLS to pick a mode:

  • Self-signed for a quick lab cert (Rook IT branded; valid 13 months).
  • Self-managed to upload a real cert + key + chain.

Either way the change takes effect on the next container restart (bin/run-etl-orchestrator.sh restart); gunicorn doesn't hot-reload TLS.

→ Next: Vocabulary.