docs(backend): add backend component overview section#12871
docs(backend): add backend component overview section#12871RATNAPRADEEP wants to merge 3 commits intokubeflow:masterfrom
Conversation
Signed-off-by: Ratnapradeep <prpr23091999@gmail.com>
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: The full list of commands accepted by this bot can be found here. DetailsNeeds approval from an approver in each of these files:Approvers can indicate their approval by writing |
|
🎉 Welcome to the Kubeflow Pipelines repo! 🎉 Thanks for opening your first PR! We're excited to have you onboard 🚀 Next steps:
Feel free to ask questions in the comments. |
|
Hi @RATNAPRADEEP. Thanks for your PR. I'm waiting for a kubeflow member to verify that this patch is reasonable to test. If it is, they should reply with Once the patch is verified, the new status will be reflected by the I understand the commands that are listed here. DetailsInstructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository. |
There was a problem hiding this comment.
Pull request overview
This PR adds a "Backend Component Overview" section to the backend README to improve contributor onboarding by documenting the key backend components and their responsibilities in the Kubeflow Pipelines architecture.
Changes:
- Added a new "Backend Component Overview" section that lists and describes six major backend components (API Server, Driver, Launcher, Persistence Agent, Metadata Writer, and Cache Layer)
- Included explanatory text about how understanding these components helps contributors
| - **Driver** – Translates pipeline specifications into executable | ||
| workflow definitions. |
There was a problem hiding this comment.
The Driver description as "Translates pipeline specifications into executable workflow definitions" may be imprecise. Based on the code in backend/src/v2/driver/driver.go and backend/src/v2/cmd/driver/main.go, the driver appears to be responsible for orchestrating task execution (ROOT_DAG, DAG, CONTAINER types) and managing execution state with MLMD, rather than translating specifications.
The pipeline-to-workflow translation is typically done by the compiler component. Consider revising this description to something more accurate like "Orchestrates task execution and manages execution state" or "Prepares and manages the execution context for pipeline tasks".
| - **Driver** – Translates pipeline specifications into executable | |
| workflow definitions. | |
| - **Driver** – Orchestrates task execution and manages execution state | |
| with ML Metadata (MLMD). |
|
@RATNAPRADEEP can you please address copilot's comments? |
…end overview Added locations for Scheduled Workflow Controller and Viewer Controller. Signed-off-by: RATNAPRADEEP <145099417+RATNAPRADEEP@users.noreply.github.com>
|
Addressed Copilot comments. Added Scheduled Workflow Controller and Viewer Controller to the Backend Component Overview. Please review. |
Description
Adds a Backend Component Overview section to the backend README to improve contributor onboarding and provide a clearer understanding of backend architecture and component responsibilities.
Checklist