8000
Skip to content

Add dqlite developer documentation and improve dqlite related code comments#17105

Merged
tomponline merged 3 commits intocanonical:mainfrom
kadinsayani:dqlite-docs
Dec 2, 2025
Merged

Add dqlite developer documentation and improve dqlite related code comments#17105
tomponline merged 3 commits intocanonical:mainfrom
kadinsayani:dqlite-docs

Conversation

@kadinsayani
Copy link
Copy Markdown
Member
@kadinsayani kadinsayani commented Nov 28, 2025

Adds dqlite developer documentation and comments to Raft and Cluster role constants. I'll continue improving upon the documentation/comments while working on cluster member evacuation improvements.

Signed-off-by: Kadin Sayani <kadin.sayani@canonical.com>
Signed-off-by: Kadin Sayani <kadin.sayani@canonical.com>
@github-actions github-actions bot added the Documentation Documentation needs updating label Nov 28, 2025
@kadinsayani kadinsayani marked this pull request as ready for review November 28, 2025 20:16
@kadinsayani kadinsayani force-pushed the dqlite-docs branch 3 times, most recently from b2ae1c1 to 9439b32 Compare November 28, 2025 20:31
Comment thread doc/reference/dqlite-internals.md Outdated
Comment thread doc/reference/dqlite-internals.md
@kadinsayani kadinsayani force-pushed the dqlite-docs branch 2 times, most recently from 27d82c2 to b72c366 Compare November 29, 2025 20:52
Copy link
Copy Markdown
Member
@tomponline tomponline left a comment

Choose a reason for hiding this comment

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

FWIW I think this is useful info to have in the LXD docs Internals section given that Dqlite is critical to LXD's operation and behaviour.

Copy link
Copy Markdown
Contributor
@minaelee minaelee left a comment

Choose a reason for hiding this comment

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

Please consider if the suggested condensed changes would be sufficient, or if the detailed original version is preferred. I'll defer if the latter.

Comment thread doc/reference/dqlite-internals.md
Comment thread doc/reference/dqlite-internals.md
Comment thread doc/reference/dqlite-internals.md Outdated
Comment thread doc/reference/dqlite-internals.md
Signed-off-by: Kadin Sayani <kadin.sayani@canonical.com>
@kadinsayani
Copy link
Copy Markdown
Member Author

Please consider if the suggested condensed changes would be sufficient, or if the detailed original version is preferred. I'll defer if the latter.

Thanks for your review! I've addressed all comments.

@tomponline tomponline merged commit 86da552 into canonical:main Dec 2, 2025
71 of 72 checks passed
@kadinsayani kadinsayani deleted the dqlite-docs branch December 2, 2025 11:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Documentation Documentation needs updating

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants

0