[ISSUE #202] refine the supporting document for cluster deploy #230
Conversation
There was a problem hiding this comment.
- You should add new content to the current version of the document, rather than modifying the historical document.
- According to [ISSUE #202] refine the supporting document for cluster LB and failover #224 (review), you still have the following items pending:
a. you should use "EventMesh" instead of "event-mesh".
b. you can add multiple subheadings such as "Using the Registry Center" or "Using a Distributed Consistency Protocol," taking Nacos and JRaft as examples, respectively, to introduce the differences in their support levels. Their usage and configuration differences can be written in another document, placed under the Installation and Deployment section.
c. The existing content is far from sufficient to explain the cluster features of EventMesh. - You should run the
npm run servecommand locally to test if the pages you've added display correctly. From what I know, you also need to modify files likecategories.jsonfor the new page to display properly.
| - Implementing JRaft eliminates the need for Nacos as a registry center. | ||
| - Existing SDK pattern relies on static IP insertion in `eventmesh.properties`. | ||
| - Node failure results in service failure. |
There was a problem hiding this comment.
Line 14 confuses me; it describes the current state of JRaft, which is unrelated to the section titled "Impact on Registry Center".
| - **Solutions:** | ||
| - **Gateway Proxy Layer:** A future solution for the new architecture. Like Nginx. | ||
| - **JRaft Protocol:** Enables dynamic scaling and cluster discovery. |
There was a problem hiding this comment.
The generated traces of LLM in these lines are quite noticeable. For formatting, I suggest using multi-level Markdown headings. Each level of heading can contain a list and corresponding explanations in plain text. There's no need to nest multiple levels of unordered lists together, as this will help with anchor jumping in the page directory.
There was a problem hiding this comment.
I will try to attend the biweekly meeting next time where we can discuss the full EventMesh cluster deployment details, which should be beneficial to you.
- Just a friendly reminder, Markdown syntax requires a blank line between the title and the body text.
- This document needs to be in both Chinese and English languages.
sidebars/docs.js
Outdated
| { | ||
| type: 'category', | ||
| label: 'Distributed Cluster Deployment', | ||
| collapsible: true, | ||
| collapsed: false, | ||
| items: [ | ||
| { | ||
| type: 'autogenerated', | ||
| dirName: 'distributed-cluster-deployment-guide', | ||
| }, | ||
| ], | ||
| } |
There was a problem hiding this comment.
It would be better to place this chapter under the Design Document category.
Once you have written the quick start guide for cluster deployment, this document will need to be placed under the Installation and Deployment category.
There was a problem hiding this comment.
I will fix it in the 'Design Document' category
| ## **Background Knowledge and Current State:** | ||
| * Kafka utilizes KRaft for insync replication of message from main broker to following brokers. |
There was a problem hiding this comment.
Just a gentle correction, it should be "In-Sync" replication, not "insync" replication. The meaning of these two words in English is completely opposite.
| ## **Using the Reverse Proxy:** | ||
| **Current State:** Nginx can be the reverse proxy of EventMesh. In the SDK we set the Nginx IP address, Nginx will transfer the subscription address to a EventMesh runtime. |
There was a problem hiding this comment.
This section requires additional information on nacos.
There was a problem hiding this comment.
I need your advisory in Nacos deployment.
| ### **Solutions: Add Gateway Proxy Layer:** A next generation of functional solution for the new architecture. Like Nginx. | ||
| **Current Flaws** |
There was a problem hiding this comment.
The title is quite lengthy and also, Nginx is not exactly the next-gen solution for the new architecture, but rather a compromise implementation for load balancing as of now.
There was a problem hiding this comment.
I will fix the title into 'A compromise implementation for load balancing for now'
| @@ -0,0 +1,24 @@ | |||
| # Distributed Consistency Protocol for EventMesh | |||
There was a problem hiding this comment.
The Distributed Consistency Protocol is applicable only to protocols akin to KRaft/JRaft and the like. Reverse Proxy does not fall under the purview of the Distributed Consistency Protocol.
There was a problem hiding this comment.
I will fix the title into 'Distributed Consistency Protocol or Reverse proxy'
There was a problem hiding this comment.
You can split them into two documents, or use a more general title, such as "Cluster Design."
…ver' documentation
Fixes #224
Motivation
Refined the supporting document for cluster load balancing and failover
The previous documentation of cluster load balancing and failover is incomplete
Modifications
*Add the supporting document for cluster load balancing and failover in the runtime instruction *
Documentation