rpk 24.2 (#591)

Co-authored-by: Joyce Fee <102751339+Feediver1@users.noreply.github.com>
redpanda-data · Jul 11, 2024 · 86ba624 · 86ba624
1 parent 42af291
commit 86ba624
Show file tree

Hide file tree

Showing 13 changed files with 342 additions and 59 deletions.
diff --git a/modules/ROOT/nav.adoc b/modules/ROOT/nav.adoc
@@ -328,6 +328,9 @@
 ****** xref:reference:rpk/rpk-cluster/rpk-cluster-partitions-move-status.adoc[]
 ***** xref:reference:rpk/rpk-cluster/rpk-cluster-partitions-transfer-leadership.adoc[]
 ***** xref:reference:rpk/rpk-cluster/rpk-cluster-partitions-unsafe-recover.adoc[]
+**** xref:reference:rpk/rpk-cluster/rpk-cluster-quotas.adoc[]
+***** xref:reference:rpk/rpk-cluster/rpk-cluster-quotas-alter.adoc[]
+***** xref:reference:rpk/rpk-cluster/rpk-cluster-quotas-describe.adoc[]
 **** xref:reference:rpk/rpk-cluster/rpk-cluster-self-test.adoc[]
 ***** xref:reference:rpk/rpk-cluster/rpk-cluster-self-test-start.adoc[]
 ***** xref:reference:rpk/rpk-cluster/rpk-cluster-self-test-status.adoc[]
@@ -467,6 +470,8 @@
 **** xref:reference:rpk/rpk-transform/rpk-transform-init.adoc[]
 **** xref:reference:rpk/rpk-transform/rpk-transform-list.adoc[]
 **** xref:reference:rpk/rpk-transform/rpk-transform-logs.adoc[]
+**** xref:reference:rpk/rpk-transform/rpk-transform-pause.adoc[]
+**** xref:reference:rpk/rpk-transform/rpk-transform-resume.adoc[]
 *** xref:reference:rpk/rpk-version.adoc[]
 ** xref:reference:console/index.adoc[Redpanda Console]
 *** xref:reference:console/config.adoc[Redpanda Console Configuration]

diff --git a/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-partitions-list.adoc b/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-partitions-list.adoc
@@ -15,40 +15,6 @@ If the Disabled column contains a '-' value, then it means you are running this
 
 Disabling a partition in Redpanda involves prohibiting any data consumption or production to and from it. All internal processes associated with the partition are stopped, and it remains unloaded during system startup. This measure aims to maintain cluster health by preventing issues caused by specific corrupted partitions that may lead to Redpanda crashes. Although the data remains stored on disk, Redpanda ceases interaction with the disabled partitions to ensure system stability. You may disable/enable partition using `rpk cluster partitions enable/disable`.	
 
-
-
-== Examples
-
-List all partitions in the cluster:
-
-[,bash]
-----
-rpk cluster partitions list --all
-----
-
-List all partitions in the cluster, filtering for topic foo and bar:
-
-[,bash]
-----
-rpk cluster partitions list foo bar
-----
-
-List only the disabled partitions:
-
-[,bash]
-----
-rpk cluster partitions list -a --disabled-only
-----
-
-
-
-List all in JSON format:
-
-[,bash]
-----
-rpk cluster partition list -a --format json
-----
-
 == Usage
 
 [,bash]
@@ -77,7 +43,9 @@ list, ls, describe
 
 |-h, --help |- |Help for list.
 
-|-p, --partition |- |ints   List of comma-separated partitions IDs that you wish to filter the results with.
+|-n, --node-ids |ints |List of comma-separated broker IDs you wish to use to filter the results.
+
+|-p, --partition |ints |List of comma-separated partitions IDs you wish to use to filter the results.
 
 |--config |string |Redpanda or `rpk` config file; default search paths are `/var/lib/redpanda/.config/rpk/rpk.yaml`, `$PWD/redpanda.yaml`, and `/etc/redpanda/redpanda.yaml`.
 
@@ -87,4 +55,42 @@ list, ls, describe
 |--profile |string |Profile to use. See xref:reference:rpk/rpk-profile.adoc[`rpk profile`] for more details.
 
 |-v, --verbose |- |Enable verbose logging.
-|===
+|===
+
+
+== Examples
+
+List all partitions in the cluster:
+
+[,bash]
+----
+rpk cluster partitions list --all
+----
+
+List all partitions in the cluster, filtering for topic foo and bar:
+
+[,bash]
+----
+rpk cluster partitions list foo bar
+----
+
+List partitions with replicas that are assigned to brokers 1 and 2.
+
+[,bash]
+----
+rpk cluster partitions list foo --node-ids 1,2
+----
+
+List only the disabled partitions:
+
+[,bash]
+----
+rpk cluster partitions list -a --disabled-only
+----
+
+List all in JSON format:
+
+[,bash]
+----
+rpk cluster partition list -a --format json
+----
diff --git a/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-quotas-alter.adoc b/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-quotas-alter.adoc
@@ -0,0 +1,81 @@
+= rpk cluster quotas alter
+:description: rpk cluster quotas alter
+
+Add or delete a client quota.
+
+A client quota consists of an entity (to which the quota is applied) and a quota type (what is being applied).
+
+There are two entity types supported by Redpanda: client ID and client ID prefix. Use the `--default` flag to assign quotas to default entity types.
+
+You can perform a dry run using the `--dry` flag.
+
+== Usage
+
+[,bash]
+----
+rpk cluster quotas alter [flags]
+----
+
+== Flags
+
+[cols="1m,1a,2a"]
+|===
+|*Value* |*Type* |*Description*
+
+|--add |strings |Key=value quota to add, where the value is a float number (repeatable).
+
+|--default |strings |Entity type for default matching, where type is client-id or client-id-prefix (repeatable).
+
+|--delete |strings |Key of the quota to delete (repeatable).
+
+|--dry |- |Key of the quota to delete (repeatable).
+
+|--format |string |Output format. Possible values: `json`, `yaml`, `text`, `wide`, `help`. Default: `text`.
+
+|-h, --help |- |Help for alter.
+
+|--name |strings |Entity for exact matching. Format `type=name` where `type` is the `client-id` or `client-id-prefix` (repeatable).
+
+|--config |string |Redpanda or `rpk` config file; default search paths are `~/.config/rpk/rpk.yaml`, `$PWD`, and `/etc/redpanda/redpanda.yaml`.
+
+|-X, --config-opt |stringArray |Override `rpk` configuration settings. See xref:reference:rpk/rpk-x-options.adoc[`rpk -X`] or execute `rpk -X help` for inline detail or `rpk -X list` for terser detail.
+
+|--profile |string |Profile to use. See xref:reference:rpk/rpk-profile.adoc[`rpk profile`] for more details.
+
+|-v, --verbose |- |Enable verbose logging.
+|===
+
+
+== Examples
+
+Add quota (consumer_byte_rate) to client ID `<foo>`:
+
+[,bash]
+----
+rpk cluster quotas alter --add consumer_byte_rate=200000 \
+  --name client-id=<foo>
+----
+
+Add quota (consumer_byte_rate) to client ID starting with `<bar>-`:
+
+[,bash]
+----
+rpk cluster quotas alter --add consumer_byte_rate=200000 \
+  --name client-id-prefix=<bar>-
+----
+
+Add quota (producer_byte_rate) to default client ID:
+
+[,bash]
+----
+rpk cluster quotas alter --add producer_byte_rate=180000 \
+  --default client-id=foo
+----
+
+Remove quota (producer_byte_rate) from client ID `foo`:
+
+[,bash]
+----
+rpk cluster quotas alter --delete producer_byte_rate \
+  --name client-id=<foo>
+----
diff --git a/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-quotas-describe.adoc b/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-quotas-describe.adoc
@@ -0,0 +1,67 @@
+= rpk cluster quotas describe
+:description: rpk cluster quotas describe
+
+Describe client quotas.
+
+This command describes client quotas that match the provided filtering criteria. Running the command without filters returns all client quotas. Use the
+`--strict` flag for strict matching, which means that the only quotas returned exactly match the filters.
+
+You can specify filters in terms of entities. An entity consists of either a client ID or a client ID prefix.
+
+== Usage
+
+[,bash]
+----
+rpk cluster quotas describe [flags]
+----
+
+== Flags
+
+[cols="1m,1a,2a"]
+|===
+|*Value* |*Type* |*Description*
+
+|--any |strings |Type for any matching (names or default), where type is `client-id` or `client-id-prefix` (repeatable).
+
+|--default |strings |Type for default matching, where type is `client-id` or `client-id-prefix` (repeatable).
+
+|--format |string |Output format. Possible values: `json`, `yaml`, `text`, `wide`, `help`. Default: `text`.
+
+|-h, --help |- |Help for describe.
+
+|--name |strings |The `type=name` pair for exact name matching, where type is `client-id` or `client-id-prefix` (repeatable).
+
+|--strict |- |Specifies whether matches are strict. If `true`, entities with unspecified entity types are excluded.
+
+|--config |string |Redpanda or `rpk` config file; default search paths are `~/.config/rpk/rpk.yaml`, `$PWD`, and `/etc/redpanda/redpanda.yaml`.
+
+|-X, --config-opt |stringArray |Override `rpk` configuration settings. See xref:reference:rpk/rpk-x-options.adoc[`rpk -X`] or execute `rpk -X help` for inline detail or `rpk -X list` for terser detail.
+
+|--profile |string |Profile to use. See xref:reference:rpk/rpk-profile.adoc[`rpk profile`] for more details.
+
+|-v, --verbose |- |Enable verbose logging.
+|===
+
+
+== Examples
+
+Describe all client quotas:
+
+[,bash]
+----
+rpk cluster quotas describe
+----
+
+Describe all client quota with client ID `<foo>`:
+
+[,bash]
+----
+rpk cluster quotas describe --name client-id=<foo>
+----
+
+Describe client quotas for a given client ID prefix `<bar>.`:
+
+[,bash]
+----
+rpk cluster quotas describe --name client-id=<bar>.
+----
diff --git a/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-quotas.adoc b/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-quotas.adoc
@@ -0,0 +1,37 @@
+= rpk cluster quotas
+:description: rpk cluster quotas
+
+Manage Redpanda client quotas.
+
+== Usage
+
+[,bash]
+----
+rpk cluster quotas [command] [flags]
+----
+
+== Aliases
+
+[,bash]
+----
+quotas, quota
+----
+
+== Flags
+
+[cols="1m,1a,2a"]
+|===
+|*Value* |*Type* |*Description*
+
+|--format |string |Output format. Possible values: `json`, `yaml`, `text`, `wide`, `help`. Default: `text`.
+
+|-h, --help |- |Help for quotas.
+
+|--config |string |Redpanda or `rpk` config file; default search paths are `~/.config/rpk/rpk.yaml`, `$PWD`, and `/etc/redpanda/redpanda.yaml`.
+
+|-X, --config-opt |stringArray |Override `rpk` configuration settings. See xref:reference:rpk/rpk-x-options.adoc[`rpk -X`] or execute `rpk -X help` for inline detail or `rpk -X list` for terser detail.
+
+|--profile |string |Profile to use. See xref:reference:rpk/rpk-profile.adoc[`rpk profile`] for more details.
+
+|-v, --verbose |- |Enable verbose logging.
+|===
diff --git a/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-self-test-start.adoc b/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-self-test-start.adoc
@@ -14,6 +14,13 @@ Available tests to run:
 ** Throughput test: 8192-bit messages
 *** Unique pairs of Redpanda nodes each act as a client and a server.
 *** The test pushes as much data over the wire, within the test parameters.
+* *Cloud tests*
+** Latency test: 1024-bit object.
+** Depending on cluster read/write permissions (xref:reference:properties/object-storage-properties.adoc#cloud_storage_enable_remote_read[`cloud_storage_enable_remote_read`], xref:reference:properties/object-storage-properties.adoc#cloud_storage_enable_remote_write[`cloud_storage_enable_remote_write`]), a series of cloud storage operations are performed:
+*** Upload an object to an object storage.
+*** List objects in the object storage.
+*** Download an object from the object storage.
+*** Delete the original object from the object storage, if it was uploaded.
 
 This command immediately returns on success, and the tests run asynchronously. The
 user polls for results with the xref:./rpk-cluster-self-test-status.adoc[rpk cluster self-test status]

diff --git a/...s/reference/pages/rpk/rpk-registry/rpk-registry-schema-check-compatibility.adoc b/...s/reference/pages/rpk/rpk-registry/rpk-registry-schema-check-compatibility.adoc
@@ -6,7 +6,7 @@ Check schema compatibility with existing schemas in the subject.
 
 [,bash]
 ----
-rpk registry schema check-compatibility SUBJECT [flags]
+rpk registry schema check-compatibility [SUBJECT] [flags]
 ----
 
 == Flags
@@ -18,11 +18,11 @@ rpk registry schema check-compatibility SUBJECT [flags]
 |-h, --help |- |Help for check-compatibility.
 |--references |string |Comma-separated list of references (name:subject:version), or path to reference file.
 
-|--schema |string |Schema filepath to check, must be `.avro` or `.proto`.
+|--schema |string |Schema file path to check. Must be `.avro`, `.json` or `.proto`.
 
 |--schema-version |string |Schema version to check compatibility with (`latest`, `0`, `1`...).
 
-|--type |string |Schema type (`avro`,`protobuf`); overrides schema file extension.
+|--type |string |Schema type (`avro`, `json`, `protobuf`). Overrides schema file extension.
 
 |--config |string |Redpanda or `rpk` config file; default search paths are `~/.config/rpk/rpk.yaml`, `$PWD`, and `/etc/redpanda/redpanda.yaml`.
 

diff --git a/modules/reference/pages/rpk/rpk-registry/rpk-registry-schema-create.adoc b/modules/reference/pages/rpk/rpk-registry/rpk-registry-schema-create.adoc
@@ -3,7 +3,7 @@
 Create a schema for the given subject.
 
 
-This uploads a schema to the registry, creating the schema if it does not exist. The schema type is detected by the filename extension: `.avro` or `.avsc` for Avro and `.proto` for Protobuf. You can manually specify the type with the `--type` flag.
+This uploads a schema to the registry, creating the schema if it does not exist. The schema type is detected by the filename extension: `.avro` or `.avsc` for Avro, `json` for JSON, and `.proto` for Protobuf. You can manually specify the type with the `--type` flag.
 
 You may pass the references using the --reference flag, which accepts either a comma separated list of `<name>:<subject>:<version>` or a path to a file. The file must contain lines of name, subject, and version separated by a tab or space, or the equivalent in json / yaml format.
 

diff --git a/modules/reference/pages/rpk/rpk-registry/rpk-registry-schema-get.adoc b/modules/reference/pages/rpk/rpk-registry/rpk-registry-schema-get.adoc
@@ -33,11 +33,12 @@ rpk registry schema get [SUBJECT] [flags]
 
 |--print-schema |- |Prints the schema in JSON format.
 
-|--schema |string |Schema filepath to upload, must be `.avro`, `.avsc`, or `.proto`.
+|--schema |string |Schema filepath to upload, must be `.avro`, `.avsc`, `json`, or `.proto`.
 
 |--schema-version |string |Schema version to check compatibility with (`latest`, `0`, `1`...).
 
-|--type |string |Schema type of the file used to lookup (avro, protobuf); overrides schema file extension.
+|--type |string |Schema type of the file used to lookup (`avro`, `json`, `protobuf`). Overrides schema file extension.
+
 
 |--config |string |Redpanda or `rpk` config file; default search paths are `/var/lib/redpanda/.config/rpk/rpk.yaml`, `$PWD/redpanda.yaml`, and `/etc/redpanda/redpanda.yaml`.