From: Soumya Koduri <skoduri@redhat.com>
Date: Fri, 4 Jul 2025 07:20:53 +0000 (+0530)
Subject: rgw/cloud-restore: Update doc with new options added
X-Git-Url: http://git.apps.os.sepia.ceph.com/?a=commitdiff_plain;h=a981b4c0245eeafe077042a045cb05eeec9d8161;p=ceph.git

rgw/cloud-restore: Update doc with new options added

Signed-off-by: Soumya Koduri <skoduri@redhat.com>
---

diff --git a/doc/radosgw/cloud-transition.rst b/doc/radosgw/cloud-transition.rst
index 85720aed9ede3..cd6db6c70e93e 100644
--- a/doc/radosgw/cloud-transition.rst
+++ b/doc/radosgw/cloud-transition.rst
@@ -420,8 +420,8 @@ For versioned and locked objects, similar semantics as that of LifecycleExpirati
 
 Restoring Objects
 -----------------
-The objects transitioned to cloud can now be restored. For more information, refer to 
-`Restoring Objects from Cloud <https://docs.aws.amazon.com/AmazonS3/latest/dev/cloud-restore.html>`_.
+The objects transitioned to cloud can now be restored. For more information, refer to
+`Restoring Objects from Cloud <https://docs.ceph.com/en/latest/radosgw/cloud-restore/>`_.
 
 
 Future Work
@@ -429,6 +429,4 @@ Future Work
 
 * Send presigned redirect or read-through the objects transitioned to cloud.
 
-* Support ``s3:RestoreObject`` operation on cloud transitioned objects.
-
 * Support transition to other cloud providers (like Azure).
diff --git a/doc/radosgw/config-ref.rst b/doc/radosgw/config-ref.rst
index 592d80eba95f6..026b30eb7eaae 100644
--- a/doc/radosgw/config-ref.rst
+++ b/doc/radosgw/config-ref.rst
@@ -354,3 +354,14 @@ retention is indefinite, and notifications are retried as frequently as possible
 .. confval:: rgw_topic_persistency_sleep_duration
 
 .. _Bucket Notifications: ../notifications
+   
+Cloud Restore settings
+======================
+
+Cloud Restore feature currently enables the restoration of objects transitioned to S3-compatible cloud services into Ceph Object Gateway (RGW). The restore requests are asynchronously processed by Restore worker thread in the background. 
+
+.. confval:: rgw_restore_max_objs
+.. confval:: rgw_restore_lock_max_time
+.. confval:: rgw_restore_processor_period
+
+These values can be tuned based upon your specific workload to further increase the aggressiveness of restore processing.