Skip to content

Commit a69ca97

Browse files
DeflaimunFeediver1
Deflaimun
and
Feediver1
authored
update with rpk 24.3.1-rc1 (#819)
Co-authored-by: Joyce Fee <[email protected]>
1 parent 0e35e26 commit a69ca97

File tree

7 files changed

+277
-1
lines changed

7 files changed

+277
-1
lines changed

‎modules/ROOT/nav.adoc‎

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -269,7 +269,13 @@
269269
***** xref:reference:rpk/rpk-cluster/rpk-cluster-self-test-status.adoc[]
270270
***** xref:reference:rpk/rpk-cluster/rpk-cluster-self-test-stop.adoc[]
271271
**** xref:reference:rpk/rpk-cluster/rpk-cluster-storage.adoc[]
272-
***** xref:reference:rpk/rpk-cluster/rpk-cluster-storage-restore.adoc[]
272+
***** rpk cluster storage mount/unmount
273+
****** xref:reference:rpk/rpk-cluster/rpk-cluster-storage-cancel-mount.adoc[]
274+
****** xref:reference:rpk/rpk-cluster/rpk-cluster-storage-list-mount.adoc[]
275+
****** xref:reference:rpk/rpk-cluster/rpk-cluster-storage-mount.adoc[]
276+
****** xref:reference:rpk/rpk-cluster/rpk-cluster-storage-status-mount.adoc[]
277+
****** xref:reference:rpk/rpk-cluster/rpk-cluster-storage-unmount.adoc[]
278+
****** xref:reference:rpk/rpk-cluster/rpk-cluster-storage-restore.adoc[]
273279
****** xref:reference:rpk/rpk-cluster/rpk-cluster-storage-restore-start.adoc[]
274280
****** xref:reference:rpk/rpk-cluster/rpk-cluster-storage-restore-status.adoc[]
275281
**** xref:reference:rpk/rpk-cluster/rpk-cluster-txn.adoc[]

‎modules/reference/pages/rpk/rpk-cluster/rpk-cluster-storage-cancel-mount.adoc‎

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
= rpk cluster storage cancel mount
2+
3+
Cancels a mount/unmount operation on a topic.
4+
5+
Use the migration ID that is emitted when the mount or unmount operation is executed. You can also get the migration ID by listing the mount/unmount operations.
6+
7+
== Usage
8+
9+
[,bash]
10+
----
11+
rpk cluster storage cancel-mount [MIGRATION ID] [flags]
12+
----
13+
14+
== Aliases
15+
16+
[,bash]
17+
----
18+
cancel-mount, cancel-unmount
19+
----
20+
21+
== Examples
22+
23+
Cancel a mount/unmount operation:
24+
25+
[,bash]
26+
----
27+
rpk cluster storage cancel-mount 123
28+
----
29+
30+
== Flags
31+
32+
[cols="1m,1a,2a"]
33+
|===
34+
|*Value* |*Type* |*Description*
35+
36+
|-h, --help |- |Help for cancel-mount.
37+
38+
|--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`.
39+
40+
|-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.
41+
42+
|--profile |string |Profile to use. See xref:reference:rpk/rpk-profile.adoc[`rpk profile`] for more details.
43+
44+
|-v, --verbose |- |Enable verbose logging.
45+
|===

‎modules/reference/pages/rpk/rpk-cluster/rpk-cluster-storage-list-mount.adoc‎

Lines changed: 67 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,67 @@
1+
= rpk cluster storage list mount
2+
3+
List mount/unmount operations on a topic in the Redpanda cluster from glossterm:tiered-storage[].
4+
5+
You can also filter the list by state using the `--filter` flag. The possible states are:
6+
7+
- `planned`
8+
9+
- `prepared`
10+
11+
- `executed`
12+
13+
- `finished`
14+
15+
If no filter is provided, all migrations are listed.
16+
17+
== Usage
18+
19+
[,bash]
20+
----
21+
rpk cluster storage list-mount [flags]
22+
----
23+
24+
== Aliases
25+
26+
[,bash]
27+
----
28+
list-mount, list-unmount
29+
----
30+
31+
32+
33+
== Examples
34+
35+
Lists mount/unmount operations:
36+
[,bash]
37+
----
38+
rpk cluster storage list-mount
39+
----
40+
41+
42+
43+
Use a filter to list only migrations in a specific state:
44+
45+
[,bash]
46+
----
47+
rpk cluster storage list-mount --filter planned
48+
----
49+
50+
== Flags
51+
52+
[cols="1m,1a,2a"]
53+
|===
54+
|*Value* |*Type* |*Description*
55+
56+
|-f, --filter |string |Filter the list of migrations by state. Only valid for text.
57+
58+
|--format |string |Output format. Possible values: `json`, `yaml`, `text`, `wide`, `help`. Default: `text`.
59+
60+
|--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`.
61+
62+
|-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.
63+
64+
|--profile |string |Profile to use. See xref:reference:rpk/rpk-profile.adoc[`rpk profile`] for more details.
65+
66+
|-v, --verbose |- |Enable verbose logging.
67+
|===

‎modules/reference/pages/rpk/rpk-cluster/rpk-cluster-storage-mount.adoc‎

Lines changed: 59 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
1+
= rpk cluster storage mount
2+
3+
Mount a topic to the Redpanda cluster from glossterm:tiered-storage[].
4+
5+
This command mounts a topic in the Redpanda cluster using log segments stored in Tiered Storage.
6+
7+
You can optionally rename the topic using the `--to` flag.
8+
9+
Requirements:
10+
11+
- xref:manage:tiered-storage.adoc#enable-tiered-storage[Tiered Storage must be enabled].
12+
13+
- Log segments for the topic must be available in Tiered Storage.
14+
15+
- A topic with the same name must not already exist in the cluster.
16+
17+
== Usage
18+
19+
[,bash]
20+
----
21+
rpk cluster storage mount [TOPIC] [flags]
22+
----
23+
24+
25+
== Examples
26+
27+
Mounts topic `<my-typic`> from Tiered Storage to the cluster in the my-namespace:
28+
29+
[,bash]
30+
----
31+
rpk cluster storage mount <my-topic>
32+
----
33+
34+
35+
Mount topic `<my-topic>` from Tiered Storage to the cluster in the `<my-namespace>` with `<my-new-topic>` as the new topic name:
36+
37+
[,bash]
38+
----
39+
rpk cluster storage mount <my-namespace>/<my-topic> --to <my-namespace>/<my-new-topic>
40+
----
41+
42+
== Flags
43+
44+
[cols="1m,1a,2a"]
45+
|===
46+
|*Value* |*Type* |*Description*
47+
48+
|--to |string |New namespace/topic name for the mounted topic (optional).
49+
50+
|-h, --help |- |Help for mount.
51+
52+
|--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`.
53+
54+
|-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.
55+
56+
|--profile |string |Profile to use. See xref:reference:rpk/rpk-profile.adoc[`rpk profile`] for more details.
57+
58+
|-v, --verbose |- |Enable verbose logging.
59+
|===

‎modules/reference/pages/rpk/rpk-cluster/rpk-cluster-storage-status-mount.adoc‎

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
= rpk cluster storage status mount
2+
3+
Status of mount/unmount operation on topic in a Redpanda cluster from glossterm:tiered-storage[].
4+
5+
== Usage
6+
7+
[,bash]
8+
----
9+
rpk cluster storage status-mount [MIGRATION ID] [flags]
10+
----
11+
12+
== Aliases
13+
14+
[,bash]
15+
----
16+
status-mount, status-unmount
17+
----
18+
19+
== Examples
20+
21+
Status for a mount/unmount operation:
22+
23+
[,bash]
24+
----
25+
rpk cluster storage status-mount 123
26+
----
27+
28+
== Flags
29+
30+
[cols="1m,1a,2a"]
31+
|===
32+
|*Value* |*Type* |*Description*
33+
34+
|--format |string |Output format. Possible values: `json`, `yaml`, `text`, `wide`, `help`. Default: `text`.
35+
36+
|-h, --help |- |Help for status-mount.
37+
38+
|--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`.
39+
40+
|-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.
41+
42+
|--profile |string |Profile to use. See xref:reference:rpk/rpk-profile.adoc[`rpk profile`] for more details.
43+
44+
|-v, --verbose |- |Enable verbose logging.
45+
|===

‎modules/reference/pages/rpk/rpk-cluster/rpk-cluster-storage-unmount.adoc‎

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
= rpk cluster storage unmount
2+
3+
Unmount a topic from the Redpanda cluster and secure it in glossterm:tiered-storage[].
4+
5+
This command performs an operation that:
6+
7+
1. Rejects all writes to the topic.
8+
9+
2. Flushes data to Tiered Storage.
10+
11+
3. Removes the topic from the cluster.
12+
13+
Key Points:
14+
15+
- During unmounting, any attempted writes or reads will receive an `UNKNOWN_TOPIC_OR_PARTITION` error.
16+
17+
- The unmount operation works independently of other topic configurations like `remote.delete=false`.
18+
19+
- After unmounting, the topic can be remounted to this cluster or a different cluster if the log segments are moved to that cluster's Tiered Storage.
20+
21+
== Usage
22+
23+
[,bash]
24+
----
25+
rpk cluster storage unmount [TOPIC] [flags]
26+
----
27+
28+
== Examples
29+
30+
Unmount topic '<my-topic>' from the cluster in the '<my-namespace>':
31+
32+
[,bash]
33+
----
34+
rpk cluster storage unmount <my-namespace>/<my-topic>
35+
----
36+
37+
== Flags
38+
39+
[cols="1m,1a,2a"]
40+
|===
41+
|*Value* |*Type* |*Description*
42+
43+
|-h, --help |- |Help for unmount.
44+
45+
|--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`.
46+
47+
|-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.
48+
49+
|--profile |string |Profile to use. See xref:reference:rpk/rpk-profile.adoc[`rpk profile`] for more details.
50+
51+
|-v, --verbose |- |Enable verbose logging.
52+
|===

‎modules/reference/pages/rpk/rpk-debug/rpk-debug-bundle.adoc‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -116,6 +116,8 @@ capturing the second snapshot of the metrics endpoints, for example
116116
because some metrics are counters that need values at two points in
117117
time. Default: `12s`.
118118

119+
|--metrics-samples |int |Number of metrics samples to take (at the interval of `--metrics-interval`). Must be higher or equals 2 (default 2).
120+
119121
|-n, --namespace |string |The Kubernetes namespace in which the Redpanda
120122
cluster is running. Default: `redpanda` +
121123
*Kubernetes only*.

0 commit comments

Comments
 (0)