From: Casey Bodley <cbodley@redhat.com>
Date: Thu, 31 Mar 2022 17:53:15 +0000 (-0400)
Subject: rgw: add scary warning to long_desc of rgw_ops_log_rados
X-Git-Tag: v18.0.0~1005^2~2
X-Git-Url: http://git.apps.os.sepia.ceph.com/?a=commitdiff_plain;h=9236529bbbb7a358cdca883800b1d48f1d5e80fd;p=ceph-ci.git

rgw: add scary warning to long_desc of rgw_ops_log_rados

Signed-off-by: Casey Bodley <cbodley@redhat.com>
---

diff --git a/src/common/options/rgw.yaml.in b/src/common/options/rgw.yaml.in
index 67d5c50b834..a1a3cc9c3f5 100644
--- a/src/common/options/rgw.yaml.in
+++ b/src/common/options/rgw.yaml.in
@@ -1447,7 +1447,10 @@ options:
   type: bool
   level: advanced
   desc: Use RADOS for ops log
-  long_desc: If set, RGW will store ops log information in RADOS.
+  long_desc: If set, RGW will store ops log information in RADOS. WARNING,
+    there is no automation to clean up these log entries, so by default they
+    will pile up without bound. This MUST NOT be enabled unless the admin has
+    a strategy to manage and trim these log entries with `radosgw-admin log rm`.
   fmt_desc: Whether the operations log should be written to the
     Ceph Storage Cluster backend.
   default: false
@@ -1455,6 +1458,8 @@ options:
   - rgw
   see_also:
   - rgw_enable_ops_log
+  - rgw_log_object_name_utc
+  - rgw_log_object_name
   with_legacy: true
 # path to unix domain socket where ops log can go
 - name: rgw_ops_log_socket_path