From 601925ba59d7d030fc72bfe841c595f27287c6af Mon Sep 17 00:00:00 2001 From: JakeSCahill <45230295+JakeSCahill@users.noreply.github.com> Date: Mon, 3 Aug 2026 08:59:24 +0000 Subject: [PATCH 1/5] docs: re-render rpk docs for overrides change --- ...k-cluster-brokers-decommission-status.adoc | 2 + .../rpk-cluster-brokers-decommission.adoc | 2 + .../rpk-cluster-brokers-recommission.adoc | 2 + .../rpk/rpk-cluster/rpk-cluster-brokers.adoc | 4 ++ .../rpk-cluster/rpk-cluster-config-edit.adoc | 2 + .../rpk-cluster-config-export.adoc | 2 + .../rpk-cluster-config-force-reset.adoc | 2 + .../rpk-cluster-config-import.adoc | 2 + .../rpk-cluster/rpk-cluster-config-lint.adoc | 12 +++- .../rpk-cluster/rpk-cluster-config-list.adoc | 2 +- .../rpk-cluster-config-status.adoc | 2 +- .../rpk/rpk-cluster/rpk-cluster-config.adoc | 20 +++++-- .../rpk/rpk-cluster/rpk-cluster-health.adoc | 18 ++++-- .../rpk/rpk-cluster/rpk-cluster-info.adoc | 4 +- .../rpk-cluster/rpk-cluster-license-set.adoc | 23 +++++++- .../rpk/rpk-cluster/rpk-cluster-license.adoc | 4 +- .../rpk-cluster-logdirs-describe.adoc | 23 ++++++-- .../rpk/rpk-cluster/rpk-cluster-logdirs.adoc | 2 +- .../rpk-cluster/rpk-cluster-loggers-list.adoc | 2 + .../rpk-cluster/rpk-cluster-loggers-set.adoc | 2 + .../rpk/rpk-cluster/rpk-cluster-loggers.adoc | 4 ++ .../rpk-cluster-maintenance-enable.adoc | 11 +++- .../rpk-cluster-maintenance-status.adoc | 43 ++++++++++++-- .../rpk-cluster/rpk-cluster-maintenance.adoc | 30 ++++++++-- .../rpk-cluster-partitions-balance.adoc | 34 ++++++++++- ...pk-cluster-partitions-balancer-status.adoc | 2 +- .../rpk-cluster-partitions-list.adoc | 29 +++++++++- .../rpk-cluster-partitions-move-cancel.adoc | 2 +- .../rpk-cluster-partitions-move-status.adoc | 2 +- .../rpk-cluster-partitions-move.adoc | 32 +++++++++++ .../rpk-cluster/rpk-cluster-partitions.adoc | 6 +- .../rpk-cluster-quotas-import.adoc | 20 +++++++ .../rpk-cluster-self-test-start.adoc | 53 ++++++++++++------ .../rpk-cluster/rpk-cluster-self-test.adoc | 4 +- .../rpk-cluster-storage-mount.adoc | 17 +++++- .../rpk-cluster-storage-restore.adoc | 2 + .../rpk-cluster-storage-unmount.adoc | 23 +++++++- .../rpk/rpk-cluster/rpk-cluster-storage.adoc | 6 +- .../rpk-cluster-upgrade-finalize.adoc | 2 + .../rpk-cluster-upgrade-status.adoc | 2 + .../rpk/rpk-cluster/rpk-cluster-upgrade.adoc | 4 ++ .../pages/rpk/rpk-cluster/rpk-cluster.adoc | 22 +++++++- .../rpk/rpk-connect/rpk-connect-echo.adoc | 8 +++ .../rpk/rpk-connect/rpk-connect-install.adoc | 2 + .../rpk/rpk-connect/rpk-connect-lint.adoc | 6 +- .../rpk/rpk-connect/rpk-connect-list.adoc | 4 ++ .../rpk/rpk-connect/rpk-connect-run.adoc | 36 +++++++----- .../rpk/rpk-connect/rpk-connect-template.adoc | 2 + .../rpk/rpk-connect/rpk-connect-test.adoc | 6 +- .../pages/rpk/rpk-connect/rpk-connect.adoc | 4 +- .../rpk-debug-remote-bundle-download.adoc | 8 ++- .../rpk-debug/rpk-debug-remote-bundle.adoc | 2 +- .../rpk/rpk-generate/rpk-generate-app.adoc | 56 +++++++++++++++---- .../rpk-generate-grafana-dashboard.adoc | 30 +++++++++- .../rpk-generate/rpk-generate-license.adoc | 18 +++++- .../rpk-generate-prometheus-config.adoc | 2 + .../pages/rpk/rpk-generate/rpk-generate.adoc | 10 +++- .../pages/rpk/rpk-group/rpk-group-delete.adoc | 25 +++++++-- .../rpk/rpk-group/rpk-group-describe.adoc | 14 ++++- .../pages/rpk/rpk-group/rpk-group-list.adoc | 2 +- .../rpk-group/rpk-group-offset-delete.adoc | 25 +++++++-- .../pages/rpk/rpk-group/rpk-group-seek.adoc | 41 ++++++++++---- .../pages/rpk/rpk-group/rpk-group.adoc | 50 +++++++++++++++-- .../pages/rpk/rpk-k8s/rpk-k8s-install.adoc | 2 + .../rpk-k8s-multicluster-bootstrap.adoc | 2 + .../rpk-k8s/rpk-k8s-multicluster-bundle.adoc | 2 + .../rpk-k8s/rpk-k8s-multicluster-status.adoc | 2 + .../rpk/rpk-k8s/rpk-k8s-multicluster.adoc | 2 + .../pages/rpk/rpk-k8s/rpk-k8s-uninstall.adoc | 2 + .../pages/rpk/rpk-k8s/rpk-k8s-upgrade.adoc | 2 + .../pages/rpk/rpk-k8s/rpk-k8s-version.adoc | 2 + .../reference/pages/rpk/rpk-k8s/rpk-k8s.adoc | 2 + .../pages/rpk/rpk-plugin/rpk-plugin-list.adoc | 2 +- .../rpk/rpk-profile/rpk-profile-list.adoc | 2 +- .../rpk/rpk-profile/rpk-profile-prompt.adoc | 2 +- .../rpk/rpk-profile/rpk-profile-set.adoc | 21 ++++++- .../rpk/rpk-profile/rpk-profile-validate.adoc | 2 + .../pages/rpk/rpk-profile/rpk-profile.adoc | 20 +++++-- .../rpk-security/rpk-security-acl-create.adoc | 2 +- .../rpk-security/rpk-security-acl-delete.adoc | 2 +- .../rpk/rpk-security/rpk-security-acl.adoc | 34 ++++++++++- .../pages/rpk/rpk-security/rpk-security.adoc | 2 +- .../rpk/rpk-shadow/rpk-shadow-config.adoc | 2 + .../rpk/rpk-shadow/rpk-shadow-describe.adoc | 6 +- .../rpk/rpk-shadow/rpk-shadow-status.adoc | 17 ++++-- .../pages/rpk/rpk-shadow/rpk-shadow.adoc | 4 +- .../rpk-topic/rpk-topic-add-partitions.adoc | 2 +- .../rpk/rpk-topic/rpk-topic-alter-config.adoc | 2 +- .../rpk/rpk-topic/rpk-topic-analyze.adoc | 2 + .../rpk/rpk-topic/rpk-topic-consume.adoc | 29 +++++++++- .../pages/rpk/rpk-topic/rpk-topic-create.adoc | 6 +- .../pages/rpk/rpk-topic/rpk-topic-delete.adoc | 34 +++++++++-- .../rpk-topic/rpk-topic-describe-storage.adoc | 11 +++- .../pages/rpk/rpk-topic/rpk-topic-list.adoc | 19 ++++++- .../rpk/rpk-topic/rpk-topic-trim-prefix.adoc | 51 ++++++++++++++++- .../pages/rpk/rpk-topic/rpk-topic.adoc | 12 ++-- .../rpk/rpk-transform/rpk-transform-init.adoc | 2 + .../rpk/rpk-transform/rpk-transform-logs.adoc | 14 ++++- .../rpk-transform/rpk-transform-pause.adoc | 2 + .../rpk-transform/rpk-transform-resume.adoc | 2 + .../rpk/rpk-transform/rpk-transform.adoc | 6 +- .../partials/rpk-ai/rpk-ai-auth-login.adoc | 10 +++- .../rpk-ai/rpk-ai-llm-provider-apply.adoc | 2 + .../rpk-ai/rpk-ai-llm-provider-check.adoc | 2 + .../rpk-ai/rpk-ai-llm-provider-create.adoc | 2 + .../rpk-ai/rpk-ai-llm-provider-delete.adoc | 2 + .../rpk-ai/rpk-ai-llm-provider-diff.adoc | 2 + .../rpk-ai/rpk-ai-llm-provider-get.adoc | 2 + .../rpk-ai/rpk-ai-llm-provider-list.adoc | 2 + .../rpk-ai/rpk-ai-llm-provider-update.adoc | 2 + .../partials/rpk-ai/rpk-ai-llm-provider.adoc | 2 + .../rpk-ai/rpk-ai-mcp-server-apply.adoc | 2 + .../rpk-ai/rpk-ai-mcp-server-create.adoc | 2 + .../rpk-ai/rpk-ai-mcp-server-delete.adoc | 2 + .../rpk-ai/rpk-ai-mcp-server-diff.adoc | 2 + .../rpk-ai/rpk-ai-mcp-server-get.adoc | 2 + .../rpk-ai/rpk-ai-mcp-server-list.adoc | 2 + .../rpk-ai/rpk-ai-mcp-server-tools-call.adoc | 2 + .../rpk-ai/rpk-ai-mcp-server-tools-list.adoc | 2 + .../rpk-ai/rpk-ai-mcp-server-tools.adoc | 2 + .../rpk-ai/rpk-ai-mcp-server-types.adoc | 2 + .../rpk-ai/rpk-ai-mcp-server-update.adoc | 2 + .../partials/rpk-ai/rpk-ai-mcp-server.adoc | 2 + .../rpk-ai/rpk-ai-oauth-client-dcr.adoc | 10 ++++ .../rpk-ai-oauth-client-revoke-tokens.adoc | 4 ++ .../rpk-ai/rpk-ai-oauth-client-update.adoc | 2 + .../partials/rpk-ai/rpk-ai-policy-apply.adoc | 2 + .../partials/rpk-ai/rpk-ai-policy-create.adoc | 2 + .../partials/rpk-ai/rpk-ai-policy-delete.adoc | 2 + .../partials/rpk-ai/rpk-ai-policy-diff.adoc | 2 + .../partials/rpk-ai/rpk-ai-policy-get.adoc | 2 + .../partials/rpk-ai/rpk-ai-policy-list.adoc | 2 + .../partials/rpk-ai/rpk-ai-policy-update.adoc | 2 + .../partials/rpk-ai/rpk-ai-policy.adoc | 2 + .../rpk-cloud/rpk-cloud-auth-list.adoc | 2 +- .../rpk-cloud/rpk-cloud-mcp-install.adoc | 2 + .../rpk-security-secret-list.adoc | 2 +- 137 files changed, 1052 insertions(+), 201 deletions(-) diff --git a/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-brokers-decommission-status.adoc b/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-brokers-decommission-status.adoc index 207bbf10d0..3775c17ab6 100644 --- a/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-brokers-decommission-status.adoc +++ b/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-brokers-decommission-status.adoc @@ -54,6 +54,8 @@ section and decommission fails. Typical scenarios for failure include: there are no brokers that have enough space to allocate a partition, or that can satisfy rack constraints, etc. +NOTE: This command was introduced in version v26.2.1. + == Usage [,bash] diff --git a/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-brokers-decommission.adoc b/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-brokers-decommission.adoc index 0cf78c50fe..d9a6c8824d 100644 --- a/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-brokers-decommission.adoc +++ b/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-brokers-decommission.adoc @@ -20,6 +20,8 @@ decommissioning a node that is currently in maintenance mode. If you are on a v22.x cluster and need to bypass the maintenance mode check (perhaps your cluster is unreachable), use the `--skip-liveness-check` flag. +NOTE: This command was introduced in version v26.2.1. + == Usage [,bash] diff --git a/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-brokers-recommission.adoc b/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-brokers-recommission.adoc index 5091a2135d..c6d372a21f 100644 --- a/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-brokers-recommission.adoc +++ b/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-brokers-recommission.adoc @@ -17,6 +17,8 @@ command. A recommission request is sent to every broker in the cluster, only the cluster leader handles the request. +NOTE: This command was introduced in version v26.2.1. + == Usage [,bash] 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 da8c3ae9bb..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 @@ -9,6 +10,8 @@ :description: Manage Redpanda cluster brokers. Manage Redpanda cluster brokers. +NOTE: This command was introduced in version v26.2.1. + == Usage [,bash] @@ -47,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 a7ef32b06a..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,12 +1,17 @@ +ifndef::env-cloud[] = rpk cluster config lint -:description: Identify any Redpanda configuration properties that are not recognized. These may be properties that were valid in earlier versions of Redpanda but are now managed via the central configuration store. +: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 // 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: Identify any Redpanda configuration properties that are not recognized. These may be properties that were valid in earlier versions of Redpanda but are now managed via the central configuration store. -Identify any Redpanda configuration properties that are not recognized. These may be properties that were valid in earlier versions of Redpanda but are now managed via the central configuration store. +: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`).] +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`). == Usage @@ -29,3 +34,4 @@ rpk cluster config lint [flags] |=== // end::single-source[] +endif::[] diff --git a/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-config-list.adoc b/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-config-list.adoc index f27bb9c90e..9225c2ae33 100644 --- a/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-config-list.adoc +++ b/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-config-list.adoc @@ -73,7 +73,7 @@ rpk cluster config list --format=yaml |--filter |string |Filter configuration keys using regular expression. |--format |string |Output format (`json`,`yaml`,`text`,`wide`,`help`). -|--node-id |int |If set, route the cluster configuration request to the given broker instead of any broker. +|--node-id |int |If set, route the cluster configuration request to the given broker instead of any broker. _(New in v26.2.1)_ |=== == Global flags 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 dd8e82ee75..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 @@ -53,7 +53,7 @@ rpk cluster config status [flags] |=== |Value |Type |Description -|--format |string |Output format (`json`,`yaml`,`text`,`wide`,`help`). +|--format |string |Output format (`json`,`yaml`,`text`,`wide`,`help`). _(New in v26.2.1)_ |=== == Global flags 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 38d2559435..c3d6602c59 100644 --- a/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-config.adoc +++ b/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-config.adoc @@ -1,13 +1,15 @@ = rpk cluster config -:description: View and modify cluster-wide configuration properties. Changes take effect across all brokers. +:description: View and modify Redpanda cluster configuration properties. Modified properties are propagated immediately to all brokers. :page-aliases: reference:rpk/rpk-redpanda/rpk-redpanda-admin-config.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: View and modify cluster-wide configuration properties. Changes take effect across all brokers. -View and modify cluster-wide configuration properties. Changes take effect across all brokers. +:description: View and modify Redpanda cluster configuration properties. Modified properties are propagated immediately to all brokers. +View and modify Redpanda cluster configuration properties. + +Modified properties are propagated immediately to all brokers. Use `rpk cluster config status` to verify that all brokers are up to date, and to identify any settings that were rejected, for example, if a broker is still restarting. ifdef::env-cloud[] Cluster properties are Redpanda settings that apply to all brokers in @@ -42,23 +44,33 @@ rpk cluster config [flags] |=== |Command |Description +ifndef::env-cloud[] |xref:reference:rpk/rpk-cluster/rpk-cluster-config-edit.adoc[`rpk cluster config edit`] |Edit cluster-wide configuration properties. This command opens a text editor to modify the cluster's configuration. +endif::[] +ifndef::env-cloud[] |xref:reference:rpk/rpk-cluster/rpk-cluster-config-export.adoc[`rpk cluster config export`] |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. +endif::[] +ifndef::env-cloud[] |xref:reference:rpk/rpk-cluster/rpk-cluster-config-force-reset.adoc[`rpk cluster config force-reset`] |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. +endif::[] |xref:reference:rpk/rpk-cluster/rpk-cluster-config-get.adoc[`rpk cluster config get`] |Get a cluster configuration property. +ifndef::env-cloud[] |xref:reference:rpk/rpk-cluster/rpk-cluster-config-import.adoc[`rpk cluster config import`] |Import cluster configuration from a file. Import configuration from a YAML file, usually generated with corresponding `export` command. +endif::[] +ifndef::env-cloud[] |xref:reference:rpk/rpk-cluster/rpk-cluster-config-lint.adoc[`rpk cluster config lint`] -|Identify any Redpanda configuration properties that are not recognized. These may be properties that were valid in earlier versions of Redpanda but are now managed via the central configuration store. +|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`). +endif::[] |xref:reference:rpk/rpk-cluster/rpk-cluster-config-list.adoc[`rpk cluster config list`] |List cluster configuration properties. This command lists all available cluster configuration properties. 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 a51694a364..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,18 +1,23 @@ +ifndef::env-cloud[] = rpk cluster health -:description: Query cluster health and display the overall health status of the cluster. Redpanda collects health reports periodically from all nodes and aggregates them into a health overview. +: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 // 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: Query cluster health and display the overall health status of the cluster. Redpanda collects health reports periodically from all nodes and aggregates them into a health overview. -Query cluster health and display the overall health status of the cluster. Redpanda collects health reports periodically from all nodes and aggregates them into a health overview. +:description: Queries cluster for health overview. Health overview is created based on the health reports collected periodically from all nodes in the cluster. +Queries cluster for health overview. -A cluster is considered healthy when the following conditions are met: +Health overview is created based on the health reports collected periodically +from all nodes in the cluster. A cluster is considered healthy when the +following conditions are met: * All cluster nodes are responding -* All partitions have leaders -* The cluster controller is present + * All partitions have leaders + * The cluster controller is present + +If the cluster is reported as unhealthy, `rpk` will exit with code 10. == Usage @@ -68,3 +73,4 @@ rpk cluster health --exit-when-healthy |=== // end::single-source[] +endif::[] diff --git a/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-info.adoc b/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-info.adoc index e5b7ca6b02..8d57ad60b5 100644 --- a/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-info.adoc +++ b/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-info.adoc @@ -59,9 +59,9 @@ rpk cluster metadata |=== |Value |Type |Description -|--detailed |bool |Augment the brokers section with Admin API metadata (`cores`, membership, liveness, version, UUID, and disk space). +|--detailed |bool |Augment the brokers section with Admin API metadata (`cores`, membership, liveness, version, UUID, and disk space). _(New in v26.2.1)_ |--format |string |Output format (`json`,`yaml`,`text`,`wide`,`help`). -|--include-decommissioned |bool |Append decommissioned nodes to the brokers section using their UUID. +|--include-decommissioned |bool |Append decommissioned nodes to the brokers section using their UUID. _(New in v26.2.1)_ |-b, --print-brokers |bool |Print brokers section. |-c, --print-cluster |bool |Print cluster section. |-d, --print-detailed-topics |bool |Print per-partition information for topics (implies `-t`). 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 808236aa03..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,12 +1,29 @@ = rpk cluster license set -:description: Upload a license to the cluster using a file path, inline string, or default location. +: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 a license to the cluster using a file path, inline string, or default location. -Upload a license to the cluster using a file path, inline string, or default location. +: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: + +[,bash] +---- +rpk cluster license set --path /home/organization/redpanda.license +---- + +Or inline the license string: + +[,bash] +---- +rpk cluster license set +---- + +If neither are present, `rpk` will look for the license in the +default location `/etc/redpanda/redpanda.license`. == Usage 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 cebe25a399..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 a license to the cluster using a file path, inline string, or default location. +|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-logdirs-describe.adoc b/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-logdirs-describe.adoc index 2f38461a8d..8668ac29d8 100644 --- a/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-logdirs-describe.adoc +++ b/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-logdirs-describe.adoc @@ -1,16 +1,29 @@ = rpk cluster logdirs describe -:description: Describe log directories on Redpanda brokers. This command prints information about log directories on brokers, as well as the number of records in those log directories. +:description: Describe log directories on Redpanda brokers. This command prints information about log directories on brokers, particularly, the base directory that topics and partitions are located in, and the size of data that has been written to the partitions. :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: Describe log directories on Redpanda brokers. This command prints information about log directories on brokers, as well as the number of records in those log directories. +:description: Describe log directories on Redpanda brokers. This command prints information about log directories on brokers, particularly, the base directory that topics and partitions are located in, and the size of data that has been written to the partitions. Describe log directories on Redpanda brokers. -This command prints information about log directories on brokers, as well as the number of records in those log directories. The information is sorted first by topic, then by partition, and last by broker. +This command prints information about log directories on brokers, particularly, +the base directory that topics and partitions are located in, and the size of +data that has been written to the partitions. The size you see may not exactly +match the size on disk as reported by du: Redpanda allocates files in chunks. +The chunks will show up in du, while the actual bytes so far written to the +file will show up in this command. -The directory returned is the root directory for partitions. Within Redpanda, the partition data lives underneath the returned root directory in `+kafka/{topic}/{partition}_{revision}/+`, where `revision` is a Redpanda internal concept. +The directory returned is the root directory for partitions. Within Redpanda, +the partition data lives underneath the the returned root directory in. + +[,text] +---- +kafka/{topic}/{partition}_{revision}/ +---- + +where revision is a Redpanda internal concept. == Usage @@ -27,7 +40,7 @@ rpk cluster logdirs describe [flags] |--aggregate-into |string |Aggregate results into the specified column starting from the partition column. Valid values: `broker`, `dir`, `topic`. |-b, --broker |int32 |If non-negative, the specific broker to describe. -|--format |string |Output format (`json`,`yaml`,`text`,`wide`,`help`). +|--format |string |Output format (`json`,`yaml`,`text`,`wide`,`help`). _(New in v26.2.1)_ |-H, --human-readable |bool |Print the logdirs size in a human-readable form. |--sort-by-size |bool |If true, sort by size. |--topics |stringSlice |Specific topics to describe. diff --git a/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-logdirs.adoc b/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-logdirs.adoc index ea1749ecd9..ec17390424 100644 --- a/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-logdirs.adoc +++ b/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-logdirs.adoc @@ -22,7 +22,7 @@ rpk cluster logdirs [flags] |Command |Description |xref:reference:rpk/rpk-cluster/rpk-cluster-logdirs-describe.adoc[`rpk cluster logdirs describe`] -|Describe log directories on Redpanda brokers. This command prints information about log directories on brokers, as well as the number of records in those log directories. +|Describe log directories on Redpanda brokers. This command prints information about log directories on brokers, particularly, the base directory that topics and partitions are located in, and the size of data that has been written to the partitions. |=== diff --git a/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-loggers-list.adoc b/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-loggers-list.adoc index 622e65d2f7..0fedf919a1 100644 --- a/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-loggers-list.adoc +++ b/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-loggers-list.adoc @@ -17,6 +17,8 @@ Loggers are discovered by, in order: Without `--node-id`, the request is sent to any broker. Use `--node-id` to query a specific broker. +NOTE: This command was introduced in version v26.2.1. + == Usage [,bash] diff --git a/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-loggers-set.adoc b/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-loggers-set.adoc index 6c08911852..50b0f5e4aa 100644 --- a/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-loggers-set.adoc +++ b/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-loggers-set.adoc @@ -26,6 +26,8 @@ failure of enabling each logger is individually printed. Use `rpk cluster loggers list` to display available loggers. +NOTE: This command was introduced in version v26.2.1. + == Usage [,bash] 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 f89a3de1a6..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 @@ -9,6 +10,8 @@ :description: List and configure Redpanda broker loggers. List and configure Redpanda broker loggers. +NOTE: This command was introduced in version v26.2.1. + == Usage [,bash] @@ -44,3 +47,4 @@ rpk cluster loggers [flags] |=== // end::single-source[] +endif::[] diff --git a/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-maintenance-enable.adoc b/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-maintenance-enable.adoc index bccbd7d6d8..6271c238a4 100644 --- a/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-maintenance-enable.adoc +++ b/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-maintenance-enable.adoc @@ -1,12 +1,17 @@ = rpk cluster maintenance enable -:description: Enable maintenance mode on a broker. While in maintenance mode, the broker drains partition leadership to other brokers. +:description: Enable maintenance mode for a node. This command enables maintenance mode for the node with the specified ID. :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: Enable maintenance mode on a broker. While in maintenance mode, the broker drains partition leadership to other brokers. -Enable maintenance mode on a broker. While in maintenance mode, the broker drains partition leadership to other brokers. Use this command before performing broker upgrades or hardware maintenance. After maintenance is complete, run `rpk cluster maintenance disable ` to restore normal operation. +:description: Enable maintenance mode for a node. This command enables maintenance mode for the node with the specified ID. +Enable maintenance mode for a node. + +This command enables maintenance mode for the node with the specified ID. If a +node exists that is already in maintenance mode then an error will be returned. + +Use this command before performing broker upgrades or hardware maintenance. After maintenance is complete, run `rpk cluster maintenance disable ` to restore normal operation. == Usage diff --git a/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-maintenance-status.adoc b/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-maintenance-status.adoc index 5261a15875..8881652c6a 100644 --- a/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-maintenance-status.adoc +++ b/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-maintenance-status.adoc @@ -1,14 +1,49 @@ = rpk cluster maintenance status -:description: Report maintenance status. This command reports maintenance status for each broker in the cluster. +:description: Report maintenance status. This command reports maintenance status for each node in the 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: Report maintenance status. This command reports maintenance status for each broker in the cluster. +:description: Report maintenance status. This command reports maintenance status for each node in the cluster. Report maintenance status. -This command reports maintenance status for each broker in the cluster. The output is presented as a table with each row representing a broker in the cluster. The output can be used to monitor the progress of node draining. +This command reports maintenance status for each node in the cluster. The output +is presented as a table with each row representing a node in the cluster. The +output can be used to monitor the progress of node draining. + +[cols="1m,1a"] +|=== +|Value |Description + +|NODE-ID |ENABLED FINISHED ERRORS PARTITIONS ELIGIBLE TRANSFERRING FAILED +|1 |false false false 0 0 0 0 +|=== + +Field descriptions: + +[,text] +---- + NODE-ID: the node ID + ENABLED: true if the node is currently in maintenance mode (draining) + FINISHED: leadership draining has completed + ERRORS: errors have been encountered while draining + PARTITIONS: number of partitions whose leadership has moved + ELIGIBLE: number of partitions with leadership eligible to move +TRANSFERRING: current active number of leadership transfers + FAILED: number of failed leadership transfers +---- + +Notes: + +* When errors are present further information will be available in the logs + for the corresponding node. + +* Only partitions with more than one replica are eligible for leadership + transfer. + +* FINISHED, ERRORS, PARTITIONS, ELIGIBLE, TRANSFERRING, and FAILED are only + populated while a node is in maintenance mode (ENABLED=true). For example: @@ -50,7 +85,7 @@ rpk cluster maintenance status [flags] |=== |Value |Type |Description -|--format |string |Output format (`json`,`yaml`,`text`,`wide`,`help`). +|--format |string |Output format (`json`,`yaml`,`text`,`wide`,`help`). _(New in v26.2.1)_ |=== == Global flags 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 263685eb40..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,12 +1,31 @@ +ifndef::env-cloud[] = rpk cluster maintenance -:description: Manage cluster maintenance mode for performing rolling upgrades and other maintenance operations. +: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 // 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 cluster maintenance mode for performing rolling upgrades and other maintenance operations. -Manage cluster maintenance mode for performing rolling upgrades and other maintenance operations. +: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. +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. The +primary use of maintenance mode is to perform a rolling upgrade in which each +node is placed into maintenance mode prior to upgrading the node. + +Use the `enable` and `disable` subcommands to place a node into maintenance mode +or remove it, respectively. Only one node at a time may be in maintenance mode. + +When a node is placed into maintenance mode the following occurs: + +Leadership draining. All raft leadership is transferred to another eligible +node, and the node in maintenance mode rejects new leadership requests. By +transferring leadership off of the node in maintenance mode all client traffic +and requests are directed to other nodes minimizing disruption to client +workloads when the node is shutdown. + +Currently leadership is not transferred for partitions with one replica. == Usage @@ -25,10 +44,10 @@ rpk cluster maintenance [flags] |Disable maintenance mode on a broker, allowing it to resume normal operations and accept partition assignments. |xref:reference:rpk/rpk-cluster/rpk-cluster-maintenance-enable.adoc[`rpk cluster maintenance enable`] -|Enable maintenance mode on a broker. While in maintenance mode, the broker drains partition leadership to other brokers. +|Enable maintenance mode for a node. This command enables maintenance mode for the node with the specified ID. |xref:reference:rpk/rpk-cluster/rpk-cluster-maintenance-status.adoc[`rpk cluster maintenance status`] -|Report maintenance status. This command reports maintenance status for each broker in the cluster. +|Report maintenance status. This command reports maintenance status for each node in the cluster. |=== @@ -46,3 +65,4 @@ rpk cluster maintenance [flags] |=== // end::single-source[] +endif::[] diff --git a/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-partitions-balance.adoc b/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-partitions-balance.adoc index 6e871b6eb8..34759b8e6a 100644 --- a/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-partitions-balance.adoc +++ b/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-partitions-balance.adoc @@ -1,12 +1,40 @@ = rpk cluster partitions balance -:description: Trigger on-demand partition balancing to redistribute partitions evenly across brokers. Redpanda automatically balances partitions when it detects imbalance; run this command to trigger balancing manually. +:description: Triggers on-demand partition balancing. This command allows you to trigger on-demand partition balancing. :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: Trigger on-demand partition balancing to redistribute partitions evenly across brokers. Redpanda automatically balances partitions when it detects imbalance; run this command to trigger balancing manually. -Trigger on-demand partition balancing to redistribute partitions evenly across brokers. Redpanda automatically balances partitions when it detects imbalance; run this command to trigger balancing manually. +:description: Triggers on-demand partition balancing. This command allows you to trigger on-demand partition balancing. +Triggers on-demand partition balancing. + +This command allows you to trigger on-demand partition balancing. + +With Redpanda Community Edition, the partition count on each broker +can easily become uneven, which leads to data skewing. To distribute +partitions across brokers, you can run this command to trigger +on-demand partition balancing. + +With Redpanda Enterprise Edition, Continuous Data Balancing monitors +broker and rack availability, as well as disk usage, to avoid topic +hotspots. However, there are edge cases where users should manually +trigger partition balancing (such as a node becoming unavailable for +a prolonged time and rejoining the cluster thereafter). In such cases, +you should run this command to trigger partition balancing manually. + +After you run this command, monitor the balancer progress using: + +[,bash] +---- +rpk cluster partitions balancer-status +---- + +To see more detailed movement status, monitor the progress using: + +[,bash] +---- +rpk cluster partitions move-status +---- == Usage diff --git a/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-partitions-balancer-status.adoc b/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-partitions-balancer-status.adoc index f6b2d2bf8d..88506cb45f 100644 --- a/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-partitions-balancer-status.adoc +++ b/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-partitions-balancer-status.adoc @@ -72,7 +72,7 @@ investigation. A few areas to investigate: |=== |Value |Type |Description -|--format |string |Output format (`json`,`yaml`,`text`,`wide`,`help`). +|--format |string |Output format (`json`,`yaml`,`text`,`wide`,`help`). _(New in v26.2.1)_ |=== == Global flags 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 a9e56b004b..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,13 +1,24 @@ = rpk cluster partitions list -:description: List partitions in the cluster. This command lists the cluster-level metadata of all partitions, including current replica assignments on brokers and CPU cores for given topics. +: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 command lists the cluster-level metadata of all partitions, including current replica assignments on brokers and CPU cores for given topics. -List partitions in the cluster. This command lists the cluster-level metadata of all partitions, including current replica assignments on brokers and CPU cores for given topics. +: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. +It shows the current replica assignments on both brokers and CPU cores for given +topics. By default, it assumes the `kafka` namespace, but you can specify an +internal namespace using the `\{namespace}/` prefix. + +The REPLICA-CORE column displayed in the output table contains a list of +replicas assignments in the form of: -. + +If the DISABLED column contains a '-' value, then it means you are running this +command against a cluster that does not support the underlying API. == Enabled/Disabled @@ -20,6 +31,18 @@ Disabling a partition in Redpanda involves prohibiting any data consumption or p rpk cluster partitions list [flags] ---- +=== Enabled/disabled + +Disabling a partition in Redpanda involves prohibiting any data consumption or +production to and from it. All internal processes associated with the partition +are stopped, and it remains unloaded during system startup. This measure aims to +maintain cluster health by preventing issues caused by specific corrupted +partitions that may lead to Redpanda crashes. Although the data remains stored +on disk, Redpanda ceases interaction with the disabled partitions to ensure +system stability. + +You may disable/enable partition using `rpk cluster partitions enable/disable`. + == Aliases [,bash] diff --git a/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-partitions-move-cancel.adoc b/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-partitions-move-cancel.adoc index bd07ae9b09..2410dcde7c 100644 --- a/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-partitions-move-cancel.adoc +++ b/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-partitions-move-cancel.adoc @@ -47,7 +47,7 @@ rpk cluster partitions alter-cancel |=== |Value |Type |Description -|--format |string |Output format (`json`,`yaml`,`text`,`wide`,`help`). +|--format |string |Output format (`json`,`yaml`,`text`,`wide`,`help`). _(New in v26.2.1)_ |--no-confirm |bool |Disable confirmation prompt. |--node |int |ID of a specific node on which to cancel ongoing partition movements. |=== diff --git a/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-partitions-move-status.adoc b/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-partitions-move-status.adoc index 638a86f7b2..a8ff20f76c 100644 --- a/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-partitions-move-status.adoc +++ b/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-partitions-move-status.adoc @@ -63,7 +63,7 @@ rpk cluster partitions move-status [flags] |=== |Value |Type |Description -|--format |string |Output format (`json`,`yaml`,`text`,`wide`,`help`). +|--format |string |Output format (`json`,`yaml`,`text`,`wide`,`help`). _(New in v26.2.1)_ |-H, --human-readable |bool |Print the partition size in a human-readable form. |-p, --partition |stringSlice |Partitions to filter ongoing movements status (`repeatable`). |-a, --print-all |bool |Print internal states about movements for debugging. diff --git a/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-partitions-move.adoc b/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-partitions-move.adoc index ea84617ef3..b1b80e7a5b 100644 --- a/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-partitions-move.adoc +++ b/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-partitions-move.adoc @@ -13,6 +13,38 @@ This command changes replica assignments for given partitions. By default, it assumes the `kafka` namespace, but you can specify an internal namespace using the `\{namespace}/` prefix. +To move replicas, use the following syntax: + +[,bash] +---- +rpk cluster partitions move foo --partition 0:1,2,3 -p 1:2,3,4 +---- + +Here, the command assigns new replicas for partition 0 to brokers [1, 2, 3] and +for partition 1 to brokers [2, 3, 4] for the topic `foo`. + +You can also specify the core id with `-\{core_id}` where the new replicas +should be placed: + +[,bash] +---- +rpk cluster partitions move foo -p 0:1-0,2-0,3-0 +---- + +Here all new replicas [1, 2, 3] will be assigned on core 0 on the nodes. + +The command does not change a `core` assignment unless it is explicitly +specified. When a core is not specified for a new node, the command randomly +picks a core and assign a replica on the core. + +Topic arguments are optional. For more control, you can specify the topic name +in the "`--partition`" flag: + +[,bash] +---- +rpk cluster partitions move -p foo/0:1,2,3 -p kafka_internal/tx/0:1-0,2-0,3-0 +---- + == Usage [,bash] 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 0ecdccbacb..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 @@ -23,7 +24,7 @@ rpk cluster partitions [flags] |Command |Description |xref:reference:rpk/rpk-cluster/rpk-cluster-partitions-balance.adoc[`rpk cluster partitions balance`] -|Trigger on-demand partition balancing to redistribute partitions evenly across brokers. Redpanda automatically balances partitions when it detects imbalance; run this command to trigger balancing manually. +|Triggers on-demand partition balancing. This command allows you to trigger on-demand partition balancing. |xref:reference:rpk/rpk-cluster/rpk-cluster-partitions-balancer-status.adoc[`rpk cluster partitions balancer-status`] |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. @@ -35,7 +36,7 @@ rpk cluster partitions [flags] |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 command lists the cluster-level metadata of all partitions, including current replica assignments on 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. 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-import.adoc b/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-quotas-import.adoc index d5f7e4612c..c7435548a3 100644 --- a/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-quotas-import.adoc +++ b/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-quotas-import.adoc @@ -10,6 +10,26 @@ Use this command to import client quotas in the format produced by `rpk cluster The schema of the import string matches the schema from `rpk cluster quotas describe --format help`: +[,text] +---- +{ + quotas: []{ + entity: []{ + name: string + type: string + } + values: []{ + key: string + values: string + } + } +} +---- + +Use the `--no-confirm` flag if you wish to avoid the confirmation prompt. + +The schema of the import string matches the schema from `rpk cluster quotas describe --format help`: + [tabs] ====== YAML:: diff --git a/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-self-test-start.adoc b/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-self-test-start.adoc index 83d8b3705f..0b205bf252 100644 --- a/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-self-test-start.adoc +++ b/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-self-test-start.adoc @@ -1,37 +1,56 @@ = rpk cluster self-test start -:description: Starts one or more benchmark tests on one or more nodes of the cluster. +:description: Starts one or more benchmark tests on one or more nodes of the cluster. NOTE: Redpanda self-test runs benchmarks that consume significant system resources. :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: Starts one or more benchmark tests on one or more nodes of the cluster. +:description: Starts one or more benchmark tests on one or more nodes of the cluster. NOTE: Redpanda self-test runs benchmarks that consume significant system resources. Starts one or more benchmark tests on one or more nodes of the cluster. NOTE: Redpanda self-test runs benchmarks that consume significant system resources. Do not start self-test if large workloads are already running on the system. Available tests to run: -* *Disk tests* +* Disk tests: + +[,text] +---- ** Throughput test: 512 KB messages, sequential read/write -*** Uses larger request message sizes and deeper I/O queue depth to write/read more bytes in a shorter amount of time, at the cost of IOPS/latency. -** Latency test: 4 KB messages, sequential read/write -*** Uses smaller request message sizes and lower levels of parallelism to achieve higher IOPS and lower latency. -* *Network tests* + *** Uses a larger request message sizes and deeper I/O queue depth to write/read more bytes in a shorter amount of time, at the cost of IOPS/latency. +** Latency and io depth tests: 4 KB messages, sequential read/write, varying io depth + *** Uses small IO sizes and varying levels of parallelism to determine the relationship between io depth and IOPS + *** Includes one test without using dsync (fdatasync) on each write to establish the cost of dsync +** 16 KB test + *** One high io depth test at 16 KB to reflect performance at Redpanda's default chunk size +---- + +* Network tests: + +[,text] +---- ** Throughput test: 8192-bit messages -*** Unique pairs of Redpanda nodes each act as a client and a server. -*** The test pushes as much data over the wire, within the test parameters. -* *Cloud storage tests* -** Configuration/latency test: 1024-byte object. -** If cloud storage is enabled (xref:reference:properties/object-storage-properties.adoc#cloud_storage_enabled[`cloud_storage_enabled`]), a series of remote operations are performed: -+ --- -include::reference:partial$rpk-self-test-cloud-tests.adoc[] --- + *** Unique pairs of Redpanda nodes each act as a client and a server. + *** The test pushes as much data over the wire, within the test parameters. +---- + +* Cloud storage tests + ** Configuration/Latency test: 1024-byte object. + ** If cloud storage is enabled (`cloud_storage_enabled`), a series of remote operations are performed: + +[,text] +---- +*** Upload an object (a random buffer of 1024 bytes) to the cloud storage bucket/container. +*** List objects in the bucket/container. +*** Download the uploaded object from the bucket/container. +*** Download the uploaded object's metadata from the bucket/container. +*** Delete the uploaded object from the bucket/container. +*** Upload and then delete multiple objects (random buffers of 1024 bytes) at once from the bucket/container. +---- This command prompts users for confirmation (unless the flag `--no-confirm` is specified), then returns a test identifier ID, and runs the tests. -To view the test status, poll xref:reference:rpk/rpk-cluster/rpk-cluster-self-test-status.adoc[`rpk cluster self-test status`]. Once the tests end, the cached results will be available with `rpk cluster self-test status`. +To view the test status, poll `rpk cluster self-test status`. Once the tests end, the cached results will be available with `rpk cluster self-test status`. == Usage 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 3ae9155478..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 @@ -22,7 +23,7 @@ rpk cluster self-test [flags] |Command |Description |xref:reference:rpk/rpk-cluster/rpk-cluster-self-test-start.adoc[`rpk cluster self-test start`] -|Starts one or more benchmark tests on one or more nodes of the cluster. +|Starts one or more benchmark tests on one or more nodes of the cluster. NOTE: Redpanda self-test runs benchmarks that consume significant system resources. |xref:reference:rpk/rpk-cluster/rpk-cluster-self-test-status.adoc[`rpk cluster self-test status`] |Returns the status of the current running tests or the cached results of the last completed run. Use this command after invoking `self-test start` to determine the status of the jobs launched. @@ -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-mount.adoc b/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-storage-mount.adoc index c667fc4aa2..bd9cd1a8ae 100644 --- a/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-storage-mount.adoc +++ b/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-storage-mount.adoc @@ -1,16 +1,27 @@ = rpk cluster storage mount -:description: Mount a topic from Tiered Storage, making it available for reads. +:description: Mount a topic to the Redpanda cluster from Tiered Storage. This command mounts a topic in the Redpanda cluster using log segments stored in Tiered Storage. :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: Mount a topic from Tiered Storage, making it available for reads. +:description: Mount a topic to the Redpanda cluster from Tiered Storage. This command mounts a topic in the Redpanda cluster using log segments stored in Tiered Storage. ifdef::env-cloud[] NOTE: This command is only supported in BYOC and Dedicated clusters. endif::[] -Mount a topic from Tiered Storage, making it available for reads. +Mount a topic to the Redpanda cluster from Tiered Storage. + +This command mounts a topic in the Redpanda cluster using log segments stored +in Tiered Storage. The topic may be optionally renamed with the `--to` flag. + +Requirements: + +- 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. ifndef::env-cloud[] xref:manage:tiered-storage.adoc#enable-tiered-storage[Tiered Storage must be enabled]. 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-storage-unmount.adoc b/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-storage-unmount.adoc index 112a735b7b..bfd5401ef2 100644 --- a/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-storage-unmount.adoc +++ b/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-storage-unmount.adoc @@ -1,16 +1,33 @@ = rpk cluster storage unmount -:description: Unmount a topic, removing it from local storage while preserving data in Tiered Storage. +:description: Unmount a topic from the Redpanda cluster and secure it in Tiered Storage. This command performs an operation that: 1. :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: Unmount a topic, removing it from local storage while preserving data in Tiered Storage. +:description: Unmount a topic from the Redpanda cluster and secure it in Tiered Storage. This command performs an operation that: 1. ifdef::env-cloud[] NOTE: This command is only supported in BYOC and Dedicated clusters. endif::[] -Unmount a topic, removing it from local storage while preserving data in Tiered Storage. +Unmount a topic from the Redpanda cluster and secure it in 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 diff --git a/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-storage.adoc b/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-storage.adoc index 31aafbaec6..badd52a490 100644 --- a/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-storage.adoc +++ b/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-storage.adoc @@ -35,16 +35,18 @@ rpk cluster storage [flags] |List topics that are available to mount from object storage. This command displays topics that exist in object storage and can be mounted to your Redpanda cluster. |xref:reference:rpk/rpk-cluster/rpk-cluster-storage-mount.adoc[`rpk cluster storage mount`] -|Mount a topic from Tiered Storage, making it available for reads. +|Mount a topic to the Redpanda cluster from Tiered Storage. This command mounts a topic in the Redpanda cluster using log segments stored in Tiered Storage. +ifndef::env-cloud[] |xref:reference:rpk/rpk-cluster/rpk-cluster-storage-restore.adoc[`rpk cluster storage restore`] |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. +endif::[] |xref:reference:rpk/rpk-cluster/rpk-cluster-storage-status-mount.adoc[`rpk cluster storage status-mount`] |Check the status of a mount or unmount operation for a topic in Tiered Storage. |xref:reference:rpk/rpk-cluster/rpk-cluster-storage-unmount.adoc[`rpk cluster storage unmount`] -|Unmount a topic, removing it from local storage while preserving data in Tiered Storage. +|Unmount a topic from the Redpanda cluster and secure it in Tiered Storage. This command performs an operation that: 1. |=== diff --git a/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-upgrade-finalize.adoc b/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-upgrade-finalize.adoc index f108ea8380..76d3a38a3f 100644 --- a/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-upgrade-finalize.adoc +++ b/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-upgrade-finalize.adoc @@ -12,6 +12,8 @@ This commits the cluster to the version all brokers report, activating version-gated features and advancing the active cluster version. It is irreversible: the previous version is no longer available for downgrade. +NOTE: This command was introduced in version v26.2.1. + == Usage [,bash] diff --git a/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-upgrade-status.adoc b/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-upgrade-status.adoc index 28e9ec73b1..78788ab3e3 100644 --- a/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-upgrade-status.adoc +++ b/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-upgrade-status.adoc @@ -14,6 +14,8 @@ finalize, or upgrade in progress), the active and post-finalization logical versions, whether auto-finalization is enabled, and a per-broker breakdown of reported versions and liveness. +NOTE: This command was introduced in version v26.2.1. + == Usage [,bash] 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 44891d583f..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 @@ -10,6 +11,8 @@ 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. +NOTE: This command was introduced in version v26.2.1. + == Usage [,bash] @@ -45,3 +48,4 @@ rpk cluster upgrade [flags] |=== // end::single-source[] +endif::[] diff --git a/modules/reference/pages/rpk/rpk-cluster/rpk-cluster.adoc b/modules/reference/pages/rpk/rpk-cluster/rpk-cluster.adoc index 25c0eb5e12..87c92792b1 100644 --- a/modules/reference/pages/rpk/rpk-cluster/rpk-cluster.adoc +++ b/modules/reference/pages/rpk/rpk-cluster/rpk-cluster.adoc @@ -22,41 +22,55 @@ rpk cluster [flags] |=== |Command |Description +ifndef::env-cloud[] |xref:reference:rpk/rpk-cluster/rpk-cluster-brokers.adoc[`rpk cluster brokers`] |Manage Redpanda cluster brokers. +endif::[] |xref:reference:rpk/rpk-cluster/rpk-cluster-config.adoc[`rpk cluster config`] -|View and modify cluster-wide configuration properties. Changes take effect across all brokers. +|View and modify Redpanda cluster configuration properties. Modified properties are propagated immediately to all brokers. |xref:reference:rpk/rpk-cluster/rpk-cluster-connections.adoc[`rpk cluster connections`] |Manage and monitor cluster connections. +ifndef::env-cloud[] |xref:reference:rpk/rpk-cluster/rpk-cluster-health.adoc[`rpk cluster health`] -|Query cluster health and display the overall health status of the cluster. Redpanda collects health reports periodically from all nodes and aggregates them into a health overview. +|Queries cluster for health overview. Health overview is created based on the health reports collected periodically from all nodes in the cluster. +endif::[] |xref:reference:rpk/rpk-cluster/rpk-cluster-info.adoc[`rpk cluster info`] |Request broker metadata information. The Kafka protocol's metadata contains information about brokers, topics, and the cluster as a whole. +ifndef::env-cloud[] |xref:reference:rpk/rpk-cluster/rpk-cluster-license.adoc[`rpk cluster license`] |Manage cluster license. +endif::[] |xref:reference:rpk/rpk-cluster/rpk-cluster-logdirs.adoc[`rpk cluster logdirs`] |Describe log directories on Redpanda brokers. +ifndef::env-cloud[] |xref:reference:rpk/rpk-cluster/rpk-cluster-loggers.adoc[`rpk cluster loggers`] |List and configure Redpanda broker loggers. +endif::[] +ifndef::env-cloud[] |xref:reference:rpk/rpk-cluster/rpk-cluster-maintenance.adoc[`rpk cluster maintenance`] -|Manage cluster maintenance mode for performing rolling upgrades and other maintenance operations. +|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. +endif::[] +ifndef::env-cloud[] |xref:reference:rpk/rpk-cluster/rpk-cluster-partitions.adoc[`rpk cluster partitions`] |Manage cluster partitions. +endif::[] |xref:reference:rpk/rpk-cluster/rpk-cluster-quotas.adoc[`rpk cluster quotas`] |Manage Redpanda client quotas. +ifndef::env-cloud[] |xref:reference:rpk/rpk-cluster/rpk-cluster-self-test.adoc[`rpk cluster self-test`] |Start, stop and query runs of Redpanda self-test through the Admin API listener. +endif::[] |xref:reference:rpk/rpk-cluster/rpk-cluster-storage.adoc[`rpk cluster storage`] |Manage cluster storage, including mounting and unmounting topics from Tiered Storage. @@ -64,8 +78,10 @@ rpk cluster [flags] |xref:reference:rpk/rpk-cluster/rpk-cluster-txn.adoc[`rpk cluster txn`] |Information about transactions and transactional producers. Transactions allow producing, or consume-modifying-producing, to Redpanda. +ifndef::env-cloud[] |xref:reference:rpk/rpk-cluster/rpk-cluster-upgrade.adoc[`rpk cluster upgrade`] |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. +endif::[] |=== diff --git a/modules/reference/pages/rpk/rpk-connect/rpk-connect-echo.adoc b/modules/reference/pages/rpk/rpk-connect/rpk-connect-echo.adoc index 0739cad981..4c85d5816d 100644 --- a/modules/reference/pages/rpk/rpk-connect/rpk-connect-echo.adoc +++ b/modules/reference/pages/rpk/rpk-connect/rpk-connect-echo.adoc @@ -8,6 +8,14 @@ :description: Parse a config file and echo back a normalized version. This command is useful for sanity checking a config if it isn't behaving as expected, as it shows you a normalised version after environment variables have been resolved. Parse a config file and echo back a normalized version. This command is useful for sanity checking a config if it isn't behaving as expected, as it shows you a normalised version after environment variables have been resolved. +Examples: + +[,bash] +---- +rpk connect echo ./config.yaml | less +rpk connect echo --set 'input.generate.mapping=root.id = uuid_v4()' +---- + == Usage [,bash] diff --git a/modules/reference/pages/rpk/rpk-connect/rpk-connect-install.adoc b/modules/reference/pages/rpk/rpk-connect/rpk-connect-install.adoc index 598e3250cf..a8198c70f2 100644 --- a/modules/reference/pages/rpk/rpk-connect/rpk-connect-install.adoc +++ b/modules/reference/pages/rpk/rpk-connect/rpk-connect-install.adoc @@ -8,6 +8,8 @@ :description: Install Redpanda Connect. This command installs the latest version by default. Install Redpanda Connect. This command installs the latest version by default. Use the `--connect-version` flag to specify a version. +You may force the installation using the `--force` flag. + == Usage [,bash] diff --git a/modules/reference/pages/rpk/rpk-connect/rpk-connect-lint.adoc b/modules/reference/pages/rpk/rpk-connect/rpk-connect-lint.adoc index 72ce70be87..0ddc00d937 100644 --- a/modules/reference/pages/rpk/rpk-connect/rpk-connect-lint.adoc +++ b/modules/reference/pages/rpk/rpk-connect/rpk-connect-lint.adoc @@ -1,13 +1,15 @@ = rpk connect lint -:description: Check a Redpanda Connect configuration file for syntax errors and potential issues without running it. +:description: Check a Redpanda Connect configuration file for syntax errors and potential issues without running it. This command exits with status code 1 if any linting errors are detected. :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: Check a Redpanda Connect configuration file for syntax errors and potential issues without running it. +:description: Check a Redpanda Connect configuration file for syntax errors and potential issues without running it. This command exits with status code 1 if any linting errors are detected. Check a Redpanda Connect configuration file for syntax errors and potential issues without running it. +This command exits with status code 1 if any linting errors are detected. + == Usage [,bash] diff --git a/modules/reference/pages/rpk/rpk-connect/rpk-connect-list.adoc b/modules/reference/pages/rpk/rpk-connect/rpk-connect-list.adoc index 3b66e3f7fe..99ad7cf6d6 100644 --- a/modules/reference/pages/rpk/rpk-connect/rpk-connect-list.adoc +++ b/modules/reference/pages/rpk/rpk-connect/rpk-connect-list.adoc @@ -8,6 +8,10 @@ :description: List available Redpanda Connect components. Shows inputs, outputs, processors, caches, rate limits, buffers, metrics, and tracers that can be used in pipelines. List available Redpanda Connect components. Shows inputs, outputs, processors, caches, rate limits, buffers, metrics, and tracers that can be used in pipelines. +If any component types are explicitly listed, only types of those components are shown. + +When using `--format jsonschema` with `bloblang-functions` or `bloblang-methods`, you can optionally specify function or method names to retrieve metadata for only those items, for example `rpk connect list --format jsonschema bloblang-functions uuid_v4`. + == Usage [,bash] diff --git a/modules/reference/pages/rpk/rpk-connect/rpk-connect-run.adoc b/modules/reference/pages/rpk/rpk-connect/rpk-connect-run.adoc index 24ebe40303..e4e03edc55 100644 --- a/modules/reference/pages/rpk/rpk-connect/rpk-connect-run.adoc +++ b/modules/reference/pages/rpk/rpk-connect/rpk-connect-run.adoc @@ -8,28 +8,36 @@ :description: Run a Redpanda Connect pipeline from a configuration file. The pipeline streams data between inputs and outputs with optional processing. Run a Redpanda Connect pipeline from a configuration file. The pipeline streams data between inputs and outputs with optional processing. +== Usage + +[,bash] +---- +rpk connect run [flags] +---- + == Flags [cols="1m,1a,2a"] |=== |Value |Type |Description -|--log.level |string |Override the configured log level. Acceptable values: `off`, `error`, `warn`, `info`, `debug`, `trace`. -|--set |stringArray |Set a field (identified by a dot path) in the main configuration file. For example: `metrics.type=prometheus`. -|--resources, -r |stringArray |Pull in extra resources from a file, which can be referenced the same as resources defined in the main config. This supports glob patterns (requires quotes). -|--chilled |bool |Continue to execute a config containing linter errors (default: false). -|--watcher, -w |bool |EXPERIMENTAL: Watch config files for changes and automatically apply them (default: false). -|--env-file, -e |string |Import environment variables from a dotenv file. -|--templates, -t |stringArray |EXPERIMENTAL: Import Redpanda Connect templates. This supports glob patterns (requires quotes). +|--log.level |string |Logging level: `OFF`, `FATAL`, `ERROR`, `WARN`, `INFO`, `DEBUG`, `TRACE`, `ALL`. Default is `INFO`. +|-s, --set |strings |Override a configuration field. Format: `path=value`. Can be used multiple times. +|-r, --resources |strings |Additional resource configuration files containing caches, rate limits, or other shared components. +|--chilled |bool |Continue to execute a config containing linter errors. +|-w, --watcher |bool |EXPERIMENTAL: Watch config files for changes and automatically apply them. +|--secrets |strings |Attempt to load secrets from a provided URN. If more than one entry is specified they will be attempted in order until a value is found. Environment variable lookups are specified with the URN env:, which by default is the only entry. In order to disable all secret lookups specify a single entry of `none:`. +|--redpanda-license |string |Provide an explicit Redpanda License, which enables enterprise functionality. By default licenses found at the path `/etc/redpanda/redpanda.license` are applied. +|--chroot |string |Chroot into the provided directory after parsing configuration. Common /etc/ files are copied to the chroot directory, and the directory is made read-only. This flag is only supported on Linux. +|--chroot-passthrough |strings |Specify additional files to be copied into the chroot directory. This flag can be used multiple times. It is only supported when `--chroot` is used. +|--disable-telemetry |bool |Disable anonymous telemetry from being emitted by this Connect instance. +|--telemetry-deployment-type |string |Tags telemetry payloads with the deployment type. Expected values: self-hosted, byoc, serverless. When unset the field is omitted from the payload. +|--telemetry-tenant-id |string |Tags telemetry payloads with an opaque tenant identifier (typically the Redpanda Cloud organization ID for cloud-managed deployments). When unset the field is omitted from the payload. +|--rpc-plugins |strings |Plugins to load over the RPC interface. This flag should point to manifest files containing the plugin definitions. Globs are also supported. +|-e, --env-file |strings |Import environment variables from a dotenv file. +|-t, --templates |strings |EXPERIMENTAL: Import Redpanda Connect templates. This supports glob patterns (requires quotes). |=== -== Usage - -[,bash] ----- -rpk connect run [flags] ----- - == Global flags [cols="1m,1a,2a"] diff --git a/modules/reference/pages/rpk/rpk-connect/rpk-connect-template.adoc b/modules/reference/pages/rpk/rpk-connect/rpk-connect-template.adoc index 87e33513de..c91a38933a 100644 --- a/modules/reference/pages/rpk/rpk-connect/rpk-connect-template.adoc +++ b/modules/reference/pages/rpk/rpk-connect/rpk-connect-template.adoc @@ -8,6 +8,8 @@ :description: Work with Redpanda Connect templates. Templates allow you to define reusable configuration patterns. Work with Redpanda Connect templates. Templates allow you to define reusable configuration patterns. +WARNING: This subcommand, and templates in general, are experimental and subject to change outside of major version releases. + IMPORTANT: This subcommand, and templates in general, are experimental and subject to change outside of major version releases. == Usage diff --git a/modules/reference/pages/rpk/rpk-connect/rpk-connect-test.adoc b/modules/reference/pages/rpk/rpk-connect/rpk-connect-test.adoc index b6d80590b2..5820597686 100644 --- a/modules/reference/pages/rpk/rpk-connect/rpk-connect-test.adoc +++ b/modules/reference/pages/rpk/rpk-connect/rpk-connect-test.adoc @@ -1,13 +1,15 @@ = rpk connect test -:description: Run unit tests defined in Redpanda Connect configuration files to verify pipeline behavior. +:description: Run unit tests defined in Redpanda Connect configuration files to verify pipeline behavior. If one or more tests fail, the command reports the errors and exits with status code 1. :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: Run unit tests defined in Redpanda Connect configuration files to verify pipeline behavior. +:description: Run unit tests defined in Redpanda Connect configuration files to verify pipeline behavior. If one or more tests fail, the command reports the errors and exits with status code 1. Run unit tests defined in Redpanda Connect configuration files to verify pipeline behavior. +If one or more tests fail, the command reports the errors and exits with status code 1. + == Usage [,bash] diff --git a/modules/reference/pages/rpk/rpk-connect/rpk-connect.adoc b/modules/reference/pages/rpk/rpk-connect/rpk-connect.adoc index e7a0e84a2c..f68182278b 100644 --- a/modules/reference/pages/rpk/rpk-connect/rpk-connect.adoc +++ b/modules/reference/pages/rpk/rpk-connect/rpk-connect.adoc @@ -45,7 +45,7 @@ rpk connect [flags] |Install Redpanda Connect. This command installs the latest version by default. |xref:reference:rpk/rpk-connect/rpk-connect-lint.adoc[`rpk connect lint`] -|Check a Redpanda Connect configuration file for syntax errors and potential issues without running it. +|Check a Redpanda Connect configuration file for syntax errors and potential issues without running it. This command exits with status code 1 if any linting errors are detected. |xref:reference:rpk/rpk-connect/rpk-connect-list.adoc[`rpk connect list`] |List available Redpanda Connect components. Shows inputs, outputs, processors, caches, rate limits, buffers, metrics, and tracers that can be used in pipelines. @@ -66,7 +66,7 @@ rpk connect [flags] |Work with Redpanda Connect templates. Templates allow you to define reusable configuration patterns. |xref:reference:rpk/rpk-connect/rpk-connect-test.adoc[`rpk connect test`] -|Run unit tests defined in Redpanda Connect configuration files to verify pipeline behavior. +|Run unit tests defined in Redpanda Connect configuration files to verify pipeline behavior. If one or more tests fail, the command reports the errors and exits with status code 1. |xref:reference:rpk/rpk-connect/rpk-connect-uninstall.adoc[`rpk connect uninstall`] |Uninstall the Redpanda Connect plugin. diff --git a/modules/reference/pages/rpk/rpk-debug/rpk-debug-remote-bundle-download.adoc b/modules/reference/pages/rpk/rpk-debug/rpk-debug-remote-bundle-download.adoc index 850fa8bd47..ddb6511e02 100644 --- a/modules/reference/pages/rpk/rpk-debug/rpk-debug-remote-bundle-download.adoc +++ b/modules/reference/pages/rpk/rpk-debug/rpk-debug-remote-bundle-download.adoc @@ -1,13 +1,17 @@ = rpk debug remote-bundle download -:description: Download the debug bundle from a remote cluster configured in flags, environment variables, or your rpk profile. +:description: pass:q[Download the debug bundle from a remote cluster configured in flags, environment variables, or your rpk profile. Use the `--job-id` flag to only download the debug bundle with the given job ID.] :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: Download the debug bundle from a remote cluster configured in flags, environment variables, or your rpk profile. +:description: pass:q[Download the debug bundle from a remote cluster configured in flags, environment variables, or your rpk profile. Use the `--job-id` flag to only download the debug bundle with the given job ID.] Download the debug bundle from a remote cluster configured in flags, environment variables, or your rpk profile. +Use the `--job-id` flag to only download the debug bundle with the given job ID. + +Use the `--no-confirm` flag to avoid the confirmation prompt. + For details, see xref:troubleshoot:debug-bundle/generate/index.adoc[Generate debug bundles]. == Usage diff --git a/modules/reference/pages/rpk/rpk-debug/rpk-debug-remote-bundle.adoc b/modules/reference/pages/rpk/rpk-debug/rpk-debug-remote-bundle.adoc index 43fe74ce32..2e12c1f426 100644 --- a/modules/reference/pages/rpk/rpk-debug/rpk-debug-remote-bundle.adoc +++ b/modules/reference/pages/rpk/rpk-debug/rpk-debug-remote-bundle.adoc @@ -28,7 +28,7 @@ rpk debug remote-bundle [flags] |Cancel a remote bundle execution. This command cancels the debug collection process in a remote cluster that you configured in flags, environment variables, or your rpk profile. |xref:reference:rpk/rpk-debug/rpk-debug-remote-bundle-download.adoc[`rpk debug remote-bundle download`] -|Download the debug bundle from a remote cluster configured in flags, environment variables, or your rpk profile. +|Download the debug bundle from a remote cluster configured in flags, environment variables, or your rpk profile. Use the `--job-id` flag to only download the debug bundle with the given job ID. |xref:reference:rpk/rpk-debug/rpk-debug-remote-bundle-start.adoc[`rpk debug remote-bundle start`] |Start a remote debug bundle collection in your cluster. This command starts the debug collection process in a remote cluster that you configured in flags, environment variables, or your rpk profile. diff --git a/modules/reference/pages/rpk/rpk-generate/rpk-generate-app.adoc b/modules/reference/pages/rpk/rpk-generate/rpk-generate-app.adoc index 2c5fb7603a..68005aad38 100644 --- a/modules/reference/pages/rpk/rpk-generate/rpk-generate-app.adoc +++ b/modules/reference/pages/rpk/rpk-generate/rpk-generate-app.adoc @@ -1,12 +1,30 @@ = rpk generate app -:description: Generate application code to connect to Redpanda. Creates starter code for various programming languages. +:description: 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. :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 application code to connect to Redpanda. Creates starter code for various programming languages. -Generate application code to connect to Redpanda. Creates starter code for various programming languages. +:description: 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. +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. Its goal is to get you producing and +consuming quickly with Redpanda in a language that is familiar to you. + +By default, this will run interactively, prompting you to select a language and +a user with which to create your application. To use this without interactivity, +specify how you would like your application to be created using flags. + +The `--language` option allows you to specify the language. The default is `go`. Available language: `go`. + +The `--new-sasl-credentials` : allows you to generate a new SASL +user with admin ACLs. If you don't want to use your current profile user nor +create a new one, you may use `--no-user` flag to generate the starter app without +the user. + +If you are having trouble connecting to your cluster, you can use `-X` +admin.hosts=comma,`delimited`,host:ports to pass a specific admin api address. ifdef::env-cloud[] NOTE: This command is only supported in Serverless clusters. @@ -23,15 +41,33 @@ endif::[] rpk generate app [flags] ---- -=== Supported languages +== Examples + +This section provides examples of how to use `rpk generate app`. + +Generate an app with interactive prompts: +[,bash] +---- +rpk generate app +---- + +Generate an app in a specified language with the existing SASL user: +[,bash] +---- +rpk generate app --language +---- -The following programming languages are supported: +Generate an app in the specified language with a new SASL user: +[,bash] +---- +rpk generate app -l --new-sasl-credentials : +---- -* Python -* Go -* Java -* JavaScript/Node.js -* Rust +Generate an app in the `tmp` dir, but take no action on the user: +[,bash] +---- +rpk generate app -l --no-user --output /tmp +---- == Flags 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 d80c312187..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,12 +1,36 @@ = rpk generate grafana-dashboard -:description: Generate Grafana dashboards for Redpanda metrics. Use this command to generate sample Grafana dashboards that can be imported into a Grafana or Grafana Cloud instance. +: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 that can be imported into a Grafana or Grafana Cloud instance. -Generate Grafana dashboards for Redpanda metrics. Use this command to generate sample Grafana dashboards that can be imported into a Grafana or Grafana Cloud instance. +: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. +These dashboards can be imported into a Grafana or Grafana Cloud instance. + +To select a specific dashboard, use the `--dashboard` flag followed by the +dashboard name. For example, to generate the operations dashboard, run: + +[,bash] +---- +rpk generate grafana-dashboard --dashboard operations +---- + +The selected dashboard will be downloaded from our GitHub repository: + +[,text] +---- +https://github.com/redpanda-data/observability +---- + +Note that the legacy dashboard is still available as an option, and will not be +downloaded from github. Instead, the dashboard will be generated based on the +metrics endpoint used. + +To see a list of all available dashboards, use the `--dashboard help` flag. ifdef::env-cloud[] |serverless |Monitoring dashboard for Redpanda Serverless clusters. 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 f0bc859a0d..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,12 +1,23 @@ +ifndef::env-cloud[] = rpk generate license -:description: Generate a trial license for a 30-day Redpanda Enterprise Edition trial. The license is saved in your working directory or the specified path. +: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 for a 30-day Redpanda Enterprise Edition trial. The license is saved in your working directory or the specified path. -Generate a trial license for a 30-day Redpanda Enterprise Edition trial. The license is saved in your working directory or the specified path. +: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 +Edition. + +To get a permanent license, contact us: https://www.redpanda.com/contact. + +The license is saved in your working directory or the specified path, based +on the `--path` flag. + +To apply the license to your cluster, use the `--apply` flag. == Usage @@ -44,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 9529e67709..105a53805b 100644 --- a/modules/reference/pages/rpk/rpk-generate/rpk-generate.adoc +++ b/modules/reference/pages/rpk/rpk-generate/rpk-generate.adoc @@ -23,16 +23,20 @@ rpk generate [template] [flags] |Command |Description |xref:reference:rpk/rpk-generate/rpk-generate-app.adoc[`rpk generate app`] -|Generate application code to connect to Redpanda. Creates starter code for various programming languages. +|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 that 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. 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 for a 30-day Redpanda Enterprise Edition trial. The license is saved in your working directory or the specified path. +|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[] |xref:reference:rpk/rpk-generate/rpk-generate-prometheus-config.adoc[`rpk generate prometheus-config`] |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. +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 Bash autocompletion relies on the `bash-completion` package. diff --git a/modules/reference/pages/rpk/rpk-group/rpk-group-delete.adoc b/modules/reference/pages/rpk/rpk-group/rpk-group-delete.adoc index 668054f630..871604ae43 100644 --- a/modules/reference/pages/rpk/rpk-group/rpk-group-delete.adoc +++ b/modules/reference/pages/rpk/rpk-group/rpk-group-delete.adoc @@ -1,12 +1,29 @@ = rpk group delete -:description: Delete one or more consumer groups from Redpanda brokers. A group must have no active members to be deleted. +:description: Delete groups from brokers. Older versions of the Kafka protocol included a retention_millis field in offset commit requests. :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: Delete one or more consumer groups from Redpanda brokers. A group must have no active members to be deleted. -Delete one or more consumer groups from Redpanda brokers. A group must have no active members to be deleted. +:description: Delete groups from brokers. Older versions of the Kafka protocol included a retention_millis field in offset commit requests. +Delete groups from brokers. + +Older versions of the Kafka protocol included a retention_millis field in +offset commit requests. Group commits persisted for this retention and then +eventually expired. Once all commits for a group expired, the group would be +considered deleted. + +The retention field was removed because it proved problematic for infrequently +committing consumers: the offsets could be expired for a group that was still +active. If clients use new enough versions of OffsetCommit (versions that have +removed the retention field), brokers expire offsets only when the group is +empty for offset.retention.minutes. Redpanda does not currently support that +configuration (see https://github.com/redpanda-data/redpanda/issues/2904[#2904]), meaning offsets for empty groups expire only when +they are explicitly deleted. + +You may want to delete groups to clean up offsets sooner than when they +automatically are cleaned up, such as when you create temporary groups for +quick investigation or testing. This command helps you do that. ifndef::env-cloud[] + @@ -31,7 +48,7 @@ rpk group delete [flags] |=== |Value |Type |Description -|--format |string |Output format (`json`,`yaml`,`text`,`wide`,`help`). +|--format |string |Output format (`json`,`yaml`,`text`,`wide`,`help`). _(New in v26.2.1)_ |=== == Global flags diff --git a/modules/reference/pages/rpk/rpk-group/rpk-group-describe.adoc b/modules/reference/pages/rpk/rpk-group/rpk-group-describe.adoc index 5b34616221..267a6f4d7a 100644 --- a/modules/reference/pages/rpk/rpk-group/rpk-group-describe.adoc +++ b/modules/reference/pages/rpk/rpk-group/rpk-group-describe.adoc @@ -1,12 +1,20 @@ = rpk group describe -:description: Display detailed information about a consumer group, including member assignments, lag per partition, and group state. +:description: Describe group offset status & lag. This command describes group members, calculates their lag, and prints detailed information about the members. :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: Display detailed information about a consumer group, including member assignments, lag per partition, and group state. -Display detailed information about a consumer group, including member assignments, lag per partition, and group state. +:description: Describe group offset status & lag. This command describes group members, calculates their lag, and prints detailed information about the members. +Describe group offset status & lag. + +This command describes group members, calculates their lag, and prints detailed +information about the members. COORDINATOR-PARTITION indicates the partition in +the __consumer_offsets topic responsible for the group, if topic details are +available; run with –verbose for more info if it is missing. + +The `--regex` flag (`-r`) parses arguments as regular expressions +and describes groups that match any of the expressions. == Usage diff --git a/modules/reference/pages/rpk/rpk-group/rpk-group-list.adoc b/modules/reference/pages/rpk/rpk-group/rpk-group-list.adoc index 432c372229..00c3670608 100644 --- a/modules/reference/pages/rpk/rpk-group/rpk-group-list.adoc +++ b/modules/reference/pages/rpk/rpk-group/rpk-group-list.adoc @@ -41,7 +41,7 @@ rpk group ls |=== |Value |Type |Description -|--format |string |Output format (`json`,`yaml`,`text`,`wide`,`help`). +|--format |string |Output format (`json`,`yaml`,`text`,`wide`,`help`). _(New in v26.2.1)_ |-s, --states |stringSlice |Comma-separated list of group states to filter for. Possible states: [PreparingRebalance, CompletingRebalance, Stable, Dead, Empty]. |=== diff --git a/modules/reference/pages/rpk/rpk-group/rpk-group-offset-delete.adoc b/modules/reference/pages/rpk/rpk-group/rpk-group-offset-delete.adoc index 8c0f9ce3bc..57529c1e0a 100644 --- a/modules/reference/pages/rpk/rpk-group/rpk-group-offset-delete.adoc +++ b/modules/reference/pages/rpk/rpk-group/rpk-group-offset-delete.adoc @@ -1,12 +1,29 @@ = rpk group offset-delete -:description: Forcefully delete offsets for a Kafka group. +:description: Forcefully delete offsets for a kafka group. The broker will only allow the request to succeed if the group is in a dead state (no subscriptions) or there are no subscriptions for offsets for topic/partitions requested to be deleted. :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: Forcefully delete offsets for a Kafka group. -Forcefully delete offsets for a Kafka group. +:description: Forcefully delete offsets for a kafka group. The broker will only allow the request to succeed if the group is in a dead state (no subscriptions) or there are no subscriptions for offsets for topic/partitions requested to be deleted. +Forcefully delete offsets for a kafka group. + +The broker will only allow the request to succeed if the group is in a dead +state (no subscriptions) or there are no subscriptions for offsets for +topic/partitions requested to be deleted. + +Use either the `--from-file` or the `--topic` option. They are mutually exclusive. +To indicate which topics or topic partitions you'd like to remove offsets from use +the `--topic` (`-t`) flag, followed by a comma separated list of partition ids. Supplying +no list will delete all offsets for all partitions for a given topic. + +You may also provide a text file to indicate topic/partition tuples. Use the +`--from-file` flag for this option. The file must contain lines of topic/partitions +separated by a tab or space. Example: + +topic_a 0 +topic_a 1 +topic_b 0. == Usage @@ -21,7 +38,7 @@ rpk group offset-delete --from-file FILE --topic foo:0,1,2 [flags] |=== |Value |Type |Description -|--format |string |Output format (`json`,`yaml`,`text`,`wide`,`help`). +|--format |string |Output format (`json`,`yaml`,`text`,`wide`,`help`). _(New in v26.2.1)_ |-f, --from-file |string |Path to a file containing topic/partition tuples for which to delete offsets. |-t, --topic |stringArray |topic:partition_id (repeatable; for example, `-t` foo:0,1,2). |=== diff --git a/modules/reference/pages/rpk/rpk-group/rpk-group-seek.adoc b/modules/reference/pages/rpk/rpk-group/rpk-group-seek.adoc index 4016f96379..bd66683935 100644 --- a/modules/reference/pages/rpk/rpk-group/rpk-group-seek.adoc +++ b/modules/reference/pages/rpk/rpk-group/rpk-group-seek.adoc @@ -8,24 +8,41 @@ :description: Modify a group's current offsets. This command allows you to modify a group's offsets. Modify a group's current offsets. -This command allows you to modify a group's offsets. Sometimes, you may need to rewind a group if you had a mistaken deploy, or fast-forward a group if it is falling behind. - -The `--to` option allows you to seek to a specific offset, or to the start or end of partitions. The offset can be at any timestamp precision (seconds since epoch, millis since epoch, etc). The start and end options are self explanatory. If any partition is deleted and recreated (a la `rpk topic delete; rpk topic create`), the prior commits are wiped out and the group will be committed to the earliest offset (similar to if specifying start). - -The `--to-group` option allows you to seek to commits that are in another group. This is a merging operation: if g1 is consuming topics A and B, and g2 is consuming only topic B, `rpk group seek g1 --to-group g2` will update g1's commits for topic B only. The `--topics` flag can be used to further narrow which topics are updated. Unlike `--to`, all non-filtered topics are committed, even topics not yet being consumed, meaning `--allow-new-topics` is not needed. - -The `--to-file` option allows to seek to offsets specified in a text file with the following format: +This command allows you to modify a group's offsets. Sometimes, you may need to +rewind a group if you had a mistaken deploy, or fast-forward a group if it is +falling behind on messages that can be skipped. + +The `--to` option allows you to seek to the start of partitions, end of +partitions, or after a specific timestamp. The default is to seek any topic +previously committed. Using `--topics` allows to you set commits for only the +specified topics; all other commits will remain untouched. Topics with no +commits will not be committed unless allowed with `--allow-new-topics`. + +The `--to-group` option allows you to seek to commits that are in another group. +This is a merging operation: if g1 is consuming topics A and B, and g2 is +consuming only topic B, `rpk group seek g1 --to-group g2` will update g1's +commits for topic B only. The `--topics` flag can be used to further narrow which +topics are updated. Unlike `--to`, all non-filtered topics are committed, even +topics not yet being consumed, meaning `--allow-new-topics` is not needed. + +The `--to-file` option allows to seek to offsets specified in a text file with +the following format: [,text] ---- - - +[TOPIC] [PARTITION] [OFFSET] +[TOPIC] [PARTITION] [OFFSET] ... ---- -Each line contains the topic, the partition, and the offset to seek to. As with the prior options, `--topics` allows filtering which topics are updated. Similar to `--to-group`, all non-filtered topics are committed, even topics not yet being consumed, meaning `--allow-new-topics` is not needed. +Each line contains the topic, the partition, and the offset to seek to. As with +the prior options, `--topics` allows filtering which topics are updated. Similar +to `--to-group`, all non-filtered topics are committed, even topics not yet being +consumed, meaning `--allow-new-topics` is not needed. -The `--to`, `--to-group`, and `--to-file` options are mutually exclusive. If you are not authorized to describe or read some topics used in a group, you will not be able to modify offsets for those topics. +The `--to`, `--to-group`, and `--to-file` options are mutually exclusive. If you are +not authorized to describe or read some topics used in a group, you will not be +able to modify offsets for those topics. == Usage @@ -87,7 +104,7 @@ rpk group seek G --to start --topics foo --allow-new-topics |Value |Type |Description |--allow-new-topics |bool |Allow seeking to new topics not currently consumed (implied with `--to-group` or `--to-file`). -|--format |string |Output format (`json`,`yaml`,`text`,`wide`,`help`). +|--format |string |Output format (`json`,`yaml`,`text`,`wide`,`help`). _(New in v26.2.1)_ |--to |string |Target position to seek to. Use `start` (or `beginning`), `end` (or `latest`), a specific offset number, or a Unix timestamp prefixed with `@` (for example, `@1622505600`). |--to-file |string |Path to a text file specifying offsets per partition. Each line must contain the topic, partition, and offset separated by a space or tab. |--to-group |string |Seek to the commits of another group. diff --git a/modules/reference/pages/rpk/rpk-group/rpk-group.adoc b/modules/reference/pages/rpk/rpk-group/rpk-group.adoc index 5b8e92f318..b3c3f9ad8a 100644 --- a/modules/reference/pages/rpk/rpk-group/rpk-group.adoc +++ b/modules/reference/pages/rpk/rpk-group/rpk-group.adoc @@ -1,13 +1,51 @@ = rpk group -:description: Manage Kafka consumer groups, including listing groups, viewing lag, and resetting offsets. +:description: Describe, list, and delete consumer groups and manage their offsets. Consumer groups allow you to horizontally scale consuming from topics. :page-aliases: reference:rpk/rpk-group.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: Manage Kafka consumer groups, including listing groups, viewing lag, and resetting offsets. -Manage Kafka consumer groups, including listing groups, viewing lag, and resetting offsets. +:description: Describe, list, and delete consumer groups and manage their offsets. Consumer groups allow you to horizontally scale consuming from topics. +Describe, list, and delete consumer groups and manage their offsets. + +Consumer groups allow you to horizontally scale consuming from topics. A +non-group consumer consumes all records from all partitions you assign it. In +contrast, consumer groups allow many consumers to coordinate and divide work. +If you have two members in a group consuming topics A and B, each with three +partitions, then both members consume three partitions. If you add another +member to the group, then each of the three members will consume two +partitions. This allows you to horizontally scale consuming of topics. + +The unit of scaling is a single partition. If you add more consumers to a group +than there are total partitions to consume, then some consumers will be +idle. More commonly, you have many more partitions than consumer group members +and each member consumes a chunk of available partitions. One scenario where +you may want more members than partitions is if you want active standby's to +take over load immediately if any consuming member dies. + +How group members divide work is entirely client driven (the "partition +assignment strategy" or `balancer` depending on the client). Brokers know +nothing about how consumers are assigning partitions. A broker's role in group +consuming is to choose which member is the leader of a group, forward that +member's assignment to every other member, and ensure all members are alive +through heartbeats. + +Consumers periodically commit their progress when consuming partitions. Through +these commits, you can monitor just how far behind a consumer is from the +latest messages in a partition. This is called `lag`. Large lag implies that +the client is having problems, which could be from the server being too slow, +or the client being oversubscribed in the number of partitions it is consuming, +or the server being in a bad state that requires restarting or removing from +the server pool, and so on. + +You can manually manage offsets for a group, which allows you to rewind or +forward commits. If you notice that a recent deploy of your consumers had a +bug, you may want to stop all members, rewind the commits to before the latest +deploy, and restart the members with a patch. + +This command allows you to list all groups, describe a group (to view the +members and their lag), and manage offsets. == Usage @@ -30,16 +68,16 @@ rpk g |Command |Description |xref:reference:rpk/rpk-group/rpk-group-delete.adoc[`rpk group delete`] -|Delete one or more consumer groups from Redpanda brokers. A group must have no active members to be deleted. +|Delete groups from brokers. Older versions of the Kafka protocol included a retention_millis field in offset commit requests. |xref:reference:rpk/rpk-group/rpk-group-describe.adoc[`rpk group describe`] -|Display detailed information about a consumer group, including member assignments, lag per partition, and group state. +|Describe group offset status & lag. This command describes group members, calculates their lag, and prints detailed information about the members. |xref:reference:rpk/rpk-group/rpk-group-list.adoc[`rpk group list`] |List all groups. This command lists all groups currently known to Redpanda, including empty groups that have not yet expired. |xref:reference:rpk/rpk-group/rpk-group-offset-delete.adoc[`rpk group offset-delete`] -|Forcefully delete offsets for a Kafka group. +|Forcefully delete offsets for a kafka group. The broker will only allow the request to succeed if the group is in a dead state (no subscriptions) or there are no subscriptions for offsets for topic/partitions requested to be deleted. |xref:reference:rpk/rpk-group/rpk-group-seek.adoc[`rpk group seek`] |Modify a group's current offsets. This command allows you to modify a group's offsets. diff --git a/modules/reference/pages/rpk/rpk-k8s/rpk-k8s-install.adoc b/modules/reference/pages/rpk/rpk-k8s/rpk-k8s-install.adoc index 67d0b3cf7b..1f6b0c4563 100644 --- a/modules/reference/pages/rpk/rpk-k8s/rpk-k8s-install.adoc +++ b/modules/reference/pages/rpk/rpk-k8s/rpk-k8s-install.adoc @@ -14,6 +14,8 @@ Alternatively, you may specify a version using the `--plugin-version` flag. You may force the installation using the `--force` flag. +NOTE: This command was introduced in k8s version 26.2.1. + == Usage [,bash] diff --git a/modules/reference/pages/rpk/rpk-k8s/rpk-k8s-multicluster-bootstrap.adoc b/modules/reference/pages/rpk/rpk-k8s/rpk-k8s-multicluster-bootstrap.adoc index 886d93e730..4b2b0f8570 100644 --- a/modules/reference/pages/rpk/rpk-k8s/rpk-k8s-multicluster-bootstrap.adoc +++ b/modules/reference/pages/rpk/rpk-k8s/rpk-k8s-multicluster-bootstrap.adoc @@ -53,6 +53,8 @@ cluster; cluster names are derived from the override keys. ServiceAccount, SA token, and kubeconfig cache Secrets are not emitted because the operator regenerates them at runtime. +NOTE: This command was introduced in k8s version 26.2.1. + == Usage [,bash] diff --git a/modules/reference/pages/rpk/rpk-k8s/rpk-k8s-multicluster-bundle.adoc b/modules/reference/pages/rpk/rpk-k8s/rpk-k8s-multicluster-bundle.adoc index b6fe8e10c9..6db551ee4a 100644 --- a/modules/reference/pages/rpk/rpk-k8s/rpk-k8s-multicluster-bundle.adoc +++ b/modules/reference/pages/rpk/rpk-k8s/rpk-k8s-multicluster-bundle.adoc @@ -17,6 +17,8 @@ raft-bootstrap flow on the starting cluster, so the tool stays useful when one of the peer clusters is down. Pass multiple `--context` flags to bypass discovery and diagnose exactly that set. +NOTE: This command was introduced in k8s version 26.2.1. + == Usage [,bash] diff --git a/modules/reference/pages/rpk/rpk-k8s/rpk-k8s-multicluster-status.adoc b/modules/reference/pages/rpk/rpk-k8s/rpk-k8s-multicluster-status.adoc index 59e9edf8d9..840e64f99c 100644 --- a/modules/reference/pages/rpk/rpk-k8s/rpk-k8s-multicluster-status.adoc +++ b/modules/reference/pages/rpk/rpk-k8s/rpk-k8s-multicluster-status.adoc @@ -14,6 +14,8 @@ Connects to each specified Kubernetes context, finds the multicluster operator pod, port-forwards to its gRPC transport, and queries raft status. Also inspects Deployment configuration and TLS secrets for correctness. +NOTE: This command was introduced in k8s version 26.2.1. + == Usage [,bash] diff --git a/modules/reference/pages/rpk/rpk-k8s/rpk-k8s-multicluster.adoc b/modules/reference/pages/rpk/rpk-k8s/rpk-k8s-multicluster.adoc index 386e293358..4b5b1aae2b 100644 --- a/modules/reference/pages/rpk/rpk-k8s/rpk-k8s-multicluster.adoc +++ b/modules/reference/pages/rpk/rpk-k8s/rpk-k8s-multicluster.adoc @@ -12,6 +12,8 @@ across multiple Kubernetes clusters. One operator runs in each Kubernetes cluster, and the operators coordinate through Raft consensus to manage the Stretch Cluster as a single unit. +NOTE: This command was introduced in k8s version 26.2.1. + == Usage [,bash] diff --git a/modules/reference/pages/rpk/rpk-k8s/rpk-k8s-uninstall.adoc b/modules/reference/pages/rpk/rpk-k8s/rpk-k8s-uninstall.adoc index 1dfdf6fb9d..e346b516d9 100644 --- a/modules/reference/pages/rpk/rpk-k8s/rpk-k8s-uninstall.adoc +++ b/modules/reference/pages/rpk/rpk-k8s/rpk-k8s-uninstall.adoc @@ -12,6 +12,8 @@ By default this removes only the` rpk-managed` plugin binary (`~/.local/bin/.rpk If the resolved plugin shadows other k8s plugin copies elsewhere on your PATH, those are left in place unless you pass `--include-shadowed`. +NOTE: This command was introduced in k8s version 26.2.1. + == Usage [,bash] diff --git a/modules/reference/pages/rpk/rpk-k8s/rpk-k8s-upgrade.adoc b/modules/reference/pages/rpk/rpk-k8s/rpk-k8s-upgrade.adoc index 8d53379259..57acafa7c4 100644 --- a/modules/reference/pages/rpk/rpk-k8s/rpk-k8s-upgrade.adoc +++ b/modules/reference/pages/rpk/rpk-k8s/rpk-k8s-upgrade.adoc @@ -8,6 +8,8 @@ :description: Upgrade to the latest Redpanda Kubernetes plugin version. Upgrade to the latest Redpanda Kubernetes plugin version. +NOTE: This command was introduced in k8s version 26.2.1. + == Usage [,bash] diff --git a/modules/reference/pages/rpk/rpk-k8s/rpk-k8s-version.adoc b/modules/reference/pages/rpk/rpk-k8s/rpk-k8s-version.adoc index 85f822eadc..d8f825dd19 100644 --- a/modules/reference/pages/rpk/rpk-k8s/rpk-k8s-version.adoc +++ b/modules/reference/pages/rpk/rpk-k8s/rpk-k8s-version.adoc @@ -8,6 +8,8 @@ :description: Print build information. Print build information. +NOTE: This command was introduced in k8s version 26.2.1. + == Usage [,bash] diff --git a/modules/reference/pages/rpk/rpk-k8s/rpk-k8s.adoc b/modules/reference/pages/rpk/rpk-k8s/rpk-k8s.adoc index c6c6fbac0a..68b70ca03e 100644 --- a/modules/reference/pages/rpk/rpk-k8s/rpk-k8s.adoc +++ b/modules/reference/pages/rpk/rpk-k8s/rpk-k8s.adoc @@ -8,6 +8,8 @@ :description: Interact with Redpanda clusters running on Kubernetes. Interact with Redpanda clusters running on Kubernetes. +NOTE: This command was introduced in k8s version 26.2.1. + == Usage [,bash] diff --git a/modules/reference/pages/rpk/rpk-plugin/rpk-plugin-list.adoc b/modules/reference/pages/rpk/rpk-plugin/rpk-plugin-list.adoc index d8725a9ab3..02423e429c 100644 --- a/modules/reference/pages/rpk/rpk-plugin/rpk-plugin-list.adoc +++ b/modules/reference/pages/rpk/rpk-plugin/rpk-plugin-list.adoc @@ -30,7 +30,7 @@ rpk plugin list [flags] |=== |Value |Type |Description -|--format |string |Output format (`json`,`yaml`,`text`,`wide`,`help`). +|--format |string |Output format (`json`,`yaml`,`text`,`wide`,`help`). _(New in v26.2.1)_ |-l, --local |bool |List locally installed plugins and shadowed plugins. |=== diff --git a/modules/reference/pages/rpk/rpk-profile/rpk-profile-list.adoc b/modules/reference/pages/rpk/rpk-profile/rpk-profile-list.adoc index 9ea8fe08d4..c0578b0e61 100644 --- a/modules/reference/pages/rpk/rpk-profile/rpk-profile-list.adoc +++ b/modules/reference/pages/rpk/rpk-profile/rpk-profile-list.adoc @@ -28,7 +28,7 @@ rpk profile ls |=== |Value |Type |Description -|--format |string |Output format (`json`,`yaml`,`text`,`wide`,`help`). +|--format |string |Output format (`json`,`yaml`,`text`,`wide`,`help`). _(New in v26.2.1)_ |=== == Global flags 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 18ede3a502..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-set.adoc b/modules/reference/pages/rpk/rpk-profile/rpk-profile-set.adoc index e831dbaba6..923ec8d70c 100644 --- a/modules/reference/pages/rpk/rpk-profile/rpk-profile-set.adoc +++ b/modules/reference/pages/rpk/rpk-profile/rpk-profile-set.adoc @@ -1,12 +1,27 @@ = rpk profile set -:description: pass:q[Set a configuration field in the current `rpk profile`.] +:description: pass:q[Set fields in the current `rpk profile`. As in the create command, this command takes a list of key=value pairs to write to the current profile.] :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 a configuration field in the current `rpk profile`.] -Set a configuration field in the current `rpk profile`. +:description: pass:q[Set fields in the current `rpk profile`. As in the create command, this command takes a list of key=value pairs to write to the current profile.] +Set fields in the current `rpk profile`. + +As in the create command, this command takes a list of key=value pairs to write +to the current profile. + +The key can either be the name of a `-X` flag or the path to the field in the +profile's `yaml` format. For example, using `--set` tls.enabled=true OR `--set` +kafka_api.tls.enabled=true is equivalent. The former corresponds to the `-X` flag +tls.enabled, while the latter corresponds to the path kafka_api.tls.enabled in +the profile's `yaml`. To see all available `-X` fields, run `rpk -X help`. + +This command supports autocompletion of valid keys, suggesting the `-X` key +format. If you begin writing a YAML path, this command will suggest the rest of +the path. + +You can also use the format `set key value` if you intend to only set one key. == 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-profile/rpk-profile.adoc b/modules/reference/pages/rpk/rpk-profile/rpk-profile.adoc index de829958f8..347022fe4c 100644 --- a/modules/reference/pages/rpk/rpk-profile/rpk-profile.adoc +++ b/modules/reference/pages/rpk/rpk-profile/rpk-profile.adoc @@ -1,13 +1,23 @@ = rpk profile -:description: pass:q[Manage `rpk` configuration profiles. Profiles store connection settings for different clusters, making it easy to switch between environments.] +:description: pass:q[Manage `rpk` profiles. An rpk profile talks to a single Redpanda cluster.] :page-aliases: reference:rpk/rpk-profile.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: pass:q[Manage `rpk` configuration profiles. Profiles store connection settings for different clusters, making it easy to switch between environments.] -Manage `rpk` configuration profiles. Profiles store connection settings for different clusters, making it easy to switch between environments. +:description: pass:q[Manage `rpk` profiles. An rpk profile talks to a single Redpanda cluster.] +Manage `rpk` profiles. + +An rpk profile talks to a single Redpanda cluster. You can create multiple +profiles for multiple clusters and swap between them with `rpk profile use`. +Multiple profiles may be useful if, for example, you use `rpk` to talk to +a localhost cluster, a dev cluster, and a prod cluster, and you want to keep +your configuration in one place. + +You can also use the RPK_PROFILE environment variable to temporarily override +the current profile without modifying your configuration. The `--profile` flag +takes precedence over the environment variable if both are set. == Usage @@ -56,7 +66,7 @@ rpk profile [flags] |Rename the current `rpk profile`. This command renames the currently active profile to the specified name. |xref:reference:rpk/rpk-profile/rpk-profile-set.adoc[`rpk profile set`] -|Set a configuration field in the current `rpk profile`. +|Set fields in the current `rpk profile`. As in the create command, this command takes a list of key=value pairs to write to the current profile. |xref:reference:rpk/rpk-profile/rpk-profile-set-globals.adoc[`rpk profile set-globals`] |Set `rpk` globals fields. This command takes a list of key=value pairs to write to the global config section of `rpk.yaml`. @@ -64,8 +74,10 @@ rpk profile [flags] |xref:reference:rpk/rpk-profile/rpk-profile-use.adoc[`rpk profile use`] |Switch to a different `rpk profile`, making it the active profile for subsequent `rpk` commands. +ifndef::env-cloud[] |xref:reference:rpk/rpk-profile/rpk-profile-validate.adoc[`rpk profile validate`] |Validate profile configuration and detect common issues. +endif::[] |=== diff --git a/modules/reference/pages/rpk/rpk-security/rpk-security-acl-create.adoc b/modules/reference/pages/rpk/rpk-security/rpk-security-acl-create.adoc index 9ee18f56b6..be2b72ab6e 100644 --- a/modules/reference/pages/rpk/rpk-security/rpk-security-acl-create.adoc +++ b/modules/reference/pages/rpk/rpk-security/rpk-security-acl-create.adoc @@ -18,7 +18,7 @@ If no host is specified, an allowed principal is allowed access from all hosts. rpk security acl create [flags] ---- -NOTE: The schema migration examples above are Schema Registry ACLs only. You also require Kafka ACLs for topics, consumer groups, and cluster operations. See xref:manage:security/authorization/acl.adoc[Configure Access Control Lists]. +NOTE: The schema migration examples on this page are Schema Registry ACLs only. You also require Kafka ACLs for topics, consumer groups, and cluster operations. See xref:manage:security/authorization/acl.adoc[Configure Access Control Lists]. == Examples diff --git a/modules/reference/pages/rpk/rpk-security/rpk-security-acl-delete.adoc b/modules/reference/pages/rpk/rpk-security/rpk-security-acl-delete.adoc index 48dd44371c..abb06cf4ab 100644 --- a/modules/reference/pages/rpk/rpk-security/rpk-security-acl-delete.adoc +++ b/modules/reference/pages/rpk/rpk-security/rpk-security-acl-delete.adoc @@ -81,7 +81,7 @@ rpk security acl delete --topic foo --operation all --allow-role red-role |--deny-principal |stringSlice |Denied principal ACLs to remove (`repeatable`). |--deny-role |stringSlice |Denied role to remove this ACL from (`repeatable`). |-d, --dry |bool |Dry run: validate what would be deleted. -|--format |string |Output format (`json`,`yaml`,`text`,`wide`,`help`). +|--format |string |Output format (`json`,`yaml`,`text`,`wide`,`help`). _(New in v26.2.1)_ |--group |stringSlice |Group to remove ACLs for (`repeatable`). |--no-confirm |bool |Disable confirmation prompt. |--operation |stringSlice |Operation to remove (`repeatable`). diff --git a/modules/reference/pages/rpk/rpk-security/rpk-security-acl.adoc b/modules/reference/pages/rpk/rpk-security/rpk-security-acl.adoc index 82cb5ad547..e59a33e717 100644 --- a/modules/reference/pages/rpk/rpk-security/rpk-security-acl.adoc +++ b/modules/reference/pages/rpk/rpk-security/rpk-security-acl.adoc @@ -1,13 +1,41 @@ = rpk security acl -:description: Manage Kafka ACLs (Access Control Lists) for authorization. ACLs control which principals can perform operations on resources. +:description: Manage ACLs and SASL users. This command space creates, lists, and deletes ACLs, as well as creates SASL users. :page-aliases: reference:rpk/rpk-acl.adoc, reference:rpk/rpk-acl/rpk-acl.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: Manage Kafka ACLs (Access Control Lists) for authorization. ACLs control which principals can perform operations on resources. -Manage Kafka ACLs (Access Control Lists) for authorization. ACLs control which principals can perform operations on resources. +:description: Manage ACLs and SASL users. This command space creates, lists, and deletes ACLs, as well as creates SASL users. +Manage ACLs and SASL users. + +This command space creates, lists, and deletes ACLs, as well as creates SASL users. This page is specific to ACLs. To learn about SASL users, see xref:reference:rpk/rpk-security/rpk-security-user.adoc[`rpk security user`]. + +When using SASL, ACLs allow or deny you access to certain requests. The `create`, `delete`, and `list` commands help you manage your ACLs. + +An ACL is made up of five components: + +* A principal (the user) or role + +* A host, which the principal (or role) is allowed or denied requests from + +* What resource to access (such as a topic name or group ID) + +* The operation (such as read or write) + +* The permission: whether to allow or deny the above + +ACL commands work on a multiplicative basis. If creating, specifying two principals and two permissions creates four ACLs: both permissions for the first principal, as well as both permissions for the second principal. Adding two resources further doubles the ACLs created. + +It is recommended to be as specific as possible when granting ACLs. Granting more ACLs than necessary per principal may inadvertently allow clients to do things they should not, such as deleting topics or joining the wrong consumer group. + +In flag form, to set up a general producing and consuming client, you can invoke `rpk security acl create` three times with the following (including your `--allow-principal`): + +* `--operation write,read,describe --topic [topics]` + +* `--operation describe,read --group [group.id]` + +* `--operation describe,write --transactional-id [id]` include::shared:partial$rpk-acl-tip.adoc[] diff --git a/modules/reference/pages/rpk/rpk-security/rpk-security.adoc b/modules/reference/pages/rpk/rpk-security/rpk-security.adoc index e9e20317da..ef25505e86 100644 --- a/modules/reference/pages/rpk/rpk-security/rpk-security.adoc +++ b/modules/reference/pages/rpk/rpk-security/rpk-security.adoc @@ -29,7 +29,7 @@ rpk sec |Command |Description |xref:reference:rpk/rpk-security/rpk-security-acl.adoc[`rpk security acl`] -|Manage Kafka ACLs (Access Control Lists) for authorization. ACLs control which principals can perform operations on resources. +|Manage ACLs and SASL users. This command space creates, lists, and deletes ACLs, as well as creates SASL users. |xref:reference:rpk/rpk-security/rpk-security-role.adoc[`rpk security role`] |Manage Redpanda roles. 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-shadow/rpk-shadow-describe.adoc b/modules/reference/pages/rpk/rpk-shadow/rpk-shadow-describe.adoc index 05da022110..e034c2a6d6 100644 --- a/modules/reference/pages/rpk/rpk-shadow/rpk-shadow-describe.adoc +++ b/modules/reference/pages/rpk/rpk-shadow/rpk-shadow-describe.adoc @@ -8,6 +8,10 @@ :description: pass:q[Describe one or more shadow links. For Redpanda Cloud, `rpk` uses the Redpanda ID of the cluster you are currently logged in to.] Describe one or more shadow links. For Redpanda Cloud, `rpk` uses the Redpanda ID of the cluster you are currently logged in to. +This command shows the Shadow Link configuration, including connection settings, synchronization options, and filters. By default, the command displays the overview and client configuration sections. Use the flags to display additional sections such as topic synchronization, consumer offset synchronization, and security synchronization settings. + +Using the `--format` flag with JSON or YAML outputs the full configuration in the specified format, ignoring section flags. + ifdef::env-cloud[] The command uses the Redpanda ID of the cluster you are currently logged into. To use a different cluster, either log in and create a profile for it, or use the `--redpanda-id` flag to specify it directly. endif::[] @@ -63,7 +67,7 @@ rpk shadow describe my-shadow-link -c |-r, --print-consumer |bool |Print the detailed consumer offset configuration section. |-o, --print-overview |bool |Print the overview section. |-y, --print-registry |bool |Print the detailed schema registry configuration section. -|--print-role |bool |Print the detailed role sync configuration section. +|--print-role |bool |Print the detailed role sync configuration section. _(New in v26.2.1)_ |-s, --print-security |bool |Print the detailed security configuration section. |-t, --print-topic |bool |Print the detailed topic configuration section. |=== diff --git a/modules/reference/pages/rpk/rpk-shadow/rpk-shadow-status.adoc b/modules/reference/pages/rpk/rpk-shadow/rpk-shadow-status.adoc index c10e952b99..8640dfe2a0 100644 --- a/modules/reference/pages/rpk/rpk-shadow/rpk-shadow-status.adoc +++ b/modules/reference/pages/rpk/rpk-shadow/rpk-shadow-status.adoc @@ -1,12 +1,21 @@ = rpk shadow status -:description: pass:q[Display the status of a shadow link. When using `--format json` or `--format yaml`, the command outputs all sections by default.] +:description: Get the status of a Redpanda Shadow Link. This command shows the current status of a Shadow Link, including the overall state, task statuses, and per-topic replication progress. :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[Display the status of a shadow link. When using `--format json` or `--format yaml`, the command outputs all sections by default.] -Display the status of a shadow link. When using `--format json` or `--format yaml`, the command outputs all sections by default. +:description: Get the status of a Redpanda Shadow Link. This command shows the current status of a Shadow Link, including the overall state, task statuses, and per-topic replication progress. +Get the status of a Redpanda Shadow Link. + +This command shows the current status of a Shadow Link, including the overall +state, task statuses, and per-topic replication progress. Use this command to +monitor replication health and track how closely shadow topics follow the source +cluster. + +By default, the command displays all status sections. Use the flags to display +specific sections such as overview, task status, or topic status. When using +this command with the `--format json/yaml` flag, we default to all sections. == Usage @@ -42,7 +51,7 @@ rpk shadow status my-shadow-link --print-overview --print-topic |--format |string |Output format (`json`,`yaml`,`text`,`wide`,`help`). |-a, --print-all |bool |Print all sections. |-o, --print-overview |bool |Print the overview section. -|-y, --print-registry |bool |Print the schema registry sync status section. +|-y, --print-registry |bool |Print the schema registry sync status section. _(New in v26.2.1)_ |-k, --print-task |bool |Print the task status section. |-t, --print-topic |bool |Print the detailed topic status section. |=== diff --git a/modules/reference/pages/rpk/rpk-shadow/rpk-shadow.adoc b/modules/reference/pages/rpk/rpk-shadow/rpk-shadow.adoc index d594727a5d..1c43f45794 100644 --- a/modules/reference/pages/rpk/rpk-shadow/rpk-shadow.adoc +++ b/modules/reference/pages/rpk/rpk-shadow/rpk-shadow.adoc @@ -27,8 +27,10 @@ rpk shadow [flags] |=== |Command |Description +ifndef::env-cloud[] |xref:reference:rpk/rpk-shadow/rpk-shadow-config.adoc[`rpk shadow config`] |Generate a Redpanda Shadow Link configuration file. +endif::[] |xref:reference:rpk/rpk-shadow/rpk-shadow-create.adoc[`rpk shadow create`] |Create a Redpanda Shadow Link. This command creates a Shadow Link using a configuration file that defines the connection details and synchronization settings. @@ -46,7 +48,7 @@ rpk shadow [flags] |List Redpanda Shadow Links. This command lists all Shadow Links on the shadow cluster, showing their names, unique identifiers, and current states. |xref:reference:rpk/rpk-shadow/rpk-shadow-status.adoc[`rpk shadow status`] -|Display the status of a shadow link. When using `--format json` or `--format yaml`, the command outputs all sections by default. +|Get the status of a Redpanda Shadow Link. This command shows the current status of a Shadow Link, including the overall state, task statuses, and per-topic replication progress. |xref:reference:rpk/rpk-shadow/rpk-shadow-update.adoc[`rpk shadow update`] |Update a Shadow Link. This command opens your default editor with the current Shadow Link configuration. diff --git a/modules/reference/pages/rpk/rpk-topic/rpk-topic-add-partitions.adoc b/modules/reference/pages/rpk/rpk-topic/rpk-topic-add-partitions.adoc index 430f91d150..dfbf0b381c 100644 --- a/modules/reference/pages/rpk/rpk-topic/rpk-topic-add-partitions.adoc +++ b/modules/reference/pages/rpk/rpk-topic/rpk-topic-add-partitions.adoc @@ -24,7 +24,7 @@ rpk topic add-partitions --num [#] [flags] |Value |Type |Description |-f, --force |bool |Force change the partition count in internal topics, for example, `__consumer_offsets`. -|--format |string |Output format (`json`,`yaml`,`text`,`wide`,`help`). +|--format |string |Output format (`json`,`yaml`,`text`,`wide`,`help`). _(New in v26.2.1)_ |-n, --num |int |Number of partitions to add to each topic. |=== diff --git a/modules/reference/pages/rpk/rpk-topic/rpk-topic-alter-config.adoc b/modules/reference/pages/rpk/rpk-topic/rpk-topic-alter-config.adoc index 973a559edc..304752bfdb 100644 --- a/modules/reference/pages/rpk/rpk-topic/rpk-topic-alter-config.adoc +++ b/modules/reference/pages/rpk/rpk-topic/rpk-topic-alter-config.adoc @@ -38,7 +38,7 @@ rpk topic alter-config --set key=value --delete key2,key3 [flags] |--append |stringArray |key=value; Value to append to a list-of-values key (`repeatable`). |-d, --delete |stringArray |Key to delete (`repeatable`). |--dry |bool |Dry run: validate the alter request, but do not apply. -|--format |string |Output format (`json`,`yaml`,`text`,`wide`,`help`). +|--format |string |Output format (`json`,`yaml`,`text`,`wide`,`help`). _(New in v26.2.1)_ |--no-confirm |bool |Disable confirmation prompt. |-s, --set |stringArray |key=value; Pair to set (`repeatable`). |--subtract |stringArray |key=value; Value to remove from list-of-values key (`repeatable`). 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-consume.adoc b/modules/reference/pages/rpk/rpk-topic/rpk-topic-consume.adoc index b0deaa6e70..22107c019c 100644 --- a/modules/reference/pages/rpk/rpk-topic/rpk-topic-consume.adoc +++ b/modules/reference/pages/rpk/rpk-topic/rpk-topic-consume.adoc @@ -79,13 +79,36 @@ Text fields without modifiers default to writing the raw bytes. Alternatively, t Unpacking text can allow translating binary input into readable output. If a value is a big-endian uint32, `%v` prints the raw four bytes, while `%v{unpack[>I]}` prints the number as ASCII. If unpacking exhausts the input before something is unpacked fully, an error message is appended to the output. +The unpack modifier has a further internal specification: + +[cols="1m,2a"] +|=== +|Character |Meaning + +|x |Pad character (does not parse input) +|< |Switch what follows to little endian +|> |Switch what follows to big endian +|b |Signed byte +|B |Unsigned byte +|h |int16 ("half word") +|H |uint16 ("half word") +|i |int32 +|I |uint32 +|q |int64 ("quad word") +|Q |uint64 ("quad word") +|c |Any character +|. |Alias for `c` +|s |Consume the rest of the input as a string +|$ |Match the end of the line (append error string if anything remains) +|=== + === Headers Headers are formatted with percent encoding inside of the modifier: [,bash] ---- -%h{%k=%v{hex}} +%h{ %k=%v{hex} } ---- This prints all headers with a space before the key and after the value, an equals sign between the key and value, and with the value hex encoded. Header formatting actually just parses the internal format as a record format, so all of the above rules about `%K`, `%V`, text, and numbers apply. @@ -145,6 +168,10 @@ Durations are parsed simply: 1m3ms one minute and three milliseconds ---- +== Connection behavior + +By default, `rpk topic consume` runs continuously, waiting for new records to arrive. It does not exit after consuming existing records. To stop consuming, press Ctrl+C. You can also use `--num` to exit after a fixed number of records, or use `--offset` to define a stop point (for example, `-o :end` stops at the current log end). + == Examples This section provides examples of how to use `rpk topic consume`. diff --git a/modules/reference/pages/rpk/rpk-topic/rpk-topic-create.adoc b/modules/reference/pages/rpk/rpk-topic/rpk-topic-create.adoc index 0dc2cfe266..b40bc27247 100644 --- a/modules/reference/pages/rpk/rpk-topic/rpk-topic-create.adoc +++ b/modules/reference/pages/rpk/rpk-topic/rpk-topic-create.adoc @@ -1,13 +1,15 @@ = rpk topic create -:description: Create one or more Kafka topics with configurable partitions, replication factor, and topic-level settings. +:description: Create one or more Kafka topics with configurable partitions, replication factor, and topic-level settings. All topics created with one invocation have the same number of partitions, replication factor, and key/value configs. :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: Create one or more Kafka topics with configurable partitions, replication factor, and topic-level settings. +:description: Create one or more Kafka topics with configurable partitions, replication factor, and topic-level settings. All topics created with one invocation have the same number of partitions, replication factor, and key/value configs. Create one or more Kafka topics with configurable partitions, replication factor, and topic-level settings. +All topics created with one invocation have the same number of partitions, replication factor, and key/value configs. For example, `rpk topic create -c cleanup.policy=compact -r 3 -p 20 foo bar` creates two topics, `foo` and `bar`, each with 20 partitions, 3 replicas, and the `cleanup.policy=compact` config option set. + [IMPORTANT] ==== include::shared:partial$tristate-behavior-change-25-3.adoc[] diff --git a/modules/reference/pages/rpk/rpk-topic/rpk-topic-delete.adoc b/modules/reference/pages/rpk/rpk-topic/rpk-topic-delete.adoc index 1e84ee0291..1fb1ff5719 100644 --- a/modules/reference/pages/rpk/rpk-topic/rpk-topic-delete.adoc +++ b/modules/reference/pages/rpk/rpk-topic/rpk-topic-delete.adoc @@ -1,12 +1,38 @@ = rpk topic delete -:description: Delete one or more Kafka topics. This operation is irreversible and removes all data in the topics. +:description: Delete topics. This command deletes all requested topics, printing the success or fail status per topic. :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: Delete one or more Kafka topics. This operation is irreversible and removes all data in the topics. -Delete one or more Kafka topics. This operation is irreversible and removes all data in the topics. +:description: Delete topics. This command deletes all requested topics, printing the success or fail status per topic. +Delete topics. + +This command deletes all requested topics, printing the success or fail status +per topic. + +The `--regex` flag (`-r`) opts into parsing the input topics as regular expressions +and deleting any non-internal topic that matches any of expressions. The input +expressions are wrapped with ^ and $ so that the expression must match the +whole topic name (which also prevents accidental delete-everything mistakes). + +The topic list command accepts the same input regex format as this delete +command. If you want to check what your regular expressions will delete before +actually deleting them, you can check the output of `rpk topic list -r`. + +For example,. + +[cols="1m,1a"] +|=== +|Value |Description + +|delete foo bar |# deletes topics foo and bar +|delete `-r` '^f.*' '.*r$' |# deletes any topic starting with f and any topics ending in r +|delete `-r` '.*' |# deletes all topics +|delete `-r` . |# deletes any one-character topics +|=== + +CAUTION: Deleting a topic is irreversible and removes all data in the topic. == Usage @@ -50,7 +76,7 @@ rpk topic delete -r '.*' |=== |Value |Type |Description -|--format |string |Output format (`json`,`yaml`,`text`,`wide`,`help`). +|--format |string |Output format (`json`,`yaml`,`text`,`wide`,`help`). _(New in v26.2.1)_ |-r, --regex |bool |Treat topic names as regular expressions and delete all matching topics. Use with caution. |=== 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 d4d196c447..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,12 +1,16 @@ +ifndef::env-cloud[] = rpk topic describe-storage -:description: Describe the cloud storage status of a topic, including storage mode, offset availability, segment sizes, and synchronization state. +:description: Describe the topic storage status. :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: Describe the cloud storage status of a topic, including storage mode, offset availability, segment sizes, and synchronization state. -Describe the cloud storage status of a topic, including storage mode, offset availability, segment sizes, and synchronization state. +:description: Describe the topic storage status. +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: == Usage @@ -75,3 +79,4 @@ segments. |=== // end::single-source[] +endif::[] diff --git a/modules/reference/pages/rpk/rpk-topic/rpk-topic-list.adoc b/modules/reference/pages/rpk/rpk-topic/rpk-topic-list.adoc index eef8bf0a1a..caf2d19cda 100644 --- a/modules/reference/pages/rpk/rpk-topic/rpk-topic-list.adoc +++ b/modules/reference/pages/rpk/rpk-topic/rpk-topic-list.adoc @@ -6,7 +6,24 @@ // tag::single-source[] :description: List topics, optionally listing specific topics. This command lists all topics that you have access to by default. -List topics, optionally listing specific topics. This command lists all topics that you have access to by default. +List topics, optionally listing specific topics. + +This command lists all topics that you have access to by default. If specifying +topics or regular expressions, this command can be used to know exactly what +topics you would delete if using the same input to the delete command. + +Alternatively, you can request specific topics to list, which can be used to +check authentication errors (do you not have access to a topic you were +expecting to see?), or to list all topics that match regular expressions. + +The `--regex` flag (`-r`) opts into parsing the input topics as regular expressions +and listing any non-internal topic that matches any of expressions. The input +expressions are wrapped with ^ and $ so that the expression must match the +whole topic name. Regular expressions cannot be used to match internal topics, +as such, specifying both `-i` and `-r` will exit with failure. + +Lastly, `--detailed` flag (`-d`) opts in to printing extra per-partition +information. If specifying topics or regular expressions, this command can be used to know exactly what topics you would delete if using the same input to the delete command. 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 d677b7c982..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,14 +1,37 @@ = rpk topic trim-prefix -:description: Trim records from topics by setting 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. +: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 by setting 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. +: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 by setting 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. +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. + +The `--offset`/`-o` flag allows you to indicate which index you want to set the +partition's low watermark (start offset) to. It can be a single integer value +denoting the offset or a timestamp if you prefix the offset with an '@'. You may +select which partition you want to trim the offset from with the `--partitions`/`-p` +flag. + +The `--from-file` option allows to trim the offsets specified in a text file with +the following format: + +[,text] +---- +[TOPIC] [PARTITION] [OFFSET] +[TOPIC] [PARTITION] [OFFSET] +... +---- + +or the equivalent keyed JSON/YAML file. == Usage @@ -24,6 +47,28 @@ rpk topic trim-prefix [flags] rpk topic trim ---- +== Examples + +This section provides examples of how to use `rpk topic trim-prefix`. + +Trim records in `foo` topic to offset 120 in partition 1 +[,bash] +---- +rpk topic trim-prefix foo --offset 120 --partitions 1 +---- + +Trim records in all partitions of topic foo previous to an specific timestamp +[,bash] +---- +rpk topic trim-prefix foo -o "@1622505600" +---- + +Trim records from a JSON file +[,bash] +---- +rpk topic trim-prefix --from-file /tmp/to_trim.json +---- + == Flags [cols="1m,1a,2a"] diff --git a/modules/reference/pages/rpk/rpk-topic/rpk-topic.adoc b/modules/reference/pages/rpk/rpk-topic/rpk-topic.adoc index c356f4313f..8717480882 100644 --- a/modules/reference/pages/rpk/rpk-topic/rpk-topic.adoc +++ b/modules/reference/pages/rpk/rpk-topic/rpk-topic.adoc @@ -28,23 +28,27 @@ rpk topic [flags] |xref:reference:rpk/rpk-topic/rpk-topic-alter-config.adoc[`rpk topic alter-config`] |Set, delete, add, and remove key/value configs for a topic. This command allows you to incrementally alter the configuration for multiple topics at a time. +ifndef::env-cloud[] |xref:reference:rpk/rpk-topic/rpk-topic-analyze.adoc[`rpk topic analyze`] |Analyze topics. This command consumes records from the specified topics to determine topic characteristics such as batch rate and batch size. +endif::[] |xref:reference:rpk/rpk-topic/rpk-topic-consume.adoc[`rpk topic consume`] |Consume records from topics. Consuming records reads from any amount of input topics, formats each record according to `--format`, and prints them to `STDOUT`. |xref:reference:rpk/rpk-topic/rpk-topic-create.adoc[`rpk topic create`] -|Create one or more Kafka topics with configurable partitions, replication factor, and topic-level settings. +|Create one or more Kafka topics with configurable partitions, replication factor, and topic-level settings. All topics created with one invocation have the same number of partitions, replication factor, and key/value configs. |xref:reference:rpk/rpk-topic/rpk-topic-delete.adoc[`rpk topic delete`] -|Delete one or more Kafka topics. This operation is irreversible and removes all data in the topics. +|Delete topics. This command deletes all requested topics, printing the success or fail status per topic. |xref:reference:rpk/rpk-topic/rpk-topic-describe.adoc[`rpk topic describe`] |Print detailed information about topics. There are three potential views: a summary of the topic, the topic configurations, and a detailed partitions section. +ifndef::env-cloud[] |xref:reference:rpk/rpk-topic/rpk-topic-describe-storage.adoc[`rpk topic describe-storage`] -|Describe the cloud storage status of a topic, including storage mode, offset availability, segment sizes, and synchronization state. +|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`] |List topics, optionally listing specific topics. This command lists all topics that you have access to by default. @@ -53,7 +57,7 @@ rpk topic [flags] |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 by setting 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. +|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-init.adoc b/modules/reference/pages/rpk/rpk-transform/rpk-transform-init.adoc index 6a10831cfe..7ca3baef7a 100644 --- a/modules/reference/pages/rpk/rpk-transform/rpk-transform-init.adoc +++ b/modules/reference/pages/rpk/rpk-transform/rpk-transform-init.adoc @@ -9,6 +9,8 @@ :description: Initialize a new data transform project. Creates a new directory with the required project files. Initialize a new data transform project. Creates a new directory with the required project files. To initialize in a new subdirectory, specify the directory name as an argument. +The project is created from a template. For example, `rpk transform init foobar` initializes a transform project in the `foobar` directory. + == Usage [,bash] 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 06b93d6f7b..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,12 +1,20 @@ = rpk transform logs -:description: View logs for a data transform. Streams STDOUT and STDERR output captured during runtime to your terminal. +: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: View logs for a data transform. Streams STDOUT and STDERR output captured during runtime to your terminal. -View logs for a data transform. Streams STDOUT and STDERR output captured during runtime to your terminal. +: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. +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. + +By default, only logs that have been emitted are displayed. +Use the `--follow` flag to stream new logs continuously. == Usage 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 bb21c8e08b..87c0201bf9 100644 --- a/modules/reference/pages/rpk/rpk-transform/rpk-transform.adoc +++ b/modules/reference/pages/rpk/rpk-transform/rpk-transform.adoc @@ -46,13 +46,17 @@ 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 data transform. Streams STDOUT and STDERR output captured during runtime to your terminal. +|View logs for a transform. transform_logs. +ifndef::env-cloud[] |xref:reference:rpk/rpk-transform/rpk-transform-pause.adoc[`rpk transform pause`] |Pause a data transform. This command suspends execution of the specified transform without removing it from the system. +endif::[] +ifndef::env-cloud[] |xref:reference:rpk/rpk-transform/rpk-transform-resume.adoc[`rpk transform resume`] |Resume a data transform. This command resumes execution of the specified data transform, if it was previously paused. +endif::[] |=== diff --git a/modules/reference/partials/rpk-ai/rpk-ai-auth-login.adoc b/modules/reference/partials/rpk-ai/rpk-ai-auth-login.adoc index f15369c618..3ab3369073 100644 --- a/modules/reference/partials/rpk-ai/rpk-ai-auth-login.adoc +++ b/modules/reference/partials/rpk-ai/rpk-ai-auth-login.adoc @@ -1,13 +1,19 @@ = rpk ai auth login -:description: Run the OAuth 2.0 device authorization grant against Redpanda Cloud, persist the resulting credentials, and prompt to select an environment whose AI Gateway URL becomes the active profile's dataplane URL. +:description: pass:q[Run the OAuth 2.0 device authorization grant against Redpanda Cloud, persist the resulting credentials, and prompt to select an environment whose AI Gateway URL becomes the active profile's dataplane URL. Credentials are stored in the `rpk ai` credentials file with `0600` permissions, keyed by organization.] :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: Run the OAuth 2.0 device authorization grant against Redpanda Cloud, persist the resulting credentials, and prompt to select an environment whose AI Gateway URL becomes the active profile's dataplane URL. +:description: pass:q[Run the OAuth 2.0 device authorization grant against Redpanda Cloud, persist the resulting credentials, and prompt to select an environment whose AI Gateway URL becomes the active profile's dataplane URL. Credentials are stored in the `rpk ai` credentials file with `0600` permissions, keyed by organization.] Run the OAuth 2.0 device authorization grant against Redpanda Cloud, persist the resulting credentials, and prompt to select an environment whose AI Gateway URL becomes the active profile's dataplane URL. +Credentials are stored in the `rpk ai` credentials file with `0600` permissions, keyed by organization. + +A successful login rewrites the config in the current schema, so running `rpk ai auth login` is also how you migrate a config left over from an older version of the plugin. + +If the current environment's organization still holds valid credentials, login is a no-op and prints "Already logged in". Run `rpk ai auth logout` first to re-authenticate, or `rpk ai auth logout --all` for a full clean slate. + == Usage [,bash] diff --git a/modules/reference/partials/rpk-ai/rpk-ai-llm-provider-apply.adoc b/modules/reference/partials/rpk-ai/rpk-ai-llm-provider-apply.adoc index 5740919c3c..d6bc4cab79 100644 --- a/modules/reference/partials/rpk-ai/rpk-ai-llm-provider-apply.adoc +++ b/modules/reference/partials/rpk-ai/rpk-ai-llm-provider-apply.adoc @@ -20,6 +20,8 @@ read stdin. This does not delete resources absent from the manifests (no prune), and drift is detected only for the fields a manifest names; see `diff --help`. +NOTE: This command was introduced in ai version 0.2.32. + == Usage [,bash] diff --git a/modules/reference/partials/rpk-ai/rpk-ai-llm-provider-check.adoc b/modules/reference/partials/rpk-ai/rpk-ai-llm-provider-check.adoc index da56a56032..ab9da3536e 100644 --- a/modules/reference/partials/rpk-ai/rpk-ai-llm-provider-check.adoc +++ b/modules/reference/partials/rpk-ai/rpk-ai-llm-provider-check.adoc @@ -8,6 +8,8 @@ :description: Runs a lightweight probe against the upstream to verify credentials and reachability. Runs a lightweight probe against the upstream to verify credentials and reachability. +NOTE: This command was introduced in ai version 0.2.32. + == Usage [,bash] diff --git a/modules/reference/partials/rpk-ai/rpk-ai-llm-provider-create.adoc b/modules/reference/partials/rpk-ai/rpk-ai-llm-provider-create.adoc index c68872665a..69fa0f4d09 100644 --- a/modules/reference/partials/rpk-ai/rpk-ai-llm-provider-create.adoc +++ b/modules/reference/partials/rpk-ai/rpk-ai-llm-provider-create.adoc @@ -11,6 +11,8 @@ Create an LLM provider. Choose the provider-config by setting flags from one group; the group you use selects it: openai-config, anthropic-config, google-config, bedrock-config, openai-compatible-config. Setting flags from two groups is an error. +NOTE: This command was introduced in ai version 0.2.32. + == Usage [,bash] diff --git a/modules/reference/partials/rpk-ai/rpk-ai-llm-provider-delete.adoc b/modules/reference/partials/rpk-ai/rpk-ai-llm-provider-delete.adoc index 956dc5c4c6..87fc1f3815 100644 --- a/modules/reference/partials/rpk-ai/rpk-ai-llm-provider-delete.adoc +++ b/modules/reference/partials/rpk-ai/rpk-ai-llm-provider-delete.adoc @@ -8,6 +8,8 @@ :description: Delete an LLM provider. Delete an LLM provider. +NOTE: This command was introduced in ai version 0.2.32. + == Usage [,bash] diff --git a/modules/reference/partials/rpk-ai/rpk-ai-llm-provider-diff.adoc b/modules/reference/partials/rpk-ai/rpk-ai-llm-provider-diff.adoc index e24a497384..dced697116 100644 --- a/modules/reference/partials/rpk-ai/rpk-ai-llm-provider-diff.adoc +++ b/modules/reference/partials/rpk-ai/rpk-ai-llm-provider-diff.adoc @@ -14,6 +14,8 @@ NOTE: diff proves only that the fields a manifest names match live. It does not detect resources that exist live but are absent from the manifests (no prune), nor drift in fields a manifest omits. +NOTE: This command was introduced in ai version 0.2.32. + == Usage [,bash] diff --git a/modules/reference/partials/rpk-ai/rpk-ai-llm-provider-get.adoc b/modules/reference/partials/rpk-ai/rpk-ai-llm-provider-get.adoc index f79896be59..eeb7e672f1 100644 --- a/modules/reference/partials/rpk-ai/rpk-ai-llm-provider-get.adoc +++ b/modules/reference/partials/rpk-ai/rpk-ai-llm-provider-get.adoc @@ -8,6 +8,8 @@ :description: Get an LLM provider. Get an LLM provider. +NOTE: This command was introduced in ai version 0.2.32. + == Usage [,bash] diff --git a/modules/reference/partials/rpk-ai/rpk-ai-llm-provider-list.adoc b/modules/reference/partials/rpk-ai/rpk-ai-llm-provider-list.adoc index e98eaa9adf..66e02b3b50 100644 --- a/modules/reference/partials/rpk-ai/rpk-ai-llm-provider-list.adoc +++ b/modules/reference/partials/rpk-ai/rpk-ai-llm-provider-list.adoc @@ -8,6 +8,8 @@ :description: List LLM providers. List LLM providers. +NOTE: This command was introduced in ai version 0.2.32. + == Usage [,bash] diff --git a/modules/reference/partials/rpk-ai/rpk-ai-llm-provider-update.adoc b/modules/reference/partials/rpk-ai/rpk-ai-llm-provider-update.adoc index a9bf8dd964..f7a8f5c3c7 100644 --- a/modules/reference/partials/rpk-ai/rpk-ai-llm-provider-update.adoc +++ b/modules/reference/partials/rpk-ai/rpk-ai-llm-provider-update.adoc @@ -8,6 +8,8 @@ :description: Update an LLM provider. Update an LLM provider. +NOTE: This command was introduced in ai version 0.2.32. + == Usage [,bash] diff --git a/modules/reference/partials/rpk-ai/rpk-ai-llm-provider.adoc b/modules/reference/partials/rpk-ai/rpk-ai-llm-provider.adoc index 3c246ddb51..e3abec9e84 100644 --- a/modules/reference/partials/rpk-ai/rpk-ai-llm-provider.adoc +++ b/modules/reference/partials/rpk-ai/rpk-ai-llm-provider.adoc @@ -8,6 +8,8 @@ :description: pass:q[Manage LLM providers (`create`, get, list, update, delete).] Manage LLM providers (`create`, get, list, update, delete). +NOTE: This command was introduced in ai version 0.2.32. + == Usage [,bash] diff --git a/modules/reference/partials/rpk-ai/rpk-ai-mcp-server-apply.adoc b/modules/reference/partials/rpk-ai/rpk-ai-mcp-server-apply.adoc index 26e315045d..67db31f671 100644 --- a/modules/reference/partials/rpk-ai/rpk-ai-mcp-server-apply.adoc +++ b/modules/reference/partials/rpk-ai/rpk-ai-mcp-server-apply.adoc @@ -20,6 +20,8 @@ read stdin. This does not delete resources absent from the manifests (no prune), and drift is detected only for the fields a manifest names; see `diff --help`. +NOTE: This command was introduced in ai version 0.2.32. + == Usage [,bash] diff --git a/modules/reference/partials/rpk-ai/rpk-ai-mcp-server-create.adoc b/modules/reference/partials/rpk-ai/rpk-ai-mcp-server-create.adoc index 122a757eb5..abab2be068 100644 --- a/modules/reference/partials/rpk-ai/rpk-ai-mcp-server-create.adoc +++ b/modules/reference/partials/rpk-ai/rpk-ai-mcp-server-create.adoc @@ -11,6 +11,8 @@ Create an MCP server. Choose the backend by setting flags from one group; the group you use selects it: remote, managed. Setting flags from two groups is an error. +NOTE: This command was introduced in ai version 0.2.32. + == Usage [,bash] diff --git a/modules/reference/partials/rpk-ai/rpk-ai-mcp-server-delete.adoc b/modules/reference/partials/rpk-ai/rpk-ai-mcp-server-delete.adoc index 5acef0b2c6..8ad11154b3 100644 --- a/modules/reference/partials/rpk-ai/rpk-ai-mcp-server-delete.adoc +++ b/modules/reference/partials/rpk-ai/rpk-ai-mcp-server-delete.adoc @@ -8,6 +8,8 @@ :description: Delete an MCP server. Delete an MCP server. +NOTE: This command was introduced in ai version 0.2.32. + == Usage [,bash] diff --git a/modules/reference/partials/rpk-ai/rpk-ai-mcp-server-diff.adoc b/modules/reference/partials/rpk-ai/rpk-ai-mcp-server-diff.adoc index 0f94502470..4388ea358e 100644 --- a/modules/reference/partials/rpk-ai/rpk-ai-mcp-server-diff.adoc +++ b/modules/reference/partials/rpk-ai/rpk-ai-mcp-server-diff.adoc @@ -14,6 +14,8 @@ NOTE: diff proves only that the fields a manifest names match live. It does not detect resources that exist live but are absent from the manifests (no prune), nor drift in fields a manifest omits. +NOTE: This command was introduced in ai version 0.2.32. + == Usage [,bash] diff --git a/modules/reference/partials/rpk-ai/rpk-ai-mcp-server-get.adoc b/modules/reference/partials/rpk-ai/rpk-ai-mcp-server-get.adoc index 891a98364b..ae16bb7582 100644 --- a/modules/reference/partials/rpk-ai/rpk-ai-mcp-server-get.adoc +++ b/modules/reference/partials/rpk-ai/rpk-ai-mcp-server-get.adoc @@ -8,6 +8,8 @@ :description: Get an MCP server. Get an MCP server. +NOTE: This command was introduced in ai version 0.2.32. + == Usage [,bash] diff --git a/modules/reference/partials/rpk-ai/rpk-ai-mcp-server-list.adoc b/modules/reference/partials/rpk-ai/rpk-ai-mcp-server-list.adoc index c8e95de5be..5ed1f77758 100644 --- a/modules/reference/partials/rpk-ai/rpk-ai-mcp-server-list.adoc +++ b/modules/reference/partials/rpk-ai/rpk-ai-mcp-server-list.adoc @@ -8,6 +8,8 @@ :description: List MCP servers. List MCP servers. +NOTE: This command was introduced in ai version 0.2.32. + == Usage [,bash] diff --git a/modules/reference/partials/rpk-ai/rpk-ai-mcp-server-tools-call.adoc b/modules/reference/partials/rpk-ai/rpk-ai-mcp-server-tools-call.adoc index 1437b2c770..9cf91c67ae 100644 --- a/modules/reference/partials/rpk-ai/rpk-ai-mcp-server-tools-call.adoc +++ b/modules/reference/partials/rpk-ai/rpk-ai-mcp-server-tools-call.adoc @@ -31,6 +31,8 @@ rpai mcp tools call pg-garrett execute --code-mode \ --args '{"code":"var r = call_tool({name:\"query\", arguments:{query:\"SELECT 1\"}}); JSON.stringify(r);"}' ---- +NOTE: This command was introduced in ai version 0.2.32. + == Usage [,bash] diff --git a/modules/reference/partials/rpk-ai/rpk-ai-mcp-server-tools-list.adoc b/modules/reference/partials/rpk-ai/rpk-ai-mcp-server-tools-list.adoc index 304f88fd68..d01a323be3 100644 --- a/modules/reference/partials/rpk-ai/rpk-ai-mcp-server-tools-list.adoc +++ b/modules/reference/partials/rpk-ai/rpk-ai-mcp-server-tools-list.adoc @@ -23,6 +23,8 @@ search tool explicitly: rpai mcp tools call search --code-mode ---- +NOTE: This command was introduced in ai version 0.2.32. + == Usage [,bash] diff --git a/modules/reference/partials/rpk-ai/rpk-ai-mcp-server-tools.adoc b/modules/reference/partials/rpk-ai/rpk-ai-mcp-server-tools.adoc index 6784b4d61b..90c854162e 100644 --- a/modules/reference/partials/rpk-ai/rpk-ai-mcp-server-tools.adoc +++ b/modules/reference/partials/rpk-ai/rpk-ai-mcp-server-tools.adoc @@ -8,6 +8,8 @@ :description: Interact with tools on an MCP server. Interact with tools on an MCP server. +NOTE: This command was introduced in ai version 0.2.32. + == Usage [,bash] diff --git a/modules/reference/partials/rpk-ai/rpk-ai-mcp-server-types.adoc b/modules/reference/partials/rpk-ai/rpk-ai-mcp-server-types.adoc index 67a1101f78..9ffdaf34cc 100644 --- a/modules/reference/partials/rpk-ai/rpk-ai-mcp-server-types.adoc +++ b/modules/reference/partials/rpk-ai/rpk-ai-mcp-server-types.adoc @@ -8,6 +8,8 @@ :description: List available managed MCP types. List available managed MCP types. +NOTE: This command was introduced in ai version 0.2.32. + == Usage [,bash] diff --git a/modules/reference/partials/rpk-ai/rpk-ai-mcp-server-update.adoc b/modules/reference/partials/rpk-ai/rpk-ai-mcp-server-update.adoc index 4e1e9743db..7face93d05 100644 --- a/modules/reference/partials/rpk-ai/rpk-ai-mcp-server-update.adoc +++ b/modules/reference/partials/rpk-ai/rpk-ai-mcp-server-update.adoc @@ -8,6 +8,8 @@ :description: Update an MCP server. Update an MCP server. +NOTE: This command was introduced in ai version 0.2.32. + == Usage [,bash] diff --git a/modules/reference/partials/rpk-ai/rpk-ai-mcp-server.adoc b/modules/reference/partials/rpk-ai/rpk-ai-mcp-server.adoc index 0551853d00..cdaaea39e0 100644 --- a/modules/reference/partials/rpk-ai/rpk-ai-mcp-server.adoc +++ b/modules/reference/partials/rpk-ai/rpk-ai-mcp-server.adoc @@ -8,6 +8,8 @@ :description: pass:q[Manage MCP servers (`create`, get, list, update, delete).] Manage MCP servers (`create`, get, list, update, delete). +NOTE: This command was introduced in ai version 0.2.32. + == Usage [,bash] diff --git a/modules/reference/partials/rpk-ai/rpk-ai-oauth-client-dcr.adoc b/modules/reference/partials/rpk-ai/rpk-ai-oauth-client-dcr.adoc index 63ce72b7ac..0ef65efdb5 100644 --- a/modules/reference/partials/rpk-ai/rpk-ai-oauth-client-dcr.adoc +++ b/modules/reference/partials/rpk-ai/rpk-ai-oauth-client-dcr.adoc @@ -8,6 +8,16 @@ :description: Manage Dynamic Client Registration (DCR) settings for the AI gateway. DCR allows OAuth clients to register themselves programmatically at a public endpoint. Manage Dynamic Client Registration (DCR) settings for the AI gateway. DCR allows OAuth clients to register themselves programmatically at a public endpoint. +When DCR is enabled, spec-conformant MCP clients (such as Claude and Cursor) self-register at the public `/oauth/idp/register` endpoint with no admin pre-provisioning. Admission is governed by the mode: + +* `open`: anyone may register (rate limit and client cap still apply) + +* `initial-access-token`: callers must present an admin-minted one-shot bearer token + +* `software-statement`: reserved, not yet supported + +DCR is disabled per tenant by default. The gateway operator must also enable the global `ingress.idp.dcr.global_enabled` flag. + == Usage [,bash] diff --git a/modules/reference/partials/rpk-ai/rpk-ai-oauth-client-revoke-tokens.adoc b/modules/reference/partials/rpk-ai/rpk-ai-oauth-client-revoke-tokens.adoc index f27e542b90..820d8977b5 100644 --- a/modules/reference/partials/rpk-ai/rpk-ai-oauth-client-revoke-tokens.adoc +++ b/modules/reference/partials/rpk-ai/rpk-ai-oauth-client-revoke-tokens.adoc @@ -8,6 +8,10 @@ :description: Revoke every refresh token the AI gateway has issued for the named OAuth client. Forces all users who connected this client to sign in again. Revoke every refresh token the AI gateway has issued for the named OAuth client. Forces all users who connected this client to sign in again. +Already-issued short-lived access tokens may continue working until natural expiry (typically minutes). + +This command is idempotent: running it again returns 0. + == Usage [,bash] diff --git a/modules/reference/partials/rpk-ai/rpk-ai-oauth-client-update.adoc b/modules/reference/partials/rpk-ai/rpk-ai-oauth-client-update.adoc index 1c2b1ff40b..13660cde23 100644 --- a/modules/reference/partials/rpk-ai/rpk-ai-oauth-client-update.adoc +++ b/modules/reference/partials/rpk-ai/rpk-ai-oauth-client-update.adoc @@ -8,6 +8,8 @@ :description: Update an OAuth client. Update an OAuth client. +NOTE: This command was introduced in ai version 0.2.32. + == Usage [,bash] diff --git a/modules/reference/partials/rpk-ai/rpk-ai-policy-apply.adoc b/modules/reference/partials/rpk-ai/rpk-ai-policy-apply.adoc index 4285ee0642..277106b26e 100644 --- a/modules/reference/partials/rpk-ai/rpk-ai-policy-apply.adoc +++ b/modules/reference/partials/rpk-ai/rpk-ai-policy-apply.adoc @@ -20,6 +20,8 @@ read stdin. This does not delete resources absent from the manifests (no prune), and drift is detected only for the fields a manifest names; see `diff --help`. +NOTE: This command was introduced in ai version 0.2.32. + == Usage [,bash] diff --git a/modules/reference/partials/rpk-ai/rpk-ai-policy-create.adoc b/modules/reference/partials/rpk-ai/rpk-ai-policy-create.adoc index 5813ac1403..ab36b83db3 100644 --- a/modules/reference/partials/rpk-ai/rpk-ai-policy-create.adoc +++ b/modules/reference/partials/rpk-ai/rpk-ai-policy-create.adoc @@ -22,6 +22,8 @@ Data shaping (`masking`, dropping, row filtering) is NOT configured here. It lives on the MCP server's data policies (`rpk` ai mcp ...), not in Cedar text; the @redact_mask / @redact_drop annotations are gone. +NOTE: This command was introduced in ai version 0.2.32. + == Usage [,bash] diff --git a/modules/reference/partials/rpk-ai/rpk-ai-policy-delete.adoc b/modules/reference/partials/rpk-ai/rpk-ai-policy-delete.adoc index 7f5115ebb8..be60021732 100644 --- a/modules/reference/partials/rpk-ai/rpk-ai-policy-delete.adoc +++ b/modules/reference/partials/rpk-ai/rpk-ai-policy-delete.adoc @@ -8,6 +8,8 @@ :description: Delete a policy. Delete a policy. +NOTE: This command was introduced in ai version 0.2.32. + == Usage [,bash] diff --git a/modules/reference/partials/rpk-ai/rpk-ai-policy-diff.adoc b/modules/reference/partials/rpk-ai/rpk-ai-policy-diff.adoc index a498b02686..11486c3f5c 100644 --- a/modules/reference/partials/rpk-ai/rpk-ai-policy-diff.adoc +++ b/modules/reference/partials/rpk-ai/rpk-ai-policy-diff.adoc @@ -14,6 +14,8 @@ NOTE: diff proves only that the fields a manifest names match live. It does not detect resources that exist live but are absent from the manifests (no prune), nor drift in fields a manifest omits. +NOTE: This command was introduced in ai version 0.2.32. + == Usage [,bash] diff --git a/modules/reference/partials/rpk-ai/rpk-ai-policy-get.adoc b/modules/reference/partials/rpk-ai/rpk-ai-policy-get.adoc index fd2093afd1..faf7e03ab3 100644 --- a/modules/reference/partials/rpk-ai/rpk-ai-policy-get.adoc +++ b/modules/reference/partials/rpk-ai/rpk-ai-policy-get.adoc @@ -8,6 +8,8 @@ :description: Get a policy. Get a policy. +NOTE: This command was introduced in ai version 0.2.32. + == Usage [,bash] diff --git a/modules/reference/partials/rpk-ai/rpk-ai-policy-list.adoc b/modules/reference/partials/rpk-ai/rpk-ai-policy-list.adoc index 1b4ecea729..fe3e7ddcd7 100644 --- a/modules/reference/partials/rpk-ai/rpk-ai-policy-list.adoc +++ b/modules/reference/partials/rpk-ai/rpk-ai-policy-list.adoc @@ -8,6 +8,8 @@ :description: List policies. List policies. +NOTE: This command was introduced in ai version 0.2.32. + == Usage [,bash] diff --git a/modules/reference/partials/rpk-ai/rpk-ai-policy-update.adoc b/modules/reference/partials/rpk-ai/rpk-ai-policy-update.adoc index fe0e227cca..1858de6dde 100644 --- a/modules/reference/partials/rpk-ai/rpk-ai-policy-update.adoc +++ b/modules/reference/partials/rpk-ai/rpk-ai-policy-update.adoc @@ -10,6 +10,8 @@ Update a policy in place. Only the flags you pass are written; the field mask is built from the flags actually set, so omitted fields are left untouched. +NOTE: This command was introduced in ai version 0.2.32. + == Usage [,bash] diff --git a/modules/reference/partials/rpk-ai/rpk-ai-policy.adoc b/modules/reference/partials/rpk-ai/rpk-ai-policy.adoc index 38325d1f0c..b7e155d9d0 100644 --- a/modules/reference/partials/rpk-ai/rpk-ai-policy.adoc +++ b/modules/reference/partials/rpk-ai/rpk-ai-policy.adoc @@ -8,6 +8,8 @@ :description: pass:q[Manage Cedar authorization policies (`create`, get, list, update, delete).] Manage Cedar authorization policies (`create`, get, list, update, delete). +NOTE: This command was introduced in ai version 0.2.32. + == Usage [,bash] diff --git a/modules/reference/partials/rpk-cloud/rpk-cloud-auth-list.adoc b/modules/reference/partials/rpk-cloud/rpk-cloud-auth-list.adoc index dc8afc4e69..512cc35d92 100644 --- a/modules/reference/partials/rpk-cloud/rpk-cloud-auth-list.adoc +++ b/modules/reference/partials/rpk-cloud/rpk-cloud-auth-list.adoc @@ -28,7 +28,7 @@ rpk cloud auth ls |=== |Value |Type |Description -|--format |string |Output format (`json`,`yaml`,`text`,`wide`,`help`). +|--format |string |Output format (`json`,`yaml`,`text`,`wide`,`help`). _(New in v26.2.1)_ |=== == Global flags diff --git a/modules/reference/partials/rpk-cloud/rpk-cloud-mcp-install.adoc b/modules/reference/partials/rpk-cloud/rpk-cloud-mcp-install.adoc index 7084e8431b..e03913a118 100644 --- a/modules/reference/partials/rpk-cloud/rpk-cloud-mcp-install.adoc +++ b/modules/reference/partials/rpk-cloud/rpk-cloud-mcp-install.adoc @@ -12,6 +12,8 @@ This command generates and installs the necessary configuration files for your M Supports Claude Desktop and Claude Code. +This command writes an `mcpServer` entry named `redpandaCloud` into the appropriate config file. + == Examples This section provides examples of how to use `rpk cloud mcp install`. diff --git a/modules/reference/partials/rpk-security/rpk-security-secret-list.adoc b/modules/reference/partials/rpk-security/rpk-security-secret-list.adoc index 913d51e112..3e4e455a66 100644 --- a/modules/reference/partials/rpk-security/rpk-security-secret-list.adoc +++ b/modules/reference/partials/rpk-security/rpk-security-secret-list.adoc @@ -21,7 +21,7 @@ rpk security secret list [flags] |=== |Value |Type |Description -|--format |string |Output format (`json`,`yaml`,`text`,`wide`,`help`). +|--format |string |Output format (`json`,`yaml`,`text`,`wide`,`help`). _(New in v26.2.1)_ |--name-contains |string |Substring match on secret name. |=== From 1a4daf7a90a198da0afed746a3f4da998b41e600 Mon Sep 17 00:00:00 2001 From: JakeSCahill Date: Mon, 3 Aug 2026 10:22:40 +0100 Subject: [PATCH 2/5] Fix garbled summaries on rpk transform logs and rpk generate license The summary generator cannot split sentences around mid-token periods (_redpanda.transform_logs, redpanda.com/contact) and glued unterminated paragraphs into run-on sentences, publishing descriptions like 'View logs for a transform. transform_logs.' Also wraps the internal topic name _redpanda.transform_logs in inline code: the leading underscore doubles as an AsciiDoc italics delimiter. Content produced by the fixed generator (docs-extensions-and-macros#241) run against this branch's snapshot, so the next regeneration reproduces it byte for byte. --- .../pages/rpk/rpk-generate/rpk-generate-license.adoc | 4 ++-- modules/reference/pages/rpk/rpk-generate/rpk-generate.adoc | 6 +++--- .../pages/rpk/rpk-transform/rpk-transform-logs.adoc | 6 +++--- .../reference/pages/rpk/rpk-transform/rpk-transform.adoc | 2 +- 4 files changed, 9 insertions(+), 9 deletions(-) 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 93f89fd690..29f6d9c8cf 100644 --- a/modules/reference/pages/rpk/rpk-generate/rpk-generate-license.adoc +++ b/modules/reference/pages/rpk/rpk-generate/rpk-generate-license.adoc @@ -1,12 +1,12 @@ ifndef::env-cloud[] = rpk generate license -: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.] +:description: Generate a trial license. This command generates a license for a 30-day trial of Redpanda Enterprise Edition. :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[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.] +:description: 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 diff --git a/modules/reference/pages/rpk/rpk-generate/rpk-generate.adoc b/modules/reference/pages/rpk/rpk-generate/rpk-generate.adoc index 105a53805b..bc43c5e352 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. 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. 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. 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 Edition. 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 Bash autocompletion relies on the `bash-completion` package. +|Shell completion can help autocomplete `rpk` commands when you press tab. BASH. |=== 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 5b42f96d78..c69ed86f6a 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: View logs for a transform. 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`.] :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: View logs for a transform. 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`.] 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.adoc b/modules/reference/pages/rpk/rpk-transform/rpk-transform.adoc index 87c0201bf9..45af7e67f8 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. 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`. ifndef::env-cloud[] |xref:reference:rpk/rpk-transform/rpk-transform-pause.adoc[`rpk transform pause`] From d2f6303c35b579f18b600bb3bad7ae28960c5c57 Mon Sep 17 00:00:00 2001 From: JakeSCahill Date: Mon, 3 Aug 2026 10:39:49 +0100 Subject: [PATCH 3/5] Drop page-level availability conditionals and fix run-on summaries Regenerated with docs-extensions-and-macros#241: - selfHostedOnly no longer wraps whole pages (doctitle included) in ifndef::env-cloud. The wrapper sat outside the single-source tag region, so includes never consumed it, and no build sets env-cloud for this component. Row, flag, and content gating inside the tag region, which does the real cloud exclusion, is unchanged. - Summaries no longer glue unterminated paragraphs into run-on sentences ('Disable partitions of a topic You may disable...') or drop sentences around mid-token periods. Output produced by running the #241 generator against this branch's snapshot, so the next regeneration reproduces it byte for byte. --- .../pages/rpk/rpk-cluster/rpk-cluster-brokers.adoc | 2 -- .../pages/rpk/rpk-cluster/rpk-cluster-config-edit.adoc | 2 -- .../pages/rpk/rpk-cluster/rpk-cluster-config-export.adoc | 2 -- .../rpk/rpk-cluster/rpk-cluster-config-force-reset.adoc | 2 -- .../pages/rpk/rpk-cluster/rpk-cluster-config-import.adoc | 2 -- .../pages/rpk/rpk-cluster/rpk-cluster-config-lint.adoc | 2 -- .../pages/rpk/rpk-cluster/rpk-cluster-config-status.adoc | 4 ++-- .../pages/rpk/rpk-cluster/rpk-cluster-config.adoc | 2 +- .../pages/rpk/rpk-cluster/rpk-cluster-health.adoc | 2 -- .../pages/rpk/rpk-cluster/rpk-cluster-license-set.adoc | 4 ++-- .../pages/rpk/rpk-cluster/rpk-cluster-license.adoc | 4 +--- .../pages/rpk/rpk-cluster/rpk-cluster-loggers.adoc | 2 -- .../pages/rpk/rpk-cluster/rpk-cluster-maintenance.adoc | 2 -- .../rpk/rpk-cluster/rpk-cluster-partitions-disable.adoc | 4 ++-- .../rpk/rpk-cluster/rpk-cluster-partitions-enable.adoc | 4 ++-- .../rpk/rpk-cluster/rpk-cluster-partitions-list.adoc | 4 ++-- .../pages/rpk/rpk-cluster/rpk-cluster-partitions.adoc | 8 +++----- .../pages/rpk/rpk-cluster/rpk-cluster-quotas-alter.adoc | 4 ++-- .../pages/rpk/rpk-cluster/rpk-cluster-quotas.adoc | 2 +- .../pages/rpk/rpk-cluster/rpk-cluster-self-test.adoc | 2 -- .../rpk/rpk-cluster/rpk-cluster-storage-restore.adoc | 2 -- .../pages/rpk/rpk-cluster/rpk-cluster-txn-list.adoc | 4 ++-- .../reference/pages/rpk/rpk-cluster/rpk-cluster-txn.adoc | 2 +- .../pages/rpk/rpk-cluster/rpk-cluster-upgrade.adoc | 2 -- .../rpk/rpk-generate/rpk-generate-grafana-dashboard.adoc | 4 ++-- .../pages/rpk/rpk-generate/rpk-generate-license.adoc | 2 -- .../rpk/rpk-generate/rpk-generate-prometheus-config.adoc | 2 -- .../pages/rpk/rpk-profile/rpk-profile-prompt.adoc | 2 +- .../pages/rpk/rpk-profile/rpk-profile-validate.adoc | 2 -- .../pages/rpk/rpk-redpanda/rpk-redpanda-config-set.adoc | 4 ++-- .../pages/rpk/rpk-redpanda/rpk-redpanda-config.adoc | 2 +- .../pages/rpk/rpk-redpanda/rpk-redpanda-mode.adoc | 4 ++-- .../pages/rpk/rpk-redpanda/rpk-redpanda-tune-list.adoc | 4 ++-- .../pages/rpk/rpk-redpanda/rpk-redpanda-tune.adoc | 2 +- .../reference/pages/rpk/rpk-redpanda/rpk-redpanda.adoc | 2 +- .../pages/rpk/rpk-registry/rpk-registry-mode-set.adoc | 4 ++-- .../pages/rpk/rpk-registry/rpk-registry-mode.adoc | 2 +- .../pages/rpk/rpk-registry/rpk-registry-schema-get.adoc | 4 ++-- .../pages/rpk/rpk-registry/rpk-registry-schema.adoc | 2 +- .../reference/pages/rpk/rpk-shadow/rpk-shadow-config.adoc | 2 -- .../reference/pages/rpk/rpk-topic/rpk-topic-analyze.adoc | 2 -- .../pages/rpk/rpk-topic/rpk-topic-describe-storage.adoc | 2 -- .../pages/rpk/rpk-topic/rpk-topic-trim-prefix.adoc | 4 ++-- modules/reference/pages/rpk/rpk-topic/rpk-topic.adoc | 4 ++-- .../pages/rpk/rpk-transform/rpk-transform-pause.adoc | 2 -- .../pages/rpk/rpk-transform/rpk-transform-resume.adoc | 2 -- modules/reference/partials/rpk-ai/rpk-ai-install.adoc | 2 +- modules/reference/partials/rpk-ai/rpk-ai-version.adoc | 6 +++--- .../partials/rpk-cloud/rpk-cloud-byoc-install.adoc | 4 ++-- .../partials/rpk-cloud/rpk-cloud-byoc-uninstall.adoc | 4 ++-- modules/reference/partials/rpk-cloud/rpk-cloud-byoc.adoc | 8 ++++---- modules/reference/partials/rpk-cloud/rpk-cloud-login.adoc | 6 +++--- .../reference/partials/rpk-cloud/rpk-cloud-logout.adoc | 4 ++-- modules/reference/partials/rpk-cloud/rpk-cloud.adoc | 6 +++--- 54 files changed, 63 insertions(+), 107 deletions(-) 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 ea1e3d9d1f..632c7ed19c 100644 --- a/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-brokers.adoc +++ b/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-brokers.adoc @@ -1,4 +1,3 @@ -ifndef::env-cloud[] = rpk cluster brokers :description: Manage Redpanda cluster brokers. :page-aliases: reference:rpk/rpk-redpanda/rpk-redpanda-admin-brokers.adoc @@ -50,4 +49,3 @@ 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 8b35a7ec6a..9838f2d4ae 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,4 +1,3 @@ -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 @@ -52,4 +51,3 @@ 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 7b70d16131..e646a9263a 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,4 +1,3 @@ -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 @@ -47,4 +46,3 @@ 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 ad7f4785c1..f87f1b8370 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,4 +1,3 @@ -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 @@ -52,4 +51,3 @@ 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 b337e2f781..2f56a97141 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,4 +1,3 @@ -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 @@ -46,4 +45,3 @@ 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 a3c6deee21..a111893424 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,4 +1,3 @@ -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 @@ -34,4 +33,3 @@ 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 8066208350..ee3acb7bbb 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 - 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. +: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. :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 - 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. +: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. 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 c3d6602c59..ec49456cb2 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 - 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. +|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. |=== 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 150503c2a2..01d530a551 100644 --- a/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-health.adoc +++ b/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-health.adoc @@ -1,4 +1,3 @@ -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 @@ -73,4 +72,3 @@ 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 a4317759dd..d3ce85aa94 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 You can either provide a path to a file containing the license: +:description: Upload license to the 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: Upload license to the cluster You can either provide a path to a file containing the license: +:description: Upload license to the cluster. 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 52e7c50e8e..4b87a1e430 100644 --- a/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-license.adoc +++ b/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-license.adoc @@ -1,4 +1,3 @@ -ifndef::env-cloud[] = rpk cluster license :description: Manage cluster license. :page-platforms: linux,darwin @@ -26,7 +25,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 You can either provide a path to a file containing the license: +|Upload license to the cluster. |=== @@ -44,4 +43,3 @@ 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 46880e2ddc..c5df05ee80 100644 --- a/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-loggers.adoc +++ b/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-loggers.adoc @@ -1,4 +1,3 @@ -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 @@ -47,4 +46,3 @@ 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 3cfb66791c..cacb58df29 100644 --- a/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-maintenance.adoc +++ b/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-maintenance.adoc @@ -1,4 +1,3 @@ -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 @@ -65,4 +64,3 @@ 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 f5e99d54a1..7b726d150b 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. The partition flag accepts the format `\{namespace}/\{topic}/[partitions...]` where namespace and topic are optional parameters.] +: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.] :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. The partition flag accepts the format `\{namespace}/\{topic}/[partitions...]` where namespace and topic are optional parameters.] +: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.] 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 57d455eeb1..57e525b77a 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. The partition flag accepts the format `\{namespace}/\{topic}/[partitions...]` where namespace and topic are optional parameters.] +: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.] :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. The partition flag accepts the format `\{namespace}/\{topic}/[partitions...]` where namespace and topic are optional parameters.] +: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.] 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 70bf880881..0410ba3c37 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. It shows the current replica assignments on both brokers and CPU cores for given topics. +:description: List partitions in the cluster. This commands lists the cluster-level metadata of all partitions in the cluster. :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. It shows the current replica assignments on both brokers and CPU cores for given topics. +:description: 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. 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 23bbbd1a21..1e0f0e7aa9 100644 --- a/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-partitions.adoc +++ b/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-partitions.adoc @@ -1,4 +1,3 @@ -ifndef::env-cloud[] = rpk cluster partitions :description: Manage cluster partitions. :page-aliases: reference:rpk/rpk-redpanda/rpk-redpanda-admin-partitions.adoc @@ -30,13 +29,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. 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 a set of topic/partitions to disable with the `--partitions`/`-p` flag. |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. 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 a set of topic/partitions to enable with the `--partitions`/`-p` flag. |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. 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. |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. @@ -69,4 +68,3 @@ 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 82881be453..22d2f5b37f 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. A client quota consists of an entity (to whom the quota is applied) and a quota type (what is being applied). +:description: Add or delete a client quota. This command allows you to add or delete a client quota. :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. A client quota consists of an entity (to whom the quota is applied) and a quota type (what is being applied). +:description: 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. 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 1ed04020a6..18672cf993 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. 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. |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 5e2845c9a1..d441f19544 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,4 +1,3 @@ -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 @@ -54,4 +53,3 @@ 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 993561046d..c89eeb7037 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,4 +1,3 @@ -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 @@ -67,4 +66,3 @@ 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 902cea4bcd..fd31fc0689 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: 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`.] +: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. :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[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`.] +: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. 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 b760eddb9c..549360c9c4 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. 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 the transactional ID, and the and the state of the transaction. |=== 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 d25f923d6a..4bfbd7985e 100644 --- a/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-upgrade.adoc +++ b/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-upgrade.adoc @@ -1,4 +1,3 @@ -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 @@ -48,4 +47,3 @@ 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 4abc5349ff..88d2082628 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. These dashboards can be imported into a Grafana or Grafana Cloud instance. +:description: Generate Grafana Dashboards for Redpanda Metrics. Use this command to generate sample Grafana dashboards for Redpanda metrics. :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. These dashboards can be imported into a Grafana or Grafana Cloud instance. +:description: 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. 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 29f6d9c8cf..dad4c3ebd6 100644 --- a/modules/reference/pages/rpk/rpk-generate/rpk-generate-license.adoc +++ b/modules/reference/pages/rpk/rpk-generate/rpk-generate-license.adoc @@ -1,4 +1,3 @@ -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. :page-platforms: linux,darwin @@ -55,4 +54,3 @@ 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 7030504702..86853e553d 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,4 +1,3 @@ -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 @@ -99,4 +98,3 @@ rpk generate prometheus-config [flags] |=== // end::single-source[] -endif::[] 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 3cc635aaf8..6c0060caea 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 ed22d80c10..db650b3a3e 100644 --- a/modules/reference/pages/rpk/rpk-profile/rpk-profile-validate.adoc +++ b/modules/reference/pages/rpk/rpk-profile/rpk-profile-validate.adoc @@ -1,4 +1,3 @@ -ifndef::env-cloud[] = rpk profile validate :description: Validate profile configuration and detect common issues. :page-platforms: linux,darwin @@ -53,4 +52,3 @@ 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 ce4aae24db..4da135d3f3 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. The first argument is the key within the `yaml` representing a property / field that you would like to 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.] :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. The first argument is the key within the `yaml` representing a property / field that you would like to 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.] 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 0d652da668..ad18336fbf 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. 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. |=== 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 a188703eed..8e61ad164a 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 184da306f3..461cffb8e8 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: 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:] +:description: List available redpanda tuners and check if they are enabled and supported by your system. :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[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:] +:description: 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. 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 61b0e55732..3e52e4544d 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 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.adoc b/modules/reference/pages/rpk/rpk-redpanda/rpk-redpanda.adoc index 97cc72d040..11aee43b00 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. PRODUCTION * Enforces optimal runtime checks. +|Enable a default configuration mode. This command allows you to set one of the following modes: Development, Production, or Recovery. |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 b834a73e46..9059bba357 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. 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).] +: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.] :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. 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).] +: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.] 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 9c3acc15d0..b42c6429d2 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. 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, alternatively you can use the `--global` flag to set the global schema registry mode at the same time as per-subject mode. |=== 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 9c79b85de7..03d3bc737a 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: 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.] +: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. :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[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.] +: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. 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 b1a35d4ffc..2381930fe6 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 * 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 potential (mutually exclusive) ways: * By version, returning a schema for a required subject and version. |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 ed5a47961e..2fbf4e6675 100644 --- a/modules/reference/pages/rpk/rpk-shadow/rpk-shadow-config.adoc +++ b/modules/reference/pages/rpk/rpk-shadow/rpk-shadow-config.adoc @@ -1,4 +1,3 @@ -ifndef::env-cloud[] = rpk shadow config :description: Generate a Redpanda Shadow Link configuration file. :page-platforms: linux,darwin @@ -41,4 +40,3 @@ 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 68b9e96464..e7fad738a8 100644 --- a/modules/reference/pages/rpk/rpk-topic/rpk-topic-analyze.adoc +++ b/modules/reference/pages/rpk/rpk-topic/rpk-topic-analyze.adoc @@ -1,4 +1,3 @@ -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 @@ -124,4 +123,3 @@ 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 dc8bad59b8..1ac0194e4e 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,4 +1,3 @@ -ifndef::env-cloud[] = rpk topic describe-storage :description: Describe the topic storage status. :page-platforms: linux,darwin @@ -79,4 +78,3 @@ 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 42f429d73a..17473d7d92 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. 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. +: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. :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. 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. +: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. 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 8717480882..43533bdccb 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 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. +|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. 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. 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. +|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. |=== 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 81f59f5f9c..ff05aa3f8d 100644 --- a/modules/reference/pages/rpk/rpk-transform/rpk-transform-pause.adoc +++ b/modules/reference/pages/rpk/rpk-transform/rpk-transform-pause.adoc @@ -1,4 +1,3 @@ -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 @@ -40,4 +39,3 @@ 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 f2a385ccfe..d9ea3f9d68 100644 --- a/modules/reference/pages/rpk/rpk-transform/rpk-transform-resume.adoc +++ b/modules/reference/pages/rpk/rpk-transform/rpk-transform-resume.adoc @@ -1,4 +1,3 @@ -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 @@ -37,4 +36,3 @@ rpk transform resume [flags] |=== // end::single-source[] -endif::[] diff --git a/modules/reference/partials/rpk-ai/rpk-ai-install.adoc b/modules/reference/partials/rpk-ai/rpk-ai-install.adoc index 15b43e22f4..98fae6121d 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 efb099b886..1491600f86 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 9969c1b96d..e986119990 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. 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. +:description: Install the BYOC plugin. This command downloads the BYOC managed plugin if necessary. :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. 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. +:description: 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 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 0046b52ac0..8589455d00 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. Often, you only need to download the plugin to create your cluster once, and then you never need the plugin again. +:description: Uninstall the BYOC plugin. This command deletes your locally downloaded BYOC managed plugin if it exists. :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. Often, you only need to download the plugin to create your cluster once, and then you never need the plugin again. +:description: 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. diff --git a/modules/reference/partials/rpk-cloud/rpk-cloud-byoc.adoc b/modules/reference/partials/rpk-cloud/rpk-cloud-byoc.adoc index d3bb40fc9e..9ad488348f 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. The agent then proceeds to provision further infrastructure and eventually, a full Redpanda cluster. +:description: Manage a Redpanda Cloud BYOC agent. For BYOC, Redpanda installs an agent service in your owned 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. The agent then proceeds to provision further infrastructure and eventually, a full Redpanda cluster. +:description: 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 @@ -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. 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. |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. 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-login.adoc b/modules/reference/partials/rpk-cloud/rpk-cloud-login.adoc index 15140f4ea0..6b6a33d82b 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. 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. +: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. :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. 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. +: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. 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 61dc9db36a..92a0343098 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: 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.] +:description: Log out from Redpanda Cloud. This command deletes your cloud auth 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: 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.] +:description: 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 diff --git a/modules/reference/partials/rpk-cloud/rpk-cloud.adoc b/modules/reference/partials/rpk-cloud/rpk-cloud.adoc index 453a92b884..0e607fb7ff 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. 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. |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. 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, ensures it is still valid. |xref:reference:rpk/rpk-cloud/rpk-cloud-logout.adoc[`rpk cloud logout`] -|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. |xref:reference:rpk/rpk-cloud/rpk-cloud-mcp.adoc[`rpk cloud mcp`] |Manage Redpanda Cloud MCP server. From afe07e425d0d4525f04e615aea8ca6e25f6c03f3 Mon Sep 17 00:00:00 2001 From: JakeSCahill Date: Mon, 3 Aug 2026 10:58:42 +0100 Subject: [PATCH 4/5] Correct two stale upstream help claims via curation-wins overrides CodeRabbit review findings, both defects in rpk's own help text that the ground-truth restoration faithfully reproduced: - rpk group delete claimed Redpanda cannot expire offsets for empty groups automatically (pre group_offset_retention_sec, redpanda#2904), contradicting the curated section on the same page that documents current expiration semantics. - rpk topic delete claimed ^/$ anchoring 'prevents accidental delete-everything mistakes', which its own '.*' example disproves. Both overrides carry _note fields naming the upstream defect so they are removed when rpk's help is corrected. --- docs-data/rpk-overrides.json | 8 +++-- .../pages/rpk/rpk-group/rpk-group-delete.adoc | 23 +++----------- .../pages/rpk/rpk-group/rpk-group.adoc | 2 +- .../pages/rpk/rpk-topic/rpk-topic-delete.adoc | 30 ++++--------------- .../pages/rpk/rpk-topic/rpk-topic.adoc | 2 +- 5 files changed, 18 insertions(+), 47 deletions(-) diff --git a/docs-data/rpk-overrides.json b/docs-data/rpk-overrides.json index bc7b0dd9ee..b6f196e47b 100644 --- a/docs-data/rpk-overrides.json +++ b/docs-data/rpk-overrides.json @@ -634,7 +634,9 @@ } ] } - ] + ], + "description": "Delete one or more Kafka topics.\n\nThis command deletes all requested topics, printing the success or fail status per topic.\n\nThe `--regex` flag (`-r`) opts into parsing the input topics as regular expressions and deleting any non-internal topic that matches any of the expressions. Each expression is wrapped with `^` and `$`, so it must match a whole topic name rather than part of one. Anchoring does not make broad expressions safe: `.*` still matches, and deletes, every non-internal topic.\n\nThe topic list command accepts the same input regex format as this delete command. To check what your regular expressions will delete before actually deleting them, check the output of `rpk topic list -r`.", + "_note": "Curation-wins: source help claims ^/$ anchoring 'prevents accidental delete-everything mistakes', which its own '.*' example disproves, and its example table duplicates the curated Examples section. Remove when upstream help is corrected." }, "rpk topic produce": { "description": "Produce records to a topic. Producing records reads from `STDIN`, parses input according to `--format`, and produces records to Redpanda.", @@ -2245,7 +2247,9 @@ "format": { "introducedInVersion": "v26.2.1" } - } + }, + "description": "Delete one or more consumer groups.\n\nYou may want to delete groups to clean up committed offsets sooner than they expire automatically, such as when you create temporary groups for quick investigation or testing. This command helps you do that.", + "_note": "Curation-wins: source help still claims Redpanda cannot expire offsets for empty groups automatically (pre group_offset_retention_sec, redpanda#2904). The curated group-offset-deletion section below documents current semantics. Remove this override when upstream help is corrected." }, "rpk plugin": { "pageAliases": "reference:rpk/rpk-plugin.adoc" diff --git a/modules/reference/pages/rpk/rpk-group/rpk-group-delete.adoc b/modules/reference/pages/rpk/rpk-group/rpk-group-delete.adoc index 871604ae43..98875c16e8 100644 --- a/modules/reference/pages/rpk/rpk-group/rpk-group-delete.adoc +++ b/modules/reference/pages/rpk/rpk-group/rpk-group-delete.adoc @@ -1,29 +1,14 @@ = rpk group delete -:description: Delete groups from brokers. Older versions of the Kafka protocol included a retention_millis field in offset commit requests. +:description: Delete one or more consumer groups. You may want to delete groups to clean up committed offsets sooner than they expire automatically, such as when you create temporary groups for quick investigation or testing. :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: Delete groups from brokers. Older versions of the Kafka protocol included a retention_millis field in offset commit requests. -Delete groups from brokers. +:description: Delete one or more consumer groups. You may want to delete groups to clean up committed offsets sooner than they expire automatically, such as when you create temporary groups for quick investigation or testing. +Delete one or more consumer groups. -Older versions of the Kafka protocol included a retention_millis field in -offset commit requests. Group commits persisted for this retention and then -eventually expired. Once all commits for a group expired, the group would be -considered deleted. - -The retention field was removed because it proved problematic for infrequently -committing consumers: the offsets could be expired for a group that was still -active. If clients use new enough versions of OffsetCommit (versions that have -removed the retention field), brokers expire offsets only when the group is -empty for offset.retention.minutes. Redpanda does not currently support that -configuration (see https://github.com/redpanda-data/redpanda/issues/2904[#2904]), meaning offsets for empty groups expire only when -they are explicitly deleted. - -You may want to delete groups to clean up offsets sooner than when they -automatically are cleaned up, such as when you create temporary groups for -quick investigation or testing. This command helps you do that. +You may want to delete groups to clean up committed offsets sooner than they expire automatically, such as when you create temporary groups for quick investigation or testing. This command helps you do that. ifndef::env-cloud[] + diff --git a/modules/reference/pages/rpk/rpk-group/rpk-group.adoc b/modules/reference/pages/rpk/rpk-group/rpk-group.adoc index b3c3f9ad8a..72ee9984e1 100644 --- a/modules/reference/pages/rpk/rpk-group/rpk-group.adoc +++ b/modules/reference/pages/rpk/rpk-group/rpk-group.adoc @@ -68,7 +68,7 @@ rpk g |Command |Description |xref:reference:rpk/rpk-group/rpk-group-delete.adoc[`rpk group delete`] -|Delete groups from brokers. Older versions of the Kafka protocol included a retention_millis field in offset commit requests. +|Delete one or more consumer groups. You may want to delete groups to clean up committed offsets sooner than they expire automatically, such as when you create temporary groups for quick investigation or testing. |xref:reference:rpk/rpk-group/rpk-group-describe.adoc[`rpk group describe`] |Describe group offset status & lag. This command describes group members, calculates their lag, and prints detailed information about the members. diff --git a/modules/reference/pages/rpk/rpk-topic/rpk-topic-delete.adoc b/modules/reference/pages/rpk/rpk-topic/rpk-topic-delete.adoc index 1fb1ff5719..5098c6b4d5 100644 --- a/modules/reference/pages/rpk/rpk-topic/rpk-topic-delete.adoc +++ b/modules/reference/pages/rpk/rpk-topic/rpk-topic-delete.adoc @@ -1,36 +1,18 @@ = rpk topic delete -:description: Delete topics. This command deletes all requested topics, printing the success or fail status per topic. +:description: Delete one or more Kafka topics. This command deletes all requested topics, printing the success or fail status per topic. :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: Delete topics. This command deletes all requested topics, printing the success or fail status per topic. -Delete topics. +:description: Delete one or more Kafka topics. This command deletes all requested topics, printing the success or fail status per topic. +Delete one or more Kafka topics. -This command deletes all requested topics, printing the success or fail status -per topic. +This command deletes all requested topics, printing the success or fail status per topic. -The `--regex` flag (`-r`) opts into parsing the input topics as regular expressions -and deleting any non-internal topic that matches any of expressions. The input -expressions are wrapped with ^ and $ so that the expression must match the -whole topic name (which also prevents accidental delete-everything mistakes). +The `--regex` flag (`-r`) opts into parsing the input topics as regular expressions and deleting any non-internal topic that matches any of the expressions. Each expression is wrapped with `^` and `$`, so it must match a whole topic name rather than part of one. Anchoring does not make broad expressions safe: `.*` still matches, and deletes, every non-internal topic. -The topic list command accepts the same input regex format as this delete -command. If you want to check what your regular expressions will delete before -actually deleting them, you can check the output of `rpk topic list -r`. - -For example,. - -[cols="1m,1a"] -|=== -|Value |Description - -|delete foo bar |# deletes topics foo and bar -|delete `-r` '^f.*' '.*r$' |# deletes any topic starting with f and any topics ending in r -|delete `-r` '.*' |# deletes all topics -|delete `-r` . |# deletes any one-character topics -|=== +The topic list command accepts the same input regex format as this delete command. To check what your regular expressions will delete before actually deleting them, check the output of `rpk topic list -r`. CAUTION: Deleting a topic is irreversible and removes all data in the topic. diff --git a/modules/reference/pages/rpk/rpk-topic/rpk-topic.adoc b/modules/reference/pages/rpk/rpk-topic/rpk-topic.adoc index 43533bdccb..27c3dd716c 100644 --- a/modules/reference/pages/rpk/rpk-topic/rpk-topic.adoc +++ b/modules/reference/pages/rpk/rpk-topic/rpk-topic.adoc @@ -40,7 +40,7 @@ endif::[] |Create one or more Kafka topics with configurable partitions, replication factor, and topic-level settings. All topics created with one invocation have the same number of partitions, replication factor, and key/value configs. |xref:reference:rpk/rpk-topic/rpk-topic-delete.adoc[`rpk topic delete`] -|Delete topics. This command deletes all requested topics, printing the success or fail status per topic. +|Delete one or more Kafka topics. This command deletes all requested topics, printing the success or fail status per topic. |xref:reference:rpk/rpk-topic/rpk-topic-describe.adoc[`rpk topic describe`] |Print detailed information about topics. There are three potential views: a summary of the topic, the topic configurations, and a detailed partitions section. From 86984315d3c7db460216d785ae1dd2ccb8bae5a1 Mon Sep 17 00:00:00 2001 From: JakeSCahill Date: Mon, 3 Aug 2026 11:12:07 +0100 Subject: [PATCH 5/5] Correct 30 fabricated introduced-in versions on rpk ai commands Every 'introduced in ai version 0.2.32' note was wrong. The plugin splice stamps commands that are new relative to the previous snapshot, but the previous snapshot's ai subtree predated 0.2.26, so three releases' worth of commands were attributed to 0.2.32. Verified against real plugin binaries (rpai 0.2.20 through 0.2.32 from the plugins manifest, --help-autocomplete tree per version): - rpk ai policy family (8 commands): introduced in 0.2.26 - rpk ai llm-provider family, mcp-server family, oauth-client update (22 commands): introduced in 0.2.28 The k8s notes (26.2.1 is the plugin's first GA in its manifest) and the 14 core v26.2.1 command stamps plus 23 flag stamps (all absent from the rpk 26.1.12 tree) verified correct. --- docs-data/rpk-overrides.json | 60 +++++++++---------- .../rpk-ai/rpk-ai-llm-provider-apply.adoc | 2 +- .../rpk-ai/rpk-ai-llm-provider-check.adoc | 2 +- .../rpk-ai/rpk-ai-llm-provider-create.adoc | 2 +- .../rpk-ai/rpk-ai-llm-provider-delete.adoc | 2 +- .../rpk-ai/rpk-ai-llm-provider-diff.adoc | 2 +- .../rpk-ai/rpk-ai-llm-provider-get.adoc | 2 +- .../rpk-ai/rpk-ai-llm-provider-list.adoc | 2 +- .../rpk-ai/rpk-ai-llm-provider-update.adoc | 2 +- .../partials/rpk-ai/rpk-ai-llm-provider.adoc | 2 +- .../rpk-ai/rpk-ai-mcp-server-apply.adoc | 2 +- .../rpk-ai/rpk-ai-mcp-server-create.adoc | 2 +- .../rpk-ai/rpk-ai-mcp-server-delete.adoc | 2 +- .../rpk-ai/rpk-ai-mcp-server-diff.adoc | 2 +- .../rpk-ai/rpk-ai-mcp-server-get.adoc | 2 +- .../rpk-ai/rpk-ai-mcp-server-list.adoc | 2 +- .../rpk-ai/rpk-ai-mcp-server-tools-call.adoc | 2 +- .../rpk-ai/rpk-ai-mcp-server-tools-list.adoc | 2 +- .../rpk-ai/rpk-ai-mcp-server-tools.adoc | 2 +- .../rpk-ai/rpk-ai-mcp-server-types.adoc | 2 +- .../rpk-ai/rpk-ai-mcp-server-update.adoc | 2 +- .../partials/rpk-ai/rpk-ai-mcp-server.adoc | 2 +- .../rpk-ai/rpk-ai-oauth-client-update.adoc | 2 +- .../partials/rpk-ai/rpk-ai-policy-apply.adoc | 2 +- .../partials/rpk-ai/rpk-ai-policy-create.adoc | 2 +- .../partials/rpk-ai/rpk-ai-policy-delete.adoc | 2 +- .../partials/rpk-ai/rpk-ai-policy-diff.adoc | 2 +- .../partials/rpk-ai/rpk-ai-policy-get.adoc | 2 +- .../partials/rpk-ai/rpk-ai-policy-list.adoc | 2 +- .../partials/rpk-ai/rpk-ai-policy-update.adoc | 2 +- .../partials/rpk-ai/rpk-ai-policy.adoc | 2 +- 31 files changed, 60 insertions(+), 60 deletions(-) diff --git a/docs-data/rpk-overrides.json b/docs-data/rpk-overrides.json index b6f196e47b..14ce6422d6 100644 --- a/docs-data/rpk-overrides.json +++ b/docs-data/rpk-overrides.json @@ -3205,7 +3205,7 @@ "description": "Stop a managed agent, setting its desired state to stopped." }, "rpk ai llm-provider check": { - "introducedInVersion": "0.2.32" + "introducedInVersion": "0.2.28" }, "rpk ai agent credential create": { "description": "Create a client ID and secret pair for an agent. The client secret is shown once and cannot be retrieved again." @@ -3514,91 +3514,91 @@ "introducedInVersion": "v26.2.1" }, "rpk ai llm-provider": { - "introducedInVersion": "0.2.32" + "introducedInVersion": "0.2.28" }, "rpk ai llm-provider apply": { - "introducedInVersion": "0.2.32" + "introducedInVersion": "0.2.28" }, "rpk ai llm-provider create": { - "introducedInVersion": "0.2.32" + "introducedInVersion": "0.2.28" }, "rpk ai llm-provider delete": { - "introducedInVersion": "0.2.32" + "introducedInVersion": "0.2.28" }, "rpk ai llm-provider diff": { - "introducedInVersion": "0.2.32" + "introducedInVersion": "0.2.28" }, "rpk ai llm-provider get": { - "introducedInVersion": "0.2.32" + "introducedInVersion": "0.2.28" }, "rpk ai llm-provider list": { - "introducedInVersion": "0.2.32" + "introducedInVersion": "0.2.28" }, "rpk ai llm-provider update": { - "introducedInVersion": "0.2.32" + "introducedInVersion": "0.2.28" }, "rpk ai mcp-server": { - "introducedInVersion": "0.2.32" + "introducedInVersion": "0.2.28" }, "rpk ai mcp-server apply": { - "introducedInVersion": "0.2.32" + "introducedInVersion": "0.2.28" }, "rpk ai mcp-server create": { - "introducedInVersion": "0.2.32" + "introducedInVersion": "0.2.28" }, "rpk ai mcp-server delete": { - "introducedInVersion": "0.2.32" + "introducedInVersion": "0.2.28" }, "rpk ai mcp-server diff": { - "introducedInVersion": "0.2.32" + "introducedInVersion": "0.2.28" }, "rpk ai mcp-server get": { - "introducedInVersion": "0.2.32" + "introducedInVersion": "0.2.28" }, "rpk ai mcp-server list": { - "introducedInVersion": "0.2.32" + "introducedInVersion": "0.2.28" }, "rpk ai mcp-server tools": { - "introducedInVersion": "0.2.32" + "introducedInVersion": "0.2.28" }, "rpk ai mcp-server tools call": { - "introducedInVersion": "0.2.32" + "introducedInVersion": "0.2.28" }, "rpk ai mcp-server tools list": { - "introducedInVersion": "0.2.32" + "introducedInVersion": "0.2.28" }, "rpk ai mcp-server types": { - "introducedInVersion": "0.2.32" + "introducedInVersion": "0.2.28" }, "rpk ai mcp-server update": { - "introducedInVersion": "0.2.32" + "introducedInVersion": "0.2.28" }, "rpk ai oauth-client update": { - "introducedInVersion": "0.2.32" + "introducedInVersion": "0.2.28" }, "rpk ai policy": { - "introducedInVersion": "0.2.32" + "introducedInVersion": "0.2.26" }, "rpk ai policy apply": { - "introducedInVersion": "0.2.32" + "introducedInVersion": "0.2.26" }, "rpk ai policy create": { - "introducedInVersion": "0.2.32" + "introducedInVersion": "0.2.26" }, "rpk ai policy delete": { - "introducedInVersion": "0.2.32" + "introducedInVersion": "0.2.26" }, "rpk ai policy diff": { - "introducedInVersion": "0.2.32" + "introducedInVersion": "0.2.26" }, "rpk ai policy get": { - "introducedInVersion": "0.2.32" + "introducedInVersion": "0.2.26" }, "rpk ai policy list": { - "introducedInVersion": "0.2.32" + "introducedInVersion": "0.2.26" }, "rpk ai policy update": { - "introducedInVersion": "0.2.32" + "introducedInVersion": "0.2.26" }, "rpk check": { "introducedInVersion": "v26.2.1" diff --git a/modules/reference/partials/rpk-ai/rpk-ai-llm-provider-apply.adoc b/modules/reference/partials/rpk-ai/rpk-ai-llm-provider-apply.adoc index d6bc4cab79..dc38bc3346 100644 --- a/modules/reference/partials/rpk-ai/rpk-ai-llm-provider-apply.adoc +++ b/modules/reference/partials/rpk-ai/rpk-ai-llm-provider-apply.adoc @@ -20,7 +20,7 @@ read stdin. This does not delete resources absent from the manifests (no prune), and drift is detected only for the fields a manifest names; see `diff --help`. -NOTE: This command was introduced in ai version 0.2.32. +NOTE: This command was introduced in ai version 0.2.28. == Usage diff --git a/modules/reference/partials/rpk-ai/rpk-ai-llm-provider-check.adoc b/modules/reference/partials/rpk-ai/rpk-ai-llm-provider-check.adoc index ab9da3536e..64bcf54341 100644 --- a/modules/reference/partials/rpk-ai/rpk-ai-llm-provider-check.adoc +++ b/modules/reference/partials/rpk-ai/rpk-ai-llm-provider-check.adoc @@ -8,7 +8,7 @@ :description: Runs a lightweight probe against the upstream to verify credentials and reachability. Runs a lightweight probe against the upstream to verify credentials and reachability. -NOTE: This command was introduced in ai version 0.2.32. +NOTE: This command was introduced in ai version 0.2.28. == Usage diff --git a/modules/reference/partials/rpk-ai/rpk-ai-llm-provider-create.adoc b/modules/reference/partials/rpk-ai/rpk-ai-llm-provider-create.adoc index 69fa0f4d09..882dc043a6 100644 --- a/modules/reference/partials/rpk-ai/rpk-ai-llm-provider-create.adoc +++ b/modules/reference/partials/rpk-ai/rpk-ai-llm-provider-create.adoc @@ -11,7 +11,7 @@ Create an LLM provider. Choose the provider-config by setting flags from one group; the group you use selects it: openai-config, anthropic-config, google-config, bedrock-config, openai-compatible-config. Setting flags from two groups is an error. -NOTE: This command was introduced in ai version 0.2.32. +NOTE: This command was introduced in ai version 0.2.28. == Usage diff --git a/modules/reference/partials/rpk-ai/rpk-ai-llm-provider-delete.adoc b/modules/reference/partials/rpk-ai/rpk-ai-llm-provider-delete.adoc index 87fc1f3815..f951ba9bf2 100644 --- a/modules/reference/partials/rpk-ai/rpk-ai-llm-provider-delete.adoc +++ b/modules/reference/partials/rpk-ai/rpk-ai-llm-provider-delete.adoc @@ -8,7 +8,7 @@ :description: Delete an LLM provider. Delete an LLM provider. -NOTE: This command was introduced in ai version 0.2.32. +NOTE: This command was introduced in ai version 0.2.28. == Usage diff --git a/modules/reference/partials/rpk-ai/rpk-ai-llm-provider-diff.adoc b/modules/reference/partials/rpk-ai/rpk-ai-llm-provider-diff.adoc index dced697116..e78e927883 100644 --- a/modules/reference/partials/rpk-ai/rpk-ai-llm-provider-diff.adoc +++ b/modules/reference/partials/rpk-ai/rpk-ai-llm-provider-diff.adoc @@ -14,7 +14,7 @@ NOTE: diff proves only that the fields a manifest names match live. It does not detect resources that exist live but are absent from the manifests (no prune), nor drift in fields a manifest omits. -NOTE: This command was introduced in ai version 0.2.32. +NOTE: This command was introduced in ai version 0.2.28. == Usage diff --git a/modules/reference/partials/rpk-ai/rpk-ai-llm-provider-get.adoc b/modules/reference/partials/rpk-ai/rpk-ai-llm-provider-get.adoc index eeb7e672f1..3e2d016632 100644 --- a/modules/reference/partials/rpk-ai/rpk-ai-llm-provider-get.adoc +++ b/modules/reference/partials/rpk-ai/rpk-ai-llm-provider-get.adoc @@ -8,7 +8,7 @@ :description: Get an LLM provider. Get an LLM provider. -NOTE: This command was introduced in ai version 0.2.32. +NOTE: This command was introduced in ai version 0.2.28. == Usage diff --git a/modules/reference/partials/rpk-ai/rpk-ai-llm-provider-list.adoc b/modules/reference/partials/rpk-ai/rpk-ai-llm-provider-list.adoc index 66e02b3b50..cdba30a700 100644 --- a/modules/reference/partials/rpk-ai/rpk-ai-llm-provider-list.adoc +++ b/modules/reference/partials/rpk-ai/rpk-ai-llm-provider-list.adoc @@ -8,7 +8,7 @@ :description: List LLM providers. List LLM providers. -NOTE: This command was introduced in ai version 0.2.32. +NOTE: This command was introduced in ai version 0.2.28. == Usage diff --git a/modules/reference/partials/rpk-ai/rpk-ai-llm-provider-update.adoc b/modules/reference/partials/rpk-ai/rpk-ai-llm-provider-update.adoc index f7a8f5c3c7..29867c86f5 100644 --- a/modules/reference/partials/rpk-ai/rpk-ai-llm-provider-update.adoc +++ b/modules/reference/partials/rpk-ai/rpk-ai-llm-provider-update.adoc @@ -8,7 +8,7 @@ :description: Update an LLM provider. Update an LLM provider. -NOTE: This command was introduced in ai version 0.2.32. +NOTE: This command was introduced in ai version 0.2.28. == Usage diff --git a/modules/reference/partials/rpk-ai/rpk-ai-llm-provider.adoc b/modules/reference/partials/rpk-ai/rpk-ai-llm-provider.adoc index e3abec9e84..8a748e0eec 100644 --- a/modules/reference/partials/rpk-ai/rpk-ai-llm-provider.adoc +++ b/modules/reference/partials/rpk-ai/rpk-ai-llm-provider.adoc @@ -8,7 +8,7 @@ :description: pass:q[Manage LLM providers (`create`, get, list, update, delete).] Manage LLM providers (`create`, get, list, update, delete). -NOTE: This command was introduced in ai version 0.2.32. +NOTE: This command was introduced in ai version 0.2.28. == Usage diff --git a/modules/reference/partials/rpk-ai/rpk-ai-mcp-server-apply.adoc b/modules/reference/partials/rpk-ai/rpk-ai-mcp-server-apply.adoc index 67db31f671..42ab916862 100644 --- a/modules/reference/partials/rpk-ai/rpk-ai-mcp-server-apply.adoc +++ b/modules/reference/partials/rpk-ai/rpk-ai-mcp-server-apply.adoc @@ -20,7 +20,7 @@ read stdin. This does not delete resources absent from the manifests (no prune), and drift is detected only for the fields a manifest names; see `diff --help`. -NOTE: This command was introduced in ai version 0.2.32. +NOTE: This command was introduced in ai version 0.2.28. == Usage diff --git a/modules/reference/partials/rpk-ai/rpk-ai-mcp-server-create.adoc b/modules/reference/partials/rpk-ai/rpk-ai-mcp-server-create.adoc index abab2be068..8b6c032349 100644 --- a/modules/reference/partials/rpk-ai/rpk-ai-mcp-server-create.adoc +++ b/modules/reference/partials/rpk-ai/rpk-ai-mcp-server-create.adoc @@ -11,7 +11,7 @@ Create an MCP server. Choose the backend by setting flags from one group; the group you use selects it: remote, managed. Setting flags from two groups is an error. -NOTE: This command was introduced in ai version 0.2.32. +NOTE: This command was introduced in ai version 0.2.28. == Usage diff --git a/modules/reference/partials/rpk-ai/rpk-ai-mcp-server-delete.adoc b/modules/reference/partials/rpk-ai/rpk-ai-mcp-server-delete.adoc index 8ad11154b3..6a6c668abc 100644 --- a/modules/reference/partials/rpk-ai/rpk-ai-mcp-server-delete.adoc +++ b/modules/reference/partials/rpk-ai/rpk-ai-mcp-server-delete.adoc @@ -8,7 +8,7 @@ :description: Delete an MCP server. Delete an MCP server. -NOTE: This command was introduced in ai version 0.2.32. +NOTE: This command was introduced in ai version 0.2.28. == Usage diff --git a/modules/reference/partials/rpk-ai/rpk-ai-mcp-server-diff.adoc b/modules/reference/partials/rpk-ai/rpk-ai-mcp-server-diff.adoc index 4388ea358e..dd10bc5ea4 100644 --- a/modules/reference/partials/rpk-ai/rpk-ai-mcp-server-diff.adoc +++ b/modules/reference/partials/rpk-ai/rpk-ai-mcp-server-diff.adoc @@ -14,7 +14,7 @@ NOTE: diff proves only that the fields a manifest names match live. It does not detect resources that exist live but are absent from the manifests (no prune), nor drift in fields a manifest omits. -NOTE: This command was introduced in ai version 0.2.32. +NOTE: This command was introduced in ai version 0.2.28. == Usage diff --git a/modules/reference/partials/rpk-ai/rpk-ai-mcp-server-get.adoc b/modules/reference/partials/rpk-ai/rpk-ai-mcp-server-get.adoc index ae16bb7582..3b2e47dd2d 100644 --- a/modules/reference/partials/rpk-ai/rpk-ai-mcp-server-get.adoc +++ b/modules/reference/partials/rpk-ai/rpk-ai-mcp-server-get.adoc @@ -8,7 +8,7 @@ :description: Get an MCP server. Get an MCP server. -NOTE: This command was introduced in ai version 0.2.32. +NOTE: This command was introduced in ai version 0.2.28. == Usage diff --git a/modules/reference/partials/rpk-ai/rpk-ai-mcp-server-list.adoc b/modules/reference/partials/rpk-ai/rpk-ai-mcp-server-list.adoc index 5ed1f77758..b5637aaaae 100644 --- a/modules/reference/partials/rpk-ai/rpk-ai-mcp-server-list.adoc +++ b/modules/reference/partials/rpk-ai/rpk-ai-mcp-server-list.adoc @@ -8,7 +8,7 @@ :description: List MCP servers. List MCP servers. -NOTE: This command was introduced in ai version 0.2.32. +NOTE: This command was introduced in ai version 0.2.28. == Usage diff --git a/modules/reference/partials/rpk-ai/rpk-ai-mcp-server-tools-call.adoc b/modules/reference/partials/rpk-ai/rpk-ai-mcp-server-tools-call.adoc index 9cf91c67ae..30aa0faf82 100644 --- a/modules/reference/partials/rpk-ai/rpk-ai-mcp-server-tools-call.adoc +++ b/modules/reference/partials/rpk-ai/rpk-ai-mcp-server-tools-call.adoc @@ -31,7 +31,7 @@ rpai mcp tools call pg-garrett execute --code-mode \ --args '{"code":"var r = call_tool({name:\"query\", arguments:{query:\"SELECT 1\"}}); JSON.stringify(r);"}' ---- -NOTE: This command was introduced in ai version 0.2.32. +NOTE: This command was introduced in ai version 0.2.28. == Usage diff --git a/modules/reference/partials/rpk-ai/rpk-ai-mcp-server-tools-list.adoc b/modules/reference/partials/rpk-ai/rpk-ai-mcp-server-tools-list.adoc index d01a323be3..3ce6af2bbd 100644 --- a/modules/reference/partials/rpk-ai/rpk-ai-mcp-server-tools-list.adoc +++ b/modules/reference/partials/rpk-ai/rpk-ai-mcp-server-tools-list.adoc @@ -23,7 +23,7 @@ search tool explicitly: rpai mcp tools call search --code-mode ---- -NOTE: This command was introduced in ai version 0.2.32. +NOTE: This command was introduced in ai version 0.2.28. == Usage diff --git a/modules/reference/partials/rpk-ai/rpk-ai-mcp-server-tools.adoc b/modules/reference/partials/rpk-ai/rpk-ai-mcp-server-tools.adoc index 90c854162e..c448a74964 100644 --- a/modules/reference/partials/rpk-ai/rpk-ai-mcp-server-tools.adoc +++ b/modules/reference/partials/rpk-ai/rpk-ai-mcp-server-tools.adoc @@ -8,7 +8,7 @@ :description: Interact with tools on an MCP server. Interact with tools on an MCP server. -NOTE: This command was introduced in ai version 0.2.32. +NOTE: This command was introduced in ai version 0.2.28. == Usage diff --git a/modules/reference/partials/rpk-ai/rpk-ai-mcp-server-types.adoc b/modules/reference/partials/rpk-ai/rpk-ai-mcp-server-types.adoc index 9ffdaf34cc..c5920d83c5 100644 --- a/modules/reference/partials/rpk-ai/rpk-ai-mcp-server-types.adoc +++ b/modules/reference/partials/rpk-ai/rpk-ai-mcp-server-types.adoc @@ -8,7 +8,7 @@ :description: List available managed MCP types. List available managed MCP types. -NOTE: This command was introduced in ai version 0.2.32. +NOTE: This command was introduced in ai version 0.2.28. == Usage diff --git a/modules/reference/partials/rpk-ai/rpk-ai-mcp-server-update.adoc b/modules/reference/partials/rpk-ai/rpk-ai-mcp-server-update.adoc index 7face93d05..92f0a93318 100644 --- a/modules/reference/partials/rpk-ai/rpk-ai-mcp-server-update.adoc +++ b/modules/reference/partials/rpk-ai/rpk-ai-mcp-server-update.adoc @@ -8,7 +8,7 @@ :description: Update an MCP server. Update an MCP server. -NOTE: This command was introduced in ai version 0.2.32. +NOTE: This command was introduced in ai version 0.2.28. == Usage diff --git a/modules/reference/partials/rpk-ai/rpk-ai-mcp-server.adoc b/modules/reference/partials/rpk-ai/rpk-ai-mcp-server.adoc index cdaaea39e0..4b8561ddf0 100644 --- a/modules/reference/partials/rpk-ai/rpk-ai-mcp-server.adoc +++ b/modules/reference/partials/rpk-ai/rpk-ai-mcp-server.adoc @@ -8,7 +8,7 @@ :description: pass:q[Manage MCP servers (`create`, get, list, update, delete).] Manage MCP servers (`create`, get, list, update, delete). -NOTE: This command was introduced in ai version 0.2.32. +NOTE: This command was introduced in ai version 0.2.28. == Usage diff --git a/modules/reference/partials/rpk-ai/rpk-ai-oauth-client-update.adoc b/modules/reference/partials/rpk-ai/rpk-ai-oauth-client-update.adoc index 13660cde23..7a935fa5b8 100644 --- a/modules/reference/partials/rpk-ai/rpk-ai-oauth-client-update.adoc +++ b/modules/reference/partials/rpk-ai/rpk-ai-oauth-client-update.adoc @@ -8,7 +8,7 @@ :description: Update an OAuth client. Update an OAuth client. -NOTE: This command was introduced in ai version 0.2.32. +NOTE: This command was introduced in ai version 0.2.28. == Usage diff --git a/modules/reference/partials/rpk-ai/rpk-ai-policy-apply.adoc b/modules/reference/partials/rpk-ai/rpk-ai-policy-apply.adoc index 277106b26e..3fb2b341b9 100644 --- a/modules/reference/partials/rpk-ai/rpk-ai-policy-apply.adoc +++ b/modules/reference/partials/rpk-ai/rpk-ai-policy-apply.adoc @@ -20,7 +20,7 @@ read stdin. This does not delete resources absent from the manifests (no prune), and drift is detected only for the fields a manifest names; see `diff --help`. -NOTE: This command was introduced in ai version 0.2.32. +NOTE: This command was introduced in ai version 0.2.26. == Usage diff --git a/modules/reference/partials/rpk-ai/rpk-ai-policy-create.adoc b/modules/reference/partials/rpk-ai/rpk-ai-policy-create.adoc index ab36b83db3..9d8dc74611 100644 --- a/modules/reference/partials/rpk-ai/rpk-ai-policy-create.adoc +++ b/modules/reference/partials/rpk-ai/rpk-ai-policy-create.adoc @@ -22,7 +22,7 @@ Data shaping (`masking`, dropping, row filtering) is NOT configured here. It lives on the MCP server's data policies (`rpk` ai mcp ...), not in Cedar text; the @redact_mask / @redact_drop annotations are gone. -NOTE: This command was introduced in ai version 0.2.32. +NOTE: This command was introduced in ai version 0.2.26. == Usage diff --git a/modules/reference/partials/rpk-ai/rpk-ai-policy-delete.adoc b/modules/reference/partials/rpk-ai/rpk-ai-policy-delete.adoc index be60021732..95a4050320 100644 --- a/modules/reference/partials/rpk-ai/rpk-ai-policy-delete.adoc +++ b/modules/reference/partials/rpk-ai/rpk-ai-policy-delete.adoc @@ -8,7 +8,7 @@ :description: Delete a policy. Delete a policy. -NOTE: This command was introduced in ai version 0.2.32. +NOTE: This command was introduced in ai version 0.2.26. == Usage diff --git a/modules/reference/partials/rpk-ai/rpk-ai-policy-diff.adoc b/modules/reference/partials/rpk-ai/rpk-ai-policy-diff.adoc index 11486c3f5c..d1e839db6d 100644 --- a/modules/reference/partials/rpk-ai/rpk-ai-policy-diff.adoc +++ b/modules/reference/partials/rpk-ai/rpk-ai-policy-diff.adoc @@ -14,7 +14,7 @@ NOTE: diff proves only that the fields a manifest names match live. It does not detect resources that exist live but are absent from the manifests (no prune), nor drift in fields a manifest omits. -NOTE: This command was introduced in ai version 0.2.32. +NOTE: This command was introduced in ai version 0.2.26. == Usage diff --git a/modules/reference/partials/rpk-ai/rpk-ai-policy-get.adoc b/modules/reference/partials/rpk-ai/rpk-ai-policy-get.adoc index faf7e03ab3..80b6bd72b6 100644 --- a/modules/reference/partials/rpk-ai/rpk-ai-policy-get.adoc +++ b/modules/reference/partials/rpk-ai/rpk-ai-policy-get.adoc @@ -8,7 +8,7 @@ :description: Get a policy. Get a policy. -NOTE: This command was introduced in ai version 0.2.32. +NOTE: This command was introduced in ai version 0.2.26. == Usage diff --git a/modules/reference/partials/rpk-ai/rpk-ai-policy-list.adoc b/modules/reference/partials/rpk-ai/rpk-ai-policy-list.adoc index fe3e7ddcd7..585eb1b0a2 100644 --- a/modules/reference/partials/rpk-ai/rpk-ai-policy-list.adoc +++ b/modules/reference/partials/rpk-ai/rpk-ai-policy-list.adoc @@ -8,7 +8,7 @@ :description: List policies. List policies. -NOTE: This command was introduced in ai version 0.2.32. +NOTE: This command was introduced in ai version 0.2.26. == Usage diff --git a/modules/reference/partials/rpk-ai/rpk-ai-policy-update.adoc b/modules/reference/partials/rpk-ai/rpk-ai-policy-update.adoc index 1858de6dde..2f082617eb 100644 --- a/modules/reference/partials/rpk-ai/rpk-ai-policy-update.adoc +++ b/modules/reference/partials/rpk-ai/rpk-ai-policy-update.adoc @@ -10,7 +10,7 @@ Update a policy in place. Only the flags you pass are written; the field mask is built from the flags actually set, so omitted fields are left untouched. -NOTE: This command was introduced in ai version 0.2.32. +NOTE: This command was introduced in ai version 0.2.26. == Usage diff --git a/modules/reference/partials/rpk-ai/rpk-ai-policy.adoc b/modules/reference/partials/rpk-ai/rpk-ai-policy.adoc index b7e155d9d0..b79ea659e7 100644 --- a/modules/reference/partials/rpk-ai/rpk-ai-policy.adoc +++ b/modules/reference/partials/rpk-ai/rpk-ai-policy.adoc @@ -8,7 +8,7 @@ :description: pass:q[Manage Cedar authorization policies (`create`, get, list, update, delete).] Manage Cedar authorization policies (`create`, get, list, update, delete). -NOTE: This command was introduced in ai version 0.2.32. +NOTE: This command was introduced in ai version 0.2.26. == Usage