Skip to content

Commit 99a07a1

Browse files
mfernestclaudemmatczukJakeSCahillFeediver1
authored
feat(DOC-1970): add missing rpk connect reference pages (#1608)
Co-authored-by: Claude Sonnet 4.6 <noreply@anthropic.com> Co-authored-by: Michal Matczuk <mmatczuk@gmail.com> Co-authored-by: JakeSCahill <jake@redpanda.com> Co-authored-by: Joyce Fee <joyce@redpanda.com>
1 parent 4adb548 commit 99a07a1

8 files changed

Lines changed: 280 additions & 0 deletions

File tree

‎modules/ROOT/nav.adoc‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -371,12 +371,21 @@
371371
***** xref:reference:rpk/rpk-cluster/rpk-cluster-txn-describe-producers.adoc[]
372372
***** xref:reference:rpk/rpk-cluster/rpk-cluster-txn-list.adoc[]
373373
*** xref:reference:rpk/rpk-connect/rpk-connect.adoc[]
374+
**** xref:reference:rpk/rpk-connect/rpk-connect-agent.adoc[]
375+
***** xref:reference:rpk/rpk-connect/rpk-connect-agent-init.adoc[]
376+
***** xref:reference:rpk/rpk-connect/rpk-connect-agent-run.adoc[]
374377
**** xref:reference:rpk/rpk-connect/rpk-connect-blobl-server.adoc[]
375378
**** xref:reference:rpk/rpk-connect/rpk-connect-create.adoc[]
379+
**** xref:reference:rpk/rpk-connect/rpk-connect-dry-run.adoc[]
376380
**** xref:reference:rpk/rpk-connect/rpk-connect-echo.adoc[]
377381
**** xref:reference:rpk/rpk-connect/rpk-connect-install.adoc[]
378382
**** xref:reference:rpk/rpk-connect/rpk-connect-lint.adoc[]
379383
**** xref:reference:rpk/rpk-connect/rpk-connect-list.adoc[]
384+
**** xref:reference:rpk/rpk-connect/rpk-connect-mcp-server.adoc[]
385+
***** xref:reference:rpk/rpk-connect/rpk-connect-mcp-server-init.adoc[]
386+
***** xref:reference:rpk/rpk-connect/rpk-connect-mcp-server-lint.adoc[]
387+
**** xref:reference:rpk/rpk-connect/rpk-connect-plugin.adoc[]
388+
***** xref:reference:rpk/rpk-connect/rpk-connect-plugin-init.adoc[]
380389
**** xref:reference:rpk/rpk-connect/rpk-connect-run.adoc[]
381390
**** xref:reference:rpk/rpk-connect/rpk-connect-streams.adoc[]
382391
**** xref:reference:rpk/rpk-connect/rpk-connect-studio-pull.adoc[]

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

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
= rpk connect agent init
2+
:description: Initialize a Redpanda Connect agent.
3+
:page-topic-type: reference
4+
:learning-objective-1: Find the syntax for initializing an agent template
5+
:learning-objective-2: Identify available initialization options
6+
7+
[IMPORTANT]
8+
====
9+
This command is experimental and subject to change.
10+
====
11+
12+
Initialize a template for building a Redpanda Connect agent.
13+
14+
Use this reference to:
15+
16+
* [ ] {learning-objective-1}
17+
* [ ] {learning-objective-2}
18+
19+
== Usage
20+
21+
rpk connect agent init [OPTIONS]
22+
23+
== Example
24+
25+
[,bash]
26+
----
27+
rpk connect agent init ./repo
28+
----
29+
30+
== Flags
31+
32+
[cols="1m,2a"]
33+
|===
34+
| Option | Description
35+
36+
| --name
37+
| The name of the agent.
38+
39+
| --help, -h
40+
| Show help for the command.
41+
|===

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

Lines changed: 59 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
1+
= rpk connect agent run
2+
:description: Execute a Redpanda Connect agent as part of a pipeline with MCP tool access.
3+
:page-topic-type: reference
4+
:learning-objective-1: Find the syntax for executing agents
5+
:learning-objective-2: Identify secret management options
6+
:learning-objective-3: Look up security-related flags
7+
8+
[IMPORTANT]
9+
====
10+
This command is experimental and subject to change.
11+
====
12+
13+
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.
14+
15+
Use this reference to:
16+
17+
* [ ] {learning-objective-1}
18+
* [ ] {learning-objective-2}
19+
* [ ] {learning-objective-3}
20+
21+
== Usage
22+
23+
rpk connect agent run [OPTIONS]
24+
25+
== Example
26+
27+
[,bash]
28+
----
29+
rpk connect agent run ./repo
30+
----
31+
32+
To disable all secret lookups:
33+
34+
[,bash]
35+
----
36+
rpk connect agent run --secrets none: ./repo
37+
----
38+
39+
== Flags
40+
41+
[cols="1m,2a"]
42+
|===
43+
| Option | Description
44+
45+
| --secrets
46+
| 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:`).
47+
48+
| --redpanda-license
49+
| Provide an explicit Redpanda license, which enables enterprise functionality. By default, licenses found at the path `/etc/redpanda/redpanda.license` are applied.
50+
51+
| --help, -h
52+
| Show help for the command.
53+
54+
| --chroot
55+
| (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.
56+
57+
| --chroot-passthrough
58+
| (Linux only) Specify additional files to be copied into the chroot directory. Can be specified multiple times. Only valid when `--chroot` is used.
59+
|===

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

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
= rpk connect agent
2+
:description: Redpanda Connect agent commands.
3+
:page-topic-type: reference
4+
:learning-objective-1: Look up available agent subcommands
5+
:learning-objective-2: Identify agent command options
6+
7+
[IMPORTANT]
8+
====
9+
This command is experimental and subject to change.
10+
====
11+
12+
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.
13+
14+
Use this reference to:
15+
16+
* [ ] {learning-objective-1}
17+
* [ ] {learning-objective-2}
18+
19+
== Usage
20+
21+
rpk connect agent [command]
22+
23+
== Subcommands
24+
25+
* xref:reference:rpk/rpk-connect/rpk-connect-agent-init.adoc[init]: Initialize a Redpanda Connect agent.
26+
* 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.
27+
* help, h: Show a list of commands or help for one command.
28+
29+
== Flags
30+
31+
[cols="1m,2a"]
32+
|===
33+
| Option | Description
34+
35+
| --help, -h
36+
| Show help for the command.
37+
|===

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

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
= rpk connect dry-run
2+
:description: Parse Redpanda Connect configs and test the connections of each plugin.
3+
:page-topic-type: reference
4+
:learning-objective-1: Find the syntax for testing pipeline configurations
5+
:learning-objective-2: Look up connection testing options
6+
7+
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.
8+
9+
Use this reference to:
10+
11+
* [ ] {learning-objective-1}
12+
* [ ] {learning-objective-2}
13+
14+
== Usage
15+
16+
rpk connect dry-run [OPTIONS] [files...]
17+
18+
== Example
19+
20+
[,bash]
21+
----
22+
rpk connect dry-run ./pipeline.yaml
23+
----
24+
25+
To disable all secret lookups:
26+
27+
[,bash]
28+
----
29+
rpk connect dry-run --secrets none: ./pipeline.yaml
30+
----
31+
32+
== Flags
33+
34+
[cols="1m,2a"]
35+
|===
36+
| Option | Description
37+
38+
| --verbose
39+
| Print the lint result for each target file (default: false).
40+
41+
| --secrets
42+
| 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:`).
43+
44+
| --env-file, -e
45+
| Import environment variables from a dotenv file.
46+
47+
| --redpanda-license
48+
| Provide an explicit Redpanda license, which enables enterprise functionality. By default, licenses found at the path `/etc/redpanda/redpanda.license` are applied.
49+
50+
| --help, -h
51+
| Show help for the command.
52+
|===

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

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
= rpk connect plugin init
2+
:description: Create the boilerplate for a custom Redpanda Connect plugin.
3+
:page-topic-type: reference
4+
:learning-objective-1: Find the syntax for creating custom plugins
5+
:learning-objective-2: Identify supported languages and component types
6+
7+
[IMPORTANT]
8+
====
9+
This command is experimental and subject to change.
10+
====
11+
12+
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.
13+
14+
Use this reference to:
15+
16+
* [ ] {learning-objective-1}
17+
* [ ] {learning-objective-2}
18+
19+
== Usage
20+
21+
rpk connect plugin init [OPTIONS]
22+
23+
== Example
24+
25+
[,bash]
26+
----
27+
rpk connect plugin init example-plugin
28+
----
29+
30+
== Flags
31+
32+
[cols="1m,2a"]
33+
|===
34+
| Option | Description
35+
36+
| --language, --lang
37+
| The programming language for the plugin. Supported languages are `golang` and `python` (default: `python`).
38+
39+
| --component
40+
| The type of component to generate. Supported components are `input`, `output`, and `processor` (default: `processor`).
41+
42+
| --help, -h
43+
| Show help for the command.
44+
|===

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

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

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

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -45,5 +45,7 @@ rpk connect streams -o ./root_config.yaml ./streams/*.yaml
4545

4646
|--prefix-stream-endpoints |- | Whether HTTP endpoints registered by stream configs should be prefixed with the stream ID (default: true).
4747

48+
|--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).
49+
4850
|--help, -h |- | Show help.
4951
|===

0 commit comments

Comments
 (0)