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

Added system startup diagram. #6269

Merged
merged 3 commits into from Apr 28, 2023
Merged

Conversation

cody-littley
Copy link
Contributor

Closes #5853

Signed-off-by: Cody Littley <cody@swirldslabs.com>
@david-bakin-sl
Copy link
Member

Sweet! Do you want to check in the diagram "source" too? (So that if the diagram needs to be altered later, it'll be there.)

@cody-littley cody-littley modified the milestones: v0.36, v0.38 Apr 27, 2023
@cody-littley
Copy link
Contributor Author

@david-bakin-sl

Sweet! Do you want to check in the diagram "source" too? (So that if the diagram needs to be altered later, it'll be there.)

The neat thing about this is that this .svg image IS the source. You can edit it using https://app.diagrams.net/. There is an intellij plugin and a desktop app, in addition to the web page. I usually end up using the desktop app, personally.

@poulok
Copy link
Member

poulok commented Apr 27, 2023

Why are these boxes green?

  • Load SignedState from disk
  • start gossip

It would helpful for each box to list the method being invoked so that it is very clear to application developers what is happening when. Most already have it, but not all.

Lastly, see my comment on the ticket #5853 (comment)

Copy link
Contributor

@Nana-EC Nana-EC left a comment

Choose a reason for hiding this comment

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

Nice.

Some thoughts

  1. Instead of "External stuff" you could note "External processes e.g JVM, network IO"
  2. In a later PR down the line it might be nice to have a section in the wiki that gives a brief summary of all the yellow and green boxes

artemananiev
artemananiev previously approved these changes Apr 27, 2023
@hendrikebbers
Copy link
Member

wynonna-earp-nicole-haught

hendrikebbers
hendrikebbers previously approved these changes Apr 28, 2023
Signed-off-by: Cody Littley <cody@swirldslabs.com>
Signed-off-by: Cody Littley <cody@swirldslabs.com>
@github-actions
Copy link

Node: Unit Test Results

  1 337 files    1 337 suites   1h 12m 54s ⏱️
97 407 tests 97 399 ✔️ 8 💤 0
99 039 runs  99 031 ✔️ 8 💤 0

Results for commit 64d1fec.

@sonarcloud
Copy link

sonarcloud bot commented Apr 28, 2023

Kudos, SonarCloud Quality Gate passed!    Quality Gate passed

Bug A 0 Bugs
Vulnerability A 0 Vulnerabilities
Security Hotspot A 0 Security Hotspots
Code Smell A 0 Code Smells

No Coverage information No Coverage information
No Duplication information No Duplication information

@github-actions
Copy link

Node: Integration Test Results

    3 files      3 suites   15m 2s ⏱️
151 tests 151 ✔️ 0 💤 0
152 runs  152 ✔️ 0 💤 0

Results for commit 64d1fec.

@github-actions
Copy link

Node: E2E Test Results

    1 files      1 suites   17m 6s ⏱️
309 tests 309 ✔️ 0 💤 0
327 runs  327 ✔️ 0 💤 0

Results for commit 64d1fec.

@github-actions
Copy link

Platform: JUnit Test Report

     500 files           1 errors  499 suites   28m 9s ⏱️
13 579 tests 13 538 ✔️ 41 💤 0
15 362 runs  15 321 ✔️ 41 💤 0

Results for commit 64d1fec.

@sonarcloud
Copy link

sonarcloud bot commented Apr 28, 2023

Kudos, SonarCloud Quality Gate passed!    Quality Gate passed

Bug A 0 Bugs
Vulnerability A 0 Vulnerabilities
Security Hotspot A 0 Security Hotspots
Code Smell A 0 Code Smells

No Coverage information No Coverage information
No Duplication information No Duplication information

@cody-littley cody-littley merged commit 72f08ee into develop Apr 28, 2023
30 of 31 checks passed
@cody-littley cody-littley deleted the 05853-startup-sequence-diagram branch April 28, 2023 17:17
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.

Proposal: platform startup sequence
7 participants