Skip to the page

Get started

Concepts

The few ideas every operation is built on. The API, the CLI and the console share them exactly: the same roles, the same prices, the same approvals.

Organisations and roles

An organisation is your company in Rykloud. Its environments, its bills and its record belong to it, and the products inside Rykloud (a Rykon Mail account, a Rykon AI workspace) link to it. A person signs in with one Rykon account and can belong to several organisations, and own up to five.

RoleWhat it may do
ownerEverything, including approving prices, changing anyone's role (never removing the last owner), billing, and deleting the organisation.
adminRun the organisation day to day: people, products, settings. Moves people between admin and member.
memberWork in the projects and environments they are given a role in.
billingA member who also manages billing and spending limits.

An organisation you are not in answers 404, never 403: the API does not say what exists outside what you may see.

Projects

A project is one product or system and its environments (production, staging, a developer's own). People hold a role in a project or in a single environment: owner, maintainer, developer or viewer. A project can require that changes in its production environments are approved by a second maintainer. Secret groups can be defined once on the project and used by each of its environments.

Environments

An environment is a place your project runs, on a cloud (Hetzner, AWS, Google Cloud or Azure) in a region, at a size, with a stage (production, staging, development or preview). Ask for one with a cloud and region, or with any and an area (us, eu, asia) for the cheapest place there. It runs on Rykloud's shared cloud accounts, or on your organisation's own account once it is connected in the console.

Asking plans it and prices it in Rykloud's prices; it then waits for an owner's approval of that price. Only then does anything start at the cloud and billing begin. An environment can carry a time limit (8h unless you say otherwise through the API; null for none) after which it is stopped and kept.

Resources

KindWhat it is
postgresA PostgreSQL database: size, storage, version, replicas, a connection pooler, backups with point-in-time restore, protection, and copies of another database.
valkeyRedis (Valkey): memory size, persistence chosen once, eviction policy, backups.
bucketS3-compatible object storage: a quota, private unless public reading is turned on, versioning, lifecycle rules, backups.
serviceYour code: built from a Git branch or run from an image, as a web service, a worker or a cron job, with replicas, health checks, variables, secret groups and connections to the other resources.
secretA secret group: named secrets and variables a service receives. Values are written, revealed on request (recorded), rotated or generated by Rykloud.
domainA custom hostname pointed at a public web service, proven by a TXT record, with its certificate issued and renewed.

Changes: previewed, then applied

Nothing about a resource changes in one step. Every add, update, delete, restore or rotation is a change:

  1. Preview (changes.preview): Rykloud works out what will happen and states the price before and after. A preview stands for an hour.
  2. Apply (changes.apply): you send the monthly price the preview stated. A different price, or a preview gone stale, is refused, so a change is only ever made at the price someone saw.
  3. Approval, when needed: the change waits for an owner when it raises the price, or for a second maintainer in a production environment that requires it.

Environment settings (networking, backups, scaling) follow the same shape with settings.preview and settings.apply, and so do updates.

Approvals

An owner approves a plan by sending its id and the prices it states (environments.approve). If the plan changed since it was read, the approval is refused and must be made again on the new plan. Spending limits and the organisation's budget are checked at the same moment, and the payment gate: a billable start needs published prices and a payment method or prepaid credit. A refused approval says why in its error code and is recorded.

Stopping to zero and waking

Stop keeps an environment's data and removes everything that runs or bills at the cloud. Restore starts it again from what was kept. Wake is the quick way any member brings a stopped environment back. A schedule stops and starts it on chosen days in a time zone, and with wake on request a stopped environment wakes when someone opens its wake link.

Backups and restore

Each environment has a backup policy: the time and time zone, how many daily, weekly and monthly copies to keep, a copy in a second region, and a weekly restore test. Back up now and test a restore now at any time. Restoring a backup is an owner's act, confirmed by typing the environment's name, and can be previewed first. Databases, Redis and buckets also have their own backups; a Postgres database restores to a point in time.

Secrets and domains

A secret's value is never shown in a list or a log. It is revealed only when someone asks for that one value, and every reveal is recorded in the organisation's activity. A .env file can be imported into a group as a previewed change. A domain is added with its hostname and the service it points at; Rykloud answers the TXT record that proves the domain is yours, then the address record and the certificate.

Versions, updates and drift

An environment shows what it runs as semantic versions, per line (Rykloud and each product), each following a channel or pinned to a version. An update is reviewed (planned and priced) and approved like a new environment, and waits for the maintenance window you set. When something changed at the cloud outside Rykloud, the environment shows drift: put it back, or keep it.

Activity and the audit record

Every request, start, success, failure and refusal is an event in the organisation's activity: who did it, when, what it cost, and a req_ reference that support can look up (Errors and references). Owners and admins see all of it; members see the environments they are in. The audit record (owners) is the complete, ordered log, exportable as JSON pages or CSV, and stays exportable after the organisation is deleted.