MB-70082 Add support for KV rate limiting to setting-cluster

Change-Id: I65683e720d09fe037496a23f4c0a3eeb92db8b26
Reviewed-on: https://review.couchbase.org/c/couchbase-cli/+/242094
Reviewed-by: Matt Hall <matt.hall@couchbase.com>
Tested-by: Build Bot <build@couchbase.com>

Author: lubomarinski

cbmgr.py

@@ -3501,6 +3501,15 @@ def __init__(self):
         group.add_argument("--cluster-query-ramsize", dest="query_mem_quota", metavar="<quota>",
                            type=(int), help="The query service memory quota in mebibytes")
         group.add_argument("--cluster-name", dest="name", metavar="<name>", help="The cluster name")
+        group.add_argument("--node-capacity", dest="node_capacity", metavar="<capacity>", type=(int),
+                           help="The number of units (bytes) per second. This is a global counter that any "
+                           "bucket can consume from")
+        group.add_argument("--throttle-enabled", dest="throttle_enabled", metavar="<1|0>", choices=["0", "1"],
+                           help="Enable/Disable throttling feature")
+        group.add_argument("--read-unit-size", dest="read_unit_size", metavar="<size>", type=(int),
+                           help="Size of read that will consume 1 unit")
+        group.add_argument("--write-unit-size", dest="write_unit_size", metavar="<size>", type=(int),
+                           help="Size of write that will consume 1 unit")
 
     @rest_initialiser(cluster_init_check=True, version_check=True)
     def execute(self, opts):
@@ -3523,6 +3532,12 @@ def execute(self, opts):
             _, errors = self.rest.set_admin_credentials(username, password, opts.port)
             _exit_if_errors(errors)
 
+        # Set global throttling settings if any were provided
+        if opts.node_capacity is not None or opts.throttle_enabled is not None or opts.read_unit_size is not None or opts.write_unit_size is not None:
+            _, errors = self.rest.set_global_memcached_settings(
+                opts.node_capacity, opts.throttle_enabled, opts.read_unit_size, opts.write_unit_size)
+            _exit_if_errors(errors)
+
         _success("Cluster settings modified")
 
     @staticmethod

docs/modules/cli/pages/cbcli/couchbase-cli-setting-cluster.adoc

@@ -19,7 +19,9 @@ _couchbase-cli setting-cluster_ [--cluster <url>] [--username <user>] [--passwor
     [--cluster-ramsize <mebibytes>] [--cluster-name <name>]
     [--cluster-index-ramsize <mebibytes>] [--cluster-fts-ramsize <mebibytes>]
     [--cluster-eventing-ramsize <mebibytes>]
-    [--cluster-analytics-ramsize <mebibytes>]
+    [--cluster-analytics-ramsize <mebibytes>] [--cluster-query-ramsize <mebibytes>]
+    [--node-capacity <capacity>] [--throttle-enabled <1|0>]
+    [--read-unit-size <size>] [--write-unit-size <size>]
 
 == DESCRIPTION
 
@@ -79,6 +81,21 @@ include::{partialsdir}/cbcli/part-common-options.adoc[]
   Specifies the port for the Couchbase Administration Console. Defaults to
   port 8091.
 
+--node-capacity::
+  The number of units (bytes) per second. This is a global counter that any
+  bucket can consume from. This sets the total amount of resources available on
+  the node.
+
+--throttle-enabled::
+  Enable or disable the throttling feature. Accepted values are "1" to enable
+  and "0" to disable.
+
+--read-unit-size::
+  The size in bytes of read that will consume 1 unit.
+
+--write-unit-size::
+  The size in bytes of write that will consume 1 unit.
+
 include::{partialsdir}/cbcli/part-host-formats.adoc[]
 
 include::{partialsdir}/cbcli/part-certificate-authentication.adoc[]

test/test_cli.py

@@ -2096,6 +2096,35 @@ def test_setting_cluster_memory(self):
                            'cbasMemoryQuota=500', 'indexMemoryQuota=200', 'queryMemoryQuota=600']
         self.rest_parameter_match(expected_params)
 
+    def test_setting_cluster_throttle_settings(self):
+        args = [
+            '--node-capacity',
+            '10000',
+            '--throttle-enabled',
+            '1',
+            '--read-unit-size',
+            '1024',
+            '--write-unit-size',
+            '2048']
+        self.no_error_run(self.command + args, self.server_args)
+        self.assertIn('POST:/pools/default/settings/memcached/global', self.server.trace)
+        expected_params = ['nodeCapacity=10000', 'throttleEnabled=true', 'readUnitSize=1024', 'writeUnitSize=2048']
+        self.rest_parameter_match(expected_params)
+
+    def test_setting_cluster_throttle_disabled(self):
+        args = ['--node-capacity', '50000', '--throttle-enabled', '0']
+        self.no_error_run(self.command + args, self.server_args)
+        self.assertIn('POST:/pools/default/settings/memcached/global', self.server.trace)
+        expected_params = ['nodeCapacity=50000', 'throttleEnabled=false']
+        self.rest_parameter_match(expected_params)
+
+    def test_setting_cluster_only_node_capacity(self):
+        args = ['--node-capacity', '25000']
+        self.no_error_run(self.command + args, self.server_args)
+        self.assertIn('POST:/pools/default/settings/memcached/global', self.server.trace)
+        expected_params = ['nodeCapacity=25000']
+        self.rest_parameter_match(expected_params)
+
 
 class TestSettingCompaction(CommandTest):
     def setUp(self):