Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(docs): Add architecture diagram #11490

Open
wants to merge 3 commits into
base: master
Choose a base branch
from

Conversation

anishasthana
Copy link

Closes #10957

This is a first draft of an architecture diagram for Kubeflow Pipelines. I started with mermaid-js but it was taking a long while... I figured we can get something via draw.io diagram and then iterate over time.

cc @HumairAK

@anishasthana anishasthana changed the title feat(documentation): Add architecture diagram feat(docs): Add architecture diagram Dec 29, 2024
images/kfp-cluster-wide-architecture.png Outdated Show resolved Hide resolved
images/kfp-cluster-wide-architecture.png Outdated Show resolved Hide resolved
images/kfp-cluster-wide-architecture.png Outdated Show resolved Hide resolved
@anishasthana anishasthana force-pushed the add_architecture_diagram branch from c93651e to 45cf652 Compare December 30, 2024 16:28
@anishasthana
Copy link
Author

@hbelmiro thanks for the review. I've made some updates.

Copy link
Contributor

@hbelmiro hbelmiro left a comment

Choose a reason for hiding this comment

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

/lgtm

README.md Outdated Show resolved Hide resolved
Signed-off-by: Anish Asthana <[email protected]>
@anishasthana anishasthana force-pushed the add_architecture_diagram branch from 45cf652 to bcb8849 Compare January 2, 2025 17:38
@google-oss-prow google-oss-prow bot removed the lgtm label Jan 2, 2025
@rimolive
Copy link
Member

rimolive commented Jan 9, 2025

/lgtm

README.md Outdated Show resolved Hide resolved
@anishasthana anishasthana force-pushed the add_architecture_diagram branch from bcb8849 to 7770ba4 Compare January 10, 2025 18:09
@google-oss-prow google-oss-prow bot removed the lgtm label Jan 10, 2025
@anishasthana anishasthana requested a review from rimolive January 10, 2025 18:12
@franciscojavierarceo
Copy link

image

@rimolive
Copy link
Member

/lgtm

@google-oss-prow google-oss-prow bot added the lgtm label Jan 10, 2025
@anishasthana anishasthana force-pushed the add_architecture_diagram branch from 7770ba4 to 02c16bd Compare January 10, 2025 18:42
@google-oss-prow google-oss-prow bot removed the lgtm label Jan 10, 2025
Copy link

New changes are detected. LGTM label has been removed.

@google-oss-prow google-oss-prow bot removed the size/S label Jan 10, 2025
Copy link

[APPROVALNOTIFIER] This PR is NOT APPROVED

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

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

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

[#kubeflow-pipelines](https://kubeflow.slack.com)
We also have a slack channel (#kubeflow-pipelines) on the Cloud Native Computing Foundation Slack workspace. You can find more details at [https://www.kubeflow.org/docs/about/community/#kubeflow-slack-channels](https://www.kubeflow.org/docs/about/community/#kubeflow-slack-channels)

## Architecture
Copy link
Collaborator

Choose a reason for hiding this comment

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

I don't think we should put the arch diagram in the front readme of the repo, can we move this further into the docs folder? https://github.com/kubeflow/pipelines/tree/master/docs

once done we can link it from the kfp website in the operator-guides section: https://www.kubeflow.org/docs/components/pipelines/operator-guides/

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[feature] Add clear architectural diagrams on how KFP works and fill out the operator guides
6 participants