Skip to content
DRAFTEnglish end user manual · web beta f7b7740e7371 · Android beta ed5d9494be9eDownload PDF

Environments

An environment is a platform-level workspace such as production, staging, or a demo area. It controls which backend configuration, storage, database, jobs, and service endpoints are used.

Every data operation runs inside one active environment. The same user may have access to several environments, but Rokks never treats them as interchangeable. Data loaded in one environment does not automatically appear in another.

Integrators use environments to separate lifecycle stages and infrastructure targets. Users use the environment selector to avoid editing the wrong workspace.

MOCKUPSource-derived illustration — not a captured product state
Source-derived Global Parameters mockup
Global Parameters illustration showing representative system configuration cards.Source baseline: beta f7b7740e

Shared application services serve every enabled environment. Storage is the explicit exception: each environment selects its PostgreSQL and document-store instance in Service Stack configuration. The environment record is the only owner of those bindings; there is no second service-assignment matrix or instance-level environment list.

Underlying database identifiers are implementation-managed and are not a stable end-user contract. Registry connection secrets are authoritative. The environment’s data and platform PostgreSQL DSNs must target the exact database assigned by the platform; do not derive, substitute, or repair a database name from the environment display name or ID. Runtime services use separate least-privilege data and platform identities; the privileged database identity is reserved for provisioning rather than ordinary dashboards and imports.

An environment has two deliberately separate identifiers:

Field Purpose Example
Display name Human-facing label in selectors and screens Development
Document routing key (firestoreNamespace) Technical deployment configuration TEST

ROKKS does not elect a default environment and does not invent a default document namespace. If routing configuration is absent, the environment remains explicitly unconfigured instead of reading from a plausible fallback. Display names never alter storage routing. Changing a technical routing key is therefore an explicit data migration, not a rename shortcut.

  1. Check the environment selector before starting work.
  2. Use production for live business workflows.
  3. Use staging or demo environments for testing sources, dashboards, and alert rules.
  4. Confirm that jobs and dashboards you expect are visible after switching.
  5. Ask an administrator if an environment is missing from your selector.

Do not copy values from one environment into another without understanding the target tenant. Environment and tenant together define the scope.

Do not test destructive operations in production. Use a non-production environment when validating imports, purge flows, or schema changes.