BBramaDocs
Browse documentation

Runnable examples

Scripts behind the subscription walkthrough. Each one reads a real gateway or a real installation; none of them stands in for a provider, and none of them writes operator state.

Script What it does
health-then-ready.sh GET /health then GET /readyz — liveness, then the readiness probe that actually redeems credentials
signed-agent-listing.sh computes the x-agent-* HMAC trio with openssl and reads GET /v1/subscription-pool, the shared pool every caller is served from
subscription-pool-report.sh brama subscription list (text and --json) against isolated state — contacts no provider, writes nothing

Run it

Against a gateway serving on this host (brama serve, port 8080 unless BRAMA_URL names another):

$ docs/examples/health-then-ready.sh
$ BRAMA_TOKEN=<client bearer> BRAMA_AGENT=<agent> BRAMA_AGENT_SECRET=<request-sign secret> \
    docs/examples/signed-agent-listing.sh
$ BRAMA_BIN=target/debug/brama docs/examples/subscription-pool-report.sh

To see each declared alias answer a real request, use brama probe on the gateway's host.

Conventions

  • Every script takes its knobs from BRAMA_-prefixed environment variables (BRAMA_BIN, BRAMA_URL, BRAMA_TOKEN, BRAMA_AGENT, BRAMA_AGENT_SECRET); nothing is positional. A variable without a working default is refused by name before any request is made.