Skip to content

Commit 3bae8a1

Browse files
paulohtb6Feediver1
andauthored
rpk update 25.3 (#1465)
Co-authored-by: Joyce Fee <[email protected]>
1 parent f70b1e9 commit 3bae8a1

26 files changed

+250
-38
lines changed

modules/ROOT/nav.adoc

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -301,6 +301,8 @@
301301
***** xref:reference:rpk/rpk-cluster/rpk-cluster-config-lint.adoc[]
302302
***** xref:reference:rpk/rpk-cluster/rpk-cluster-config-set.adoc[]
303303
***** xref:reference:rpk/rpk-cluster/rpk-cluster-config-status.adoc[]
304+
**** xref:reference:rpk/rpk-cluster/rpk-cluster-connections.adoc[]
305+
***** xref:reference:rpk/rpk-cluster/rpk-cluster-connections-list.adoc[]
304306
**** xref:reference:rpk/rpk-cluster/rpk-cluster-health.adoc[]
305307
**** xref:reference:rpk/rpk-cluster/rpk-cluster-license.adoc[]
306308
***** xref:reference:rpk/rpk-cluster/rpk-cluster-license-info.adoc[]
@@ -439,6 +441,7 @@
439441
****** xref:reference:rpk/rpk-redpanda/rpk-redpanda-admin-config-log-level-set.adoc[]
440442
****** xref:reference:rpk/rpk-redpanda/rpk-redpanda-admin-config-log-level.adoc[]
441443
****** xref:reference:rpk/rpk-redpanda/rpk-redpanda-admin-config-print.adoc[]
444+
***** xref:reference:rpk/rpk-redpanda/rpk-redpanda-config-print.adoc[]
442445
***** xref:reference:rpk/rpk-redpanda/rpk-redpanda-admin-partitions.adoc[]
443446
****** xref:reference:rpk/rpk-redpanda/rpk-redpanda-admin-partitions.adoc[]
444447
****** xref:reference:rpk/rpk-redpanda/rpk-redpanda-admin-partitions-list.adoc[]

modules/get-started/pages/release-notes/redpanda.adoc

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -49,6 +49,11 @@ You can now generate a security report for your Redpanda cluster using the link:
4949

5050
Redpanda v25.3 implements topic identifiers using 16 byte UUIDs as proposed in https://cwiki.apache.org/confluence/display/KAFKA/KIP-516%3A+Topic+Identifiers[KIP-516^].
5151

52+
== New rpk commands
53+
54+
* **xref:reference:rpk/rpk-cluster/rpk-cluster-connections.adoc[rpk cluster connections]** - Monitor cluster connections and client statistics.
55+
* **xref:reference:rpk/rpk-redpanda/rpk-redpanda-config-print.adoc[rpk redpanda config print]** - Display node configuration.
56+
5257
== Deprecations
5358

5459
Several TLSv1.2 and TLSv1.3 cipher suites have been deprecated. See xref:upgrade:deprecated/index.adoc[Deprecated Features].

modules/reference/pages/rpk/rpk-cluster/rpk-cluster-config-force-reset.adoc

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -31,8 +31,6 @@ Redpanda `data` directory).
3131

3232
|-h, --help |- |Help for force-reset.
3333

34-
|--all |- |Include all properties, including tunables.
35-
3634
|--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`.
3735

3836
|-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.

modules/reference/pages/rpk/rpk-cluster/rpk-cluster-config-get.adoc

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,8 +23,6 @@ rpk cluster config get <key> [flags]
2323

2424
|-h, --help |- |Help for get.
2525

26-
|--all |- |Include all properties, including tunables.
27-
2826
|--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`.
2927

3028
|-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.

modules/reference/pages/rpk/rpk-cluster/rpk-cluster-config-lint.adoc

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,8 +20,6 @@ rpk cluster config lint [flags]
2020

2121
|-h, --help |- |Help for lint.
2222

23-
|--all |- |Include all properties, including tunables.
24-
2523
|--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`.
2624

2725
|-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.

modules/reference/pages/rpk/rpk-cluster/rpk-cluster-config-set.adoc

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -43,8 +43,6 @@ rpk cluster config set <key> <value> [flags]
4343

4444
|-h, --help |- |Help for set.
4545

46-
|--all |- |Include all properties, including tunables.
47-
4846
|--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`.
4947

5048
|-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.

modules/reference/pages/rpk/rpk-cluster/rpk-cluster-config-status.adoc

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -49,8 +49,6 @@ rpk cluster config status [flags]
4949

5050
|-h, --help |- |Help for status.
5151

52-
|--all |- |Include all properties, including tunables.
53-
5452
|--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`.
5553

5654
|-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.

modules/reference/pages/rpk/rpk-cluster/rpk-cluster-config.adoc

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -41,8 +41,6 @@ rpk cluster config [command]
4141
|===
4242
|*Value* |*Type* |*Description*
4343

44-
|--all |- |Include all properties, including tunables.
45-
4644
|-h, --help |- |Help for config.
4745

4846
|--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`.
Lines changed: 96 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,96 @@
1+
= rpk cluster connections list
2+
3+
Display statistics about current Kafka connections.
4+
5+
This command displays a table of active and recently closed connections within the cluster.
6+
7+
Use filtering and sorting to identify the connections of the client applications that you are interested in. See `--help` for the list of filtering arguments and sorting arguments.
8+
9+
In addition to the filtering shorthand CLI arguments (For example, `--client-id`, `--state`), you can also use the `--filter-raw` and `--order-by` arguments that take string expressions. To understand the syntax of these arguments, refer to the Admin API docs of the filter and order-by fields of the [ListKafkaConnections endpoint](https://docs.redpanda.com/api/doc/admin/version/11f41833-5783-4f1a-ad64-5957267abd52/operation/operation-redpanda-core-admin-v2-clusterservice-listkafkaconnections):
10+
11+
By default only a subset of the per-connection data is printed. To see all of the available data, use `--format=json`.
12+
13+
== Usage
14+
15+
[,bash]
16+
----
17+
rpk cluster connections list [flags]
18+
----
19+
20+
== Examples
21+
22+
List connections ordered by their recent produce throughput:
23+
24+
[,bash]
25+
----
26+
rpk cluster connections list --order-by="recent_request_statistics.produce_bytes desc"
27+
----
28+
29+
List connections ordered by their recent fetch throughput:
30+
31+
[,bash]
32+
----
33+
rpk cluster connections list --order-by="recent_request_statistics.fetch_bytes desc"
34+
----
35+
36+
List connections ordered by the time that they've been idle:
37+
38+
[,bash]
39+
----
40+
rpk cluster connections list --order-by="idle_duration desc"
41+
----
42+
43+
List connections ordered by those that have made the least requests:
44+
45+
[,bash]
46+
----
47+
rpk cluster connections list --order-by="total_request_statistics.request_count asc"
48+
----
49+
50+
List extended output for open connections in JSON format:
51+
52+
[,bash]
53+
----
54+
rpk cluster connections list --format=json --state="OPEN"
55+
----
56+
57+
== Flags
58+
59+
[cols="1m,1a,2a"]
60+
|===
61+
|*Value* |*Type* |*Description*
62+
63+
|--client-id |string |Filter results by the client ID.
64+
65+
|--client-software-name |string |Filter results by the client software name.
66+
67+
|--client-software-version |string |Filter results by the client software version.
68+
69+
|--filter-raw |string |Filter connections based on a raw query (overrides other filters).
70+
71+
|--format |string |Output format. Possible values: `json`, `yaml`, `text`, `wide`, `help`. Default: `text`.
72+
73+
|-g, --group-id |string |Filter by client group ID.
74+
75+
|-h, --help |- |Help for connections list.
76+
77+
|-i, --idle-ms |int |Show connections idle for more than `i` milliseconds.
78+
79+
|--ip-address |string |Filter results by the client IP address.
80+
81+
|--limit |int32 |Limit how many records can be returned (default `20`).
82+
83+
|--order-by |string |Order the results by their values. See <<examples>>.
84+
85+
|-s, --state |string |Filter results by state. Acceptable values: `OPEN`, `CLOSED`.
86+
87+
|-u, --user |string |Filter results by a specific user principal.
88+
89+
|--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`.
90+
91+
|-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.
92+
93+
|--profile |string |Profile to use. See xref:reference:rpk/rpk-profile.adoc[`rpk profile`] for more details.
94+
95+
|-v, --verbose |- |Enable verbose logging.
96+
|===
Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
= rpk cluster connections
2+
3+
Manage and monitor cluster connections.
4+
5+
== Usage
6+
7+
[,bash]
8+
----
9+
rpk cluster connections [command] [flags]
10+
----
11+
12+
== Aliases
13+
14+
[,bash]
15+
----
16+
connections, connection
17+
----
18+
19+
== Flags
20+
21+
[cols="1m,1a,2a"]
22+
|===
23+
|*Value* |*Type* |*Description*
24+
25+
|-h, --help |- |Help for connections.
26+
27+
|--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`.
28+
29+
|-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.
30+
31+
|--profile |string |Profile to use. See xref:reference:rpk/rpk-profile.adoc[`rpk profile`] for more details.
32+
33+
|-v, --verbose |- |Enable verbose logging.
34+
|===

0 commit comments

Comments
 (0)