Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -1,20 +1,20 @@
= rpk connect echo

Parse a config file and echo back a normalized version.
Parse a configuration file and echo back a normalized version.

This command is useful to check a config that isn't working as expected. It shows a normalized version after environment variables have been resolved.
This command is useful to check a configuration that isn't working as expected. It shows a normalized version after environment variables have been resolved.

== Usage

[,bash]
----
rpk connect echo [command options] [arguments...]
rpk connect echo [arguments...]
----

== Example

```bash
rpk connect -c ./config.yaml echo | less
rpk connect echo ./config.yaml | less
```

== Flags
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,15 +14,15 @@ rpk connect lint [command options] [arguments...]
== Examples

```bash
rpk connect -c target.yaml lint
rpk connect lint target.yaml
```

```bash
rpk connect lint ./configs/*.yaml
```

```bash
rpk connect lint ./foo.yaml ./bar.yaml
rpk connect lint -r ./foo.yaml ./bar.yaml
```

```bash
Expand All @@ -35,6 +35,8 @@ rpk connect lint ./configs/...
|===
|*Value* |*Type* |*Description*

|--resources, -r |- | Pulls in extra resources from a file, which you can reference with a unique label in the main configuration. Supports glob patterns (requires quotes).

|--deprecated |- | Print linting errors for the presence of deprecated fields (default: false).

|--labels |- | Print linting errors when components do not have labels (default: false).
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
= rpk connect streams

Run Redpanda Connect in streams mode, where multiple pipelines can be executed in a single process and can be created, updated, and removed with REST HTTP endpoints. In streams mode, the stream fields of a root target config (input, buffer, pipeline, output) is ignored. Other fields are shared across all loaded streams (resources, metrics, etc.).
Run Redpanda Connect in streams mode, where multiple pipelines can be executed in a single process and can be created, updated, and removed with REST HTTP endpoints. In streams mode, the stream fields of a root target configuration (input, buffer, pipeline, output) are ignored. Other fields are shared across all loaded streams (resources, metrics, etc.).

See xref:redpanda-connect:guides:streams_mode/about.adoc[Streams Mode].

Expand All @@ -20,7 +20,7 @@ rpk connect streams

[,bash]
----
rpk connect -c ./root_config.yaml streams`
rpk connect streams -o ./root_config.yaml
----

[,bash]
Expand All @@ -30,7 +30,7 @@ rpk connect streams ./path/to/stream/configs ./and/some/more

[,bash]
----
rpk connect -c ./root_config.yaml streams ./streams/*.yaml
rpk connect streams -o ./root_config.yaml ./streams/*.yaml
----

== Flags
Expand All @@ -41,6 +41,8 @@ rpk connect -c ./root_config.yaml streams ./streams/*.yaml

|--no-api |- | Disable the HTTP API for streams mode (default: false).

|--observability, -o |- | Specify a path to a service wide configuration file, which can include observability configuration, such as metrics, logger, and tracing sections.

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

|--help, -h |- | Show help.
Expand Down
6 changes: 4 additions & 2 deletions modules/reference/pages/rpk/rpk-connect/rpk-connect.adoc
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
= rpk connect
:description: These commands let manage Redpanda Connectors
:description: These commands let you create and manage data pipelines using Redpanda Connect.

Redpanda Connect provides an ecosystem of over 220 open source connectors.

Expand Down Expand Up @@ -46,7 +46,9 @@ rpk connect -r "./production/*.yaml" -c ./config.yaml

|--config , -c |- | Path to a configuration file.

|--resources, -r |- | Pull in extra resources from a file, which can be referenced by the same as resources defined in the main config. This supports glob patterns (requires quotes).
|--observability, -o |- | Use in streams mode. Specify a path to a service wide configuration file, which can include observability configuration, such as metrics, logger, and tracing sections.

|--resources, -r |- | Pulls in extra resources from a file, which you can reference with a unique label in the main configuration. Supports glob patterns (requires quotes).

|--templates, -t |- | EXPERIMENTAL: Import Redpanda Connect templates. This supports glob patterns (requires quotes).

Expand Down