Service catalog · 03 of 05 · The contract

What one catalog entry has to carry

This is Airframe's real PostgreSQL entry, read from its XRD and its sidecar meta file. The form a developer fills in is the smallest part of it.

What one catalog entry has to carry The PostgreSQL API, postgresqls.catalog.hangar.io, at the centre of six facets, all taken from Airframe. What you ask for: environmentRef (required), size (small, medium or large) and instances (1 to 3). What you get back: the CloudNativePG-managed Secret named after the database with host, port, username, password, uri and jdbcUri keys. How you know, highlighted: the ComponentReady reasons PostgreSQLReady (true), PostgreSQLProvisioning and PostgreSQLDegraded (false). How it is verified: xr-ready, secret-exists and reachable on TCP 5432. Said for agents: a one-line agent summary, the generated contract bundle and llms.txt at the repo root. Who may change it: the owner is a human, the write path is a git commit, and drift between the contract and its source fails CI. ONE CATALOG ENTRY · POSTGRESQLASKWhat you ask forenvironmentRefrequiredsizesmall · medium · largeinstances1 to 3GETWhat you get backSecret {name}-appcnpg managedhost · port · usernamesecret keypassword · uri · jdbcUrisecret keyKNOWHow you knowPostgreSQLReadytruePostgreSQLProvisioningfalsePostgreSQLDegradedfalseCHECKHow it is verifiedxr-readyconditionsecret-existspassword keyreachabletcp :5432AGENTSSaid for agentsagent-summaryone linecontract bundlegeneratedllms.txtrepo rootRULESWho may change itownerhumanwrite patha git commitdriftfails ciPostgreSQLpostgresqls.catalog.hangar.ioA name and a form is a wish list. The contract is what makes it an API.LEGENDPart of the contractWhat an agent switches on

For people

The ask is a handful of fields, and only the environment has no default. Everything a developer needs to connect is named in advance, so nobody guesses a Secret name.

For machines

A closed list of reasons, and checks that say what "working" means. An agent can act on PostgreSQLDegraded. It can't act on "something's off".

For the platform team

The contract is generated and checked in CI, so the entry can't quietly drift from what the composition does.

Hangar · Airframe · Service catalog