Skip to content

Commit

Permalink
add connector-plugins
Browse files Browse the repository at this point in the history
  • Loading branch information
raulb committed Oct 25, 2024
1 parent 90c1974 commit d51f097
Showing 1 changed file with 40 additions and 15 deletions.
55 changes: 40 additions & 15 deletions docs/design-documents/20241024-conduit-cli.md
Original file line number Diff line number Diff line change
Expand Up @@ -253,43 +253,68 @@ It requires having Conduit previously running.
```bash
$ conduit connectors ls
ID PLUGIN TYPE PIPELINE
my-source [email protected] builtin file-to-postgres
my-source [email protected] builtin file-to-postgres
my-destination [email protected]. standalone my-other-pipeline
```

### `conduit connectors describe [--plugin] [--id]`
### `conduit connectors describe ID`

This command will describe the connector configuration available.
This command will describe the existing running connector.

When using `--plugin` will describe the configuration for that connector plugin.

When using `--id` will require having Conduit previously running since it'll describe the existing running connector.
It requires having Conduit previously running.

#### Flags

| Name | Description | Required | Default Value |
|------|-------------|----------|---------------|
| id | connector identifier (returned by `connectors ls`) | Yes | |
| plugin | plugin name and version | Yes | |
| grpc.address | address for serving the gRPC API | No | ":8084" |

#### `--help`

```bash
$ conduit connnectors describe [--plugin] [--id] [--grpc.address]
$ conduit connnectors describe ID [--grpc.address]

EXAMPLE:

$ conduit connectors describe my-source
NAME URL PIPELINE PLUGIN
my-source https://... my-pipeline [email protected]
```

### `conduit connector-plugins ls`

This command will list all the available connector plugins.

It does not require having Conduit previously running.

#### `--help`

```bash
$ conduit connector-plugins ls
PLUGIN
[email protected]
[email protected]
```

### `conduit connector-plugins PLUGIN`

This command will describe the configuration for that connector plugin.

It does not require having Conduit previously running.

#### `--help`

```bash
$ conduit connnector-plugins describe PLUGIN

EXAMPLE:

$ conduit connectors describe --plugin [email protected]
$ conduit connector-plugins describe [email protected]
NAME DESCRIPTION REQUIRED DEFAULT VALUE EXAMPLE
url HTTP URL to send requests to. true https://...
...

$ conduit connectors describe --id my-source
NAME URL PIPELINE
my-source https://... my-pipeline
```


Check failure on line 317 in docs/design-documents/20241024-conduit-cli.md

View workflow job for this annotation

GitHub Actions / markdownlint-cli2

Multiple consecutive blank lines

docs/design-documents/20241024-conduit-cli.md:317 MD012/no-multiple-blanks Multiple consecutive blank lines [Expected: 1; Actual: 2] https://github.com/DavidAnson/markdownlint/blob/v0.35.0/doc/md012.md
### `conduit processors ls`

This command will list all the available processors.
Expand Down

0 comments on commit d51f097

Please sign in to comment.