From: Kamoltat Sirivadhna <ksirivad@redhat.com>
Date: Tue, 5 Nov 2024 21:12:33 +0000 (+0000)
Subject: doc/rados/operations/pools: Edit Unsetting values for a stretch pool
X-Git-Tag: v20.3.0~296^2~1
X-Git-Url: http://git-server-git.apps.pok.os.sepia.ceph.com/?a=commitdiff_plain;h=cc66889b974d39f119ee140994eaa77ed89075ec;p=ceph.git

doc/rados/operations/pools: Edit Unsetting values for a stretch pool

Fixes: https://tracker.ceph.com/issues/68842

Signed-off-by: Kamoltat Sirivadhna <ksirivad@redhat.com>
---

diff --git a/doc/rados/operations/pools.rst b/doc/rados/operations/pools.rst
index ed99732b016e..8686dddf6351 100644
--- a/doc/rados/operations/pools.rst
+++ b/doc/rados/operations/pools.rst
@@ -840,7 +840,7 @@ To move the pool back to non-stretch, run a command of the following form:
 
 .. prompt:: bash $
 
-   ceph osd pool stretch unset {pool-name}
+   ceph osd pool stretch unset {pool-name} {crush_rule} {size} {min_size}
 
 Here are the breakdowns of the arguments:
 
@@ -852,6 +852,28 @@ Here are the breakdowns of the arguments:
    :Type: String
    :Required: Yes.
 
+.. describe:: {crush_rule}
+      
+   The crush rule to use after exiting the stretch pool. The type of pool must match the type of crush_rule
+   (replicated or erasure).
+
+   :Type: String
+   :Required: Yes.
+
+.. describe:: {size}
+         
+   The number of replicas for objects after exiting stretch pool.
+   
+   :Type: Integer
+   :Required: Yes.
+
+.. describe:: {min_size}
+            
+   The minimum number of replicas required for I/O after exiting stretch pool.
+
+   :Type: Integer
+   :Required: Yes.
+
 Showing values of a stretch pool
 ================================
 To show values for a stretch pool, run a command of the following form: