Command-line tool
Look up the commands and options of etorm here. We ship one binary for several jobs. It signs you in for kubectl, runs the gateway agent, runs the whole platform in one process for development, opens a graph shell, and lets platform operators register platform programs. Build it with cargo build --release -p etorm.
etorm login, logout
login signs you in through your browser, creates a personal token and writes a kubeconfig with a context for the platform and one for each project you can reach. logout revokes the token and removes the files. See Sign in and get kubectl access.
etorm login [--api URL] [--issuer URL] [--days N] [--name NAME] [--kubeconfig FILE] [--ca-file FILE] [--no-browser] etorm logout [--kubeconfig FILE] [--ca-file FILE]
| Option | Meaning |
|---|---|
--api URL | the platform API (default https://api.etorm.com) |
--issuer URL | the sign-in service (default https://auth.etorm.com) |
--days N | token lifetime, 1 to 365 (default 30) |
--name NAME | token name (default cli-<host>-<date>-<random>) |
--kubeconfig FILE | where to write it, mode 0600 (default ~/.config/etorm/kubeconfig) |
--no-browser | only print the sign-in address |
--ca-file FILE | trust this certificate as well as the public roots (private or solo servers) |
etorm gateway
This is the dataplane agent for Linux hosts. It needs ip, bridge and wg. With --apply it also runs the Compute processes whose VPCs it serves, including those that use platform programs, and keeps their state in DIR/compute. See Run a gateway.
etorm gateway [--data DIR] [--server URL] [--token-file FILE] [--ca-file FILE] [--gateway NAME]
[--private-key-file FILE] [--interval SECS] [--once] [--apply]
| Option | Meaning |
|---|---|
--gateway NAME | the Gateway object to realise (default default) |
--private-key-file FILE | WireGuard private key (default DIR/gateway.key) |
--interval SECS | reconcile period (default 5) |
--once | run one pass and exit |
--apply | change the host; without it the plan is only printed |
--server, --token-file, --ca-file, --data | as for cypher |
etorm serve
Runs the API, storage, identity, billing and every controller as one process, with no external services. Use it when you want a complete platform on one machine.
etorm serve [--data DIR] [--listen ADDR] [--no-tls] [--tls-san NAME]... [--gateway-endpoint HOST:PORT]
[--gateway-public-key KEY] [--cluster-host-suffix SUFFIX] [--console-origin ORIGIN]...
[--oidc-issuer URL] [--admin-oidc-sub SUB]...
The last two rows of the table below are environment variables, not options.
| Option | Meaning |
|---|---|
--data DIR | data directory (default ./data) |
--listen ADDR | listen address (default 127.0.0.1:7443) |
--no-tls | serve plain HTTP, only behind a TLS-terminating proxy; kubectl does not send credentials over plain HTTP |
--tls-san NAME | extra DNS name or IP for the self-signed certificate (repeatable) |
--gateway-endpoint H:P | WireGuard endpoint of the default gateway (default 127.0.0.1:51820) |
--gateway-public-key KEY | its public key; a development key pair is generated when omitted |
--cluster-host-suffix S | host <project>S addresses a project (for example -api.etorm.com) |
--console-origin ORIGIN | browser origin allowed to call the API (repeatable) |
--admin-oidc-sub SUB | make this sign-in subject a platform admin (repeatable); removing the flag revokes it |
--oidc-issuer URL | also accept access tokens from this issuer; its keys are read from URL/jwks.json |
ETORM_MASTER_KEY | 64 hex characters; when unset, DIR/master.key is used (created on first run) |
ETORM_STORAGE_KEY | 64 hex characters; when unset, DIR/storage.key is used (created on first run); encrypts the objects of Storage |
etorm cypher
Runs read-only openCypher queries over the graph of your objects. Give one statement as QUERY, or leave it out to get an interactive prompt.
etorm cypher [--data DIR] [--server URL] [--token-file FILE] [--ca-file FILE] [QUERY]
By default it talks to the server at https://127.0.0.1:7443, with the token in DIR/admin.token and the certificate in DIR/tls.crt. These defaults suit an etorm serve on the same machine. The other commands that take --server, --token-file, --ca-file and --data use the same defaults.
etorm program publish
Platform administrators use this to register a platform program, up to 32 MiB, that every project can run with programRef: {name: N, system: true}. The module is validated before anything is stored.
etorm program publish [--data DIR] [--server URL] [--token-file FILE] [--ca-file FILE]
--project P --bucket B --name N [--description TEXT] FILE.wasm
| Option | Meaning |
|---|---|
--project P, --bucket B | the platform project and bucket that hold the module; both must exist |
--name N | the program's name; it cannot change, so a new version is a new name |
--description TEXT | what the program does, for people |
--server, --token-file, --ca-file, --data | as for cypher |
You register programs of your own with a Program object instead. See Run a program as a process.
etorm version
etorm version prints the version, and etorm help prints the usage.