Add documentation for Operation Cache Controller and related components #24
Conversation
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
There was a problem hiding this comment.
Pull Request Overview
This PR introduces comprehensive documentation for the Operation Cache Controller and related components, enhancing clarity around command usage, sequence flows, and CRD specifications.
- Adds detailed Mermaid sequence diagrams for Cache, Operation, AppDeployment, and Requirement controllers.
- Provides updated YAML examples for Job CR specifications and client command usage.
- Updates overall architectural context and interactions in the overview documentation.
Reviewed Changes
Copilot reviewed 6 out of 6 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
| doc/arch/5-cache-controller.md | Added sequence diagrams for cache controller flows. |
| doc/arch/4-appdeployment-controller.md | Added diagrams for provisioning/teardown and Job CR specs. |
| doc/arch/3-operation-controller.md | Added operation controller sequences for reconcile/finalize. |
| doc/arch/2-requirement-controller.md | Added sequence diagrams covering cache hit and miss flows. |
| doc/arch/1-client.md | Provided usage examples and a sequence diagram for deployctl. |
| doc/arch/0-overview.md | Updated context diagrams and detailed CRD specifications. |
Comments suppressed due to low confidence (1)
doc/arch/0-overview.md:6
- Correct 'Pre-Provsion' to 'Pre-Provision'.
Pre-Provsion the resources for future use(Cache).
|
|
||
| ## Spec for Job CR | ||
|
|
||
| ### Provsion Job |
There was a problem hiding this comment.
Correct the spelling from 'Provsion Job' to 'Provision Job'.
Suggested change
| ### Provsion Job | |
| ### Provision Job |
| participant k8s | ||
|
|
||
| user ->>+ ctl: deployctl create -f <path-to-yaml-file> | ||
| ctl ->>+ k8s: Check if cache CR for exist |
There was a problem hiding this comment.
Correct the phrase to 'Check if cache CR exists' for improved grammar and clarity.
Suggested change
| ctl ->>+ k8s: Check if cache CR for exist | |
| ctl ->>+ k8s: Check if cache CR exists |
|
|
||
| The detailed interaction of Operation Cache Controller components is as follows: | ||
|
|
||
| - The Operation Cache controller comsumes Requirement CRD and return the Operation ID which is used to indicate the resources are provisioned. |
There was a problem hiding this comment.
Correct 'comsumes' to 'consumes' and consider changing 'return' to 'returns' for grammatical accuracy.
Suggested change
| - The Operation Cache controller comsumes Requirement CRD and return the Operation ID which is used to indicate the resources are provisioned. | |
| - The Operation Cache controller consumes Requirement CRD and returns the Operation ID which is used to indicate the resources are provisioned. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Introduce comprehensive documentation for the Operation Cache Controller, including command usage, sequence diagrams for various operations, and specifications for job configurations. This enhances understanding and usability of the components involved.