Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
68 changes: 36 additions & 32 deletions docs-data/rpk-overrides.json
Original file line number Diff line number Diff line change
Expand Up @@ -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.",
Expand Down Expand Up @@ -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"
Expand Down Expand Up @@ -3201,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."
Expand Down Expand Up @@ -3510,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"
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,8 @@
:description: Manage Redpanda cluster brokers.
Manage Redpanda cluster brokers.

NOTE: This command was introduced in version v26.2.1.

== Usage

[,bash]
Expand Down
Original file line number Diff line number Diff line change
@@ -1,12 +1,16 @@
= 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

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Original file line number Diff line number Diff line change
@@ -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.

Expand Down Expand Up @@ -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
Expand Down
22 changes: 17 additions & 5 deletions modules/reference/pages/rpk/rpk-cluster/rpk-cluster-config.adoc
Original file line number Diff line number Diff line change
@@ -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
Expand Down Expand Up @@ -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.
Expand All @@ -67,7 +79,7 @@ rpk cluster config [flags]
|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.

|===

Expand Down
16 changes: 10 additions & 6 deletions modules/reference/pages/rpk/rpk-cluster/rpk-cluster-health.adoc
Original file line number Diff line number Diff line change
@@ -1,18 +1,22 @@
= 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

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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`).
Expand Down
Original file line number Diff line number Diff line change
@@ -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.
: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.
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 <license string>
----

If neither are present, `rpk` will look for the license in the
default location `/etc/redpanda/redpanda.license`.

== Usage

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,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 a license to the cluster using a file path, inline string, or default location.
|Upload license to the cluster.

|===

Expand Down
Loading
Loading