doc: add architecture-design doc #1698
Conversation
Codecov Report
@@ Coverage Diff @@
## main #1698 +/- ##
============================================
- Coverage 69.44% 69.44% -0.01%
Complexity 2766 2766
============================================
Files 1059 1059
Lines 93400 93400
Branches 1790 1790
============================================
- Hits 64859 64857 -2
- Misses 27650 27652 +2
Partials 891 891
Flags with carried forward coverage won't be shown. Click here to find out more.
📣 Codecov can now indicate which changes are the most critical in Pull Requests. Learn more |
docs/architecture-design.md
Outdated
|
|
||
| * **Frontend**: Frontend is a stateless proxy that accepts user queries through Postgres protocol. It is responsible for parsing, validation, optimization, and answering the results of each individual query. | ||
| * **ComputeNode**: ComputeNode is responsible to execute the optimized query plan. | ||
| * **MetaServer**: The central metadata management service. It also acts as a failure detector that periodically sends a heartbeat to every Frontends and ComputeNode-s in the cluster. |
There was a problem hiding this comment.
"ComputeNode-s" looks weird to me. How about just "compute nodes"?
There was a problem hiding this comment.
sends a heartbeat to every... --> sends heartbeats to frontend and compute nodes.
Also not sure if we want to change "ComputeNode" to "Compute"
There was a problem hiding this comment.
Compute is somewhat ambiguous; I still prefer to compute nodes.
There was a problem hiding this comment.
So shall we replace "ComputeNode-s" to "compute nodes"?
There was a problem hiding this comment.
I think we can say "frontend nodes", "compute nodes", and "meta nodes" (do we have more than one meta nodes in one cluster?)
I think we can move the content in this document to the "Architecture" article (https://www.risingwave.dev/docs/latest/architecture/) in our user docs. Currently, the Architecture page is a bit too simple.
|
|
|
@neverchanje the svg https://github.com/singularity-data/risingwave/blob/06bcfa918249e8c535bae7a2f9c98a28465be156/docs/images/architecture-design/batch-query.svg has the name bummock instead of hummock |
What's changed and what's your intention?
Checklist
Refer to a related PR or issue link (optional)