Skip to content

Add cross-repo capability specs#160

Draft
thomasmaas wants to merge 1 commit intomainfrom
add-capability-specs
Draft

Add cross-repo capability specs#160
thomasmaas wants to merge 1 commit intomainfrom
add-capability-specs

Conversation

@thomasmaas
Copy link

Summary

  • Adds cross-repository specification documents under docs/specs/ that capture how Kuadrant capabilities span multiple repositories, the contracts between components, and shared conventions
  • These specs enable AI coding assistants to reason about cross-repo changes (Spec-Driven Development) and serve as human-readable architecture documentation
  • Covers all major capabilities: rate limiting, auth, DNS, TLS, and the policy-machinery framework

Files

File Repos covered
docs/specs/repo-map.md All repos — dependency flow, CRD ownership tables, 7 cross-repo contracts
docs/specs/capabilities/gateway-policy.md policy-machinery, kuadrant-operator
docs/specs/capabilities/rate-limiting.md kuadrant-operator, limitador, limitador-operator, wasm-shim
docs/specs/capabilities/auth.md kuadrant-operator, authorino, authorino-operator, wasm-shim
docs/specs/capabilities/dns.md kuadrant-operator, dns-operator
docs/specs/capabilities/tls.md kuadrant-operator, cert-manager
docs/specs/capabilities/cross-cutting.md All repos — labels, conditions, errors, images, toolchain, testing

What each spec includes

  • Data flow diagrams showing how a user action propagates through components
  • CRD spec structures with realistic YAML examples
  • Cross-repo contracts specifying exact data formats at each integration boundary
  • Critical invariants that must stay in sync across repos
  • Key source file links (GitHub URLs) for navigating to implementation

Test plan

  • Verify all GitHub URLs in Key Source Files sections resolve correctly
  • Review for accuracy against current codebase
  • Confirm no sensitive or internal-only information is included

🤖 Generated with Claude Code

Adds specification documents that capture how Kuadrant capabilities span
multiple repositories, the contracts between components, and shared
conventions. These specs enable AI coding assistants to reason about
cross-repo changes and serve as human-readable architecture docs.

Files added:
- docs/specs/repo-map.md: inter-repo dependencies and contracts
- docs/specs/capabilities/gateway-policy.md: policy-machinery framework
- docs/specs/capabilities/rate-limiting.md: rate limiting (4 repos)
- docs/specs/capabilities/auth.md: auth/authz (4 repos)
- docs/specs/capabilities/dns.md: DNS management (2 repos)
- docs/specs/capabilities/tls.md: TLS certificates
- docs/specs/capabilities/cross-cutting.md: shared conventions

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
@thomasmaas thomasmaas marked this pull request as draft March 19, 2026 12:10
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