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

Create architecture diagram #369

Draft
wants to merge 11 commits into
base: master
Choose a base branch
from
Draft

Conversation

alexgeorgousis
Copy link
Contributor

@alexgeorgousis alexgeorgousis commented Sep 27, 2024

This PR adds a high-level architecture diagram illustrating the KFP Operator managing ML pipelines using Kubernetes Custom Resource Definitions (CRDs) across multiple provider and user namespaces. It demonstrates how the operator interacts with Kubernetes components to orchestrate pipelines in various runtime environments.

The PR also integrates the diagram in a diffable and editable format using draw.io, enabling easy version control and collaboration.

Tasks

  • Create high-level architecture diagram
  • Figure out how to embed draw.io diagrams so they're diffable and editable (if that's possible)

@alexgeorgousis alexgeorgousis force-pushed the architecture-diagram branch 7 times, most recently from beb0991 to 8ddf0df Compare September 30, 2024 14:05
@edinekj edinekj force-pushed the architecture-diagram branch from 75a15da to 824fd30 Compare October 3, 2024 09:50
@edinekj edinekj marked this pull request as ready for review October 3, 2024 09:54
@edinekj
Copy link

edinekj commented Oct 3, 2024

  • Only drawio diagrams saved as SVG support links, which can be used for better navigation. The team decided to use SVG files.
  • Diagrams can be opened in the editor from the browser using the orange icon in the bottom right corner or by using extensions in the IDE. drawio-link
  • We should be able to see visual changes in the diagrams (an example is provided below).
diagram-diff - We were able to enable flow animation styles for connectors. More details: [link](https://www.drawio.com/blog/connector-animation-styles)

@edinekj edinekj requested a review from a team October 3, 2024 10:09
@edinekj edinekj force-pushed the architecture-diagram branch from dbf86f3 to 0168c28 Compare October 4, 2024 10:56
@edinekj edinekj requested review from a team, edinekj and grahamia October 4, 2024 11:20
Copy link
Contributor

@grahamia grahamia left a comment

Choose a reason for hiding this comment

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

Approving but will leave up to team whether animations are worth it but this cant be merged yet as it would go straight live on website and this is target achitecture.

@grahamia grahamia marked this pull request as draft October 4, 2024 15:07
@edinekj edinekj force-pushed the architecture-diagram branch 9 times, most recently from ccc1f05 to 55bea4e Compare October 10, 2024 14:26
@edinekj edinekj force-pushed the architecture-diagram branch from 55bea4e to 928457b Compare October 10, 2024 14:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants