API reference

Workspace

The company itself, as its Settings have it: its name, whether people at its domains may join by themselves, and its domains.

People

Everyone of the company: with a mailbox here, and those who only sign in with an address elsewhere.

Apps

Which apps the company’s people see. Every app is on but those turned off; an app Yet adds later comes on.

Domains

The company’s domains: asked for, shown to be its own by a TXT record, then with mail here or not.

Mail addresses

A domain’s addresses that are not a person: aliases landing in someone’s inbox, lists that deliver to several, and the catch-all.

Sending, storage, logo

How the company’s mail leaves — Yet’s Amazon SES or its own — the bucket Drive keeps its files in, and its logo.

Connections

The company’s accounts elsewhere, whichever product uses them: GitHub — Cloud builds from it and runs its runners — and AWS, whose SES the mail may leave through and whose bucket Drive may keep its files in.

Your API keys

The key’s own person: who they are in Cloud, and their keys. Keys are made in Yet — Preferences → API keys — never with another key: a key that could make keys would outlive its own revocation, were it leaked.

IAM

The company’s IAM, for its admins: who may do what in its products, everyone’s API keys, and what was done. Giving a role takes a person signed in to Yet — with a key, it is refused — so a leaked key never hands out more than its person had.

Racks

Where servers and runtimes belong: the company’s own machines (`local`), or what Cloud runs in an AWS account or a GCP project — the clouds themselves are connected under Connections.

Servers

A machine of a local rack, which Yet’s agent runs on. Made, it waits for its machine: a join token, run there, brings it online.

Runtimes

How things run on a server — k3s, Docker, or native — by its stack. A k3s runtime goes behind the company’s Cloudflare tunnel by itself, when Cloud’s edge is set.

Pools

Runtimes that run the same environments together — across servers, or across clouds.

Containers

The containers a Docker runtime keeps running on its server, as they are listed.

Runners

GitHub’s self-hosted runners on a native runtime — a Mac’s — as many copies as asked, each taking a job.

Environments

Where a stage of the company’s applications runs — staging, production — on one runtime or one pool, and the domain it answers at. Each is a Kubernetes namespace of its own, `yet-<name>`.

Applications

Something the company runs, in a namespace, through its stages — one environment each, in order. Built from a GitHub repository, or released from an image.

Databases

An environment’s database — Overlite, Postgres or Redis — run there for the applications attached to it.

DNS

Domains whose records Cloud keeps: zones, and their record sets. Cloud keeps its own records for environments; the rest are the company’s.