Skip to content

Workspace backup

Use this guide to add Team Edition-specific data to a server recovery inventory.

This guide applies only to Docker deployments.

A recovery set is the database backup, file storage, and deployment configuration captured from the same consistent state, called a recovery point. Follow the complete create, restore, startup, and verification sequence in Server backup and restore. This page lists only the Team Edition additions to that shared workflow.

Inventory Team Edition data

Team Edition uses these service roles:

  • Domain Controller manages users and access.
  • Resource Manager stores shared and private projects.
  • Query Manager stores query history.
  • Task Manager stores scheduled tasks.

Add the configured central database, Resource Manager project storage, deployment configuration, certificates, keys, and actual product and supporting-service mounts required by the active deployment. Add external stores only when the deployment uses them.

Treat .pgpass files and /opt/workspace/.metadata as conditional. Include them only when they exist and the deployment uses them. Kafka queues and temporary SQLite files are service runtime data, not automatic core product recovery targets. Inventory supporting-service mounts and include only the data required by the deployment's recovery design. Don't use Kafka topic equality as a product-data acceptance check.

A desktop workspace backup is separate and optional. Keep it outside the server recovery set.

Resolve configured paths

  1. Read the active service configuration to identify the central database, configured schema names, and Resource Manager paths. Keep every configured schema name in its original case.
  2. Inspect the actual container mounts for each product and supporting service.
  3. For every configured Resource Manager path, record the backing Docker volume, bind mount, or external target.
  4. Record deployment configuration, certificate and key locations, and each conditional external store.
  5. Record secret locations without recording secret values.

The reference deployment directory is ~/team-edition-deploy/compose/cbte. Confirm its mappings against the active deployment.

Use this inventory to identify deployment-specific storage:

Location Data to preserve
Configured central database Service schemas, roles, memberships, ownership, and database contents
Resource Manager rootPath, <sharedProjectsPath>/<project-name>, and <userProjectsPath>/<user-id> Global, shared, and private project storage
<workspace>/.data Runtime configuration for each applicable service
<installation>/conf Original configuration for each applicable service
/opt/workspace/.metadata, when used File-based Query Manager records
An active .pgpass file, when present and used PostgreSQL password file used by a product service
/opt/domain-controller/conf/custom-certs or /opt/domain-controller/conf/custom Custom certificates imported during startup
Active deployment-specific secret locations Private keys, key stores, licenses, and other required secrets
Active proxy mappings Proxy configuration and Transport Layer Security (TLS) data

Important

Custom certificate directories don't contain imported private keys. Include required private keys from their deployment-specific secret locations.

Add Team Edition data to the backup

Follow the shared backup sequence. Include the Resource Manager targets, required service configuration and mounts, and conditional files and external stores from the Team Edition inventory. Create a separate logical backup when Query Manager uses a different database.

Add Team Edition data to the restore

Follow the shared restore sequence. Restore each inventoried Resource Manager target, required service mount, and conditional external store before the corresponding service attaches. Keep configured schema names in their original case.

Start services in stages and allow their dependencies to become ready. A proxy may briefly return HTTP 502 while the database and applications initialize. Retry for the operational timeout defined for the deployment, and inspect service logs if readiness doesn't complete.

Verify the restored server

Complete these manual Team Edition checks in addition to the shared verification sequence:

  1. Sign in with representative administrator and regular-user accounts.
  2. Open saved connections and confirm that their saved credentials work without exposing them.
  3. Verify representative Query Manager history, tasks, shared and private projects, and Structured Query Language (SQL) scripts.
  4. Confirm the license status in the product interface.
  5. Manually confirm trusted TLS, including hostname and trust-chain validation, from a production-equivalent client.

Capture stable business-record counts and representative project files before product startup when possible. Compare them after restore. Track runtime metadata created by services during startup separately. Structural checks supplement the manual functional checks and don't replace them. Mark any incomplete manual checks as pending.