search

thoth-station / core

Using Artificial Intelligence to analyse and recommend Software Stacks for Artificial Intelligence applications.
https://thoth-station.github.io/
GNU General Public License v3.0
28 stars 25 forks source link

[tracker] Update and expand Thoth architecture diagrams #330

Open codificat opened 3 years ago

codificat commented 3 years ago

Is your feature request related to a problem? Please describe.

Thoth is relatively complex, and it can be challenging to understand what are all the components and their interactions - both internal and external.

High-level Goals list of high-level Acceptance Criteria/Goals (that is signed off by the team, and unchangeable)

As an individual who wants to understand how Thoth works, I would like to have a set of diagrams about Thoth components so that I can have a visual understanding of its architecture, integrations, and interaction points.

Describe the solution you'd like

A single diagram would not be enough here, because in order to be comprehensive it would have to be too complex, so multiple diagrams would be involved:

Describe alternatives you've considered

Additional context Add any other context or screenshots about the feature request here.

There are some existing diagrams that can contribute to the whole story:

Acceptance Criteria checklist of detailed Acceptance Criteria (that might extend over the lifetime of the card)

pacospace commented 3 years ago

See also investigator docs: https://github.com/thoth-station/investigator

codificat commented 3 years ago

Also possibly related / could be part of this: https://github.com/thoth-station/core/issues/253

pacospace commented 3 years ago

Also possibly related / could be part of this: #253

that issue might be closed, as we will consider sig-store, maybe it can be repurposed

pacospace commented 3 years ago

Some example of the sequence diagrams, let me know what you think! https://app.diagrams.net/#G1972Ny8BnPgsVUcF85r6qmj_H5AvqnQaa Kebechet Schema-Kebechet advise (external trigger) (2)

pacospace commented 3 years ago

Kebechet Schema-Kebechet advise (external trigger)

pacospace commented 3 years ago

Kebechet Schema-Kebechet advise (internal trigger - package release) (1)

pacospace commented 3 years ago

Kebechet Schema-Kebechet advise (internal trigger - package release)

goern commented 3 years ago

/triage accepted /priority important-soon /assign @pacospace /assign @codificat /kind demo

pacospace commented 3 years ago

new Thoth diagram https://app.diagrams.net/#G1XN1L8KLNtUNPIYL1QHEFcBv6lvcjN63M Thoth diagrams (2)

codificat commented 3 years ago

Many thanks for these diagrams @pacospace, they look great!

Some comments about them:

Beyond that, a more general comment about the approach here, in the context of this issue overall.

These are great diagrams to understand the details. However, we are still missing the higher level / general overview ones. In that sense, I wonder if it would not be better to start with these high-level ones: I believe it would help us achieve more consistency across the whole set.

In practical terms: this being a tracker issue for a "whole story" set of diagrams, should we split individual diagrams to their own separate issue/PR?

As a side note: I can't access the direct links to the diagram sources. Sharing the drawio file should work, but I'm not sure how practical that is.

pacospace commented 3 years ago

Many thanks for these diagrams @pacospace, they look great!

Some comments about them:

  • For the first two (internal and external triggers) I would probably just use the complete version of each. Maybe make the "main flow" black line slightly thicker, like you did with the last of the diagrams, for better clarity... but at that level of detail, we probably don't need a "more simple" version of each
  • In the internal trigger diagram, I believe it would be better to have "gitub" be a small box towards the bottom, where the issue/pr arrow goes, similar to the thoth diagram, instead of taking all the left margin.

I ll adjust those thanks! Beyond that, a more general comment about the approach here, in the context of this issue overall.

These are great diagrams to understand the details. However, we are still missing the higher level / general overview ones. In that sense, I wonder if it would not be better to start with these high-level ones: I believe it would help us achieve more consistency across the whole set.

what kind of high level ones are we talking about? is the thoth diagram good for high level of all components we maintain?

In practical terms: this being a tracker issue for a "whole story" set of diagrams, should we split individual diagrams to their own separate issue/PR?

Sounds good to open one for each diagram we want, thanks!

As a side note: I can't access the direct links to the diagram sources. Sharing the drawio file should work, but I'm not sure how practical that is.

I ll check why the links do not work!

codificat commented 2 years ago

/sig docs

goern commented 2 years ago

ping?

sesheta commented 2 years ago

Issues go stale after 90d of inactivity. Mark the issue as fresh with /remove-lifecycle stale. Stale issues rot after an additional 30d of inactivity and eventually close.

If this issue is safe to close now please do so with /close.

/lifecycle stale

sesheta commented 2 years ago

Stale issues rot after 30d of inactivity. Mark the issue as fresh with /remove-lifecycle rotten. Rotten issues close after an additional 30d of inactivity.

If this issue is safe to close now please do so with /close.

/lifecycle rotten

sesheta commented 2 years ago

Rotten issues close after 30d of inactivity. Reopen the issue with /reopen. Mark the issue as fresh with /remove-lifecycle rotten.

/close

sesheta commented 2 years ago

@sesheta: Closing this issue.

In response to [this](https://github.com/thoth-station/core/issues/330#issuecomment-1200360994): >Rotten issues close after 30d of inactivity. >Reopen the issue with `/reopen`. >Mark the issue as fresh with `/remove-lifecycle rotten`. > >/close Instructions for interacting with me using PR comments are available [here](https://git.k8s.io/community/contributors/guide/pull-requests.md). If you have questions or suggestions related to my behavior, please file an issue against the [kubernetes/test-infra](https://github.com/kubernetes/test-infra/issues/new?title=Prow%20issue:) repository.
codificat commented 2 years ago

/reopen /lifecycle frozen

discussing this in today's SIG-UX meeting

sesheta commented 2 years ago

@codificat: Reopened this issue.

In response to [this](https://github.com/thoth-station/core/issues/330#issuecomment-1231642528): >/reopen >/lifecycle frozen > >discussing this in today's SIG-UX meeting Instructions for interacting with me using PR comments are available [here](https://git.k8s.io/community/contributors/guide/pull-requests.md). If you have questions or suggestions related to my behavior, please file an issue against the [kubernetes/test-infra](https://github.com/kubernetes/test-infra/issues/new?title=Prow%20issue:) repository.