From 9e7246b74075da557012b0744167011ca43eedb1 Mon Sep 17 00:00:00 2001 From: Zac Dover Date: Thu, 22 May 2025 16:55:52 +1000 Subject: [PATCH] doc/mgr: edit localpool.rst Edit doc/mgr/localpool.rst. Improve the English where necessary. This is part of a project to separate out the twenty-five files that were committed to https://github.com/ceph/ceph/pull/62782. Signed-off-by: Zac Dover --- doc/mgr/localpool.rst | 34 ++++++++++++++++++++-------------- 1 file changed, 20 insertions(+), 14 deletions(-) diff --git a/doc/mgr/localpool.rst b/doc/mgr/localpool.rst index 2812925caf302..0feace2ac8b99 100644 --- a/doc/mgr/localpool.rst +++ b/doc/mgr/localpool.rst @@ -3,24 +3,27 @@ Local Pool Module .. mgr_module:: localpool -The *localpool* module can automatically create RADOS pools that are -localized to a subset of the overall cluster. For example, by default, it will -create a pool for each distinct ``rack`` in the cluster. This can be useful for -deployments where it is desirable to distribute some data locally and other data -globally across the cluster. One use-case is measuring performance and testing -behavior of specific drive, NIC, or chassis models in isolation. +The ``localpool`` module can automatically create RADOS pools that are +localized to a subset of the overall cluster. For example, by default, it +creates a pool for each distinct ``rack`` in the cluster. This can be +useful for deployments where it is desirable to distribute some data locally +and other data globally across the cluster. One use case is measuring +performance and testing behavior of specific drive, NIC, or chassis models in +isolation. Enabling -------- -The *localpool* module is enabled with:: +To enable the ``localpool`` module, run the following command: - ceph mgr module enable localpool +.. prompt:: bash # + + ceph mgr module enable localpool Configuring ----------- -The *localpool* module understands the following options: +The ``localpool`` module understands the following options: .. confval:: subtree .. confval:: failure_domain @@ -28,12 +31,15 @@ The *localpool* module understands the following options: .. confval:: num_rep .. confval:: min_size .. confval:: prefix - :default: by-$subtreetype- -These options are set via the config-key interface. For example, to -change the replication level to 2x with only 64 PGs, :: +The default is ``by-$subtreetype-``. + +These options are set via the ``config-key`` interface. For example, to +change the replication level to 2x with only 64 PGs, run the following two commands: + +.. prompt:: bash # - ceph config set mgr mgr/localpool/num_rep 2 - ceph config set mgr mgr/localpool/pg_num 64 + ceph config set mgr mgr/localpool/num_rep 2 + ceph config set mgr mgr/localpool/pg_num 64 .. mgr_module:: None -- 2.39.5