MB-70082 Add CLI Support for rate limiting per bucket

Add two new flags to bucket-create and bucket-edit:
--reserved - Set the minimum resource usage reserved for this bucket
--hard-limit - If set, the bucket will be throttled at this limit

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

Author: lubomarinski

cbmgr.py

@@ -1354,6 +1354,12 @@ def __init__(self):
             type=(int),
             help="The number of seconds of acceptable drift at which new CAS values will be accepted")
 
+        group.add_argument("--reserved", dest="throttle_reserved", metavar="<number>", type=(int),
+                           help="The guaranteed resource usage reserved for this bucket (units/s)")
+        group.add_argument("--hard-limit", dest="throttle_hard_limit", metavar="<number>", type=(int),
+                           help="If set, the bucket will be throttled at this limit regardless of any capacity "
+                           "left over (units/s)")
+
     @rest_initialiser(cluster_init_check=True, version_check=True, enterprise_check=False)
     def execute(self, opts):
         if opts.max_ttl and not self.enterprise:
@@ -1476,7 +1482,7 @@ def execute(self, opts):
                                             opts.history_retention_bytes, opts.history_retention_seconds,
                                             opts.enable_history_retention, opts.rank, opts.num_vbuckets, opts.encryption_key,
                                             dek_rotate_interval, dek_lifetime, opts.invalid_hlc_strategy,
-                                            opts.hlc_max_future_threshold)
+                                            opts.hlc_max_future_threshold, opts.throttle_reserved, opts.throttle_hard_limit)
         _exit_if_errors(errors)
         _success("Bucket created")
 
@@ -1608,6 +1614,12 @@ def __init__(self):
             type=(int),
             help="The number of seconds of acceptable drift at which new CAS values will be accepted")
 
+        group.add_argument("--reserved", dest="throttle_reserved", metavar="<number>", type=(int),
+                           help="The guaranteed resource usage reserved for this bucket (units/s)")
+        group.add_argument("--hard-limit", dest="throttle_hard_limit", metavar="<number>", type=(int),
+                           help="If set, the bucket will be throttled at this limit regardless of any capacity "
+                           "left over (units/s)")
+
         group.add_argument("--enable-cross-cluster-versioning", dest="xcluster_versioning", action='store_true')
         group.add_argument("--force", dest="force", action='store_true')
 
@@ -1715,7 +1727,8 @@ def execute(self, opts):
                                           opts.history_retention_bytes, opts.history_retention_seconds,
                                           opts.enable_history_retention, opts.rank, opts.encryption_key,
                                           dek_rotate_interval, dek_lifetime, is_couchbase_bucket, opts.invalid_hlc_strategy,
-                                          opts.hlc_max_future_threshold, opts.xcluster_versioning)
+                                          opts.hlc_max_future_threshold, opts.xcluster_versioning,
+                                          opts.throttle_reserved, opts.throttle_hard_limit)
         _exit_if_errors(errors)
 
         _success("Bucket edited")

cluster_manager.py

@@ -1156,6 +1156,8 @@ def create_bucket(
             dek_lifetime,
             invalid_hlc_strategy,
             hlc_max_future_threshold,
+            throttle_reserved,
+            throttle_hard_limit,
             timeout=60):
         url = f'{self.hostname}/pools/default/buckets'
 
@@ -1245,6 +1247,11 @@ def create_bucket(
         if hlc_max_future_threshold is not None:
             params["hlcMaxFutureThreshold"] = hlc_max_future_threshold
 
+        if throttle_reserved is not None:
+            params["throttleReserved"] = throttle_reserved
+        if throttle_hard_limit is not None:
+            params["throttleHardLimit"] = throttle_hard_limit
+
         result, errors = self._post_form_encoded(url, params)
         if errors:
             return None, errors
@@ -1288,7 +1295,8 @@ def edit_bucket(self, name, memory_quota, durability_min_level, eviction_policy,
                     abort_outside, paralleldb_and_view_compact, purge_interval,
                     history_retention_bytes, history_retention_seconds, history_retention_default,
                     rank, encryption_key, dek_rotation_interval, dek_lifetime, couchbase_bucket: bool = True,
-                    invalid_hlc_strategy=None, hlc_max_future_threshold=None, xcluster_versioning: bool = False):
+                    invalid_hlc_strategy=None, hlc_max_future_threshold=None, xcluster_versioning: bool = False,
+                    throttle_reserved=None, throttle_hard_limit=None):
         url = f'{self.hostname}/pools/default/buckets/{name}'
 
         if name is None:
@@ -1365,6 +1373,11 @@ def edit_bucket(self, name, memory_quota, durability_min_level, eviction_policy,
         if xcluster_versioning:
             params["enableCrossClusterVersioning"] = "true"
 
+        if throttle_reserved is not None:
+            params["throttleReserved"] = throttle_reserved
+        if throttle_hard_limit is not None:
+            params["throttleHardLimit"] = throttle_hard_limit
+
         return self._post_form_encoded(url, params)
 
     def delete_bucket(self, name):

docs/modules/cli/pages/cbcli/couchbase-cli-bucket-create.adoc

@@ -32,6 +32,7 @@ _couchbase-cli bucket-create_ [--cluster <url>] [--username <user>]
     [--num-vbuckets <128|1024>]
     [--encryption-key <key>] [--dek-rotate-every <days>] [--dek-lifetime <days>]
     [--invalid-hlc-strategy <error|ignore|replace>] [--hlc-max-future-threshold <seconds>]
+    [--reserved <number>] [--hard-limit <number>]
 
 == DESCRIPTION
 
@@ -262,6 +263,14 @@ The number of days which the DEK (Data Encryption Key) should be kept for.
 --hlc-max-future-threshold <seconds>::
 The number of seconds of acceptable drift at which new CAS values will be accepted.
 
+--reserved <number>::
+Measured in units per second. The guaranteed resource usage that is reserved for
+this bucket only.
+
+--hard-limit <number>::
+Measured in units per second. If set, the bucket will be throttled at this limit
+regardless of any capacity left over.
+
 include::{partialsdir}/cbcli/part-common-history-retention.adoc[]
 
 include::{partialsdir}/cbcli/part-host-formats.adoc[]

docs/modules/cli/pages/cbcli/couchbase-cli-bucket-edit.adoc

@@ -31,7 +31,7 @@ _couchbase-cli bucket-edit_ [--cluster <url>] [--username <user>]
     [--enable-history-retention-by-default <0|1>] [--rank <num>]
     [--encryption-key <key>] [--dek-rotate-every <days>] [--dek-lifetime <days>]
     [--invalid-hlc-strategy <error|ignore|replace>] [--hlc-max-future-threshold <seconds>]
-    [--enable-cross-cluster-versioning]
+    [--enable-cross-cluster-versioning] [--reserved <number>] [--hard-limit <number>]
 
 == DESCRIPTION
 
@@ -234,6 +234,14 @@ Run index and data compaction in parallel. Global setting only.
 --force::
   Skip any prompts asking you whether to continue.
 
+--reserved <number>::
+Measured in units per second. The guaranteed resource usage that is reserved for this
+bucket only.
+
+--hard-limit <number>::
+Measured in units per second. If set, the bucket will be throttled at this limit
+regardless of any capacity left over.
+
 include::{partialsdir}/cbcli/part-common-history-retention.adoc[]
 
 include::{partialsdir}/cbcli/part-host-formats.adoc[]

test/test_cli.py

@@ -705,6 +705,24 @@ def test_bucket_create_hlc_threshold_invalid(self):
         self.assertIn("--hlc-max-future-threshold cannot be lower than 10",
                       self.str_output)
 
+    def test_bucket_create_reserved(self):
+        self.no_error_run(self.command + self.command_args + self.command_couch_args + ['--reserved', '2000'],
+                          self.server_args)
+        expected_params = [
+            'bucketType=couchbase', 'name=name', 'evictionPolicy=fullEviction', 'replicaNumber=0', 'ramQuotaMB=100',
+            'storageBackend=magma', 'rank=3', 'numVBuckets=128', 'throttleReserved=2000',
+        ]
+        self.rest_parameter_match(expected_params)
+
+    def test_bucket_create_hard_limit(self):
+        self.no_error_run(self.command + self.command_args + self.command_couch_args + ['--hard-limit', '3000'],
+                          self.server_args)
+        expected_params = [
+            'bucketType=couchbase', 'name=name', 'evictionPolicy=fullEviction', 'replicaNumber=0', 'ramQuotaMB=100',
+            'storageBackend=magma', 'rank=3', 'numVBuckets=128', 'throttleHardLimit=3000',
+        ]
+        self.rest_parameter_match(expected_params)
+
 
 class TestBucketDelete(CommandTest):
     def setUp(self):
@@ -920,6 +938,26 @@ def test_bucket_edit_cross_cluster_versioning(self):
 
         self.rest_parameter_match(expected_params)
 
+    def test_bucket_edit_reserved(self):
+        self.server_args['buckets'].append(self.bucket_membase)
+        self.no_error_run(self.command + self.command_args + self.command_couch_args + ['--reserved', '2000'],
+                          self.server_args)
+        expected_params = [
+            'evictionPolicy=fullEviction', 'flushEnabled=1', 'threadsNumber=8', 'replicaNumber=0', 'ramQuotaMB=100',
+            'rank=3', 'throttleReserved=2000',
+        ]
+        self.rest_parameter_match(expected_params)
+
+    def test_bucket_edit_hard_limit(self):
+        self.server_args['buckets'].append(self.bucket_membase)
+        self.no_error_run(self.command + self.command_args + self.command_couch_args + ['--hard-limit', '3000'],
+                          self.server_args)
+        expected_params = [
+            'evictionPolicy=fullEviction', 'flushEnabled=1', 'threadsNumber=8', 'replicaNumber=0', 'ramQuotaMB=100',
+            'rank=3', 'throttleHardLimit=3000',
+        ]
+        self.rest_parameter_match(expected_params)
+
 
 class TestBucketFlush(CommandTest):
     def setUp(self):