Documentation #54015
openImprove vstart cluster documentation
0%
Description
It would be nice to have some more details written about deploying a vstart cluster, i.e. tips and tricks, troubleshooting, etc.
Some concepts that could be better explained include:- How to stop/start/restart daemons on a vstart cluster (init-ceph)
- How to initialize a vstart cluster to record rocksdb performance (rocksdb_perf=true)
- How to build with vstart-base
- How to deploy a vstart cluster in a container (there is already sufficient explanation for this in the ceph-container repository [https://github.com/ceph/ceph-container], but some of this knowledge could be transferred to or clarified in the official documentation)
- "Deploying a Development Cluster"
https://github.com/ceph/ceph/blob/master/doc/dev/dev_cluster_deployement.rst
https://docs.ceph.com/en/latest/dev/dev_cluster_deployement/ - "Ceph - a scalable distributed storage system"
https://github.com/ceph/ceph#readme
These are just a few of my ideas for improvement, but there are probably many more details that could be expanded on. This issue is a great place to start for first-time contributors who are setting up their development environments for the first time.
Updated by John Chai about 2 years ago
- Assignee set to John Chai
I am a new developer to the community and like to work on this issue. Wondering if you'd like to have more detailed description on the vstart cluster in ceph docs quick_guide?
Updated by Laura Flores about 2 years ago
Hi John, thanks for taking on this Tracker! To answer your question, yes! Any mention of vstart in the Ceph documentation that you think lacks information welcomes your improvements. Glancing over the latest version of our quick guide (https://docs.ceph.com/en/latest/dev/quick_guide/), I see that it is relatively fleshed out already. As this is supposed to be a quick guide, I would not add too much more information and instead would focus on making appropriate adjustments to ensure that the existing information is up-to-date.
Let me know if you have any questions, and if you have a pull request ready, update this Tracker with the link.
Updated by Laura Flores 7 months ago
Claiming this issue for Grace Hopper Open Source Day.