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
1,111 changes: 1,111 additions & 0 deletions docs-data/rpk-diff-v26.1.12_to_v26.2.1.json

Large diffs are not rendered by default.

297 changes: 277 additions & 20 deletions docs-data/rpk-overrides.json

Large diffs are not rendered by default.

23,769 changes: 23,769 additions & 0 deletions docs-data/rpk-v26.2.1.json

Large diffs are not rendered by default.

64 changes: 64 additions & 0 deletions modules/get-started/pages/release-notes/redpanda.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -106,6 +106,70 @@ Redpanda 26.2 introduces the following rpk changes:
* *New `k8s` managed plugin*: The xref:reference:rpk/rpk-k8s/rpk-k8s.adoc[`rpk k8s`] plugin adds the xref:reference:rpk/rpk-k8s/rpk-k8s-multicluster.adoc[`rpk k8s multicluster`] commands to bootstrap TLS certificates and peer configuration, check deployment health, and collect diagnostics bundles for xref:deploy:redpanda/kubernetes/k-stretch-clusters.adoc[Stretch Clusters]. Install it with `rpk k8s install`.
* *New `check` managed plugin*: The xref:reference:rpk/rpk-check/rpk-check.adoc[`rpk check`] plugin runs production readiness checks for a Redpanda deployment. Install it with xref:reference:rpk/rpk-check/rpk-check-install.adoc[`rpk check install`].

// AUTOGEN-RPK-CHANGES v26.2.1 START
=== v26.2.1

==== New commands

* xref:reference:rpk/rpk-check/rpk-check.adoc[`rpk check`] - Run production readiness checks for a Redpanda deployment
* xref:reference:rpk/rpk-check/rpk-check-install.adoc[`rpk check install`] - Install Redpanda Check
* xref:reference:rpk/rpk-check/rpk-check-uninstall.adoc[`rpk check uninstall`] - Uninstall the Redpanda Check plugin
* xref:reference:rpk/rpk-check/rpk-check-upgrade.adoc[`rpk check upgrade`] - Upgrade to the latest Redpanda Check version
* xref:reference:rpk/rpk-cluster/rpk-cluster-brokers.adoc[`rpk cluster brokers`] - Manage Redpanda cluster brokers
* xref:reference:rpk/rpk-cluster/rpk-cluster-brokers-decommission.adoc[`rpk cluster brokers decommission`] - Decommission the given broker.
* xref:reference:rpk/rpk-cluster/rpk-cluster-brokers-decommission-status.adoc[`rpk cluster brokers decommission-status`] - Show the progress of a node decommissioning.
* xref:reference:rpk/rpk-cluster/rpk-cluster-brokers-recommission.adoc[`rpk cluster brokers recommission`] - Recommission the given broker if it is still decommissioning.
* xref:reference:rpk/rpk-cluster/rpk-cluster-loggers.adoc[`rpk cluster loggers`] - List and configure Redpanda broker loggers
* xref:reference:rpk/rpk-cluster/rpk-cluster-loggers-list.adoc[`rpk cluster loggers list`] - List loggers available on a Redpanda broker.
* xref:reference:rpk/rpk-cluster/rpk-cluster-loggers-set.adoc[`rpk cluster loggers set`] - Set broker logger's log level.
* xref:reference:rpk/rpk-cluster/rpk-cluster-upgrade.adoc[`rpk cluster upgrade`] - Check and finalize major-version upgrades.
* xref:reference:rpk/rpk-cluster/rpk-cluster-upgrade-finalize.adoc[`rpk cluster upgrade finalize`] - Finalize a deferred cluster upgrade.
* xref:reference:rpk/rpk-cluster/rpk-cluster-upgrade-status.adoc[`rpk cluster upgrade status`] - Show the cluster upgrade finalization status.
* xref:reference:rpk/rpk-k8s/rpk-k8s.adoc[`rpk k8s`] - Interact with Redpanda clusters running on Kubernetes
* xref:reference:rpk/rpk-k8s/rpk-k8s-install.adoc[`rpk k8s install`] - Install the Redpanda Kubernetes plugin.
* xref:reference:rpk/rpk-k8s/rpk-k8s-multicluster.adoc[`rpk k8s multicluster`] - Commands for bootstrapping and managing the multicluster operators that run a Redpanda Stretch Cluster: a single logical Redpanda cluster distributed across multiple Kubernetes clusters.
* xref:reference:rpk/rpk-k8s/rpk-k8s-multicluster-bootstrap.adoc[`rpk k8s multicluster bootstrap`] - Bootstrap the TLS certificates and kubeconfig secrets that the multicluster operators of a Redpanda Stretch Cluster need to communicate across Kubernetes clusters.
* xref:reference:rpk/rpk-k8s/rpk-k8s-multicluster-bundle.adoc[`rpk k8s multicluster bundle`] - Collects environment data from each Kubernetes cluster in a Redpanda Stretch Cluster deployment and packages it into a ZIP file for support.
* xref:reference:rpk/rpk-k8s/rpk-k8s-multicluster-status.adoc[`rpk k8s multicluster status`] - Checks the health of the multicluster operators that run a Redpanda Stretch Cluster: each cluster's operator pod health, raft consensus state, TLS certificate validity, and cross-cluster consistency.
* xref:reference:rpk/rpk-k8s/rpk-k8s-uninstall.adoc[`rpk k8s uninstall`] - Uninstall the Redpanda Kubernetes plugin.
* xref:reference:rpk/rpk-k8s/rpk-k8s-upgrade.adoc[`rpk k8s upgrade`] - Upgrade to the latest Redpanda Kubernetes plugin version
* xref:reference:rpk/rpk-k8s/rpk-k8s-version.adoc[`rpk k8s version`] - Print build information

==== New flags

* `rpk cloud auth list`: Added `--format`
* xref:reference:rpk/rpk-cluster/rpk-cluster-config-list.adoc[`rpk cluster config list`]: Added `--node-id`
* xref:reference:rpk/rpk-cluster/rpk-cluster-config-status.adoc[`rpk cluster config status`]: Added `--format`
* xref:reference:rpk/rpk-cluster/rpk-cluster-info.adoc[`rpk cluster info`]: Added `--detailed`, `--include-decommissioned`
* xref:reference:rpk/rpk-cluster/rpk-cluster-logdirs-describe.adoc[`rpk cluster logdirs describe`]: Added `--format`
* xref:reference:rpk/rpk-cluster/rpk-cluster-maintenance-status.adoc[`rpk cluster maintenance status`]: Added `--format`
* xref:reference:rpk/rpk-cluster/rpk-cluster-partitions-balancer-status.adoc[`rpk cluster partitions balancer-status`]: Added `--format`
* xref:reference:rpk/rpk-cluster/rpk-cluster-partitions-move-cancel.adoc[`rpk cluster partitions move-cancel`]: Added `--format`
* xref:reference:rpk/rpk-cluster/rpk-cluster-partitions-move-status.adoc[`rpk cluster partitions move-status`]: Added `--format`
* xref:reference:rpk/rpk-group/rpk-group-delete.adoc[`rpk group delete`]: Added `--format`
* xref:reference:rpk/rpk-group/rpk-group-list.adoc[`rpk group list`]: Added `--format`
* xref:reference:rpk/rpk-group/rpk-group-offset-delete.adoc[`rpk group offset-delete`]: Added `--format`
* xref:reference:rpk/rpk-group/rpk-group-seek.adoc[`rpk group seek`]: Added `--format`
* xref:reference:rpk/rpk-plugin/rpk-plugin-list.adoc[`rpk plugin list`]: Added `--format`
* xref:reference:rpk/rpk-profile/rpk-profile-list.adoc[`rpk profile list`]: Added `--format`
* xref:reference:rpk/rpk-security/rpk-security-acl-delete.adoc[`rpk security acl delete`]: Added `--format`
* `rpk security secret list`: Added `--format`
* xref:reference:rpk/rpk-shadow/rpk-shadow-describe.adoc[`rpk shadow describe`]: Added `--print-role`
* xref:reference:rpk/rpk-shadow/rpk-shadow-status.adoc[`rpk shadow status`]: Added `--print-registry`
* xref:reference:rpk/rpk-topic/rpk-topic-add-partitions.adoc[`rpk topic add-partitions`]: Added `--format`
* xref:reference:rpk/rpk-topic/rpk-topic-alter-config.adoc[`rpk topic alter-config`]: Added `--format`
* xref:reference:rpk/rpk-topic/rpk-topic-delete.adoc[`rpk topic delete`]: Added `--format`

==== Changed defaults

* xref:reference:rpk/rpk-container/rpk-container-start.adoc[`rpk container start`]: `--console-image` default changed from `redpandadata/console:v3.7.1` to `redpandadata/console:v3.8.0`

==== Deprecated commands

* `rpk redpanda admin`: Use xref:reference:rpk/rpk-cluster/rpk-cluster.adoc[`rpk cluster`] instead.
+
Includes its subcommands: `rpk redpanda admin brokers`, `rpk redpanda admin brokers decommission`, `rpk redpanda admin brokers decommission-status`, `rpk redpanda admin brokers list`, `rpk redpanda admin brokers recommission`, `rpk redpanda admin config`, `rpk redpanda admin config log-level`, `rpk redpanda admin config log-level set`, `rpk redpanda admin config print`, `rpk redpanda admin partitions`, `rpk redpanda admin partitions list`.
// AUTOGEN-RPK-CHANGES v26.2.1 END
== New configuration properties

**Shadowing:**
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,15 @@ Example.
rpk connect agent init ./repo
----

== Flags

[cols="1m,1a,2a"]
|===
|Value |Type |Description

|--name |string |
|===

== Global flags

[cols="1m,1a,2a"]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,18 @@ To disable all secret lookups.
rpk connect agent run --secrets none: ./repo
----

== Flags

[cols="1m,1a,2a"]
|===
|Value |Type |Description

|--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.
|===

== Global flags

[cols="1m,1a,2a"]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,20 @@ WARNING: This server is intended for local debugging and experimentation purpose
rpk connect blobl server [flags]
----

== Flags

[cols="1m,1a,2a"]
|===
|Value |Type |Description

|--host |string |the host to bind to.
|-p, --port |string |the port to bind to.
|-n, --no-open |bool |do not open the app in the browser automatically.
|-m, --mapping-file |string |an optional path to a mapping file to load as the initial mapping within the app.
|-i, --input-file |string |an optional path to an input file to load as the initial input to the mapping within the app.
|-w, --write |bool |when editing a mapping and/or input file write changes made back to the respective source file, if the file does not exist it will be created.
|===

== Global flags

[cols="1m,1a,2a"]
Expand Down
15 changes: 15 additions & 0 deletions modules/reference/pages/rpk/rpk-connect/rpk-connect-blobl.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,21 @@ rpk connect blobl -i input.jsonl -f ./mapping.blobl

|===

== Flags

[cols="1m,1a,2a"]
|===
|Value |Type |Description

|-t, --threads |string |the number of processing threads to use, when >1 ordering is no longer guaranteed.
|-r, --raw |bool |consume raw strings.
|-p, --pretty |bool |pretty-print output.
|-f, --file |string |execute a mapping from a file.
|-i, --input |string |read input from a file instead of stdin.
|--max-token-length |string |Set the buffer size for document lines.
|-e, --env-file |strings |import environment variables from a dotenv file.
|===

== Global flags

[cols="1m,1a,2a"]
Expand Down
11 changes: 11 additions & 0 deletions modules/reference/pages/rpk/rpk-connect/rpk-connect-create.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,17 @@ Create a config with file/http_server inputs, protobuf processor, and http_clien
rpk connect create file,http_server/protobuf/http_client
----

== Flags

[cols="1m,1a,2a"]
|===
|Value |Type |Description

|-s, --small |bool |Print only the main components of a Redpanda Connect config (`input`, pipeline, output) and omit all fields marked as advanced.
|-e, --env-file |strings |import environment variables from a dotenv file.
|-t, --templates |strings |EXPERIMENTAL: import Redpanda Connect templates, supports glob patterns (requires quotes).
|===

== Global flags

[cols="1m,1a,2a"]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,18 @@ To disable all secret lookups.
rpk connect dry-run --secrets none: ./pipeline.yaml
----

== Flags

[cols="1m,1a,2a"]
|===
|Value |Type |Description

|--verbose |bool |Print the lint result for each target file.
|--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:`.
|-e, --env-file |strings |import environment variables from a dotenv file.
|--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.
|===

== Global flags

[cols="1m,1a,2a"]
Expand Down
12 changes: 12 additions & 0 deletions modules/reference/pages/rpk/rpk-connect/rpk-connect-echo.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,18 @@ Parse a config file and echo back a normalized version. This command is useful f
rpk connect echo [flags]
----

== Flags

[cols="1m,1a,2a"]
|===
|Value |Type |Description

|-s, --set |strings |set a field (identified by a dot path) in the main configuration file, for example, "metrics.type=prometheus".
|-r, --resources |strings |pull in extra resources from a file, which can be referenced the same as resources defined in the main config, supports glob patterns (requires quotes).
|-e, --env-file |strings |import environment variables from a dotenv file.
|-t, --templates |strings |EXPERIMENTAL: import Redpanda Connect templates, supports glob patterns (requires quotes).
|===

== Global flags

[cols="1m,1a,2a"]
Expand Down
15 changes: 15 additions & 0 deletions modules/reference/pages/rpk/rpk-connect/rpk-connect-lint.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,21 @@ Lint all files in a directory tree.
rpk connect lint ./configs/...
----

== Flags

[cols="1m,1a,2a"]
|===
|Value |Type |Description

|--deprecated |bool |Print linting errors for the presence of deprecated fields.
|--labels |bool |Print linting errors when components do not have labels.
|--skip-env-var-check |bool |Do not produce lint errors when environment interpolations exist without defaults within configs but aren't defined.
|--verbose |bool |Print the lint result for each target file.
|-r, --resources |strings |pull in extra resources from a file, which can be referenced the same as resources defined in the main config, supports glob patterns (requires quotes).
|-e, --env-file |strings |import environment variables from a dotenv file.
|-t, --templates |strings |EXPERIMENTAL: import Redpanda Connect templates, supports glob patterns (requires quotes).
|===

== Global flags

[cols="1m,1a,2a"]
Expand Down
11 changes: 11 additions & 0 deletions modules/reference/pages/rpk/rpk-connect/rpk-connect-list.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,17 @@ Example.
rpk connect list rate-limits buffers
----

== Flags

[cols="1m,1a,2a"]
|===
|Value |Type |Description

|--format |string |Output format: `text` (human-readable table), `json` (`machine-readable`), `cue` (CUE schema). Default is `text`.
|--status |string |Filter the component list to only those matching the given status. Options are stable, beta or experimental.
|-t, --templates |strings |EXPERIMENTAL: import Redpanda Connect templates, supports glob patterns (requires quotes).
|===

== Global flags

[cols="1m,1a,2a"]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,20 @@ IMPORTANT: This command is experimental and subject to change.
rpk connect mcp-server lint [flags]
----

== Flags

[cols="1m,1a,2a"]
|===
|Value |Type |Description

|--deprecated |bool |Print linting errors for the presence of deprecated fields.
|--labels |bool |Print linting errors when components do not have labels.
|--skip-env-var-check |bool |Do not produce lint errors when environment interpolations exist without defaults within configs but aren't defined.
|--verbose |bool |Print the lint result for each target file.
|--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:`.
|-e, --env-file |strings |import environment variables from a dotenv file.
|===

== Global flags

[cols="1m,1a,2a"]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,22 @@ rpk connect mcp-server [flags]

|===

== Flags

[cols="1m,1a,2a"]
|===
|Value |Type |Description

|--address |string |An optional address to bind the MCP server to instead of running in stdio mode.
|--observability-address |string |Address to bind the observability server (`metrics`, pprof) to. If not set, observability server is disabled. Only applies when `--address` is set.
|--tag |strings |Optionally limit the resources that this command runs by providing one or more regular expressions. Resources that do not contain a match within the field meta.tags for each tag regular expression specified will be ignored.
|--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:`.
|-e, --env-file |strings |import environment variables from a dotenv file.
|--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.
|===

== Global flags

[cols="1m,1a,2a"]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,16 @@ Example.
rpk connect plugin init example-plugin
----

== Flags

[cols="1m,1a,2a"]
|===
|Value |Type |Description

|--language |string |The programming language to use for the plugin. Supported languages are: golang, python.
|--component |string |The type of component to generate. Supported components are: input, output, processor.
|===

== Global flags

[cols="1m,1a,2a"]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,32 @@ Example.
rpk connect streams -o ./root_config.yaml ./streams/*.yaml
----

== Flags

[cols="1m,1a,2a"]
|===
|Value |Type |Description

|--no-api |bool |Disable the HTTP API for streams mode.
|--prefix-stream-endpoints |bool |Whether HTTP endpoints registered by stream configs should be prefixed with the stream ID.
|-o, --observability |string |a path to a configuration file containing general service-wide fields such as http, logger, and so on.
|--log.level |string |override the configured log level, options are: off, error, warn, info, debug, trace.
|-s, --set |strings |set a field (identified by a dot path) in the main configuration file, for example, "metrics.type=prometheus".
|-r, --resources |strings |pull in extra resources from a file, which can be referenced the same as resources defined in the main config, supports glob patterns (requires quotes).
|--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, supports glob patterns (requires quotes).
|===

== Global flags

[cols="1m,1a,2a"]
Expand Down
Loading