VectorVue Documentation

Integration, platform operations, architecture, and assurance references

VectorVue Deployment Guide

This runbook deploys VectorVue for production-style environments.

1. Prerequisites

2. Deploy Full Stack

Recommended guided flow:

make wizard

Select option 1.

Direct command path:

make deploy

Expected services:

3. Seed Demo or Acceptance Data

make seed-clients

Guided path: make wizard and select option 4.

4. Validation

make api-smoke
docker compose ps

Confirm API health, OpenAPI availability, and worker uptime.

5. TLS Certificate Assets

Generate local cert assets when needed:

./deploy/scripts/generate_tls_certs.sh

6. Tenant-Isolated Deployment Pattern

To run a separate customer namespace:

make customer-deploy-isolated \
  CUSTOMER=acme \
  TENANT_NAME="ACME Industries" \
  HTTP_HOST_PORT=8081 \
  HTTPS_HOST_PORT=8444 \
  POSTGRES_HOST_PORT=5544

Default local docker host mapping for PostgreSQL is 55433 (override with POSTGRES_HOST_PORT when needed).

For full isolated portal onboarding in one flow:

make wizard

Select option 2.

7. Upgrade and Migration Sequence

Use this order:

  1. make deploy
  2. make pg-schema-bootstrap
  3. make phase65-migrate
  4. make phase7e-migrate
  5. make phase8-migrate
  6. make phase9-migrate
  7. make seed-clients (if demo/non-production)

8. Operational Notes

9. Commercial Tenant Commands

10. TUI Admin Onboarding Wizard

Use this flow to onboard tenant + portal metadata from the app UI.

  1. Start TUI:
    • make run-tui
  2. Login with admin role.
  3. Open wizard:
    • hotkey Ctrl+Shift+W
    • or sidebar ONBOARD WIZARD
  4. Fill tenant metadata, company branding, and credentials.
  5. Run CREATE TENANT + USERS.