PSA/docs/deployment/app-wide-search-runbook.md
Hermes 284313f908
Some checks are pending
Bidi Control Character Guard / bidi-control-guard (push) Waiting to run
Circular Dependency Check / Check for new circular dependencies (push) Waiting to run
Citus Migration Smoke / Combined migrations on single-node Citus (push) Waiting to run
E2E Fresh Install Tests / fresh-install-e2e (push) Waiting to run
ext-v2 guardrails / Run ext-v2 guard and ESLint (push) Waiting to run
Integration Tests / Check for relevant changes (push) Waiting to run
Integration Tests / ${{ (github.event_name == 'schedule' || github.event.inputs.suite == 'full') && 'Full integration suite' || 'Tier-1 integration subset' }} (push) Blocked by required conditions
Mobile checks / Mobile lint + typecheck (push) Waiting to run
Mobile checks / Mobile unit tests (push) Waiting to run
Mobile checks / Mobile dependency audit (report) (push) Waiting to run
Mobile checks / Mobile reproducibility checks (push) Waiting to run
Secrets guard (env backups) / Ensure no tracked env backup files (push) Waiting to run
Temporal Readiness / fast-readiness (push) Waiting to run
Temporal Readiness / docker-parity (push) Waiting to run
TypeScript Type Check / Nx affected typecheck (push) Waiting to run
Unit Tests / Skipped-test budget (push) Waiting to run
Unit Tests / Nx affected unit tests (push) Waiting to run
Unit Tests / Server unit coverage (informational) (push) Waiting to run
Validate Tenant Management Schema / Check for relevant changes (push) Waiting to run
Validate Tenant Management Schema / Validate Tenant Management Schema (push) Blocked by required conditions
EE Workflows Build Guard / ee-workflows-build-guard (push) Waiting to run
Initial import of AlgaPSA codebase from PSA server
Excluded: .git, node_modules, secrets/, compose.env, assemblyscript tgz

Source: /opt/alga-psa on psa.joliet.tech
2026-06-22 16:12:17 -05:00

1.1 KiB

App-Wide Search Deploy Runbook

Use this runbook when deploying the app-wide search index for the first time in an environment.

Steps

  1. Apply the database migration that creates app_search_index and its indexes.

    npm run migrate
    
  2. Deploy the application with live indexing disabled.

    SEARCH_INDEX_LIVE=false
    

    For Helm deployments, keep server.searchIndexLive: false.

  3. Backfill the index.

    npm run search:backfill
    

    To backfill one tenant first:

    npm run search:backfill -- --tenant=<tenant_uuid>
    
  4. Flip live indexing on and roll the server/workers.

    SEARCH_INDEX_LIVE=true
    

    For Helm deployments, set server.searchIndexLive: true.

  5. Verify search health for a sampled tenant.

    SELECT object_type, count(*), max(indexed_at)
    FROM app_search_index
    WHERE tenant = '<tenant_uuid>'
    GROUP BY object_type
    ORDER BY object_type;
    
  6. Confirm the daily search:reconcile job is registered. It repairs missed events by re-indexing updated or missing source rows and deleting orphaned index rows.