Skip to content

docs(readme): document features shipped since the v0.1.0 scaffold#42

Merged
joy-software merged 1 commit into
mainfrom
docs/readme-refresh
Jun 7, 2026
Merged

docs(readme): document features shipped since the v0.1.0 scaffold#42
joy-software merged 1 commit into
mainfrom
docs/readme-refresh

Conversation

@joy-software

Copy link
Copy Markdown
Contributor

The README predated the audit backlog. This refreshes it to match what main actually ships:

  • Per-service capabilities — secret-backed env (valueFrom/envFrom + External Secrets), custom domains + automatic TLS, traffic splitting, with a worked example.
  • Observability section — Prometheus metrics (ELPIO_METRICS=1), Kubernetes Events, child-readiness gating, and the optional in-cluster Spero bundle.
  • Security — expanded with ELPIO_BAN_LATEST/ELPIO_REQUIRE_REQUESTS, no-credential-leak API + tokenSecretRef, scoped operator RBAC, and signed images + SBOM.
  • CLIstatus / logs / delete verbs.
  • Layout — adds api/, webhook/, dispatcher/, tenant.py.

Docs-only; no code or CI change.

Refresh the README to match what main now ships: secret-backed env
(valueFrom/envFrom + External Secrets), custom domains + automatic TLS, traffic
splitting, operator metrics + Events, child-readiness gating, the optional
in-cluster Spero bundle, expanded admission knobs (ban :latest, require
requests), token-secret refs + scoped operator RBAC, signed images + SBOM, the
new CLI verbs (status/logs/delete), and an updated source layout (api, webhook,
dispatcher, tenant).
@joy-software joy-software merged commit e154b9c into main Jun 7, 2026
7 of 9 checks passed
@joy-software joy-software deleted the docs/readme-refresh branch June 7, 2026 22:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant