From c9f4727aab6900dabf3eb713866a457ec89d384b Mon Sep 17 00:00:00 2001 From: Shrish0098 <107606123+Shrish0098@users.noreply.github.com> Date: Thu, 19 Dec 2024 09:27:56 +0530 Subject: [PATCH] doc: Update vstart section in readme.md Add guidance about vstart clusters to README.md. Signed-off-by: Shrish Mishra --- README.md | 31 +++++++++++++++++++++++++++++++ 1 file changed, 31 insertions(+) diff --git a/README.md b/README.md index 56257697e9a1d..1ca46f364fa6c 100644 --- a/README.md +++ b/README.md @@ -126,6 +126,37 @@ To build Ceph, follow this procedure: 5. Install the vstart cluster: ninja install + + >vstart.sh is commonly used to quickly deploy a development cluster. + + > [TIPS & TRICKS] + > + >Use Debug Builds Only When Needed + > + >While debugging builds are helpful for development, they can slow down performance. + > + >Use `-DCMAKE_BUILD_TYPE=Release` when debugging isn't necessary. + + Enable Selective Daemons if you're testing specific components, don't start unnecessary daemons. + Preserve Existing Data skip cluster reinitialization between tests by using the `-n` flag + + > [TROUBLESHOOTING] + > + >Cluster Fails to Start: Look for errors in the logs under the out/ directory, e.g. + > + >OSD Crashes: Check the OSD logs for errors. + > + >Cluster in a Health Error State: Run `ceph status` to identify the issue. + > + >RocksDB Errors: Look for RocksDB-related errors in OSD logs. + + To manage a vstart cluster, stop daemons using `./stop.sh` and start them with ./vstart.sh --daemon osd.${ID} [--nodaemonize]. + Restart by stopping and restarting daemons, ensuring no stale sockets. + For RocksDB performance tracking, set `export ROCKSDB_PERF=true` and start the cluster with `./vstart.sh -n -d -x --bluestore`. + Build with `vstart-base` using debug flags in cmake, compile, and deploy via `./vstart.sh -d -n --bluestore`. + To containerize, generate configurations with `vstart.sh`, and deploy with Docker, mapping directories and configuring the network. + Manage containers using `docker run`, `stop`, and `rm`. For detailed setups, consult the Ceph-Container repository. + ### CMake Options -- 2.39.5