Skip to main content
CYPEX Documentation
Support
v2.0.0 Latest stable release View changelog ->

Detailed organization setup

Info
Looking for the conceptual reference (“what is an Organization?”)? See Organizations.

After the v2.0.0 upgrade, every CYPEX deployment starts with a single Default Organization that holds all existing data. This page is the entry point for setting up additional organizations and assigning existing clients / schemas to them.

When to read this

  • You want to split a single-tenant deployment into multiple organizations (one per client, per business unit, or per environment).
  • You need to backfill the organization_id column on existing application-schema tables.
  • You are operating the cutover from “everything on Default Organization” to “each row tagged with the right organization.”

Pages in this section

  1. Prepare the existing database — pre-flight checks, downtime planning, smoke-test environment.
  2. Enable RLS — the SQL primitives for enabling and configuring RLS on application-schema tables.
  3. Assign clients to organizations — uses the client-add-organization-id SQL template.
  4. Verify and roll back — verification queries and the rollback procedure if something goes wrong.

Prerequisite reading

Reference assets

Migrations

This section contains upgrade guides for CYPEX administrators, DBAs, and operations engineers. Use these guides when moving an existing CYPEX deployment from one major version to the next, especially when the upgrade involves schema or permission-model changes.

From v2.0.0 onward, multi-tenant isolation is a database property: PostgreSQL Row-Level Security (RLS) scopes every query. Application-layer filters are not the security boundary.

The guides are written with factual upgrade behavior in mind: what the migrations actually do, what is additive, what is breaking, what is behavior-changing, and what the rollback constraints are.

Read full post