Repository navigation
docs: mark self-managed-only text in the inproc and http_server descriptions - #523
JakeSCahill wants to merge 3 commits into
Conversation
|
Commits Review LGTM |
![claude[bot]](https://avatars.githubusercontent.com/in/1236702?s=60&v=4){kind=small}
| ifndef::env-cloud[] | ||
| This allows you to hook up isolated streams whilst running Redpanda Connect in ` + "xref:guides:streams_mode/about.adoc[streams mode]" + `, it is NOT recommended that you connect the inputs of a stream with an output of the same stream, as feedback loops can lead to deadlocks in your message flow. | ||
| endif::[] |
There was a problem hiding this comment.
The ifndef::env-cloud[] block hides more than the streams-mode text. It also hides the warning that connecting a stream's output to its own input can create a feedback loop and deadlock. That risk is not specific to streams mode, and Cloud users can still set up an inproc loop, so they lose a safety warning that still applies to them. The same thing happens in internal/impl/pure/output_inproc.go (L28-L31).
Suggested fix: keep only the streams-mode sentence inside the ifndef::env-cloud[] block, and move the "it is NOT recommended that you connect the inputs of a stream with an output of the same stream…" warning outside it so it renders everywhere.
https://github.com/redpanda-data/connect/blob//internal/impl/pure/input_inproc.go#L27-L31
|
Commits Review
|
|
Moved the feedback loop warning out of the Cloud conditional in 819e967. It applies in Cloud too, where inproc can only connect a stream to itself. Only the streams mode sentence is self-managed now. |
|
Commits Review LGTM |
1 participant
Redpanda Cloud includes the generated docs for these components, but streams mode and the service-wide HTTP server do not exist there. The hand-written docs pages hid those sentences in Cloud. This wraps them in
ifndef::env-cloud[]in the spec, the form documented onConfigSpec.Description, so every renderer does the same.The
inprocsummaries also said "when running in streams mode". A summary renders as one line on every surface and cannot carry a conditional, so the clause is dropped.Draft until the Cloud UI reads Markdown (benthos 524, connect 4954, then cloudv2 https://github.com/redpanda-data/cloudv2/pull/30961); before that, a conditional shows as literal text in the pipeline editor.