feat(DOC-1970): add missing rpk connect reference pages #1608
+234
−3
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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 | ||
|
Contributor
There was a problem hiding this comment. No change required for this PR, but I wanted to note that the other rpk connect pages use a "Flags" heading (example). This might have to do with our reference automation tool, could be worth raising a separate ticket to look into. |
||
|
|
||
| [cols="1m,2a"] | ||
| |=== | ||
| | Option | Description | ||
|
|
||
| | --name | ||
| | The name of the agent. | ||
|
|
||
| | --help, -h | ||
| | Show help for the command. | ||
| |=== | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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. | ||
| |=== |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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. | ||
| |=== |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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. | ||
| |=== |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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. | ||
| |=== |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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. | ||
| |=== |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Would also recommend adding this to the new pages -- we don't have this consistently for live pages so there's some tech debt here, but we should try and start adding these topic types to new pages.