Add an architecture diagram #858
Labels
Comments
antoniivanov
added a commit
that referenced
this issue
Jun 15, 2023
The goal of the architecture file is to provide a comprehensive overview of the VDK's architecture, components, and their relationships, serving as a reference document for developers, contributors, stakeholders, and users to understand the system's structure and make informed decisions. The diagrams are based on C4 model https://c4model.com The architecture is based on OnePage documents and we (Yoan and I) used the following architecture overviews as an example of good (data related) open source project arch documents: - https://argoproj.github.io/argo-workflows/architecture/ - https://docs.getdbt.com/docs/cloud/about-cloud/architecture - https://airflow.apache.org/ docs/apache-airflow/stable/core-concepts/overview.html - https://docs.airbyte.com/understanding-airbyte/high-level-view/ - https://docs.metaflow.org/internals/technical-overview - https://docs.dagster.io/deployment/overview - https://docs.flyte.org/en/latest/concepts/architecture.html Closes #858 Signed-off-by: Antoni Ivanov <[email protected]>
antoniivanov
added a commit
that referenced
this issue
Jun 15, 2023
The goal of the architecture file is to provide a comprehensive overview of the VDK's architecture, components, and their relationships, serving as a reference document for developers, contributors, stakeholders, and users to understand the system's structure and make informed decisions. The diagrams are based on C4 model https://c4model.com The architecture is based on OnePage documents and we (Yoan and I) used the following architecture overviews as an example of good (data related) open source project arch documents: - https://argoproj.github.io/argo-workflows/architecture/ - https://docs.getdbt.com/docs/cloud/about-cloud/architecture - https://airflow.apache.org/ docs/apache-airflow/stable/core-concepts/overview.html - https://docs.airbyte.com/understanding-airbyte/high-level-view/ - https://docs.metaflow.org/internals/technical-overview - https://docs.dagster.io/deployment/overview - https://docs.flyte.org/en/latest/concepts/architecture.html Closes #858 Signed-off-by: Antoni Ivanov <[email protected]>
antoniivanov
added a commit
that referenced
this issue
Jun 15, 2023
The goal of the architecture file is to provide a comprehensive overview of the VDK's architecture, components, and their relationships, serving as a reference document for developers, contributors, stakeholders, and users to understand the system's structure and make informed decisions. The diagrams are based on C4 model https://c4model.com The architecture is based on OnePage documents and we (Yoan and I) used the following architecture overviews as an example of good (data related) open source project arch documents: - https://argoproj.github.io/argo-workflows/architecture/ - https://docs.getdbt.com/docs/cloud/about-cloud/architecture - https://airflow.apache.org/ docs/apache-airflow/stable/core-concepts/overview.html - https://docs.airbyte.com/understanding-airbyte/high-level-view/ - https://docs.metaflow.org/internals/technical-overview - https://docs.dagster.io/deployment/overview - https://docs.flyte.org/en/latest/concepts/architecture.html Closes #858 Signed-off-by: Antoni Ivanov <[email protected]>
antoniivanov
added a commit
that referenced
this issue
Jun 15, 2023
The goal of the architecture file is to provide a comprehensive overview of the VDK's architecture, components, and their relationships, serving as a reference document for developers, contributors, stakeholders, and users to understand the system's structure and make informed decisions. The diagrams are based on C4 model https://c4model.com The architecture is based on OnePage documents and we (Yoan and I) used the following architecture overviews as an example of good (data related) open source project arch documents: - https://argoproj.github.io/argo-workflows/architecture/ - https://docs.getdbt.com/docs/cloud/about-cloud/architecture - https://airflow.apache.org/ docs/apache-airflow/stable/core-concepts/overview.html - https://docs.airbyte.com/understanding-airbyte/high-level-view/ - https://docs.metaflow.org/internals/technical-overview - https://docs.dagster.io/deployment/overview - https://docs.flyte.org/en/latest/concepts/architecture.html Closes #858 Signed-off-by: Antoni Ivanov <[email protected]>
antoniivanov
added a commit
that referenced
this issue
Jun 16, 2023
The goal of the architecture file is to provide a comprehensive overview of the VDK's architecture, components, and their relationships, serving as a reference document for developers, contributors, stakeholders, and users to understand the system's structure and make informed decisions. The diagrams are based on C4 model https://c4model.com The architecture is based on OnePage documents and we (Yoan and I) used the following architecture overviews as an example of good (data related) open source project arch documents: - https://argoproj.github.io/argo-workflows/architecture/ - https://docs.getdbt.com/docs/cloud/about-cloud/architecture - https://airflow.apache.org/ docs/apache-airflow/stable/core-concepts/overview.html - https://docs.airbyte.com/understanding-airbyte/high-level-view/ - https://docs.metaflow.org/internals/technical-overview - https://docs.dagster.io/deployment/overview - https://docs.flyte.org/en/latest/concepts/architecture.html Closes #858 Signed-off-by: Antoni Ivanov <[email protected]>
antoniivanov
added a commit
that referenced
this issue
Jul 16, 2023
The goal of the architecture file is to provide a comprehensive overview of the VDK's architecture, components, and their relationships, serving as a reference document for developers, contributors, stakeholders, and users to understand the system's structure and make informed decisions. The diagrams are based on C4 model https://c4model.com The architecture is based on OnePage documents and we (Yoan and I) used the following architecture overviews as an example of good (data related) open source project arch documents: - https://argoproj.github.io/argo-workflows/architecture/ - https://docs.getdbt.com/docs/cloud/about-cloud/architecture - https://airflow.apache.org/ docs/apache-airflow/stable/core-concepts/overview.html - https://docs.airbyte.com/understanding-airbyte/high-level-view/ - https://docs.metaflow.org/internals/technical-overview - https://docs.dagster.io/deployment/overview - https://docs.flyte.org/en/latest/concepts/architecture.html Closes #858 Signed-off-by: Antoni Ivanov <[email protected]>
antoniivanov
added a commit
that referenced
this issue
Jul 16, 2023
The goal of the architecture file is to provide a comprehensive overview of the VDK's architecture, components, and their relationships, serving as a reference document for developers, contributors, stakeholders, and users to understand the system's structure and make informed decisions. The diagrams are based on C4 model https://c4model.com The architecture is based on OnePage documents and we (Yoan and I) used the following architecture overviews as an example of good (data related) open source project arch documents: - https://argoproj.github.io/argo-workflows/architecture/ - https://docs.getdbt.com/docs/cloud/about-cloud/architecture - https://airflow.apache.org/ docs/apache-airflow/stable/core-concepts/overview.html - https://docs.airbyte.com/understanding-airbyte/high-level-view/ - https://docs.metaflow.org/internals/technical-overview - https://docs.dagster.io/deployment/overview - https://docs.flyte.org/en/latest/concepts/architecture.html Closes #858 Signed-off-by: Antoni Ivanov <[email protected]>
antoniivanov
added a commit
that referenced
this issue
Jul 16, 2023
The goal of the architecture file is to provide a comprehensive overview of the VDK's architecture, components, and their relationships, serving as a reference document for developers, contributors, stakeholders, and users to understand the system's structure and make informed decisions. The diagrams are based on C4 model https://c4model.com The architecture is based on OnePage documents and we (Yoan and I) used the following architecture overviews as an example of good (data related) open source project arch documents: - https://argoproj.github.io/argo-workflows/architecture/ - https://docs.getdbt.com/docs/cloud/about-cloud/architecture - https://airflow.apache.org/ docs/apache-airflow/stable/core-concepts/overview.html - https://docs.airbyte.com/understanding-airbyte/high-level-view/ - https://docs.metaflow.org/internals/technical-overview - https://docs.dagster.io/deployment/overview - https://docs.flyte.org/en/latest/concepts/architecture.html Closes #858 Signed-off-by: Antoni Ivanov <[email protected]>
antoniivanov
added a commit
that referenced
this issue
Jul 16, 2023
The goal of the architecture file is to provide a comprehensive overview of the VDK's architecture, components, and their relationships, serving as a reference document for developers, contributors, stakeholders, and users to understand the system's structure and make informed decisions. The diagrams are based on C4 model https://c4model.com The architecture is based on OnePage documents and we (Yoan and I) used the following architecture overviews as an example of good (data related) open source project arch documents: - https://argoproj.github.io/argo-workflows/architecture/ - https://docs.getdbt.com/docs/cloud/about-cloud/architecture - https://airflow.apache.org/ docs/apache-airflow/stable/core-concepts/overview.html - https://docs.airbyte.com/understanding-airbyte/high-level-view/ - https://docs.metaflow.org/internals/technical-overview - https://docs.dagster.io/deployment/overview - https://docs.flyte.org/en/latest/concepts/architecture.html Closes #858 Signed-off-by: Antoni Ivanov <[email protected]>
antoniivanov
added a commit
that referenced
this issue
Jul 17, 2023
The goal of the architecture file is to provide a comprehensive overview of the VDK's architecture, components, and their relationships, serving as a reference document for developers, contributors, stakeholders, and users to understand the system's structure and make informed decisions. The diagrams are based on C4 model https://c4model.com The architecture is based on OnePage documents and we (Yoan and I) used the following architecture overviews as an example of good (data related) open source project arch documents: - https://argoproj.github.io/argo-workflows/architecture/ - https://docs.getdbt.com/docs/cloud/about-cloud/architecture - https://airflow.apache.org/ docs/apache-airflow/stable/core-concepts/overview.html - https://docs.airbyte.com/understanding-airbyte/high-level-view/ - https://docs.metaflow.org/internals/technical-overview - https://docs.dagster.io/deployment/overview - https://docs.flyte.org/en/latest/concepts/architecture.html Closes #858 Signed-off-by: Antoni Ivanov <[email protected]>
antoniivanov
added a commit
that referenced
this issue
Jul 17, 2023
The goal of the architecture file is to provide a comprehensive overview of the VDK's architecture, components, and their relationships, serving as a reference document for developers, contributors, stakeholders, and users to understand the system's structure and make informed decisions. The diagrams are based on C4 model https://c4model.com The architecture is based on OnePage documents and we (Yoan and I) used the following architecture overviews as an example of good (data related) open source project arch documents: - https://argoproj.github.io/argo-workflows/architecture/ - https://docs.getdbt.com/docs/cloud/about-cloud/architecture - https://airflow.apache.org/ docs/apache-airflow/stable/core-concepts/overview.html - https://docs.airbyte.com/understanding-airbyte/high-level-view/ - https://docs.metaflow.org/internals/technical-overview - https://docs.dagster.io/deployment/overview - https://docs.flyte.org/en/latest/concepts/architecture.html Closes #858 Signed-off-by: Antoni Ivanov <[email protected]>
antoniivanov
added a commit
that referenced
this issue
Jul 18, 2023
The goal of the architecture file is to provide a comprehensive overview of the VDK's architecture, components, and their relationships, serving as a reference document for developers, contributors, stakeholders, and users to understand the system's structure and make informed decisions. The diagrams are based on C4 model https://c4model.com The architecture is based on OnePage documents and we (Yoan and I) used the following architecture overviews as an example of good (data related) open source project arch documents: - https://argoproj.github.io/argo-workflows/architecture/ - https://docs.getdbt.com/docs/cloud/about-cloud/architecture - https://airflow.apache.org/ docs/apache-airflow/stable/core-concepts/overview.html - https://docs.airbyte.com/understanding-airbyte/high-level-view/ - https://docs.metaflow.org/internals/technical-overview - https://docs.dagster.io/deployment/overview - https://docs.flyte.org/en/latest/concepts/architecture.html Closes #858 Signed-off-by: Antoni Ivanov <[email protected]>
antoniivanov
added a commit
that referenced
this issue
Jul 18, 2023
The goal of the architecture file is to provide a comprehensive overview of the VDK's architecture, components, and their relationships, serving as a reference document for developers, contributors, stakeholders, and users to understand the system's structure and make informed decisions. The diagrams are based on C4 model https://c4model.com The architecture is based on OnePage documents and we (Yoan and I) used the following architecture overviews as an example of good (data related) open source project arch documents: - https://argoproj.github.io/argo-workflows/architecture/ - https://docs.getdbt.com/docs/cloud/about-cloud/architecture - https://airflow.apache.org/ docs/apache-airflow/stable/core-concepts/overview.html - https://docs.airbyte.com/understanding-airbyte/high-level-view/ - https://docs.metaflow.org/internals/technical-overview - https://docs.dagster.io/deployment/overview - https://docs.flyte.org/en/latest/concepts/architecture.html Closes #858 Signed-off-by: Antoni Ivanov <[email protected]>
|
Triaged. This is WiP that will be completed soon. |
antoniivanov
added a commit
that referenced
this issue
Jul 20, 2023
The goal of the architecture file is to provide a comprehensive overview of the VDK's architecture, components, and their relationships, serving as a reference document for developers, contributors, stakeholders, and users to understand the system's structure and make informed decisions. The diagrams are based on C4 model https://c4model.com The architecture is based on OnePage documents and we (Yoan and I) used the following architecture overviews as an example of good (data related) open source project arch documents: - https://argoproj.github.io/argo-workflows/architecture/ - https://docs.getdbt.com/docs/cloud/about-cloud/architecture - https://airflow.apache.org/ docs/apache-airflow/stable/core-concepts/overview.html - https://docs.airbyte.com/understanding-airbyte/high-level-view/ - https://docs.metaflow.org/internals/technical-overview - https://docs.dagster.io/deployment/overview - https://docs.flyte.org/en/latest/concepts/architecture.html Closes #858 Signed-off-by: Antoni Ivanov <[email protected]>
antoniivanov
added a commit
that referenced
this issue
Jul 20, 2023
The goal of the architecture file is to provide a comprehensive overview of the VDK's architecture, components, and their relationships, serving as a reference document for developers, contributors, stakeholders, and users to understand the system's structure and make informed decisions. The diagrams are based on C4 model https://c4model.com The architecture is based on OnePage documents and we (Yoan and I) used the following architecture overviews as an example of good (data related) open source project arch documents: - https://argoproj.github.io/argo-workflows/architecture/ - https://docs.getdbt.com/docs/cloud/about-cloud/architecture - https://airflow.apache.org/ docs/apache-airflow/stable/core-concepts/overview.html - https://docs.airbyte.com/understanding-airbyte/high-level-view/ - https://docs.metaflow.org/internals/technical-overview - https://docs.dagster.io/deployment/overview - https://docs.flyte.org/en/latest/concepts/architecture.html Closes #858 Signed-off-by: Antoni Ivanov <[email protected]>
antoniivanov
added a commit
that referenced
this issue
Jul 20, 2023
The goal of the architecture file is to provide a comprehensive overview of the VDK's architecture, components, and their relationships, serving as a reference document for developers, contributors, stakeholders, and users to understand the system's structure and make informed decisions. The diagrams are based on C4 model https://c4model.com The architecture is based on OnePage documents and we (Yoan and I) used the following architecture overviews as an example of good (data related) open source project arch documents: - https://argoproj.github.io/argo-workflows/architecture/ - https://docs.getdbt.com/docs/cloud/about-cloud/architecture - https://airflow.apache.org/ docs/apache-airflow/stable/core-concepts/overview.html - https://docs.airbyte.com/understanding-airbyte/high-level-view/ - https://docs.metaflow.org/internals/technical-overview - https://docs.dagster.io/deployment/overview - https://docs.flyte.org/en/latest/concepts/architecture.html Closes #858 Signed-off-by: Antoni Ivanov <[email protected]>
antoniivanov
added a commit
that referenced
this issue
Jul 27, 2023
The goal of the architecture file is to provide a comprehensive overview of the VDK's architecture, components, and their relationships, serving as a reference document for developers, contributors, stakeholders, and users to understand the system's structure and make informed decisions. The diagrams are based on C4 model https://c4model.com The architecture is based on OnePage documents and we (Yoan and I) used the following architecture overviews as an example of good (data related) open source project arch documents: - https://argoproj.github.io/argo-workflows/architecture/ - https://docs.getdbt.com/docs/cloud/about-cloud/architecture - https://airflow.apache.org/ docs/apache-airflow/stable/core-concepts/overview.html - https://docs.airbyte.com/understanding-airbyte/high-level-view/ - https://docs.metaflow.org/internals/technical-overview - https://docs.dagster.io/deployment/overview - https://docs.flyte.org/en/latest/concepts/architecture.html Closes #858 Signed-off-by: Antoni Ivanov <[email protected]>
antoniivanov
added a commit
that referenced
this issue
Jul 27, 2023
The goal of the architecture file is to provide a comprehensive overview of the VDK's architecture, components, and their relationships, serving as a reference document for developers, contributors, stakeholders, and users to understand the system's structure and make informed decisions. The diagrams are based on C4 model https://c4model.com The architecture is based on OnePage documents and we (Yoan and I) used the following architecture overviews as an example of good (data related) open source project arch documents: - https://argoproj.github.io/argo-workflows/architecture/ - https://docs.getdbt.com/docs/cloud/about-cloud/architecture - https://airflow.apache.org/ docs/apache-airflow/stable/core-concepts/overview.html - https://docs.airbyte.com/understanding-airbyte/high-level-view/ - https://docs.metaflow.org/internals/technical-overview - https://docs.dagster.io/deployment/overview - https://docs.flyte.org/en/latest/concepts/architecture.html Closes #858 Signed-off-by: Antoni Ivanov <[email protected]>
antoniivanov
added a commit
that referenced
this issue
Jul 27, 2023
The goal of the architecture file is to provide a comprehensive overview of the VDK's architecture, components, and their relationships, serving as a reference document for developers, contributors, stakeholders, and users to understand the system's structure and make informed decisions. The diagrams are based on C4 model https://c4model.com The architecture is based on OnePage documents and we (Yoan and I) used the following architecture overviews as an example of good (data related) open source project arch documents: - https://argoproj.github.io/argo-workflows/architecture/ - https://docs.getdbt.com/docs/cloud/about-cloud/architecture - https://airflow.apache.org/ docs/apache-airflow/stable/core-concepts/overview.html - https://docs.airbyte.com/understanding-airbyte/high-level-view/ - https://docs.metaflow.org/internals/technical-overview - https://docs.dagster.io/deployment/overview - https://docs.flyte.org/en/latest/concepts/architecture.html Closes #858 Signed-off-by: Antoni Ivanov <[email protected]>
antoniivanov
added a commit
that referenced
this issue
Jul 27, 2023
The goal of the architecture file is to provide a comprehensive overview of the VDK's architecture, components, and their relationships, serving as a reference document for developers, contributors, stakeholders, and users to understand the system's structure and make informed decisions. The diagrams are based on C4 model https://c4model.com The architecture is based on OnePage documents we use in VMware and we (Yoan (@yonitoo) and I) used the following architecture overviews as an example of good (data related) open source project arch documents: [argo](https://argoproj.github.io/argo-workflows/architecture), [dbt](https://docs.getdbt.com/docs/cloud/about-cloud/architecture), [airbyte](https://docs.airbyte.com/understanding-airbyte/high-level-view), [metaflow](https://docs.metaflow.org/internals/technical-overview), [dagster](https://docs.dagster.io/deployment/overview), [flyte](https://docs.flyte.org/en/latest/concepts/architecture.html) Closes #858 Signed-off-by: Antoni Ivanov <[email protected]> Co-authored-by: Yoan Salambashev <[email protected]> --------- Signed-off-by: Antoni Ivanov <[email protected]> Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
I cannot "sell" VDK to engineers unless they assess the architecture. A picture is worth a thousand words. A reusable file (e.g. .pptx) would be even better.
The text was updated successfully, but these errors were encountered: