Skip to content

Commit 8a97c9d

Browse files
committed
Update with latest rpk commands from v0.0.0-20241104git4a0f859 (#835)
1 parent 5efc18c commit 8a97c9d

File tree

5 files changed

+58
-5
lines changed

5 files changed

+58
-5
lines changed

modules/ROOT/nav.adoc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -283,6 +283,7 @@
283283
***** rpk cluster storage mount/unmount
284284
****** xref:reference:rpk/rpk-cluster/rpk-cluster-storage-cancel-mount.adoc[]
285285
****** xref:reference:rpk/rpk-cluster/rpk-cluster-storage-list-mount.adoc[]
286+
****** xref:reference:rpk/rpk-cluster/rpk-cluster-storage-list-mountable.adoc[]
286287
****** xref:reference:rpk/rpk-cluster/rpk-cluster-storage-mount.adoc[]
287288
****** xref:reference:rpk/rpk-cluster/rpk-cluster-storage-status-mount.adoc[]
288289
****** xref:reference:rpk/rpk-cluster/rpk-cluster-storage-unmount.adoc[]

modules/reference/pages/rpk/rpk-cluster/rpk-cluster-license-info.adoc

Lines changed: 13 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,11 @@
22

33
Retrieve license information:
44

5-
----
6-
Organization: Organization the license was generated for.
7-
Type: Type of license: free, enterprise, etc.
8-
Expires: Expiration date of the license.
9-
----
5+
- Organization: Organization the license was generated for.
6+
- Type: Type of license (free, enterprise, etc).
7+
- Expires: Expiration date of the license.
8+
- License Status: Status of the loaded license (valid, expired, not_present).
9+
- Violation: Whether the cluster is using enterprise features without a valid license.
1010
1111
== Usage
1212

@@ -15,6 +15,14 @@ Expires: Expiration date of the license.
1515
rpk cluster license info [flags]
1616
----
1717

18+
== Aliases
19+
20+
[,bash]
21+
----
22+
info, status
23+
----
24+
25+
1826
== Flags
1927

2028
[cols="1m,1a,2a"]
Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
= rpk cluster storage list-mountable
2+
3+
List topics that are available to mount from object storage.
4+
5+
This command displays topics that exist in object storage and can be mounted to your Redpanda cluster. Each topic includes its location in object storage and namespace information if applicable.
6+
7+
== Usage
8+
9+
[,bash]
10+
----
11+
rpk cluster storage list-mountable [flags]
12+
----
13+
14+
== Examples
15+
16+
List all mountable topics:
17+
18+
[,bash]
19+
----
20+
rpk cluster storage list-mountable
21+
----
22+
23+
== Flags
24+
25+
[cols="1m,1a,2a"]
26+
|===
27+
|*Value* |*Type* |*Description*
28+
29+
|-h, --help |- |Help for list-mountable.
30+
31+
|--format |string |Output format. Possible values: `json`, `yaml`, `text`, `wide`, `help`. Default: `text`.
32+
33+
|--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`.
34+
35+
|-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.
36+
37+
|--profile |string |Profile to use. See xref:reference:rpk/rpk-profile.adoc[`rpk profile`] for more details.
38+
39+
|-v, --verbose |- |Enable verbose logging.
40+
|===

modules/reference/pages/rpk/rpk-topic/rpk-topic-list.adoc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,8 @@ list, ls
4141

4242
|-d, --detailed |- |Print per-partition information for topics.
4343

44+
|--format |string |Output format. Possible values: `json`, `yaml`, `text`, `wide`, `help`. Default: `text`.
45+
4446
|-h, --help |- |Help for list.
4547

4648
|-i, --internal |- |Print internal topics.

modules/reference/pages/rpk/rpk-version.adoc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,8 @@ Prints the current `rpk` and Redpanda version and allows you to list the Redpand
66

77
To list the Redpanda version of each broker in your cluster you may pass the Admin API hosts via flags, profile, or environment variables.
88

9+
To get only the rpk version, use `rpk --version`.
10+
911
== Usage
1012

1113
[,bash]

0 commit comments

Comments
 (0)