RepoMirrors/ceph
1
0
Fork 0
mirror of https://github.com/ceph/ceph synced 2025-02-21 09:57:26 +00:00
Code Issues Packages Projects Releases Wiki Activity

doc: README.md - improve "Tshooting" and "Tips & Tricks"

Browse Source 
Improve the formatting and English language in the sections
"Troubleshooting" and "Tips and Tricks", and move those sections to a
place where they don't interrupt the flow of the vstart cluster
installation instructions. Some of the strings in "Tips and Tricks" are
not yet unambiguous sentences that will make sense to the uninitiated,
but this PR represents a step in that direction.

This PR is part of a series of PRs meant to preserve the integrity of
the README.md file after some recent additions that break the flow of
the document.

This PR follows https://github.com/ceph/ceph/pull/61226 and
https://github.com/ceph/ceph/pull/61221.

Signed-off-by: Zac Dover <zac.dover@proton.me>
This commit is contained in:
Zac Dover 2025-01-05 06:54:48 +10:00
parent 316d3c1f69
commit c0e91389b0
1 changed files with 30 additions and 24 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

54
README.md
View File

@ -127,31 +127,7 @@ To build Ceph, follow this procedure:
ninja install
## Tips and Tricks
* Use "debug builds" only when needed. Debugging builds are helpful for
development, but they can slow down performance. Use
`-DCMAKE_BUILD_TYPE=Release` when debugging isn't necessary.
* Enable Selective Daemons when 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.
* OSD Crashes: Check the OSD logs for errors.
* Cluster in a `Health Error` State: Run the `ceph status` command to
identify the issue.
* RocksDB Errors: Look for RocksDB-related errors in the 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
@ -204,6 +180,36 @@ The diagnostic colors will be visible when the following command is run:
Other available values for `DIAGNOSTICS_COLOR` are `auto` (default) and
`never`.
## Tips and Tricks
* Use "debug builds" only when needed. Debugging builds are helpful for
development, but they can slow down performance. Use
`-DCMAKE_BUILD_TYPE=Release` when debugging isn't necessary.
* Enable Selective Daemons when testing specific components. Don't start
unnecessary daemons.
* Preserve Existing Data skip cluster reinitialization between tests by
using the `-n` flag.
* To manage a vstart cluster, stop daemons using `./stop.sh` and start them
with `./vstart.sh --daemon osd.${ID} [--nodaemonize]`.
* Restart the sockets by stopping and restarting the daemons associated with
them. This ensures that there are no stale sockets in the cluster.
* To track RocksDB performance, set `export ROCKSDB_PERF=true` and start
the cluster by using the command `./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.
## Troubleshooting
* Cluster Fails to Start: Look for errors in the logs under the `out/`
directory.
* OSD Crashes: Check the OSD logs for errors.
* Cluster in a `Health Error` State: Run the `ceph status` command to
identify the issue.
* RocksDB Errors: Look for RocksDB-related errors in the OSD logs.
## Building a source tarball