diff --git a/antora.yml b/antora.yml index d29ee356c0..f8607e1ab1 100644 --- a/antora.yml +++ b/antora.yml @@ -1,13 +1,13 @@ name: ROOT title: Self-Managed -version: 25.3 +version: 26.1 start_page: home:index.adoc nav: - modules/ROOT/nav.adoc asciidoc: attributes: # Date of release in the format YYYY-MM-DD - page-release-date: 2025-11-19 + page-release-date: 2026-03-31 # Only used in the main branch (latest version) page-header-data: order: 2 @@ -17,16 +17,16 @@ asciidoc: # Fallback versions # We try to fetch the latest versions from GitHub at build time # -- - full-version: 25.3.10 - latest-redpanda-tag: 'v25.3.10' + full-version: 26.1.8 + latest-redpanda-tag: 'v26.1.8' latest-console-tag: 'v3.3.1' - latest-release-commit: '6aa5af28b020b66e5caa966094882b7260497a53' + latest-release-commit: 'ebee215fdb2b8004735c6f800e532564cdcc05e1' latest-operator-version: 'v2.3.8-24.3.6' operator-beta-tag: '' helm-beta-tag: '' latest-redpanda-helm-chart-version: '' - redpanda-beta-version: '25.3.1-rc4' - redpanda-beta-tag: 'v25.3.1-rc4' + redpanda-beta-version: '' + redpanda-beta-tag: '' console-beta-version: '' console-beta-tag: '' # -- diff --git a/modules/ROOT/nav.adoc b/modules/ROOT/nav.adoc index 3c8abcbce6..903b7f95e6 100644 --- a/modules/ROOT/nav.adoc +++ b/modules/ROOT/nav.adoc @@ -356,12 +356,21 @@ ***** xref:reference:rpk/rpk-cluster/rpk-cluster-txn-describe-producers.adoc[] ***** xref:reference:rpk/rpk-cluster/rpk-cluster-txn-list.adoc[] *** xref:reference:rpk/rpk-connect/rpk-connect.adoc[] +**** xref:reference:rpk/rpk-connect/rpk-connect-agent.adoc[] +***** xref:reference:rpk/rpk-connect/rpk-connect-agent-init.adoc[] +***** xref:reference:rpk/rpk-connect/rpk-connect-agent-run.adoc[] **** xref:reference:rpk/rpk-connect/rpk-connect-blobl-server.adoc[] **** xref:reference:rpk/rpk-connect/rpk-connect-create.adoc[] +**** xref:reference:rpk/rpk-connect/rpk-connect-dry-run.adoc[] **** xref:reference:rpk/rpk-connect/rpk-connect-echo.adoc[] **** xref:reference:rpk/rpk-connect/rpk-connect-install.adoc[] **** xref:reference:rpk/rpk-connect/rpk-connect-lint.adoc[] **** xref:reference:rpk/rpk-connect/rpk-connect-list.adoc[] +**** xref:reference:rpk/rpk-connect/rpk-connect-mcp-server.adoc[] +***** xref:reference:rpk/rpk-connect/rpk-connect-mcp-server-init.adoc[] +***** xref:reference:rpk/rpk-connect/rpk-connect-mcp-server-lint.adoc[] +**** xref:reference:rpk/rpk-connect/rpk-connect-plugin.adoc[] +***** xref:reference:rpk/rpk-connect/rpk-connect-plugin-init.adoc[] **** xref:reference:rpk/rpk-connect/rpk-connect-run.adoc[] **** xref:reference:rpk/rpk-connect/rpk-connect-streams.adoc[] **** xref:reference:rpk/rpk-connect/rpk-connect-studio-pull.adoc[] @@ -370,9 +379,6 @@ **** xref:reference:rpk/rpk-connect/rpk-connect-test.adoc[] **** xref:reference:rpk/rpk-connect/rpk-connect-uninstall.adoc[] **** xref:reference:rpk/rpk-connect/rpk-connect-upgrade.adoc[] -**** xref:reference:rpk/rpk-connect/rpk-connect-mcp-server.adoc[] -***** xref:reference:rpk/rpk-connect/rpk-connect-mcp-server-init.adoc[] -***** xref:reference:rpk/rpk-connect/rpk-connect-mcp-server-lint.adoc[] *** xref:reference:rpk/rpk-container/rpk-container.adoc[] **** xref:reference:rpk/rpk-container/rpk-container.adoc[] **** xref:reference:rpk/rpk-container/rpk-container-purge.adoc[] diff --git a/modules/reference/pages/rpk/rpk-connect/rpk-connect-agent-init.adoc b/modules/reference/pages/rpk/rpk-connect/rpk-connect-agent-init.adoc new file mode 100644 index 0000000000..e619983eac --- /dev/null +++ b/modules/reference/pages/rpk/rpk-connect/rpk-connect-agent-init.adoc @@ -0,0 +1,41 @@ += rpk connect agent init +:description: Initialize a Redpanda Connect agent. +:page-topic-type: reference +:learning-objective-1: Find the syntax for initializing an agent template +:learning-objective-2: Identify available initialization options + +[IMPORTANT] +==== +This command is experimental and subject to change. +==== + +Initialize a template for building a Redpanda Connect agent. + +Use this reference to: + +* [ ] {learning-objective-1} +* [ ] {learning-objective-2} + +== Usage + + rpk connect agent init [OPTIONS] + +== Example + +[,bash] +---- +rpk connect agent init ./repo +---- + +== Flags + +[cols="1m,2a"] +|=== +| Option | Description + +| --name +| The name of the agent. + +| --help, -h +| Show help for the command. +|=== diff --git a/modules/reference/pages/rpk/rpk-connect/rpk-connect-agent-run.adoc b/modules/reference/pages/rpk/rpk-connect/rpk-connect-agent-run.adoc new file mode 100644 index 0000000000..b1b4cc0c65 --- /dev/null +++ b/modules/reference/pages/rpk/rpk-connect/rpk-connect-agent-run.adoc @@ -0,0 +1,59 @@ += rpk connect agent run +:description: Execute a Redpanda Connect agent as part of a pipeline with MCP tool access. +:page-topic-type: reference +:learning-objective-1: Find the syntax for executing agents +:learning-objective-2: Identify secret management options +:learning-objective-3: Look up security-related flags + +[IMPORTANT] +==== +This command is experimental and subject to change. +==== + +Execute a Redpanda Connect agent as part of a pipeline that has access to tools via the Model Context Protocol (MCP). The command first reads resource definitions from the `mcp` subdirectory and exposes them as tools. It then runs the agent defined in `redpanda_agents.yaml` along with any Python agent modules. + +Use this reference to: + +* [ ] {learning-objective-1} +* [ ] {learning-objective-2} +* [ ] {learning-objective-3} + +== Usage + + rpk connect agent run [OPTIONS] + +== Example + +[,bash] +---- +rpk connect agent run ./repo +---- + +To disable all secret lookups: + +[,bash] +---- +rpk connect agent run --secrets none: ./repo +---- + +== Flags + +[cols="1m,2a"] +|=== +| Option | Description + +| --secrets +| Attempt to load secrets from a provided URN. If more than one entry is specified, they are attempted in order until a value is found. Environment variable lookups are specified with the URN `env:`, which by default is the only entry. To disable all secret lookups, specify a single entry of `none:` (default: `env:`). + +| --redpanda-license +| Provide an explicit Redpanda license, which enables enterprise functionality. By default, licenses found at the path `/etc/redpanda/redpanda.license` are applied. + +| --help, -h +| Show help for the command. + +| --chroot +| (Linux only) Chroot into the provided directory after parsing configuration. Common `/etc/` files are copied to the chroot directory, and the directory is made read-only. + +| --chroot-passthrough +| (Linux only) Specify additional files to be copied into the chroot directory. Can be specified multiple times. Only valid when `--chroot` is used. +|=== diff --git a/modules/reference/pages/rpk/rpk-connect/rpk-connect-agent.adoc b/modules/reference/pages/rpk/rpk-connect/rpk-connect-agent.adoc new file mode 100644 index 0000000000..3ed40783bf --- /dev/null +++ b/modules/reference/pages/rpk/rpk-connect/rpk-connect-agent.adoc @@ -0,0 +1,37 @@ += rpk connect agent +:description: Redpanda Connect agent commands. +:page-topic-type: reference +:learning-objective-1: Look up available agent subcommands +:learning-objective-2: Identify agent command options + +[IMPORTANT] +==== +This command is experimental and subject to change. +==== + +Run and initialize Redpanda Connect agents. Agents are pipelines that have access to tools via the Model Context Protocol (MCP) and can interact with AI models. + +Use this reference to: + +* [ ] {learning-objective-1} +* [ ] {learning-objective-2} + +== Usage + + rpk connect agent [command] + +== Subcommands + +* xref:reference:rpk/rpk-connect/rpk-connect-agent-init.adoc[init]: Initialize a Redpanda Connect agent. +* xref:reference:rpk/rpk-connect/rpk-connect-agent-run.adoc[run]: Execute a Redpanda Connect agent as part of a pipeline with MCP tool access. +* help, h: Show a list of commands or help for one command. + +== Flags + +[cols="1m,2a"] +|=== +| Option | Description + +| --help, -h +| Show help for the command. +|=== diff --git a/modules/reference/pages/rpk/rpk-connect/rpk-connect-dry-run.adoc b/modules/reference/pages/rpk/rpk-connect/rpk-connect-dry-run.adoc new file mode 100644 index 0000000000..e5208a52f0 --- /dev/null +++ b/modules/reference/pages/rpk/rpk-connect/rpk-connect-dry-run.adoc @@ -0,0 +1,52 @@ += rpk connect dry-run +:description: Parse Redpanda Connect configs and test the connections of each plugin. +:page-topic-type: reference +:learning-objective-1: Find the syntax for testing pipeline configurations +:learning-objective-2: Look up connection testing options + +Parse Redpanda Connect configs and test the connections of each plugin. Exits with a status code of `1` if the command detects any connection errors. + +Use this reference to: + +* [ ] {learning-objective-1} +* [ ] {learning-objective-2} + +== Usage + + rpk connect dry-run [OPTIONS] [files...] + +== Example + +[,bash] +---- +rpk connect dry-run ./pipeline.yaml +---- + +To disable all secret lookups: + +[,bash] +---- +rpk connect dry-run --secrets none: ./pipeline.yaml +---- + +== Flags + +[cols="1m,2a"] +|=== +| Option | Description + +| --verbose +| Print the lint result for each target file (default: false). + +| --secrets +| Attempt to load secrets from a provided URN. If more than one entry is specified, they are attempted in order until a value is found. Environment variable lookups are specified with the URN `env:`, which by default is the only entry. To disable all secret lookups, specify a single entry of `none:` (default: `env:`). + +| --env-file, -e +| Import environment variables from a dotenv file. + +| --redpanda-license +| Provide an explicit Redpanda license, which enables enterprise functionality. By default, licenses found at the path `/etc/redpanda/redpanda.license` are applied. + +| --help, -h +| Show help for the command. +|=== diff --git a/modules/reference/pages/rpk/rpk-connect/rpk-connect-plugin-init.adoc b/modules/reference/pages/rpk/rpk-connect/rpk-connect-plugin-init.adoc new file mode 100644 index 0000000000..fce84c9d1d --- /dev/null +++ b/modules/reference/pages/rpk/rpk-connect/rpk-connect-plugin-init.adoc @@ -0,0 +1,44 @@ += rpk connect plugin init +:description: Create the boilerplate for a custom Redpanda Connect plugin. +:page-topic-type: reference +:learning-objective-1: Find the syntax for creating custom plugins +:learning-objective-2: Identify supported languages and component types + +[IMPORTANT] +==== +This command is experimental and subject to change. +==== + +Generate a project on the local filesystem that can be used as a starting point for building a custom component for Redpanda Connect. The command overwrites existing files in the specified directory. + +Use this reference to: + +* [ ] {learning-objective-1} +* [ ] {learning-objective-2} + +== Usage + + rpk connect plugin init [OPTIONS] + +== Example + +[,bash] +---- +rpk connect plugin init example-plugin +---- + +== Flags + +[cols="1m,2a"] +|=== +| Option | Description + +| --language, --lang +| The programming language for the plugin. Supported languages are `golang` and `python` (default: `python`). + +| --component +| The type of component to generate. Supported components are `input`, `output`, and `processor` (default: `processor`). + +| --help, -h +| Show help for the command. +|=== diff --git a/modules/reference/pages/rpk/rpk-connect/rpk-connect-plugin.adoc b/modules/reference/pages/rpk/rpk-connect/rpk-connect-plugin.adoc new file mode 100644 index 0000000000..a506bcc39c --- /dev/null +++ b/modules/reference/pages/rpk/rpk-connect/rpk-connect-plugin.adoc @@ -0,0 +1,36 @@ += rpk connect plugin +:description: Plugin management commands for Redpanda Connect. +:page-topic-type: reference +:learning-objective-1: Look up available plugin management commands +:learning-objective-2: Identify plugin command options + +[IMPORTANT] +==== +This command is experimental and subject to change. +==== + +Manage custom Redpanda Connect plugins. Use these commands to scaffold and build custom components. + +Use this reference to: + +* [ ] {learning-objective-1} +* [ ] {learning-objective-2} + +== Usage + + rpk connect plugin [command] + +== Subcommands + +* xref:reference:rpk/rpk-connect/rpk-connect-plugin-init.adoc[init]: Create the boilerplate for a custom component plugin. +* help, h: Show a list of commands or help for one command. + +== Flags + +[cols="1m,2a"] +|=== +| Option | Description + +| --help, -h +| Show help for the command. +|=== diff --git a/modules/reference/pages/rpk/rpk-connect/rpk-connect-streams.adoc b/modules/reference/pages/rpk/rpk-connect/rpk-connect-streams.adoc index c83d7297bd..70f5f6eaae 100644 --- a/modules/reference/pages/rpk/rpk-connect/rpk-connect-streams.adoc +++ b/modules/reference/pages/rpk/rpk-connect/rpk-connect-streams.adoc @@ -45,5 +45,7 @@ rpk connect streams -o ./root_config.yaml ./streams/*.yaml |--prefix-stream-endpoints |- | Whether HTTP endpoints registered by stream configs should be prefixed with the stream ID (default: true). +|--resources, -r |- | Pull in extra resources from a file, which can be referenced by a unique label in the main configuration. Supports glob patterns (requires quotes). + |--help, -h |- | Show help. |=== \ No newline at end of file