57 lines
2.1 KiB
Markdown
57 lines
2.1 KiB
Markdown
|
# SCOPE
|
||
|
|
|
||
|
|
## One-liner
|
||
|
|
|
||
|
|
Package and operate the `canned-prompts` hosted registry and index on
|
||
|
|
Railiance, without moving product ownership into an operations repository.
|
||
|
|
|
||
|
|
## In Scope
|
||
|
|
|
||
|
|
- `declarations/rapp.yaml` — the managed-workload declaration: composition,
|
||
|
|
image pin, rollout, smoke and rollback contracts.
|
||
|
|
- `manifests/` — namespace, external secrets, migration Job, and the runtime
|
||
|
|
Deployment, Service, ServiceAccount and NetworkPolicies.
|
||
|
|
- `tools/smoke.sh` — deployment-level verification, delegating the
|
||
|
|
service-level half to `canned-prompts`.
|
||
|
|
- Rollout, rollback and the network posture.
|
||
|
|
|
||
|
|
## Out of Scope
|
||
|
|
|
||
|
|
- What a valid prompt package is, what any endpoint means, the schema and its
|
||
|
|
migrations, and image publication — all `canned-prompts`.
|
||
|
|
- PostgreSQL topology, isolation, backups, credential issuance — `rapp-postgres`
|
||
|
|
and the platform credential broker.
|
||
|
|
- Who may publish. The service's identity is a single shared token proving
|
||
|
|
"the operator"; per-publisher identity is an open question upstream, and this
|
||
|
|
repo must not imply finer control than exists.
|
||
|
|
|
||
|
|
## Current State
|
||
|
|
|
||
|
|
**Draft.** The package is written and its manifests parse, but nothing is
|
||
|
|
deployed and `readiness_state` is `draft`. Two things block a first rollout,
|
||
|
|
both operator actions rather than authoring ones:
|
||
|
|
|
||
|
|
- the image has never been published, so no registry digest exists to pin
|
||
|
|
(`declarations/rapp.yaml` says `pending-publication` rather than carrying a
|
||
|
|
placeholder that could be mistaken for something deployable);
|
||
|
|
- database roles and OpenBao credentials are not provisioned.
|
||
|
|
|
||
|
|
`workplans/RCP-WP-0002-first-deployment.md` carries both.
|
||
|
|
|
||
|
|
## Verification
|
||
|
|
|
||
|
|
This repo builds nothing.
|
||
|
|
|
||
|
|
```bash
|
||
|
|
for f in manifests/*.yaml; do python3 -c "import yaml,sys; list(yaml.safe_load_all(open('$f')))"; done
|
||
|
|
bash -n tools/smoke.sh
|
||
|
|
NS=canned-prompts ./tools/smoke.sh # against a live deployment
|
||
|
|
```
|
||
|
|
|
||
|
|
## Getting Oriented
|
||
|
|
|
||
|
|
- Intent and boundaries: `INTENT.md`
|
||
|
|
- The declaration: `declarations/rapp.yaml`
|
||
|
|
- What the service is: `canned-prompts/service/README.md`
|
||
|
|
- Deployment guide: `repo-manager/docs/RailianceAppDeploymentGuide.md`
|