PSA/ee/docs/appliance/operators-manual.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.7 KiB

Operator's Manual (Ubuntu Appliance)

This manual covers day-2 operation for installed Ubuntu appliances.

Core Endpoints

  • Setup/Status plane: http://<node-ip>:8080
  • Setup flow: http://<node-ip>:8080/setup?token=<setup-token>
  • Support bundle: http://<node-ip>:8080/support-bundle?token=<status-token>
  • App updates: http://<node-ip>:8080/updates?token=<status-token>

Status And Failures

Status reports:

  • current phase and last action
  • readiness tiers
  • failure classification (network, dns, registry-release-source, k3s, flux, storage, app-bootstrap, app-readiness, background-services)
  • suspected cause, suggested next step, retry safety, and log hints

Support Bundle

Use the status UI button or API to generate a redacted support bundle.

Bundle includes:

  • appliance install/update state
  • host service journal excerpts
  • k3s/cluster snapshots
  • Flux and Helm status
  • bootstrap logs
  • network and DNS diagnostics
  • disk usage
  • release-selection metadata

App-Channel Updates

Use updates UI to apply stable or nightly channel changes.

Update flow:

  1. resolve selected channel metadata
  2. apply Flux source/release selection
  3. request Flux/Helm reconcile
  4. store update history

This flow is application-only in v1.

OS/K3s Maintenance In v1

Ubuntu package updates and k3s upgrades are not automated in v1. Run them through support/operations procedures.

Operational liability is explicit: CVE response for OS and k3s requires manual planning until v2 managed maintenance ships.

v2 Direction

Planned v2 maintenance direction:

  • managed maintenance windows
  • OS/k3s preflight checks and version-path validation
  • backup/snapshot checks
  • maintenance history and remediation guidance