diff --git a/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-brokers.adoc b/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-brokers.adoc index 632c7ed19c..ea1e3d9d1f 100644 --- a/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-brokers.adoc +++ b/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-brokers.adoc @@ -1,3 +1,4 @@ +ifndef::env-cloud[] = rpk cluster brokers :description: Manage Redpanda cluster brokers. :page-aliases: reference:rpk/rpk-redpanda/rpk-redpanda-admin-brokers.adoc @@ -49,3 +50,4 @@ rpk cluster brokers [flags] |=== // end::single-source[] +endif::[] diff --git a/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-config-edit.adoc b/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-config-edit.adoc index 9838f2d4ae..8b35a7ec6a 100644 --- a/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-config-edit.adoc +++ b/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-config-edit.adoc @@ -1,3 +1,4 @@ +ifndef::env-cloud[] = rpk cluster config edit :description: Edit cluster-wide configuration properties. This command opens a text editor to modify the cluster's configuration. :page-platforms: linux,darwin @@ -51,3 +52,4 @@ rpk cluster config edit [flags] |=== // end::single-source[] +endif::[] diff --git a/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-config-export.adoc b/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-config-export.adoc index e646a9263a..7b70d16131 100644 --- a/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-config-export.adoc +++ b/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-config-export.adoc @@ -1,3 +1,4 @@ +ifndef::env-cloud[] = rpk cluster config export :description: pass:q[Export cluster configuration. Writes out a YAML representation of the cluster configuration to a file, suitable for editing and later applying with the corresponding `import` command.] :page-platforms: linux,darwin @@ -46,3 +47,4 @@ rpk cluster config export [flags] |=== // end::single-source[] +endif::[] diff --git a/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-config-force-reset.adoc b/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-config-force-reset.adoc index f87f1b8370..ad7f4785c1 100644 --- a/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-config-force-reset.adoc +++ b/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-config-force-reset.adoc @@ -1,3 +1,4 @@ +ifndef::env-cloud[] = rpk cluster config force-reset :description: Forcibly clear a cluster configuration property on this node. This command is not for general changes to cluster configuration: use this only when Redpanda will not start due to a configuration issue. :page-platforms: linux,darwin @@ -51,3 +52,4 @@ rpk cluster config force-reset [flags] |=== // end::single-source[] +endif::[] diff --git a/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-config-import.adoc b/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-config-import.adoc index 2f56a97141..b337e2f781 100644 --- a/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-config-import.adoc +++ b/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-config-import.adoc @@ -1,3 +1,4 @@ +ifndef::env-cloud[] = rpk cluster config import :description: pass:q[Import cluster configuration from a file. Import configuration from a YAML file, usually generated with corresponding `export` command.] :page-platforms: linux,darwin @@ -45,3 +46,4 @@ rpk cluster config import [flags] |=== // end::single-source[] +endif::[] diff --git a/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-config-lint.adoc b/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-config-lint.adoc index a111893424..a3c6deee21 100644 --- a/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-config-lint.adoc +++ b/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-config-lint.adoc @@ -1,3 +1,4 @@ +ifndef::env-cloud[] = rpk cluster config lint :description: pass:q[Remove any deprecated content from `redpanda.yaml`. Deprecated content includes properties which were set via `redpanda.yaml` in earlier versions of redpanda, but are now managed via Redpanda's central configuration store (and via `rpk cluster config edit`).] :page-platforms: linux,darwin @@ -33,3 +34,4 @@ rpk cluster config lint [flags] |=== // end::single-source[] +endif::[] diff --git a/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-config-status.adoc b/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-config-status.adoc index ee3acb7bbb..8066208350 100644 --- a/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-config-status.adoc +++ b/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-config-status.adoc @@ -1,11 +1,11 @@ = rpk cluster config status -:description: Get the configuration status of Redpanda brokers. For each broker, the command output shows: - Whether you need to restart the broker to apply the new settings. +:description: Get the configuration status of Redpanda brokers. For each broker, the command output shows: - Whether you need to restart the broker to apply the new settings - Any settings that the broker has flagged as invalid or unknown The command also returns the version of cluster configuration that each broker has applied. :page-platforms: linux,darwin // This content is autogenerated. Do not edit manually. To customize content, see the writer's guide: https://github.com/redpanda-data/docs/blob/main/docs-data/RPK_OVERRIDES_GUIDE.adoc // tag::single-source[] -:description: Get the configuration status of Redpanda brokers. For each broker, the command output shows: - Whether you need to restart the broker to apply the new settings. +:description: Get the configuration status of Redpanda brokers. For each broker, the command output shows: - Whether you need to restart the broker to apply the new settings - Any settings that the broker has flagged as invalid or unknown The command also returns the version of cluster configuration that each broker has applied. ifndef::env-cloud[] Get the configuration status of Redpanda brokers. diff --git a/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-config.adoc b/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-config.adoc index ec49456cb2..c3d6602c59 100644 --- a/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-config.adoc +++ b/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-config.adoc @@ -79,7 +79,7 @@ endif::[] |Set a single cluster configuration property. This command is provided for use in scripts. |xref:reference:rpk/rpk-cluster/rpk-cluster-config-status.adoc[`rpk cluster config status`] -|Get the configuration status of Redpanda brokers. For each broker, the command output shows: - Whether you need to restart the broker to apply the new settings. +|Get the configuration status of Redpanda brokers. For each broker, the command output shows: - Whether you need to restart the broker to apply the new settings - Any settings that the broker has flagged as invalid or unknown The command also returns the version of cluster configuration that each broker has applied. |=== diff --git a/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-health.adoc b/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-health.adoc index 01d530a551..150503c2a2 100644 --- a/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-health.adoc +++ b/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-health.adoc @@ -1,3 +1,4 @@ +ifndef::env-cloud[] = rpk cluster health :description: Queries cluster for health overview. Health overview is created based on the health reports collected periodically from all nodes in the cluster. :page-platforms: linux,darwin @@ -72,3 +73,4 @@ rpk cluster health --exit-when-healthy |=== // end::single-source[] +endif::[] diff --git a/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-license-set.adoc b/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-license-set.adoc index d3ce85aa94..a4317759dd 100644 --- a/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-license-set.adoc +++ b/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-license-set.adoc @@ -1,11 +1,11 @@ = rpk cluster license set -:description: Upload license to the cluster. +:description: Upload license to the cluster You can either provide a path to a file containing the license: :page-platforms: linux,darwin // This content is autogenerated. Do not edit manually. To customize content, see the writer's guide: https://github.com/redpanda-data/docs/blob/main/docs-data/RPK_OVERRIDES_GUIDE.adoc // tag::single-source[] -:description: Upload license to the cluster. +:description: Upload license to the cluster You can either provide a path to a file containing the license: Upload license to the cluster. You can either provide a path to a file containing the license: diff --git a/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-license.adoc b/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-license.adoc index 4b87a1e430..52e7c50e8e 100644 --- a/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-license.adoc +++ b/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-license.adoc @@ -1,3 +1,4 @@ +ifndef::env-cloud[] = rpk cluster license :description: Manage cluster license. :page-platforms: linux,darwin @@ -25,7 +26,7 @@ rpk cluster license [flags] |Retrieve license information: |xref:reference:rpk/rpk-cluster/rpk-cluster-license-set.adoc[`rpk cluster license set`] -|Upload license to the cluster. +|Upload license to the cluster You can either provide a path to a file containing the license: |=== @@ -43,3 +44,4 @@ rpk cluster license [flags] |=== // end::single-source[] +endif::[] diff --git a/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-loggers.adoc b/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-loggers.adoc index c5df05ee80..46880e2ddc 100644 --- a/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-loggers.adoc +++ b/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-loggers.adoc @@ -1,3 +1,4 @@ +ifndef::env-cloud[] = rpk cluster loggers :description: List and configure Redpanda broker loggers. :page-aliases: reference:rpk/rpk-redpanda/rpk-redpanda-admin-config-log-level.adoc @@ -46,3 +47,4 @@ rpk cluster loggers [flags] |=== // end::single-source[] +endif::[] diff --git a/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-maintenance.adoc b/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-maintenance.adoc index cacb58df29..3cfb66791c 100644 --- a/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-maintenance.adoc +++ b/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-maintenance.adoc @@ -1,3 +1,4 @@ +ifndef::env-cloud[] = rpk cluster maintenance :description: Interact with cluster maintenance mode. Maintenance mode is a state that a node may be placed into in which the node may be shutdown or restarted with minimal disruption to client workloads. :page-platforms: linux,darwin @@ -64,3 +65,4 @@ rpk cluster maintenance [flags] |=== // end::single-source[] +endif::[] diff --git a/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-partitions-disable.adoc b/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-partitions-disable.adoc index 7b726d150b..f5e99d54a1 100644 --- a/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-partitions-disable.adoc +++ b/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-partitions-disable.adoc @@ -1,11 +1,11 @@ = rpk cluster partitions disable -:description: pass:q[Disable partitions of a topic. You may disable all partitions of a topic using the `--all` flag or you may select a set of topic/partitions to disable with the `--partitions`/`-p` flag.] +:description: pass:q[Disable partitions of a topic You may disable all partitions of a topic using the `--all` flag or you may select a set of topic/partitions to disable with the `--partitions`/`-p` flag. The partition flag accepts the format `\{namespace}/\{topic}/[partitions...]` where namespace and topic are optional parameters.] :page-platforms: linux,darwin // This content is autogenerated. Do not edit manually. To customize content, see the writer's guide: https://github.com/redpanda-data/docs/blob/main/docs-data/RPK_OVERRIDES_GUIDE.adoc // tag::single-source[] -:description: pass:q[Disable partitions of a topic. You may disable all partitions of a topic using the `--all` flag or you may select a set of topic/partitions to disable with the `--partitions`/`-p` flag.] +:description: pass:q[Disable partitions of a topic You may disable all partitions of a topic using the `--all` flag or you may select a set of topic/partitions to disable with the `--partitions`/`-p` flag. The partition flag accepts the format `\{namespace}/\{topic}/[partitions...]` where namespace and topic are optional parameters.] Disable partitions of a topic. You may disable all partitions of a topic using the `--all` flag or you may select diff --git a/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-partitions-enable.adoc b/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-partitions-enable.adoc index 57e525b77a..57d455eeb1 100644 --- a/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-partitions-enable.adoc +++ b/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-partitions-enable.adoc @@ -1,11 +1,11 @@ = rpk cluster partitions enable -:description: pass:q[Enable partitions of a topic. You may enable all partitions of a topic using the `--all` flag or you may select a set of topic/partitions to enable with the `--partitions`/`-p` flag.] +:description: pass:q[Enable partitions of a topic You may enable all partitions of a topic using the `--all` flag or you may select a set of topic/partitions to enable with the `--partitions`/`-p` flag. The partition flag accepts the format `\{namespace}/\{topic}/[partitions...]` where namespace and topic are optional parameters.] :page-platforms: linux,darwin // This content is autogenerated. Do not edit manually. To customize content, see the writer's guide: https://github.com/redpanda-data/docs/blob/main/docs-data/RPK_OVERRIDES_GUIDE.adoc // tag::single-source[] -:description: pass:q[Enable partitions of a topic. You may enable all partitions of a topic using the `--all` flag or you may select a set of topic/partitions to enable with the `--partitions`/`-p` flag.] +:description: pass:q[Enable partitions of a topic You may enable all partitions of a topic using the `--all` flag or you may select a set of topic/partitions to enable with the `--partitions`/`-p` flag. The partition flag accepts the format `\{namespace}/\{topic}/[partitions...]` where namespace and topic are optional parameters.] Enable partitions of a topic. You may enable all partitions of a topic using the `--all` flag or you may select 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 index 0410ba3c37..70bf880881 100644 --- a/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-partitions-list.adoc +++ b/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-partitions-list.adoc @@ -1,12 +1,12 @@ = rpk cluster partitions list -:description: List partitions in the cluster. This commands lists the cluster-level metadata of all partitions in the cluster. +:description: List partitions in the cluster This commands lists the cluster-level metadata of all partitions in the cluster. It shows the current replica assignments on both brokers and CPU cores for given topics. :page-aliases: reference:rpk/rpk-redpanda/rpk-redpanda-admin-partitions-list.adoc :page-platforms: linux,darwin // This content is autogenerated. Do not edit manually. To customize content, see the writer's guide: https://github.com/redpanda-data/docs/blob/main/docs-data/RPK_OVERRIDES_GUIDE.adoc // tag::single-source[] -:description: List partitions in the cluster. This commands lists the cluster-level metadata of all partitions in the cluster. +:description: List partitions in the cluster This commands lists the cluster-level metadata of all partitions in the cluster. It shows the current replica assignments on both brokers and CPU cores for given topics. List partitions in the cluster. This commands lists the cluster-level metadata of all partitions in the cluster. diff --git a/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-partitions.adoc b/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-partitions.adoc index 1e0f0e7aa9..23bbbd1a21 100644 --- a/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-partitions.adoc +++ b/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-partitions.adoc @@ -1,3 +1,4 @@ +ifndef::env-cloud[] = rpk cluster partitions :description: Manage cluster partitions. :page-aliases: reference:rpk/rpk-redpanda/rpk-redpanda-admin-partitions.adoc @@ -29,13 +30,13 @@ rpk cluster partitions [flags] |Queries cluster for partition balancer status: If continuous partition balancing is enabled, Redpanda will continuously reassign partitions from both unavailable nodes and from nodes using more disk space than the configured limit. Use this command to monitor the partition balancer status and the partition distribution across brokers in the cluster. |xref:reference:rpk/rpk-cluster/rpk-cluster-partitions-disable.adoc[`rpk cluster partitions disable`] -|Disable partitions of a topic. You may disable all partitions of a topic using the `--all` flag or you may select a set of topic/partitions to disable with the `--partitions`/`-p` flag. +|Disable partitions of a topic You may disable all partitions of a topic using the `--all` flag or you may select a set of topic/partitions to disable with the `--partitions`/`-p` flag. The partition flag accepts the format `\{namespace}/\{topic}/[partitions...]` where namespace and topic are optional parameters. |xref:reference:rpk/rpk-cluster/rpk-cluster-partitions-enable.adoc[`rpk cluster partitions enable`] -|Enable partitions of a topic. You may enable all partitions of a topic using the `--all` flag or you may select a set of topic/partitions to enable with the `--partitions`/`-p` flag. +|Enable partitions of a topic You may enable all partitions of a topic using the `--all` flag or you may select a set of topic/partitions to enable with the `--partitions`/`-p` flag. The partition flag accepts the format `\{namespace}/\{topic}/[partitions...]` where namespace and topic are optional parameters. |xref:reference:rpk/rpk-cluster/rpk-cluster-partitions-list.adoc[`rpk cluster partitions list`] -|List partitions in the cluster. This commands lists the cluster-level metadata of all partitions in the cluster. +|List partitions in the cluster This commands lists the cluster-level metadata of all partitions in the cluster. It shows the current replica assignments on both brokers and CPU cores for given topics. |xref:reference:rpk/rpk-cluster/rpk-cluster-partitions-move.adoc[`rpk cluster partitions move`] |Move partition replicas across nodes / cores. This command changes replica assignments for given partitions. @@ -68,3 +69,4 @@ rpk cluster partitions [flags] |=== // end::single-source[] +endif::[] 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 index 22d2f5b37f..82881be453 100644 --- a/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-quotas-alter.adoc +++ b/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-quotas-alter.adoc @@ -1,11 +1,11 @@ = rpk cluster quotas alter -:description: Add or delete a client quota. This command allows you to add or delete a client quota. +:description: Add or delete a client quota This command allows you to add or delete a client quota. A client quota consists of an entity (to whom the quota is applied) and a quota type (what is being applied). :page-platforms: linux,darwin // This content is autogenerated. Do not edit manually. To customize content, see the writer's guide: https://github.com/redpanda-data/docs/blob/main/docs-data/RPK_OVERRIDES_GUIDE.adoc // tag::single-source[] -:description: Add or delete a client quota. This command allows you to add or delete a client quota. +:description: Add or delete a client quota This command allows you to add or delete a client quota. A client quota consists of an entity (to whom the quota is applied) and a quota type (what is being applied). Add or delete a client quota. This command allows you to add or delete a client quota. diff --git a/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-quotas.adoc b/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-quotas.adoc index 18672cf993..1ed04020a6 100644 --- a/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-quotas.adoc +++ b/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-quotas.adoc @@ -29,7 +29,7 @@ rpk cluster quota |Command |Description |xref:reference:rpk/rpk-cluster/rpk-cluster-quotas-alter.adoc[`rpk cluster quotas alter`] -|Add or delete a client quota. This command allows you to add or delete a client quota. +|Add or delete a client quota This command allows you to add or delete a client quota. A client quota consists of an entity (to whom the quota is applied) and a quota type (what is being applied). |xref:reference:rpk/rpk-cluster/rpk-cluster-quotas-describe.adoc[`rpk cluster quotas describe`] |Describe client quotas. This command describes client quotas that match the provided filtering criteria. diff --git a/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-self-test.adoc b/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-self-test.adoc index d441f19544..5e2845c9a1 100644 --- a/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-self-test.adoc +++ b/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-self-test.adoc @@ -1,3 +1,4 @@ +ifndef::env-cloud[] = rpk cluster self-test :description: Start, stop and query runs of Redpanda self-test through the Admin API listener. :page-platforms: linux,darwin @@ -53,3 +54,4 @@ rpk cluster self-test [flags] * xref:reference:rpk/rpk-cluster/rpk-cluster-self-test-stop.adoc[rpk cluster self-test stop] // end::single-source[] +endif::[] diff --git a/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-storage-restore.adoc b/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-storage-restore.adoc index c89eeb7037..993561046d 100644 --- a/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-storage-restore.adoc +++ b/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-storage-restore.adoc @@ -1,3 +1,4 @@ +ifndef::env-cloud[] = rpk cluster storage restore :description: Interact with the topic restoration process. This command is used to restore topics from the archival bucket, which can be useful for disaster recovery or if a topic was accidentally deleted. :page-aliases: reference:rpk/rpk-cluster/rpk-cluster-storage-recovery.adoc @@ -66,3 +67,4 @@ rpk cluster storage recovery * xref:manage:whole-cluster-restore.adoc[Whole-Cluster Restore] // end::single-source[] +endif::[] diff --git a/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-txn-list.adoc b/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-txn-list.adoc index fd31fc0689..902cea4bcd 100644 --- a/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-txn-list.adoc +++ b/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-txn-list.adoc @@ -1,11 +1,11 @@ = rpk cluster txn list -:description: List transactions and their current states. This command lists all known transactions in the cluster, the producer ID for the transactional ID, and the and the state of the transaction. +:description: pass:q[List transactions and their current states This command lists all known transactions in the cluster, the producer ID for the transactional ID, and the and the state of the transaction. For information on what the columns in the output mean, see `rpk cluster txn --help`.] :page-platforms: linux,darwin // This content is autogenerated. Do not edit manually. To customize content, see the writer's guide: https://github.com/redpanda-data/docs/blob/main/docs-data/RPK_OVERRIDES_GUIDE.adoc // tag::single-source[] -:description: List transactions and their current states. This command lists all known transactions in the cluster, the producer ID for the transactional ID, and the and the state of the transaction. +:description: pass:q[List transactions and their current states This command lists all known transactions in the cluster, the producer ID for the transactional ID, and the and the state of the transaction. For information on what the columns in the output mean, see `rpk cluster txn --help`.] List transactions and their current states. This command lists all known transactions in the cluster, the producer ID for diff --git a/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-txn.adoc b/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-txn.adoc index 549360c9c4..b760eddb9c 100644 --- a/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-txn.adoc +++ b/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-txn.adoc @@ -85,7 +85,7 @@ rpk cluster transaction |Describe transactional producers to partitions. This command describes partitions that active transactional producers are producing to. |xref:reference:rpk/rpk-cluster/rpk-cluster-txn-list.adoc[`rpk cluster txn list`] -|List transactions and their current states. This command lists all known transactions in the cluster, the producer ID for the transactional ID, and the and the state of the transaction. +|List transactions and their current states This command lists all known transactions in the cluster, the producer ID for the transactional ID, and the and the state of the transaction. For information on what the columns in the output mean, see `rpk cluster txn --help`. |=== diff --git a/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-upgrade.adoc b/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-upgrade.adoc index 4bfbd7985e..d25f923d6a 100644 --- a/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-upgrade.adoc +++ b/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-upgrade.adoc @@ -1,3 +1,4 @@ +ifndef::env-cloud[] = rpk cluster upgrade :description: pass:q[Check and finalize major-version upgrades. When the cluster configuration `features_auto_finalization` is disabled, an upgrade stays pending after all brokers are on the new version, so you can downgrade while soak-testing.] :page-platforms: linux,darwin @@ -47,3 +48,4 @@ rpk cluster upgrade [flags] |=== // end::single-source[] +endif::[] diff --git a/modules/reference/pages/rpk/rpk-generate/rpk-generate-grafana-dashboard.adoc b/modules/reference/pages/rpk/rpk-generate/rpk-generate-grafana-dashboard.adoc index 88d2082628..4abc5349ff 100644 --- a/modules/reference/pages/rpk/rpk-generate/rpk-generate-grafana-dashboard.adoc +++ b/modules/reference/pages/rpk/rpk-generate/rpk-generate-grafana-dashboard.adoc @@ -1,11 +1,11 @@ = rpk generate grafana-dashboard -:description: Generate Grafana Dashboards for Redpanda Metrics. Use this command to generate sample Grafana dashboards for Redpanda metrics. +:description: Generate Grafana Dashboards for Redpanda Metrics Use this command to generate sample Grafana dashboards for Redpanda metrics. These dashboards can be imported into a Grafana or Grafana Cloud instance. :page-platforms: linux,darwin // This content is autogenerated. Do not edit manually. To customize content, see the writer's guide: https://github.com/redpanda-data/docs/blob/main/docs-data/RPK_OVERRIDES_GUIDE.adoc // tag::single-source[] -:description: Generate Grafana Dashboards for Redpanda Metrics. Use this command to generate sample Grafana dashboards for Redpanda metrics. +:description: Generate Grafana Dashboards for Redpanda Metrics Use this command to generate sample Grafana dashboards for Redpanda metrics. These dashboards can be imported into a Grafana or Grafana Cloud instance. Generate Grafana Dashboards for Redpanda Metrics. Use this command to generate sample Grafana dashboards for Redpanda metrics. diff --git a/modules/reference/pages/rpk/rpk-generate/rpk-generate-license.adoc b/modules/reference/pages/rpk/rpk-generate/rpk-generate-license.adoc index dad4c3ebd6..93f89fd690 100644 --- a/modules/reference/pages/rpk/rpk-generate/rpk-generate-license.adoc +++ b/modules/reference/pages/rpk/rpk-generate/rpk-generate-license.adoc @@ -1,11 +1,12 @@ +ifndef::env-cloud[] = rpk generate license -:description: Generate a trial license. This command generates a license for a 30-day trial of Redpanda Enterprise Edition. +:description: pass:q[Generate a trial license This command generates a license for a 30-day trial of Redpanda Enterprise Edition. com/contact The license is saved in your working directory or the specified path, based on the `--path` flag.] :page-platforms: linux,darwin // This content is autogenerated. Do not edit manually. To customize content, see the writer's guide: https://github.com/redpanda-data/docs/blob/main/docs-data/RPK_OVERRIDES_GUIDE.adoc // tag::single-source[] -:description: Generate a trial license. This command generates a license for a 30-day trial of Redpanda Enterprise Edition. +:description: pass:q[Generate a trial license This command generates a license for a 30-day trial of Redpanda Enterprise Edition. com/contact The license is saved in your working directory or the specified path, based on the `--path` flag.] Generate a trial license. This command generates a license for a 30-day trial of Redpanda Enterprise @@ -54,3 +55,4 @@ rpk generate license [flags] |=== // end::single-source[] +endif::[] diff --git a/modules/reference/pages/rpk/rpk-generate/rpk-generate-prometheus-config.adoc b/modules/reference/pages/rpk/rpk-generate/rpk-generate-prometheus-config.adoc index 86853e553d..7030504702 100644 --- a/modules/reference/pages/rpk/rpk-generate/rpk-generate-prometheus-config.adoc +++ b/modules/reference/pages/rpk/rpk-generate/rpk-generate-prometheus-config.adoc @@ -1,3 +1,4 @@ +ifndef::env-cloud[] = rpk generate prometheus-config :description: pass:q[Generate the Prometheus configuration to scrape Redpanda nodes. The output of this command should be included in the `scrape_configs` array within the YAML configuration file of your Prometheus instance.] :page-platforms: linux,darwin @@ -98,3 +99,4 @@ rpk generate prometheus-config [flags] |=== // end::single-source[] +endif::[] diff --git a/modules/reference/pages/rpk/rpk-generate/rpk-generate.adoc b/modules/reference/pages/rpk/rpk-generate/rpk-generate.adoc index bc43c5e352..105a53805b 100644 --- a/modules/reference/pages/rpk/rpk-generate/rpk-generate.adoc +++ b/modules/reference/pages/rpk/rpk-generate/rpk-generate.adoc @@ -26,11 +26,11 @@ rpk generate [template] [flags] |Generate a sample application to connect with Redpanda. This command generates a starter application to produce and consume from the settings defined in the rpk profile. |xref:reference:rpk/rpk-generate/rpk-generate-grafana-dashboard.adoc[`rpk generate grafana-dashboard`] -|Generate Grafana Dashboards for Redpanda Metrics. Use this command to generate sample Grafana dashboards for Redpanda metrics. +|Generate Grafana Dashboards for Redpanda Metrics Use this command to generate sample Grafana dashboards for Redpanda metrics. These dashboards can be imported into a Grafana or Grafana Cloud instance. ifndef::env-cloud[] |xref:reference:rpk/rpk-generate/rpk-generate-license.adoc[`rpk generate license`] -|Generate a trial license. This command generates a license for a 30-day trial of Redpanda Enterprise Edition. +|Generate a trial license This command generates a license for a 30-day trial of Redpanda Enterprise Edition. com/contact The license is saved in your working directory or the specified path, based on the `--path` flag. endif::[] ifndef::env-cloud[] @@ -39,7 +39,7 @@ ifndef::env-cloud[] endif::[] |xref:reference:rpk/rpk-generate/rpk-generate-shell-completion.adoc[`rpk generate shell-completion`] -|Shell completion can help autocomplete `rpk` commands when you press tab. BASH. +|Shell completion can help autocomplete `rpk` commands when you press tab. BASH Bash autocompletion relies on the `bash-completion` package. |=== diff --git a/modules/reference/pages/rpk/rpk-profile/rpk-profile-prompt.adoc b/modules/reference/pages/rpk/rpk-profile/rpk-profile-prompt.adoc index 6c0060caea..3cc635aaf8 100644 --- a/modules/reference/pages/rpk/rpk-profile/rpk-profile-prompt.adoc +++ b/modules/reference/pages/rpk/rpk-profile/rpk-profile-prompt.adoc @@ -17,7 +17,7 @@ This command may introduce other `%` variables in the future, if you want to print a `%` directly, use `%%` to escape it. To use this in zsh, be sure to add setopt PROMPT_SUBST to your .zshrc. -To edit your PS1, use something like PS1='$(`rpk profile prompt`)' in your +To edit your PS1, use something like PS1='$(`rpk` profile prompt)' in your shell rc file. == Usage diff --git a/modules/reference/pages/rpk/rpk-profile/rpk-profile-validate.adoc b/modules/reference/pages/rpk/rpk-profile/rpk-profile-validate.adoc index db650b3a3e..ed22d80c10 100644 --- a/modules/reference/pages/rpk/rpk-profile/rpk-profile-validate.adoc +++ b/modules/reference/pages/rpk/rpk-profile/rpk-profile-validate.adoc @@ -1,3 +1,4 @@ +ifndef::env-cloud[] = rpk profile validate :description: Validate profile configuration and detect common issues. :page-platforms: linux,darwin @@ -52,3 +53,4 @@ rpk profile validate my-profile |=== // end::single-source[] +endif::[] diff --git a/modules/reference/pages/rpk/rpk-redpanda/rpk-redpanda-config-set.adoc b/modules/reference/pages/rpk/rpk-redpanda/rpk-redpanda-config-set.adoc index 4da135d3f3..ce4aae24db 100644 --- a/modules/reference/pages/rpk/rpk-redpanda/rpk-redpanda-config-set.adoc +++ b/modules/reference/pages/rpk/rpk-redpanda/rpk-redpanda-config-set.adoc @@ -1,11 +1,11 @@ = rpk redpanda config set -:description: pass:q[Set node configuration values, such as the list of seed servers or the ports that various APIs listen on. This command modifies the `redpanda.yaml` you have locally on disk.] +:description: pass:q[Set node configuration values, such as the list of seed servers or the ports that various APIs listen on This command modifies the `redpanda.yaml` you have locally on disk. The first argument is the key within the `yaml` representing a property / field that you would like to set.] :page-platforms: linux // This content is autogenerated. Do not edit manually. To customize content, see the writer's guide: https://github.com/redpanda-data/docs/blob/main/docs-data/RPK_OVERRIDES_GUIDE.adoc // tag::single-source[] -:description: pass:q[Set node configuration values, such as the list of seed servers or the ports that various APIs listen on. This command modifies the `redpanda.yaml` you have locally on disk.] +:description: pass:q[Set node configuration values, such as the list of seed servers or the ports that various APIs listen on This command modifies the `redpanda.yaml` you have locally on disk. The first argument is the key within the `yaml` representing a property / field that you would like to set.] Set node configuration values, such as the list of seed servers or the ports that various APIs listen on. This command modifies the `redpanda.yaml` you have locally on disk. The first diff --git a/modules/reference/pages/rpk/rpk-redpanda/rpk-redpanda-config.adoc b/modules/reference/pages/rpk/rpk-redpanda/rpk-redpanda-config.adoc index ad18336fbf..0d652da668 100644 --- a/modules/reference/pages/rpk/rpk-redpanda/rpk-redpanda-config.adoc +++ b/modules/reference/pages/rpk/rpk-redpanda/rpk-redpanda-config.adoc @@ -33,7 +33,7 @@ rpk redpanda config [flags] |Display the selected node configuration. |xref:reference:rpk/rpk-redpanda/rpk-redpanda-config-set.adoc[`rpk redpanda config set`] -|Set node configuration values, such as the list of seed servers or the ports that various APIs listen on. This command modifies the `redpanda.yaml` you have locally on disk. +|Set node configuration values, such as the list of seed servers or the ports that various APIs listen on This command modifies the `redpanda.yaml` you have locally on disk. The first argument is the key within the `yaml` representing a property / field that you would like to set. |=== diff --git a/modules/reference/pages/rpk/rpk-redpanda/rpk-redpanda-mode.adoc b/modules/reference/pages/rpk/rpk-redpanda/rpk-redpanda-mode.adoc index 8e61ad164a..a188703eed 100644 --- a/modules/reference/pages/rpk/rpk-redpanda/rpk-redpanda-mode.adoc +++ b/modules/reference/pages/rpk/rpk-redpanda/rpk-redpanda-mode.adoc @@ -1,11 +1,11 @@ = rpk redpanda mode -:description: Enable a default configuration mode. This command allows you to set one of the following modes: Development, Production, or Recovery. +:description: Enable a default configuration mode This command allows you to set one of the following modes: Development, Production, or Recovery. :page-platforms: linux // This content is autogenerated. Do not edit manually. To customize content, see the writer's guide: https://github.com/redpanda-data/docs/blob/main/docs-data/RPK_OVERRIDES_GUIDE.adoc // tag::single-source[] -:description: Enable a default configuration mode. This command allows you to set one of the following modes: Development, Production, or Recovery. +:description: Enable a default configuration mode This command allows you to set one of the following modes: Development, Production, or Recovery. Enable a default configuration mode. This command allows you to set one of the following modes: Development, diff --git a/modules/reference/pages/rpk/rpk-redpanda/rpk-redpanda-tune-list.adoc b/modules/reference/pages/rpk/rpk-redpanda/rpk-redpanda-tune-list.adoc index 461cffb8e8..184da306f3 100644 --- a/modules/reference/pages/rpk/rpk-redpanda/rpk-redpanda-tune-list.adoc +++ b/modules/reference/pages/rpk/rpk-redpanda/rpk-redpanda-tune-list.adoc @@ -1,11 +1,11 @@ = rpk redpanda tune list -:description: List available redpanda tuners and check if they are enabled and supported by your system. +:description: pass:q[List available redpanda tuners and check if they are enabled and supported by your system To enable a tuner it must be set in the `redpanda.yaml` configuration file under `rpk` section, e.g:] :page-platforms: linux // This content is autogenerated. Do not edit manually. To customize content, see the writer's guide: https://github.com/redpanda-data/docs/blob/main/docs-data/RPK_OVERRIDES_GUIDE.adoc // tag::single-source[] -:description: List available redpanda tuners and check if they are enabled and supported by your system. +:description: pass:q[List available redpanda tuners and check if they are enabled and supported by your system To enable a tuner it must be set in the `redpanda.yaml` configuration file under `rpk` section, e.g:] List available redpanda tuners and check if they are enabled and supported by your system. diff --git a/modules/reference/pages/rpk/rpk-redpanda/rpk-redpanda-tune.adoc b/modules/reference/pages/rpk/rpk-redpanda/rpk-redpanda-tune.adoc index 3e52e4544d..61b0e55732 100644 --- a/modules/reference/pages/rpk/rpk-redpanda/rpk-redpanda-tune.adoc +++ b/modules/reference/pages/rpk/rpk-redpanda/rpk-redpanda-tune.adoc @@ -68,7 +68,7 @@ rpk redpanda tune [list of elements to tune] [flags] |Display detailed information about the tuner. |xref:reference:rpk/rpk-redpanda/rpk-redpanda-tune-list.adoc[`rpk redpanda tune list`] -|List available redpanda tuners and check if they are enabled and supported by your system. +|List available redpanda tuners and check if they are enabled and supported by your system To enable a tuner it must be set in the `redpanda.yaml` configuration file under `rpk` section, e.g: |=== diff --git a/modules/reference/pages/rpk/rpk-redpanda/rpk-redpanda.adoc b/modules/reference/pages/rpk/rpk-redpanda/rpk-redpanda.adoc index 11aee43b00..97cc72d040 100644 --- a/modules/reference/pages/rpk/rpk-redpanda/rpk-redpanda.adoc +++ b/modules/reference/pages/rpk/rpk-redpanda/rpk-redpanda.adoc @@ -28,7 +28,7 @@ rpk redpanda [flags] |Edit configuration. |xref:reference:rpk/rpk-redpanda/rpk-redpanda-mode.adoc[`rpk redpanda mode`] -|Enable a default configuration mode. This command allows you to set one of the following modes: Development, Production, or Recovery. +|Enable a default configuration mode This command allows you to set one of the following modes: Development, Production, or Recovery. PRODUCTION * Enforces optimal runtime checks. |xref:reference:rpk/rpk-redpanda/rpk-redpanda-start.adoc[`rpk redpanda start`] |Start redpanda. diff --git a/modules/reference/pages/rpk/rpk-registry/rpk-registry-mode-set.adoc b/modules/reference/pages/rpk/rpk-registry/rpk-registry-mode-set.adoc index 9059bba357..b834a73e46 100644 --- a/modules/reference/pages/rpk/rpk-registry/rpk-registry-mode-set.adoc +++ b/modules/reference/pages/rpk/rpk-registry/rpk-registry-mode-set.adoc @@ -1,11 +1,11 @@ = rpk registry mode set -:description: pass:q[Set schema registry mode. Running this command with no subject sets the global schema registry mode, alternatively you can use the `--global` flag to set the global schema registry mode at the same time as per-subject mode.] +:description: pass:q[Set schema registry mode Running this command with no subject sets the global schema registry mode, alternatively you can use the `--global` flag to set the global schema registry mode at the same time as per-subject mode. Acceptable mode values: * READONLY * READWRITE * IMPORT You can only enable IMPORT mode on an empty schema registry (if setting mode globally) or an empty subject (if setting at the subject level).] :page-platforms: linux,darwin // This content is autogenerated. Do not edit manually. To customize content, see the writer's guide: https://github.com/redpanda-data/docs/blob/main/docs-data/RPK_OVERRIDES_GUIDE.adoc // tag::single-source[] -:description: pass:q[Set schema registry mode. Running this command with no subject sets the global schema registry mode, alternatively you can use the `--global` flag to set the global schema registry mode at the same time as per-subject mode.] +:description: pass:q[Set schema registry mode Running this command with no subject sets the global schema registry mode, alternatively you can use the `--global` flag to set the global schema registry mode at the same time as per-subject mode. Acceptable mode values: * READONLY * READWRITE * IMPORT You can only enable IMPORT mode on an empty schema registry (if setting mode globally) or an empty subject (if setting at the subject level).] Set schema registry mode. Running this command with no subject sets the global schema registry mode, diff --git a/modules/reference/pages/rpk/rpk-registry/rpk-registry-mode.adoc b/modules/reference/pages/rpk/rpk-registry/rpk-registry-mode.adoc index b42c6429d2..9c3acc15d0 100644 --- a/modules/reference/pages/rpk/rpk-registry/rpk-registry-mode.adoc +++ b/modules/reference/pages/rpk/rpk-registry/rpk-registry-mode.adoc @@ -28,7 +28,7 @@ rpk registry mode [flags] |Reset schema registry mode. This command deletes any subject modes and reverts to the global default. |xref:reference:rpk/rpk-registry/rpk-registry-mode-set.adoc[`rpk registry mode set`] -|Set schema registry mode. Running this command with no subject sets the global schema registry mode, alternatively you can use the `--global` flag to set the global schema registry mode at the same time as per-subject mode. +|Set schema registry mode Running this command with no subject sets the global schema registry mode, alternatively you can use the `--global` flag to set the global schema registry mode at the same time as per-subject mode. Acceptable mode values: * READONLY * READWRITE * IMPORT You can only enable IMPORT mode on an empty schema registry (if setting mode globally) or an empty subject (if setting at the subject level). |=== 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 index 03d3bc737a..9c79b85de7 100644 --- a/modules/reference/pages/rpk/rpk-registry/rpk-registry-schema-get.adoc +++ b/modules/reference/pages/rpk/rpk-registry/rpk-registry-schema-get.adoc @@ -1,11 +1,11 @@ = rpk registry schema get -:description: Get a schema by version, ID, or by an existing schema. This returns a lookup of an existing schema or schemas in one of a few potential (mutually exclusive) ways: * By version, returning a schema for a required subject and version. +:description: pass:q[Get a schema by version, ID, or by an existing schema. This returns a lookup of an existing schema or schemas in one of a few potential (mutually exclusive) ways: * By version, returning a schema for a required subject and version * By ID, returning all subjects using the schema, or filtering for one subject * By schema, checking if the schema has been created in the subject To print the schema, use the `--print-schema` flag.] :page-platforms: linux,darwin // This content is autogenerated. Do not edit manually. To customize content, see the writer's guide: https://github.com/redpanda-data/docs/blob/main/docs-data/RPK_OVERRIDES_GUIDE.adoc // tag::single-source[] -:description: Get a schema by version, ID, or by an existing schema. This returns a lookup of an existing schema or schemas in one of a few potential (mutually exclusive) ways: * By version, returning a schema for a required subject and version. +:description: pass:q[Get a schema by version, ID, or by an existing schema. This returns a lookup of an existing schema or schemas in one of a few potential (mutually exclusive) ways: * By version, returning a schema for a required subject and version * By ID, returning all subjects using the schema, or filtering for one subject * By schema, checking if the schema has been created in the subject To print the schema, use the `--print-schema` flag.] Get a schema by version, ID, or by an existing schema. This returns a lookup of an existing schema or schemas in one of a few diff --git a/modules/reference/pages/rpk/rpk-registry/rpk-registry-schema.adoc b/modules/reference/pages/rpk/rpk-registry/rpk-registry-schema.adoc index 2381930fe6..b1a35d4ffc 100644 --- a/modules/reference/pages/rpk/rpk-registry/rpk-registry-schema.adoc +++ b/modules/reference/pages/rpk/rpk-registry/rpk-registry-schema.adoc @@ -31,7 +31,7 @@ rpk registry schema [flags] |Delete a specific schema for the given subject. By default, schemas are soft deleted and can still be retrieved with the `--deleted` flag on other commands. |xref:reference:rpk/rpk-registry/rpk-registry-schema-get.adoc[`rpk registry schema get`] -|Get a schema by version, ID, or by an existing schema. This returns a lookup of an existing schema or schemas in one of a few potential (mutually exclusive) ways: * By version, returning a schema for a required subject and version. +|Get a schema by version, ID, or by an existing schema. This returns a lookup of an existing schema or schemas in one of a few potential (mutually exclusive) ways: * By version, returning a schema for a required subject and version * By ID, returning all subjects using the schema, or filtering for one subject * By schema, checking if the schema has been created in the subject To print the schema, use the `--print-schema` flag. |xref:reference:rpk/rpk-registry/rpk-registry-schema-list.adoc[`rpk registry schema list`] |List the schemas for the requested subjects, or list all schemas. diff --git a/modules/reference/pages/rpk/rpk-shadow/rpk-shadow-config.adoc b/modules/reference/pages/rpk/rpk-shadow/rpk-shadow-config.adoc index 2fbf4e6675..ed5a47961e 100644 --- a/modules/reference/pages/rpk/rpk-shadow/rpk-shadow-config.adoc +++ b/modules/reference/pages/rpk/rpk-shadow/rpk-shadow-config.adoc @@ -1,3 +1,4 @@ +ifndef::env-cloud[] = rpk shadow config :description: Generate a Redpanda Shadow Link configuration file. :page-platforms: linux,darwin @@ -40,3 +41,4 @@ rpk shadow config [flags] |=== // end::single-source[] +endif::[] diff --git a/modules/reference/pages/rpk/rpk-topic/rpk-topic-analyze.adoc b/modules/reference/pages/rpk/rpk-topic/rpk-topic-analyze.adoc index e7fad738a8..68b9e96464 100644 --- a/modules/reference/pages/rpk/rpk-topic/rpk-topic-analyze.adoc +++ b/modules/reference/pages/rpk/rpk-topic/rpk-topic-analyze.adoc @@ -1,3 +1,4 @@ +ifndef::env-cloud[] = rpk topic analyze :description: Analyze topics. This command consumes records from the specified topics to determine topic characteristics such as batch rate and batch size. :page-platforms: linux,darwin @@ -123,3 +124,4 @@ For example, |=== // end::single-source[] +endif::[] diff --git a/modules/reference/pages/rpk/rpk-topic/rpk-topic-describe-storage.adoc b/modules/reference/pages/rpk/rpk-topic/rpk-topic-describe-storage.adoc index 1ac0194e4e..dc8bad59b8 100644 --- a/modules/reference/pages/rpk/rpk-topic/rpk-topic-describe-storage.adoc +++ b/modules/reference/pages/rpk/rpk-topic/rpk-topic-describe-storage.adoc @@ -1,3 +1,4 @@ +ifndef::env-cloud[] = rpk topic describe-storage :description: Describe the topic storage status. :page-platforms: linux,darwin @@ -78,3 +79,4 @@ segments. |=== // end::single-source[] +endif::[] diff --git a/modules/reference/pages/rpk/rpk-topic/rpk-topic-trim-prefix.adoc b/modules/reference/pages/rpk/rpk-topic/rpk-topic-trim-prefix.adoc index 17473d7d92..42f429d73a 100644 --- a/modules/reference/pages/rpk/rpk-topic/rpk-topic-trim-prefix.adoc +++ b/modules/reference/pages/rpk/rpk-topic/rpk-topic-trim-prefix.adoc @@ -1,11 +1,11 @@ = rpk topic trim-prefix -:description: Trim records from topics. This command allows you to trim records from topics, to trim the topics Redpanda sets the LogStartOffset for partitions to the requested offset. +:description: Trim records from topics This command allows you to trim records from topics, to trim the topics Redpanda sets the LogStartOffset for partitions to the requested offset. All segments whose base offset is less than the requested offset are deleted, and any records within the segment before the requested offset can no longer be read. :page-platforms: linux,darwin // This content is autogenerated. Do not edit manually. To customize content, see the writer's guide: https://github.com/redpanda-data/docs/blob/main/docs-data/RPK_OVERRIDES_GUIDE.adoc // tag::single-source[] -:description: Trim records from topics. This command allows you to trim records from topics, to trim the topics Redpanda sets the LogStartOffset for partitions to the requested offset. +:description: Trim records from topics This command allows you to trim records from topics, to trim the topics Redpanda sets the LogStartOffset for partitions to the requested offset. All segments whose base offset is less than the requested offset are deleted, and any records within the segment before the requested offset can no longer be read. include::shared:partial$warning-delete-records.adoc[] Trim records from topics. diff --git a/modules/reference/pages/rpk/rpk-topic/rpk-topic.adoc b/modules/reference/pages/rpk/rpk-topic/rpk-topic.adoc index 27c3dd716c..905c053547 100644 --- a/modules/reference/pages/rpk/rpk-topic/rpk-topic.adoc +++ b/modules/reference/pages/rpk/rpk-topic/rpk-topic.adoc @@ -47,7 +47,7 @@ endif::[] ifndef::env-cloud[] |xref:reference:rpk/rpk-topic/rpk-topic-describe-storage.adoc[`rpk topic describe-storage`] -|Describe the topic storage status. This commands prints detailed information about the cloud storage status of a given topic, the information is divided in 4 sections: SUMMARY. +|Describe the topic storage status. This commands prints detailed information about the cloud storage status of a given topic, the information is divided in 4 sections: SUMMARY The summary section contains general information about the topic, the cloud storage mode (one of disabled, write_only, read_only, full, read_replica, cloud_topic, and cloud_topic_read_replica), and the delta in milliseconds since the last upload of either the partition manifest or a segment. endif::[] |xref:reference:rpk/rpk-topic/rpk-topic-list.adoc[`rpk topic list`] @@ -57,7 +57,7 @@ endif::[] |Produce records to a topic. Producing records reads from `STDIN`, parses input according to `--format`, and produces records to Redpanda. |xref:reference:rpk/rpk-topic/rpk-topic-trim-prefix.adoc[`rpk topic trim-prefix`] -|Trim records from topics. This command allows you to trim records from topics, to trim the topics Redpanda sets the LogStartOffset for partitions to the requested offset. +|Trim records from topics This command allows you to trim records from topics, to trim the topics Redpanda sets the LogStartOffset for partitions to the requested offset. All segments whose base offset is less than the requested offset are deleted, and any records within the segment before the requested offset can no longer be read. |=== diff --git a/modules/reference/pages/rpk/rpk-transform/rpk-transform-logs.adoc b/modules/reference/pages/rpk/rpk-transform/rpk-transform-logs.adoc index c69ed86f6a..5b42f96d78 100644 --- a/modules/reference/pages/rpk/rpk-transform/rpk-transform-logs.adoc +++ b/modules/reference/pages/rpk/rpk-transform/rpk-transform-logs.adoc @@ -1,15 +1,15 @@ = rpk transform logs -:description: pass:q[View logs for a transform. Data transform's STDOUT and STDERR are captured during runtime and written to an internally managed topic `_redpanda.transform_logs`.] +:description: View logs for a transform. transform_logs. :page-platforms: linux,darwin // This content is autogenerated. Do not edit manually. To customize content, see the writer's guide: https://github.com/redpanda-data/docs/blob/main/docs-data/RPK_OVERRIDES_GUIDE.adoc // tag::single-source[] -:description: pass:q[View logs for a transform. Data transform's STDOUT and STDERR are captured during runtime and written to an internally managed topic `_redpanda.transform_logs`.] +:description: View logs for a transform. transform_logs. View logs for a transform. Data transform's STDOUT and STDERR are captured during runtime and written to -an internally managed topic `_redpanda.transform_logs`. +an internally managed topic _redpanda.transform_logs. This command outputs logs for a single transform over a period of time and printing them to STDOUT. The logs can be printed in various formats. diff --git a/modules/reference/pages/rpk/rpk-transform/rpk-transform-pause.adoc b/modules/reference/pages/rpk/rpk-transform/rpk-transform-pause.adoc index ff05aa3f8d..81f59f5f9c 100644 --- a/modules/reference/pages/rpk/rpk-transform/rpk-transform-pause.adoc +++ b/modules/reference/pages/rpk/rpk-transform/rpk-transform-pause.adoc @@ -1,3 +1,4 @@ +ifndef::env-cloud[] = rpk transform pause :description: Pause a data transform. This command suspends execution of the specified transform without removing it from the system. :page-platforms: linux,darwin @@ -39,3 +40,4 @@ rpk transform pause [flags] |=== // end::single-source[] +endif::[] diff --git a/modules/reference/pages/rpk/rpk-transform/rpk-transform-resume.adoc b/modules/reference/pages/rpk/rpk-transform/rpk-transform-resume.adoc index d9ea3f9d68..f2a385ccfe 100644 --- a/modules/reference/pages/rpk/rpk-transform/rpk-transform-resume.adoc +++ b/modules/reference/pages/rpk/rpk-transform/rpk-transform-resume.adoc @@ -1,3 +1,4 @@ +ifndef::env-cloud[] = rpk transform resume :description: Resume a data transform. This command resumes execution of the specified data transform, if it was previously paused. :page-platforms: linux,darwin @@ -36,3 +37,4 @@ rpk transform resume [flags] |=== // end::single-source[] +endif::[] diff --git a/modules/reference/pages/rpk/rpk-transform/rpk-transform.adoc b/modules/reference/pages/rpk/rpk-transform/rpk-transform.adoc index 45af7e67f8..87c0201bf9 100644 --- a/modules/reference/pages/rpk/rpk-transform/rpk-transform.adoc +++ b/modules/reference/pages/rpk/rpk-transform/rpk-transform.adoc @@ -46,7 +46,7 @@ rpk transfrom |List data transforms. This command lists all data transforms in a cluster, as well as showing the state of a individual transform processor, such as if it's errored or how many records are pending to be processed (`lag`). |xref:reference:rpk/rpk-transform/rpk-transform-logs.adoc[`rpk transform logs`] -|View logs for a transform. Data transform's STDOUT and STDERR are captured during runtime and written to an internally managed topic `_redpanda.transform_logs`. +|View logs for a transform. transform_logs. ifndef::env-cloud[] |xref:reference:rpk/rpk-transform/rpk-transform-pause.adoc[`rpk transform pause`] diff --git a/modules/reference/partials/rpk-ai/rpk-ai-install.adoc b/modules/reference/partials/rpk-ai/rpk-ai-install.adoc index 98fae6121d..15b43e22f4 100644 --- a/modules/reference/partials/rpk-ai/rpk-ai-install.adoc +++ b/modules/reference/partials/rpk-ai/rpk-ai-install.adoc @@ -10,7 +10,7 @@ Install the Redpanda AI CLI. This command installs the latest version by default. -Alternatively, you may specify an `rpk ai version` using the `--ai-version` flag. +Alternatively, you may specify an `rpk` ai version using the `--ai-version` flag. You may force the installation using the `--force` flag. diff --git a/modules/reference/partials/rpk-ai/rpk-ai-version.adoc b/modules/reference/partials/rpk-ai/rpk-ai-version.adoc index 1491600f86..efb099b886 100644 --- a/modules/reference/partials/rpk-ai/rpk-ai-version.adoc +++ b/modules/reference/partials/rpk-ai/rpk-ai-version.adoc @@ -1,12 +1,12 @@ = rpk ai version -:description: pass:q[Print `rpk ai version` and commit.] +:description: pass:q[Print `rpk` ai version and commit.] :page-platforms: linux,darwin // This content is autogenerated. Do not edit manually. To customize content, see the writer's guide: https://github.com/redpanda-data/docs/blob/main/docs-data/RPK_OVERRIDES_GUIDE.adoc // tag::single-source[] -:description: pass:q[Print `rpk ai version` and commit.] -Print `rpk ai version` and commit. +:description: pass:q[Print `rpk` ai version and commit.] +Print `rpk` ai version and commit. == Usage diff --git a/modules/reference/partials/rpk-cloud/rpk-cloud-byoc-install.adoc b/modules/reference/partials/rpk-cloud/rpk-cloud-byoc-install.adoc index e986119990..9969c1b96d 100644 --- a/modules/reference/partials/rpk-cloud/rpk-cloud-byoc-install.adoc +++ b/modules/reference/partials/rpk-cloud/rpk-cloud-byoc-install.adoc @@ -1,11 +1,11 @@ = rpk cloud byoc install -:description: Install the BYOC plugin. This command downloads the BYOC managed plugin if necessary. +:description: Install the BYOC plugin This command downloads the BYOC managed plugin if necessary. The plugin is installed by default if you try to run a non-install command, but this command exists if you want to download the plugin ahead of time. :page-platforms: linux,darwin // This content is autogenerated. Do not edit manually. To customize content, see the writer's guide: https://github.com/redpanda-data/docs/blob/main/docs-data/RPK_OVERRIDES_GUIDE.adoc // tag::single-source[] -:description: Install the BYOC plugin. This command downloads the BYOC managed plugin if necessary. +:description: Install the BYOC plugin This command downloads the BYOC managed plugin if necessary. The plugin is installed by default if you try to run a non-install command, but this command exists if you want to download the plugin ahead of time. Install the BYOC plugin. This command downloads the BYOC managed plugin if necessary. The plugin is diff --git a/modules/reference/partials/rpk-cloud/rpk-cloud-byoc-uninstall.adoc b/modules/reference/partials/rpk-cloud/rpk-cloud-byoc-uninstall.adoc index 8589455d00..0046b52ac0 100644 --- a/modules/reference/partials/rpk-cloud/rpk-cloud-byoc-uninstall.adoc +++ b/modules/reference/partials/rpk-cloud/rpk-cloud-byoc-uninstall.adoc @@ -1,11 +1,11 @@ = rpk cloud byoc uninstall -:description: Uninstall the BYOC plugin. This command deletes your locally downloaded BYOC managed plugin if it exists. +:description: Uninstall the BYOC plugin This command deletes your locally downloaded BYOC managed plugin if it exists. Often, you only need to download the plugin to create your cluster once, and then you never need the plugin again. :page-platforms: linux,darwin // This content is autogenerated. Do not edit manually. To customize content, see the writer's guide: https://github.com/redpanda-data/docs/blob/main/docs-data/RPK_OVERRIDES_GUIDE.adoc // tag::single-source[] -:description: Uninstall the BYOC plugin. This command deletes your locally downloaded BYOC managed plugin if it exists. +:description: Uninstall the BYOC plugin This command deletes your locally downloaded BYOC managed plugin if it exists. Often, you only need to download the plugin to create your cluster once, and then you never need the plugin again. Uninstall the BYOC plugin. This command deletes your locally downloaded BYOC managed plugin if it exists. diff --git a/modules/reference/partials/rpk-cloud/rpk-cloud-byoc.adoc b/modules/reference/partials/rpk-cloud/rpk-cloud-byoc.adoc index 9ad488348f..d3bb40fc9e 100644 --- a/modules/reference/partials/rpk-cloud/rpk-cloud-byoc.adoc +++ b/modules/reference/partials/rpk-cloud/rpk-cloud-byoc.adoc @@ -1,11 +1,11 @@ = rpk cloud byoc -:description: Manage a Redpanda Cloud BYOC agent. For BYOC, Redpanda installs an agent service in your owned cluster. +:description: Manage a Redpanda Cloud BYOC agent For BYOC, Redpanda installs an agent service in your owned cluster. The agent then proceeds to provision further infrastructure and eventually, a full Redpanda cluster. :page-platforms: linux,darwin // This content is autogenerated. Do not edit manually. To customize content, see the writer's guide: https://github.com/redpanda-data/docs/blob/main/docs-data/RPK_OVERRIDES_GUIDE.adoc // tag::single-source[] -:description: Manage a Redpanda Cloud BYOC agent. For BYOC, Redpanda installs an agent service in your owned cluster. +:description: Manage a Redpanda Cloud BYOC agent For BYOC, Redpanda installs an agent service in your owned cluster. The agent then proceeds to provision further infrastructure and eventually, a full Redpanda cluster. Manage a Redpanda Cloud BYOC agent. For BYOC, Redpanda installs an agent service in your owned cluster. The agent @@ -31,10 +31,10 @@ rpk cloud byoc [flags] |Command |Description |xref:reference:rpk/rpk-cloud/rpk-cloud-byoc-install.adoc[`rpk cloud byoc install`] -|Install the BYOC plugin. This command downloads the BYOC managed plugin if necessary. +|Install the BYOC plugin This command downloads the BYOC managed plugin if necessary. The plugin is installed by default if you try to run a non-install command, but this command exists if you want to download the plugin ahead of time. |xref:reference:rpk/rpk-cloud/rpk-cloud-byoc-uninstall.adoc[`rpk cloud byoc uninstall`] -|Uninstall the BYOC plugin. This command deletes your locally downloaded BYOC managed plugin if it exists. +|Uninstall the BYOC plugin This command deletes your locally downloaded BYOC managed plugin if it exists. Often, you only need to download the plugin to create your cluster once, and then you never need the plugin again. |=== diff --git a/modules/reference/partials/rpk-cloud/rpk-cloud-login.adoc b/modules/reference/partials/rpk-cloud/rpk-cloud-login.adoc index 6b6a33d82b..15140f4ea0 100644 --- a/modules/reference/partials/rpk-cloud/rpk-cloud-login.adoc +++ b/modules/reference/partials/rpk-cloud/rpk-cloud-login.adoc @@ -1,11 +1,11 @@ = rpk cloud login -:description: Log in to the Redpanda Cloud. This command checks for an existing Redpanda Cloud API token and, if present, ensures it is still valid. +:description: Log in to the Redpanda Cloud This command checks for an existing Redpanda Cloud API token and, if present, ensures it is still valid. If no token is found or the token is no longer valid, this command will login and save your token along with the client ID used to request the token. :page-platforms: linux,darwin // This content is autogenerated. Do not edit manually. To customize content, see the writer's guide: https://github.com/redpanda-data/docs/blob/main/docs-data/RPK_OVERRIDES_GUIDE.adoc // tag::single-source[] -:description: Log in to the Redpanda Cloud. This command checks for an existing Redpanda Cloud API token and, if present, ensures it is still valid. +:description: Log in to the Redpanda Cloud This command checks for an existing Redpanda Cloud API token and, if present, ensures it is still valid. If no token is found or the token is no longer valid, this command will login and save your token along with the client ID used to request the token. Log in to the Redpanda Cloud. This command checks for an existing Redpanda Cloud API token and, if present, @@ -36,7 +36,7 @@ Cloud client credentials can be used to login to Redpanda, they can be created in the Clients tab of the Users section in the Redpanda Cloud online interface. client credentials can be provided in three ways, in order of preference: -* In your `rpk cloud auth`, `client_id` and `client_secret` fields +* In your `rpk` cloud auth, `client_id` and `client_secret` fields * Through RPK_CLOUD_CLIENT_ID and RPK_CLOUD_CLIENT_SECRET environment variables diff --git a/modules/reference/partials/rpk-cloud/rpk-cloud-logout.adoc b/modules/reference/partials/rpk-cloud/rpk-cloud-logout.adoc index 92a0343098..61dc9db36a 100644 --- a/modules/reference/partials/rpk-cloud/rpk-cloud-logout.adoc +++ b/modules/reference/partials/rpk-cloud/rpk-cloud-logout.adoc @@ -1,11 +1,11 @@ = rpk cloud logout -:description: Log out from Redpanda Cloud. This command deletes your cloud auth token. +:description: pass:q[Log out from Redpanda Cloud This command deletes your cloud auth token. If you want to log out entirely and switch to a different organization, you can use the `--clear-credentials` flag to additionally clear your client ID and client secret.] :page-platforms: linux,darwin // This content is autogenerated. Do not edit manually. To customize content, see the writer's guide: https://github.com/redpanda-data/docs/blob/main/docs-data/RPK_OVERRIDES_GUIDE.adoc // tag::single-source[] -:description: Log out from Redpanda Cloud. This command deletes your cloud auth token. +:description: pass:q[Log out from Redpanda Cloud This command deletes your cloud auth token. If you want to log out entirely and switch to a different organization, you can use the `--clear-credentials` flag to additionally clear your client ID and client secret.] Log out from Redpanda Cloud. This command deletes your cloud auth token. If you want to log out entirely and diff --git a/modules/reference/partials/rpk-cloud/rpk-cloud.adoc b/modules/reference/partials/rpk-cloud/rpk-cloud.adoc index 0e607fb7ff..453a92b884 100644 --- a/modules/reference/partials/rpk-cloud/rpk-cloud.adoc +++ b/modules/reference/partials/rpk-cloud/rpk-cloud.adoc @@ -25,16 +25,16 @@ rpk cloud [flags] |Manage `rpk` cloud authentications. An `rpk` cloud authentication allows you to talk to Redpanda Cloud. |xref:reference:rpk/rpk-cloud/rpk-cloud-byoc.adoc[`rpk cloud byoc`] -|Manage a Redpanda Cloud BYOC agent. For BYOC, Redpanda installs an agent service in your owned cluster. +|Manage a Redpanda Cloud BYOC agent For BYOC, Redpanda installs an agent service in your owned cluster. The agent then proceeds to provision further infrastructure and eventually, a full Redpanda cluster. |xref:reference:rpk/rpk-cloud/rpk-cloud-cluster.adoc[`rpk cloud cluster`] |Manage `rpk` cloud clusters. This command allows you to manage cloud clusters, as well as easily switch between which cluster you are talking to. |xref:reference:rpk/rpk-cloud/rpk-cloud-login.adoc[`rpk cloud login`] -|Log in to the Redpanda Cloud. This command checks for an existing Redpanda Cloud API token and, if present, ensures it is still valid. +|Log in to the Redpanda Cloud This command checks for an existing Redpanda Cloud API token and, if present, ensures it is still valid. If no token is found or the token is no longer valid, this command will login and save your token along with the client ID used to request the token. |xref:reference:rpk/rpk-cloud/rpk-cloud-logout.adoc[`rpk cloud logout`] -|Log out from Redpanda Cloud. This command deletes your cloud auth token. +|Log out from Redpanda Cloud This command deletes your cloud auth token. If you want to log out entirely and switch to a different organization, you can use the `--clear-credentials` flag to additionally clear your client ID and client secret. |xref:reference:rpk/rpk-cloud/rpk-cloud-mcp.adoc[`rpk cloud mcp`] |Manage Redpanda Cloud MCP server.