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..4cd054af40 --- /dev/null +++ b/modules/reference/pages/rpk/rpk-connect/rpk-connect-agent-init.adoc @@ -0,0 +1,34 @@ += rpk connect agent init +:description: Initialize a Redpanda Connect agent. +:page-topic-type: reference + +[IMPORTANT] +==== +This command is experimental and subject to change. +==== + +Initialize a template for building a Redpanda Connect agent. + +== Usage + + rpk connect agent init [OPTIONS] + +== Example + +[,bash] +---- +rpk connect agent init ./repo +---- + +== Options + +[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..64be03b297 --- /dev/null +++ b/modules/reference/pages/rpk/rpk-connect/rpk-connect-agent-run.adoc @@ -0,0 +1,50 @@ += rpk connect agent run +:description: Execute a Redpanda Connect agent as part of a pipeline with MCP tool access. +:page-topic-type: reference + +[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 MCP (Model Context Protocol). The command first reads resource definitions in the `mcp` subdirectory and exposes them as tools. It then runs the agent defined in `redpanda_agents.yaml` along with any Python agent modules. + +== 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 +---- + +== Options + +[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..403750e55a --- /dev/null +++ b/modules/reference/pages/rpk/rpk-connect/rpk-connect-agent.adoc @@ -0,0 +1,30 @@ += rpk connect agent +:description: Redpanda Connect agent commands. +:page-topic-type: reference + +[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 MCP (Model Context Protocol) and can interact with AI models. + +== Usage + + rpk connect agent [command] + +== Subcommands + +* xref:reference:rpk/rpk-connect/rpk-connect-agent-init.adoc[]: Initialize a Redpanda Connect agent. +* xref:reference:rpk/rpk-connect/rpk-connect-agent-run.adoc[]: 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. + +== Options + +[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..6cc182e2aa --- /dev/null +++ b/modules/reference/pages/rpk/rpk-connect/rpk-connect-dry-run.adoc @@ -0,0 +1,45 @@ += rpk connect dry-run +:description: Parse Redpanda Connect configs and test the connections of each plugin. +:page-topic-type: reference + +Parse Redpanda Connect configs and test the connections of each plugin. Exits with a status code of `1` if any connection errors are detected. + +== 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 +---- + +== Options + +[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..b3503b0157 --- /dev/null +++ b/modules/reference/pages/rpk/rpk-connect/rpk-connect-plugin-init.adoc @@ -0,0 +1,37 @@ += rpk connect plugin init +:description: Create the boilerplate for a custom Redpanda Connect plugin. +:page-topic-type: reference + +[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. Existing files in the specified directory are overwritten. + +== Usage + + rpk connect plugin init [OPTIONS] + +== Example + +[,bash] +---- +rpk connect plugin init example-plugin +---- + +== Options + +[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..80f0eac210 --- /dev/null +++ b/modules/reference/pages/rpk/rpk-connect/rpk-connect-plugin.adoc @@ -0,0 +1,29 @@ += rpk connect plugin +:description: Plugin management commands for Redpanda Connect. +:page-topic-type: reference + +[IMPORTANT] +==== +This command is experimental and subject to change. +==== + +Manage custom Redpanda Connect plugins. Use these commands to scaffold and build custom components. + +== Usage + + rpk connect plugin [command] + +== Subcommands + +* xref:reference:rpk/rpk-connect/rpk-connect-plugin-init.adoc[]: Create the boilerplate for a custom component plugin. +* help, h: Show a list of commands or help for one command. + +== Options + +[cols="1m,2a"] +|=== +| Option | Description + +| --help, -h +| Show help for the command. +|===