Skip to content

Commit 8804181

Browse files
mfernestclaude
mfernest
and
claude
committed
feat(DOC-1970): add missing rpk connect reference pages
Adds documentation for three rpk connect commands missing from the reference: - rpk connect agent (+ agent init, agent run subcommands) — EXPERIMENTAL - rpk connect dry-run - rpk connect plugin (+ plugin init subcommand) — EXPERIMENTAL Updates nav.adoc to include the new pages in alphabetical order. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
1 parent fe8a357 commit 8804181

7 files changed

Lines changed: 201 additions & 3 deletions

File tree

‎modules/ROOT/nav.adoc‎

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -356,12 +356,21 @@
356356
***** xref:reference:rpk/rpk-cluster/rpk-cluster-txn-describe-producers.adoc[]
357357
***** xref:reference:rpk/rpk-cluster/rpk-cluster-txn-list.adoc[]
358358
*** xref:reference:rpk/rpk-connect/rpk-connect.adoc[]
359+
**** xref:reference:rpk/rpk-connect/rpk-connect-agent.adoc[]
360+
***** xref:reference:rpk/rpk-connect/rpk-connect-agent-init.adoc[]
361+
***** xref:reference:rpk/rpk-connect/rpk-connect-agent-run.adoc[]
359362
**** xref:reference:rpk/rpk-connect/rpk-connect-blobl-server.adoc[]
360363
**** xref:reference:rpk/rpk-connect/rpk-connect-create.adoc[]
364+
**** xref:reference:rpk/rpk-connect/rpk-connect-dry-run.adoc[]
361365
**** xref:reference:rpk/rpk-connect/rpk-connect-echo.adoc[]
362366
**** xref:reference:rpk/rpk-connect/rpk-connect-install.adoc[]
363367
**** xref:reference:rpk/rpk-connect/rpk-connect-lint.adoc[]
364368
**** xref:reference:rpk/rpk-connect/rpk-connect-list.adoc[]
369+
**** xref:reference:rpk/rpk-connect/rpk-connect-mcp-server.adoc[]
370+
***** xref:reference:rpk/rpk-connect/rpk-connect-mcp-server-init.adoc[]
371+
***** xref:reference:rpk/rpk-connect/rpk-connect-mcp-server-lint.adoc[]
372+
**** xref:reference:rpk/rpk-connect/rpk-connect-plugin.adoc[]
373+
***** xref:reference:rpk/rpk-connect/rpk-connect-plugin-init.adoc[]
365374
**** xref:reference:rpk/rpk-connect/rpk-connect-run.adoc[]
366375
**** xref:reference:rpk/rpk-connect/rpk-connect-streams.adoc[]
367376
**** xref:reference:rpk/rpk-connect/rpk-connect-studio-pull.adoc[]
@@ -370,9 +379,6 @@
370379
**** xref:reference:rpk/rpk-connect/rpk-connect-test.adoc[]
371380
**** xref:reference:rpk/rpk-connect/rpk-connect-uninstall.adoc[]
372381
**** xref:reference:rpk/rpk-connect/rpk-connect-upgrade.adoc[]
373-
**** xref:reference:rpk/rpk-connect/rpk-connect-mcp-server.adoc[]
374-
***** xref:reference:rpk/rpk-connect/rpk-connect-mcp-server-init.adoc[]
375-
***** xref:reference:rpk/rpk-connect/rpk-connect-mcp-server-lint.adoc[]
376382
*** xref:reference:rpk/rpk-container/rpk-container.adoc[]
377383
**** xref:reference:rpk/rpk-container/rpk-container.adoc[]
378384
**** xref:reference:rpk/rpk-container/rpk-container-purge.adoc[]

‎modules/reference/pages/rpk/rpk-connect/rpk-connect-agent-init.adoc‎

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
= rpk connect agent init
2+
:description: Initialize a Redpanda Connect agent.
3+
4+
[IMPORTANT]
5+
====
6+
This command is experimental and subject to change.
7+
====
8+
9+
Initialize a template for building a Redpanda Connect agent.
10+
11+
== Usage
12+
13+
rpk connect agent init [OPTIONS]
14+
15+
== Example
16+
17+
[,bash]
18+
----
19+
rpk connect agent init ./repo
20+
----
21+
22+
== Options
23+
24+
[cols="1m,2a"]
25+
|===
26+
| Option | Description
27+
28+
| --name
29+
| The name of the agent.
30+
31+
| --help, -h
32+
| Show help for the command.
33+
|===

‎modules/reference/pages/rpk/rpk-connect/rpk-connect-agent-run.adoc‎

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
= rpk connect agent run
2+
:description: Execute a Redpanda Connect agent as part of a pipeline with MCP tool access.
3+
4+
[IMPORTANT]
5+
====
6+
This command is experimental and subject to change.
7+
====
8+
9+
Execute a Redpanda Connect agent as part of a pipeline that has access to tools via the MCP (Model Context Protocol). Each resource in the `mcp` subdirectory creates tools that can be used, then the `redpanda_agents.yaml` file along with Python agent modules are invoked.
10+
11+
== Usage
12+
13+
rpk connect agent run [OPTIONS]
14+
15+
== Example
16+
17+
[,bash]
18+
----
19+
rpk connect agent run ./repo
20+
----
21+
22+
== Options
23+
24+
[cols="1m,2a"]
25+
|===
26+
| Option | Description
27+
28+
| --secrets env:
29+
| 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:`).
30+
31+
| --redpanda-license
32+
| Provide an explicit Redpanda License, which enables enterprise functionality. By default, licenses found at the path `/etc/redpanda/redpanda.license` are applied.
33+
34+
| --help, -h
35+
| Show help for the command.
36+
|===

‎modules/reference/pages/rpk/rpk-connect/rpk-connect-agent.adoc‎

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
= rpk connect agent
2+
:description: Redpanda Connect agent commands.
3+
4+
[IMPORTANT]
5+
====
6+
This command is experimental and subject to change.
7+
====
8+
9+
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.
10+
11+
== Usage
12+
13+
rpk connect agent [command]
14+
15+
== Subcommands
16+
17+
* xref:rpk/rpk-connect/rpk-connect-agent-init.adoc[init]: Initialize a Redpanda Connect agent.
18+
* xref:rpk/rpk-connect/rpk-connect-agent-run.adoc[run]: Execute a Redpanda Connect agent as part of a pipeline with MCP tool access.
19+
* help, h: Show a list of commands or help for one command.
20+
21+
== Options
22+
23+
[cols="1m,2a"]
24+
|===
25+
| Option | Description
26+
27+
| --help, -h
28+
| Show help for the command.
29+
|===

‎modules/reference/pages/rpk/rpk-connect/rpk-connect-dry-run.adoc‎

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
= rpk connect dry-run
2+
:description: Parse Redpanda Connect configs and test the connections of each plugin.
3+
4+
Parse Redpanda Connect configs and test the connections of each plugin. Exits with a status code of `1` if any connection errors are detected.
5+
6+
== Usage
7+
8+
rpk connect dry-run [command options]
9+
10+
== Example
11+
12+
[,bash]
13+
----
14+
rpk connect dry-run ./foo.yaml
15+
----
16+
17+
== Options
18+
19+
[cols="1m,2a"]
20+
|===
21+
| Option | Description
22+
23+
| --verbose
24+
| Print the lint result for each target file (default: false).
25+
26+
| --secrets env:
27+
| 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:`).
28+
29+
| --env-file, -e
30+
| Import environment variables from a dotenv file.
31+
32+
| --redpanda-license
33+
| Provide an explicit Redpanda License, which enables enterprise functionality. By default, licenses found at the path `/etc/redpanda/redpanda.license` are applied.
34+
35+
| --help, -h
36+
| Show help for the command.
37+
|===

‎modules/reference/pages/rpk/rpk-connect/rpk-connect-plugin-init.adoc‎

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
= rpk connect plugin init
2+
:description: Create the boilerplate for a custom Redpanda Connect plugin.
3+
4+
[IMPORTANT]
5+
====
6+
This command is experimental and subject to change.
7+
====
8+
9+
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.
10+
11+
== Usage
12+
13+
rpk connect plugin init [OPTIONS]
14+
15+
== Options
16+
17+
[cols="1m,2a"]
18+
|===
19+
| Option | Description
20+
21+
| --language, --lang
22+
| The programming language for the plugin. Supported languages are `golang` and `python` (default: `python`).
23+
24+
| --component
25+
| The type of component to generate. Supported components are `input`, `output`, and `processor` (default: `processor`).
26+
27+
| --help, -h
28+
| Show help for the command.
29+
|===

‎modules/reference/pages/rpk/rpk-connect/rpk-connect-plugin.adoc‎

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
= rpk connect plugin
2+
:description: Plugin management commands for Redpanda Connect.
3+
4+
[IMPORTANT]
5+
====
6+
This command is experimental and subject to change.
7+
====
8+
9+
Manage custom Redpanda Connect plugins. Use these commands to scaffold and build custom components.
10+
11+
== Usage
12+
13+
rpk connect plugin [command]
14+
15+
== Subcommands
16+
17+
* xref:rpk/rpk-connect/rpk-connect-plugin-init.adoc[init]: Create the boilerplate for a custom component plugin.
18+
* help, h: Show a list of commands or help for one command.
19+
20+
== Options
21+
22+
[cols="1m,2a"]
23+
|===
24+
| Option | Description
25+
26+
| --help, -h
27+
| Show help for the command.
28+
|===

0 commit comments

Comments
 (0)