docs: add functional modules and interactions document#361
Draft
docs: add functional modules and interactions document#361
Conversation
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
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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:cluster-managerREST server,template-controlleroperator) with startup sequencesrest,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 responsibilitiesClusterTemplateCRD schema, CAPI resources generated by the controller, and CAPI resources managed by the REST serverdoc/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.