Install the platform

From a bare Debian 13 host to a running platform: one orchestrator first, then as many nodes as you want. Every download is checked against a signed manifest (Ed25519) and a SHA-256 before anything is installed.

Before you start

  • A Debian 13 host (or Ubuntu 22.04 and later) with systemd, root access, a public IP address and ports 80, 443 and 53 (TCP and UDP) open: it becomes the first orchestrator.
  • A DNS zone for your applications (for example apps.example.org), delegated by NS records to that public IP: the orchestrator answers for it and obtains the TLS certificates. Other modes leave the zone with you (external, Cloudflare).
  • The three binaries of the stack (gdown, charm, top) as HTTPS addresses with their SHA-256: the platform runs its own services as applications.
  • Optionally, more Debian hosts: each becomes a node with one command.

Trust rests on the TLS certificate of this site and on the fingerprint above: pass it with --key-sha256 so that the script refuses any other key.

1. The first orchestrator

The orchestrator (Higgs): API, scheduler, ingress, DNS, ACME and Raft state. The command downloads and checks the release, then runs the installer for the orchestrator role; everything after the second -- goes to the installer. With gluonify.higgs.stack.enabled, it also deploys the stack by itself: gdown, then identity, then the top.

2. Check that it is up

The stack starts one step at a time and each step is checked on the real state; a restart resumes where it was. The administrator token is in a file readable by root only.

3. Add nodes

Ask the orchestrator for a one-time token; the answer contains the command to run on the new host. The host opens an outgoing connection to the orchestrator, runs only a closed catalogue of signed tasks, then enrols itself: no port is opened on it.

4. High availability

Add a second and a third orchestrator the same way (orchestrator role): the orchestrator that creates the request gives the new member a narrow join token, valid once for 15 minutes, never the administrator token. Three orchestrators keep working when one is lost.

5. Deploy

From here the platform is empty and ready: deploy your applications with the API, the Synchrotron console or the starter application gluonify-source.

Then: your application, with no configuration

An application reaches the services of the platform with 0 lines of configuration. For production, there is nothing to declare: Bup detects the SDK modules and fills "uses" by itself; gluonify.json only adds the services reached outside the SDK. For development, run gluonify login once on your machine (gluonify.lan for the local development cluster, your zone otherwise). The SDK then finds the address and the token by itself.

On your machine, once

gluonify login gluonify.lan     # once, in your browser (PKCE): the SDK then finds the services of the zone

In the code

@Inject CrystallonClient crystallon;   // no URL, no token, no property: 0 lines of configuration

RenderedPdf pdf = crystallon.byName("Gluonify invoice").render(payload);

What is not automated yet

The stack binaries are not on the release store yet: build them (see BOOTSTRAP.md) or host them on any HTTPS server. gDown alone already installs with gDown.sh (page gDown).