Appearance
apphost.addon.prepare
Resolve a hosted site, force the Machine always-on, and build chart-shaped Nostr Buzz manifests (WebSocket relay + Redis + MinIO; Postgres is AppData) pinned to pool apphost. Not native Chat Relay and not DPWAI Chat Relay REST/SSE.
Build the pinned Buzz addon manifests for an AppHost site.
Overview
| Property | Value |
|---|---|
| Workflow type | Atomic |
| Library | App-apphost |
| Version | 1.0 |
Input Schema
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
site_uuid | uuid | Yes | — | Claimed AppHost site to apply the addon on |
addon | string | Yes | — | Addon name. v1 ships buzz only |
sku | string | No | small | Shared size class for the relay (small |
custom_hostname | string | No | — | Optional customer subdomain to put on the addon Ingress (CNAME to the platform host) |
owner_public_key | string | No | — | Bound owner public key; turns membership on when present |
owner_key_kind | string | No | — | identity key kind of the owner: service = Buzz space (platform-held) |
secrets_key_ref | string | No | — | Per-site secrets key uuid; stamped on Redis/MinIO/relay so a rotation rolls them |
rollout_token | string | No | — | Apply run id; stamped on the relay so each apply's AppData password is picked up |
Output Schema
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
site_uuid | uuid | Yes | — | — |
organization_uuid | uuid | No | — | — |
machine_uuid | uuid | No | — | — |
slug | string | Yes | — | — |
host | string | Yes | — | — |
hosts | json | No | — | — |
url | string | Yes | — | — |
namespace | string | Yes | — | — |
addon | string | Yes | — | — |
sku | string | Yes | — | — |
connection_uuid | uuid | Yes | — | — |
field_manager | string | Yes | — | — |
manifests | json | Yes | — | — |
restore_ingress | json | No | — | — |
custom_hostname | string | No | — | Optional customer subdomain on the addon Ingress |
failure_reason | string | No | — | — |
failure_type | string | No | — | — |
failed_action | string | No | — | — |
failed_at_state | string | No | — | — |
failed_step | string | No | — | — |
failed_layer | string | No | — | — |
error | string | No | — | — |
error_type | string | No | — | — |
States
| State | Initial | Terminal | Success | Auto-advance | Description |
|---|---|---|---|---|---|
pending | Yes | No | — | execute | Will resolve the site and build addon manifests |
completed | No | Yes | Yes | — | Manifests ready |
failed | No | Yes | No | — | Prepare rejected |
State Diagram
Transitions
| From | Action | To | Description |
|---|---|---|---|
pending | execute | completed | — |
* (any state) | fail | failed | — |
Outcomes
| Outcome | Type | Description | State Data Keys |
|---|---|---|---|
prepared | SUCCESS | Addon manifests ready for k8s.manifest.sync | url, namespace, addon |
failed | FAILURE | Apphost workflow failed | failure_reason |
API Usage
bash
POST /api/workflows/start
Content-Type: application/json
{
"workflow_type": "apphost.addon.prepare",
"initial_data": {
"site_uuid": "value",
"addon": "value"
}
}