]> git.apps.os.sepia.ceph.com Git - ceph-ci.git/commitdiff
rgw: add scary warning to long_desc of rgw_ops_log_rados
authorCasey Bodley <cbodley@redhat.com>
Thu, 31 Mar 2022 17:53:15 +0000 (13:53 -0400)
committerCasey Bodley <cbodley@redhat.com>
Tue, 5 Apr 2022 21:13:23 +0000 (17:13 -0400)
Signed-off-by: Casey Bodley <cbodley@redhat.com>
src/common/options/rgw.yaml.in

index 67d5c50b834cf95037bc770cb12c81ff295b5762..a1a3cc9c3f5499d9cbd4fb1dc31798c9b75f9027 100644 (file)
@@ -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