CLI: conduit pipelines describe ID

[raulb]

Feature description

This command will describe the topology of the pipeline.

It requires having Conduit previously running.

It requires the pipeline id as argument.

Arguments

Name	Description	Required	Default Value
id	pipeline id to describe	Yes

Flags

Name	Description	Required	Default Value
grpc.address	address for serving the gRPC API	No	":8084"

--help

$ conduit pipelines describe ID

EXAMPLE:

$ conduit pipelines describe my-pipeline
ID: generator-to-log
State:
  Status: STATUS_STOPPED
Config:
  Name: generator-to-log
  Description: Postgres source, file destination
Connector IDs:
  - generator-to-log:postgres-source
  - generator-to-log:destination
Processor IDs:
  - my-processor:avro.encode
Created At: 2024-10-09T13:55:17.113068Z
Updated At: 2024-10-09T13:55:17.113802Z

---

Part of #1911

[lovromazgon]

Given the issue that made us think we have a bug, I think that a user would expect to see the whole pipeline including processors attached to connectors in this command's output. In this sense, describing a pipeline would mean seeing the whole pipeline topology (all connecotrs and processors). If we go a step further, we could even visualize the pipeline using ASCII art. Maybe not as part of the first release though, the scope if big enough already.

[hariso]

Given the issue that made us think we have a bug, I think that a user would expect to see the whole pipeline including processors attached to connectors in this command's output. In this sense, describing a pipeline would mean seeing the whole pipeline topology (all connecotrs and processors). If we go a step further, we could even visualize the pipeline using ASCII art. Maybe not as part of the first release though, the scope if big enough already.

This makes a lot of sense especially in simpler pipelines, e.g. with one source/destination, where there's practically no difference between a pipeline processor and a connector processor.