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

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

Open
cjidboon94 opened this issue Jun 25, 2024 · 10 comments · May be fixed by #11490
Open

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

cjidboon94 opened this issue Jun 25, 2024 · 10 comments · May be fixed by #11490

Comments

@cjidboon94
Copy link
Contributor

cjidboon94 commented Jun 25, 2024

Feature Area

/area docs

What feature would you like to see?

For operators, contributors and administrators of KFP, it would be great to have clear diagrams and documentation of KFP v2's architecture.
How, for example, Launcher, Driver and Compiler components relate to each other in the backend. ( https://cloud-native.slack.com/archives/C073N7BMLB1/p1719335776541249 )
Parameters and tweaks to improve KFP performance and stability (similar to #5333 )

What is the use case or pain point?

This will help new KFP admins and contributors better understand the inner workings and what knobs one can turn to configure KFP to the desired state.

Is there a workaround currently?

Asking on slack, stackoverflow, GH issues and praying for answers, or diving into the code and try to figure it out yourself.


Love this idea? Give it a 👍.

@droctothorpe
Copy link
Contributor

Happy to contribute to this.

@StefanoFioravanzo
Copy link
Member

@cjidboon94 Indeed we are missing a lot of reference architecture from KFP docs. I was discussing this with @rimolive. Maybe with the help of @hbelmiro we can start by creating a new issue similar to kubeflow/website#3712 but targeted at Kubeflow 1.10.

This is a list of all the docs I could find related to KFP V2 architecture and related topics:

For each doc, someone should identify if there are topics worth extrapolating into the website. And then once this is done, we can also start listing other topics that need documentation but that had no reference at all.

@StefanoFioravanzo
Copy link
Member

There is also the matter of an architectural explanation about multi-backend support and current integration with Tekton - #10980

@HumairAK
Copy link
Collaborator

/assign @anishasthana

@juliusvonkohout
Copy link
Member

Maybe the diagrams in https://blogs.vmware.com/opensource/2023/06/20/hardening-kubeflow-security-for-enterprise-environments-2/ are useful.

Copy link

github-actions bot commented Oct 1, 2024

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

@github-actions github-actions bot added the lifecycle/stale The issue / pull request is stale, any activities remove this label. label Oct 1, 2024
@HumairAK
Copy link
Collaborator

HumairAK commented Oct 7, 2024

/remove-lifecycle stale

@google-oss-prow google-oss-prow bot removed the lifecycle/stale The issue / pull request is stale, any activities remove this label. label Oct 7, 2024
Copy link

github-actions bot commented Dec 7, 2024

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

@github-actions github-actions bot added the lifecycle/stale The issue / pull request is stale, any activities remove this label. label Dec 7, 2024
@juliusvonkohout
Copy link
Member

/lifecycle frozen

@google-oss-prow google-oss-prow bot added lifecycle/frozen and removed lifecycle/stale The issue / pull request is stale, any activities remove this label. labels Dec 7, 2024
@anishasthana anishasthana linked a pull request Dec 29, 2024 that will close this issue
@anishasthana
Copy link

/remove-lifecycle frozen

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

Successfully merging a pull request may close this issue.

6 participants