]> git.apps.os.sepia.ceph.com Git - ceph.git/commitdiff
doc: added missing documentation on "pubsub" in rgw_enable_apis 40258/head
authorGaurav Sitlani <gauravsitlani@riseup.net>
Tue, 9 Feb 2021 19:24:41 +0000 (00:54 +0530)
committersinguliere <singuliere@autistici.org>
Fri, 19 Mar 2021 18:22:13 +0000 (19:22 +0100)
Fixes: https://tracker.ceph.com/issues/49203
Adding support for the term "notifications" in rgw_enable_apis

Signed-off-by: Gaurav Sitlani <gauravsitlani@riseup.net>
(cherry picked from commit f6dd3750911109fc29d70dbf886c0f4dc43d2957)

doc/radosgw/config-ref.rst
doc/radosgw/notifications.rst
doc/radosgw/pubsub-module.rst
src/common/options.cc
src/rgw/rgw_main.cc

index 4426b3563d117aeff2c7e70a5c5789480f691869..e9d419fd3c064795f080a38962b6f9694ea3e457 100644 (file)
@@ -40,7 +40,7 @@ instances or all radosgw-admin options can be put into the ``[global]`` or the
                         participate in a `multi-site <../multisite>`_
                         configuration.
 :Type: String
-:Default: ``s3, swift, swift_auth, admin`` All APIs.
+:Default: ``s3, s3website, swift, swift_auth, admin, sts, iam, notifications`` All APIs.
 
 
 ``rgw_cache_enabled``
index bda5e0e9731296fe1dec7143a88e0b451984634f..adf0d4d93a30fb69db56446cb5da8bcb64a4fbe1 100644 (file)
@@ -29,6 +29,7 @@ mechanism. This API is similar to the one defined as the S3-compatible API of th
 
    S3 Bucket Notification Compatibility <s3-notification-compatibility>
 
+.. note:: To enable bucket notifications API, the `rgw_enable_apis` configuration parameter should contain: "notifications".
 
 Notification Reliability
 ------------------------
index e2eaac7c8e24f945c65a0915bafc430bd6e86ecf..c1b8e4cd553a0098383c303269e24057e1a1419b 100644 (file)
@@ -38,6 +38,8 @@ be accessed directly, but need to be pulled and acked using the new REST API.
 
    S3 Bucket Notification Compatibility <s3-notification-compatibility>
 
+.. note:: To enable bucket notifications API, the `rgw_enable_apis` configuration parameter should contain: "notifications".
+
 PubSub Zone Configuration
 -------------------------
 
index e315b267a2a1c44bc3eebbd968124912146b1af7..5a4079290b42b2bc358ea8c7eb3fbc94c08e58a3 100644 (file)
@@ -5729,7 +5729,7 @@ std::vector<Option> get_rgw_options() {
         "will be located in the path that is specified here. "),
 
     Option("rgw_enable_apis", Option::TYPE_STR, Option::LEVEL_ADVANCED)
-    .set_default("s3, s3website, swift, swift_auth, admin, sts, iam, pubsub")
+    .set_default("s3, s3website, swift, swift_auth, admin, sts, iam, notifications")
     .set_description("A list of set of RESTful APIs that rgw handles."),
 
     Option("rgw_cache_enabled", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
index 391d56524393cbc629ca2ebcb1a9a6a869a58ce2..3f451d7eef9f8a1c8a4f33f5639fdc8277ef75a2 100644 (file)
@@ -380,7 +380,7 @@ int radosgw_Main(int argc, const char **argv)
   const bool s3website_enabled = apis_map.count("s3website") > 0;
   const bool sts_enabled = apis_map.count("sts") > 0;
   const bool iam_enabled = apis_map.count("iam") > 0;
-  const bool pubsub_enabled = apis_map.count("pubsub") > 0;
+  const bool pubsub_enabled = apis_map.count("pubsub") > 0 || apis_map.count("notifications") > 0;
   // Swift API entrypoint could placed in the root instead of S3
   const bool swift_at_root = g_conf()->rgw_swift_url_prefix == "/";
   if (apis_map.count("s3") > 0 || s3website_enabled) {