Skip to content

docs(backend): add backend component overview section#12871

Open
RATNAPRADEEP wants to merge 3 commits intokubeflow:masterfrom
RATNAPRADEEP:docs-backend-overview
Open

docs(backend): add backend component overview section#12871
RATNAPRADEEP wants to merge 3 commits intokubeflow:masterfrom
RATNAPRADEEP:docs-backend-overview

Conversation

@RATNAPRADEEP
Copy link

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

  • Signed off my commit (DCO)
  • Follows PR title convention
  • Documentation only change

Signed-off-by: Ratnapradeep <prpr23091999@gmail.com>
Copilot AI review requested due to automatic review settings February 21, 2026 05:26
@google-oss-prow google-oss-prow bot requested a review from hbelmiro February 21, 2026 05:26
@google-oss-prow
Copy link

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by:
Once this PR has been reviewed and has the lgtm label, please assign chensun for approval. For more information see the Kubernetes Code Review Process.

The full list of commands accepted by this bot can be found here.

Details Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@google-oss-prow google-oss-prow bot requested a review from HumairAK February 21, 2026 05:26
@github-actions
Copy link

🎉 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.

@google-oss-prow
Copy link

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 /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

Details

Instructions 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.

Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Comment on lines +15 to +16
- **Driver** – Translates pipeline specifications into executable
workflow definitions.
Copy link

Copilot AI Feb 21, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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".

Suggested change
- **Driver**Translates pipeline specifications into executable
workflow definitions.
- **Driver**Orchestrates task execution and manages execution state
with ML Metadata (MLMD).

Copilot uses AI. Check for mistakes.
@hbelmiro
Copy link
Contributor

@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>
@RATNAPRADEEP
Copy link
Author

Addressed Copilot comments. Added Scheduled Workflow Controller and Viewer Controller to the Backend Component Overview. Please review.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants