Skip to content

docs: add functional modules and interactions document#361

Draft
Copilot wants to merge 2 commits intomainfrom
copilot/list-functional-modules
Draft

docs: add functional modules and interactions document#361
Copilot wants to merge 2 commits intomainfrom
copilot/list-functional-modules

Conversation

Copy link
Copy Markdown

Copilot AI commented Mar 9, 2026

No documentation existed describing CM's internal structure or how its components relate to each other. This adds a reference document covering all functional modules and their interactions.

Changes

  • doc/modules.md (new) — covers:

    • Both binaries (cluster-manager REST server, template-controller operator) with startup sequences
    • All 21 internal packages (rest, controller, auth, multitenancy, k8s, convert, providers, inventory, middleware, template, config, labels, pagination, metrics, logger, events, webhook, core, common, cluster, mocks) — each with path, role, and key responsibilities
    • Four ASCII interaction flow diagrams: REST request pipeline, ClusterTemplate reconciliation, project lifecycle (Nexus → namespace), and admission webhook validation
    • External integrations table (OIDC, Keycloak, OPA, Vault, infra-core inventory gRPC, Nexus gRPC, Kubernetes API)
    • Kubernetes custom resource catalogue: ClusterTemplate CRD schema, CAPI resources generated by the controller, and CAPI resources managed by the REST server
  • doc/README.md — adds SPDX header and links to the new document


✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.

Co-authored-by: krishnajs <47258934+krishnajs@users.noreply.github.com>
Copilot AI changed the title [WIP] Document functional modules and their interactions docs: add functional modules and interactions document Mar 9, 2026
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.

2 participants