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

Armada V1 and Armada V2 diagrams #2738

Closed
Tracked by #2726
Sharpz7 opened this issue Jul 24, 2023 · 7 comments · Fixed by #2758
Closed
Tracked by #2726

Armada V1 and Armada V2 diagrams #2738

Sharpz7 opened this issue Jul 24, 2023 · 7 comments · Fixed by #2758
Assignees

Comments

@Sharpz7
Copy link
Contributor

Sharpz7 commented Jul 24, 2023

Armada is migrating to a new set of components. To help users with that move, we need to have diagrams of both setups.

Currently we have https://github.com/armadaproject/armada/blob/master/docs/design/diagrams/relationships/armada_system.png, which is created using code from here https://github.com/armadaproject/armada/blob/master/docs/design/diagrams/relationships/generate.py. The one change that needs to happen, is it should be called "Lookout V2" instead of just "Lookout".

For the Lookout V1 Doc, it should instead look like this: https://drive.google.com/uc?id=1XtXdCP2dVXa2pXqLFGHdeSNkh8A6hBt8. Where items crossed out are part of V2, and the items in the green box are all one component.

We should have https://github.com/armadaproject/armada/blob/master/docs/design/relationships_diagram.md be changed to include both diagrams. I expect a PR for this to be a back-and-forth process.

┆Issue is synchronized with this Jira Task by Unito

@Pradeep-Kurapati
Copy link
Contributor

@Sharpz7 I would like to work on this. Please assign this to me.

@Pradeep-Kurapati
Copy link
Contributor

@Sharpz7 would you like both diagrams in a single generate.py file or seperate python programs?

@Sharpz7
Copy link
Contributor Author

Sharpz7 commented Jul 26, 2023

Either or, whatever your preference is :))

@Pradeep-Kurapati
Copy link
Contributor

Pradeep-Kurapati commented Jul 26, 2023

When I run generate.py file, it is not able to access images. I changed the reference to "images/armada.png" from "../files/armada.png" but still it's not accessing images. I don't know if it unique to my environment or is it something I don't understand.

armada_systems_diagram

image

How to fix this?

P.S: I changed "Lookout" to "Lookout V2".

@Pradeep-Kurapati
Copy link
Contributor

After hours of exploration, I finally found solution.
In with Diagram(), I commented out filename parameter and it is working!
But the produced image will be in relationships folder and not in out folder.
Need help here.

image

should we add this info in our README.md ?

@Pradeep-Kurapati
Copy link
Contributor

Pradeep-Kurapati commented Jul 27, 2023

Please review Armada V2 diagram

armada_v2_system

@Sharpz7
Copy link
Contributor Author

Sharpz7 commented Jul 28, 2023

Good spot with the I/o issues, feel free to edit it and document it as you see fit to get it working.

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 a pull request may close this issue.

2 participants