PSA/ee/appliance/README.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

76 lines
3.0 KiB
Markdown

# Appliance Assets (Ubuntu v1)
This directory owns the Alga PSA self-hosted appliance runtime assets.
Supported customer appliance path for v1 is Ubuntu Server 24.04 LTS with the host setup/status service on port `8080`. The older local release tree and script-driven bootstrap/upgrade process have been removed from this repository.
For user-facing appliance installation and operation guides, start with:
- `ee/docs/appliance/README.md`
- `ee/docs/appliance/quick-start.md`
- `ee/docs/appliance/operators-manual.md`
- `ee/docs/appliance/technical-reference.md`
Current responsibilities:
- Ubuntu appliance ISO workspace under `ubuntu-iso/`
- host setup/status/update service under `host-service/`
- Flux deployment profiles under `flux/`
- storage prerequisites under `manifests/`
- support/repair/reset helpers under `scripts/`
## Release publishing
Appliance release metadata is published as an OCI artifact in `ghcr.io/nine-minds/alga-appliance-release`. It is not stored under `ee/appliance` and is not published by scripts in this repository.
Use the Argo workflow in the Kubernetes config repository:
```text
~/nm-kube-config/alga-psa/workflows/composite/alga-psa-build-migrate-deploy.yaml
```
For stable channel publishing, submit the workflow with:
```text
promote-release=true
publish-appliance-release=true
appliance-release-channel=stable
```
Use `appliance-release-source-ref` / `appliance-release-version` only when intentionally overriding the source commit or release version. The appliance setup and update engines resolve the selected channel from OCI at runtime.
## Setup and updates
- First install is driven by the host service and setup UI on port `8080`.
- Application channel updates are driven by `host-service/update-engine.mjs` and the in-cluster status/update UI.
- Both paths resolve release metadata from the OCI artifact registry, then apply runtime values, the pinned Flux config bundle, and the selected image tags.
## Operator and support helpers
The `ee/appliance/appliance` operator is for status, support bundles, repair helpers, and destructive reset in engineering/support contexts. It no longer exposes bootstrap or upgrade commands.
```bash
ee/appliance/appliance status
ee/appliance/appliance support-bundle --output-dir ./bundles
ee/appliance/appliance repair-release --release-name alga-core
ee/appliance/appliance reset --force
```
Use the destructive reset helper directly when you need to clear persisted appliance data between test runs:
```bash
ee/appliance/scripts/reset-appliance-data.sh \
--kubeconfig ~/.alga-psa-appliance/appliance-single-node/kubeconfig \
--force
```
## Support bundles
Use `ee/appliance/scripts/collect-support-bundle.sh` to export the standard diagnostics package for support. The `--talosconfig` and `--node-ip` flags are optional legacy diagnostics inputs, not required for the supported Ubuntu appliance path.
```bash
ee/appliance/scripts/collect-support-bundle.sh \
--kubeconfig ~/.alga-psa-appliance/appliance-single-node/kubeconfig \
--site-id appliance-single-node
```