update with rpk 24.3.1-rc1 (#819)

Co-authored-by: Joyce Fee <[email protected]>

modules/ROOT/nav.adoc

@@ -271,9 +271,15 @@
 ***** xref:reference:rpk/rpk-cluster/rpk-cluster-self-test-status.adoc[]
 ***** xref:reference:rpk/rpk-cluster/rpk-cluster-self-test-stop.adoc[]
 **** xref:reference:rpk/rpk-cluster/rpk-cluster-storage.adoc[]
+***** rpk cluster storage mount/unmount
+****** xref:reference:rpk/rpk-cluster/rpk-cluster-storage-cancel-mount.adoc[]
+****** xref:reference:rpk/rpk-cluster/rpk-cluster-storage-list-mount.adoc[]
+****** xref:reference:rpk/rpk-cluster/rpk-cluster-storage-mount.adoc[]
+****** xref:reference:rpk/rpk-cluster/rpk-cluster-storage-status-mount.adoc[]
+****** xref:reference:rpk/rpk-cluster/rpk-cluster-storage-unmount.adoc[]
 ***** xref:reference:rpk/rpk-cluster/rpk-cluster-storage-restore.adoc[]
-****** xref:reference:rpk/rpk-cluster/rpk-cluster-storage-restore-start.adoc[]
-****** xref:reference:rpk/rpk-cluster/rpk-cluster-storage-restore-status.adoc[]
+***** xref:reference:rpk/rpk-cluster/rpk-cluster-storage-restore-start.adoc[]
+***** xref:reference:rpk/rpk-cluster/rpk-cluster-storage-restore-status.adoc[]
 **** xref:reference:rpk/rpk-cluster/rpk-cluster-txn.adoc[]
 ***** xref:reference:rpk/rpk-cluster/rpk-cluster-txn-describe.adoc[]
 ***** xref:reference:rpk/rpk-cluster/rpk-cluster-txn-describe-producers.adoc[]

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

@@ -0,0 +1,45 @@
+= rpk cluster storage cancel mount
+
+Cancels a mount/unmount operation on a topic.
+
+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.
+
+== Usage
+
+[,bash]
+----
+rpk cluster storage cancel-mount [MIGRATION ID] [flags]
+----
+
+== Aliases
+
+[,bash]
+----
+cancel-mount, cancel-unmount
+----
+
+== Examples
+
+Cancel a mount/unmount operation:
+
+[,bash]
+----
+rpk cluster storage cancel-mount 123
+----
+
+== Flags
+
+[cols="1m,1a,2a"]
+|===
+|*Value* |*Type* |*Description*
+
+|-h, --help |- |Help for cancel-mount.
+
+|--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`.
+
+|-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.
+|===

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

@@ -0,0 +1,67 @@
+= rpk cluster storage list mount
+
+List mount/unmount operations on a topic in the Redpanda cluster from glossterm:tiered-storage[].
+
+You can also filter the list by state using the `--filter` flag. The possible states are:
+
+- `planned`
+
+- `prepared`
+
+- `executed`
+
+- `finished`
+
+If no filter is provided, all migrations are listed.
+
+== Usage
+
+[,bash]
+----
+rpk cluster storage list-mount [flags]
+----
+
+== Aliases
+
+[,bash]
+----
+list-mount, list-unmount
+----
+
+
+
+== Examples
+
+Lists mount/unmount operations:
+[,bash]
+----
+rpk cluster storage list-mount
+----
+
+
+
+Use a filter to list only migrations in a specific state:
+
+[,bash]
+----
+rpk cluster storage list-mount --filter planned
+----
+
+== Flags
+
+[cols="1m,1a,2a"]
+|===
+|*Value* |*Type* |*Description*
+
+|-f, --filter |string |Filter the list of migrations by state. Only valid for text.
+
+|--format |string |Output format. Possible values: `json`, `yaml`, `text`, `wide`, `help`. Default: `text`.
+
+|--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`.
+
+|-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.
+|===

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

@@ -0,0 +1,59 @@
+= rpk cluster storage mount
+
+Mount a topic to the Redpanda cluster from glossterm:tiered-storage[].
+
+This command mounts a topic in the Redpanda cluster using log segments stored in Tiered Storage. 
+
+You can optionally rename the topic using the `--to` flag.
+
+Requirements:
+
+- xref:manage:tiered-storage.adoc#enable-tiered-storage[Tiered Storage must be enabled].
+
+- Log segments for the topic must be available in Tiered Storage.
+
+- A topic with the same name must not already exist in the cluster.
+
+== Usage
+
+[,bash]
+----
+rpk cluster storage mount [TOPIC] [flags]
+----
+
+
+== Examples
+
+Mounts topic `<my-typic`> from Tiered Storage to the cluster in the my-namespace:
+
+[,bash]
+----
+rpk cluster storage mount <my-topic>
+----
+
+
+Mount topic `<my-topic>` from Tiered Storage to the cluster in the `<my-namespace>` with `<my-new-topic>` as the new topic name:
+
+[,bash]
+----
+rpk cluster storage mount <my-namespace>/<my-topic> --to <my-namespace>/<my-new-topic>
+----
+
+== Flags
+
+[cols="1m,1a,2a"]
+|===
+|*Value* |*Type* |*Description*
+
+|--to |string |New namespace/topic name for the mounted topic (optional).
+
+|-h, --help |- |Help for mount.
+
+|--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`.
+
+|-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.
+|===

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

@@ -0,0 +1,45 @@
+= rpk cluster storage status mount
+
+Status of mount/unmount operation on topic in a Redpanda cluster from glossterm:tiered-storage[].
+
+== Usage
+
+[,bash]
+----
+rpk cluster storage status-mount [MIGRATION ID] [flags]
+----
+
+== Aliases
+
+[,bash]
+----
+status-mount, status-unmount
+----
+
+== Examples
+
+Status for a mount/unmount operation:
+
+[,bash]
+----
+rpk cluster storage status-mount 123
+----
+
+== 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 status-mount.
+
+|--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`.
+
+|-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.
+|===

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

@@ -0,0 +1,52 @@
+= rpk cluster storage unmount
+
+Unmount a topic from the Redpanda cluster and secure it in glossterm:tiered-storage[].
+
+This command performs an operation that:
+
+1. Rejects all writes to the topic.
+
+2. Flushes data to Tiered Storage.
+
+3. Removes the topic from the cluster.
+
+Key Points:
+
+- During unmounting, any attempted writes or reads will receive an `UNKNOWN_TOPIC_OR_PARTITION` error.
+
+- The unmount operation works independently of other topic configurations like `remote.delete=false`.
+
+- 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.
+
+== Usage
+
+[,bash]
+----
+rpk cluster storage unmount [TOPIC] [flags]
+----
+
+== Examples
+
+Unmount topic '<my-topic>' from the cluster in the '<my-namespace>':
+
+[,bash]
+----
+rpk cluster storage unmount <my-namespace>/<my-topic>
+----
+
+== Flags
+
+[cols="1m,1a,2a"]
+|===
+|*Value* |*Type* |*Description*
+
+|-h, --help |- |Help for unmount.
+
+|--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`.
+
+|-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.
+|===

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

@@ -116,6 +116,8 @@ capturing the second snapshot of the metrics endpoints, for example
 because some metrics are counters that need values at two points in
 time. Default: `12s`.
 
+|--metrics-samples |int |Number of metrics samples to take (at the interval of `--metrics-interval`). Must be higher or equals 2 (default 2).
+
 |-n, --namespace |string |The Kubernetes namespace in which the Redpanda
 cluster is running. Default: `redpanda` +
 *Kubernetes only*.