Clean up cluster documentation #547
Conversation
Deploying documentation with
|
| Latest commit: |
800e646
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://f044379c.documentation-beg.pages.dev |
| Branch Preview URL: | https://polishing.documentation-beg.pages.dev |
tillrohrmann
left a comment
tillrohrmann
left a comment
There was a problem hiding this comment.
LGTM. Thanks for updating the cluster documentation @gvdongen. +1 for merging :-)
docs/operate/clusters.mdx
Outdated
| ```shell | ||
| restatectl status | ||
| ``` | ||
|
|
||
| <details className={"grey-details"}> | ||
| <summary>Output</summary> | ||
|
|
||
| ``` | ||
| Node Configuration (v3) | ||
| NODE GEN NAME ADDRESS ROLES | ||
| N1 2 n1 http://127.0.0.1:5122/ admin | log-server | metadata-server | worker | ||
|
|
||
| Log Configuration (v2) | ||
| Default Provider Config: Local | ||
| L-ID FROM-LSN KIND LOGLET-ID REPLICATION SEQUENCER NODESET | ||
| 0 1 Local N/A N/A N/A N/A | ||
|
|
||
| Alive partition processors (nodes config v3, partition table v2) | ||
| P-ID NODE MODE STATUS LEADER EPOCH SEQUENCER APPLIED-LSN ARCHIVED-LSN LAST-UPDATE | ||
| 0 N1:2 Leader Active N1:2 e1 1 - 615 ms ago | ||
| ``` |
There was a problem hiding this comment.
By now, this is already outdated.
There was a problem hiding this comment.
I will just remove it while it is still changing often
docs/operate/clusters.mdx
Outdated
| ``` | ||
| </details> | ||
|
|
||
| The cluster controller reconfigures the log nodeset to exclude `N1`. Depending on the configured log replication level, you may see a warning about compromised availability or, if insufficient log servers are available to achieve the minimum required replication, the log will stop accepting writes altogether. You have to take care as `restatectl` does not currently check whether the cluster will be able to generate new nodesets with the remaining log servers. |
There was a problem hiding this comment.
We are now checking whether it is is possible to create new node sets after marking a given node or set of nodes as read-only.
|
Hey @gvdongen, I merged #556 and took the liberty of merging the latest A secondary concern is that we have a simple, clean URL that we can print in the I moved the new troubleshooting sub-section to the cluster page to resolve the conflict and keep the content from being deleted. I've tried to keep it in the the style of the one you created, but the combination of collapsed details + steps doesn't look very good visually. I expect that we'll have more of these "standard operating procedure" type entries in the docs in the future, and I think it's worth planning for them being separate pages rather to avoid overwhelming those following them. |
|
@pcholakov To keep the urls compact, we can override the link for the subsection header with The problem with separate pages is that it creates a long sidebar that is not intuitive and makes information hard to discover. So that's why for now I would just keep it together. I will have a look at the steps inside the details section. |
Co-authored-by: Till Rohrmann <[email protected]>
Co-authored-by: Till Rohrmann <[email protected]>
|
This is great, thank you very much @gvdongen! 🚢 |
I tried to consolidate the cluster documentation between
This might make it easier to find the needed information.
I didn't remove anything, just restructured it.
I prefer not having a restatectl page with too much output on it because this will get outdated soon.
A follow-up PR will collapse the terminal output together with the command to make the page more concise: https://terminal-improvements.documentation-beg.pages.dev/operate/clusters