Project

General

Profile

Actions

Documentation #54015

open

Improve vstart cluster documentation

Added by Laura Flores over 2 years ago. Updated 8 months ago.

Status:
New
Priority:
Low
Assignee:
-
Category:
documentation
Target version:
-
% Done:

0%

Tags:
Backport:
Reviewed:
Affected Versions:
Pull request ID:

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:
  1. How to stop/start/restart daemons on a vstart cluster (init-ceph)
  2. How to initialize a vstart cluster to record rocksdb performance (rocksdb_perf=true)
  3. How to build with vstart-base
  4. 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)
Relevant documentation includes:
  1. "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/
  2. "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.

Actions

Also available in: Atom PDF