Skip to content

DOC-1065 Enabling connectivity for cloud-based external systems #185

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

DOC-1065 Enabling connectivity for cloud-based external systems #185

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
2 changes: 2 additions & 0 deletions modules/components/pages/inputs/timeplus.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -97,6 +97,8 @@ Replace the following placeholders with your own values:
--
======

include::components:partial$external_connectivity_inputs.adoc[]

== Fields

=== `query`
Expand Down
2 changes: 2 additions & 0 deletions modules/components/pages/outputs/elasticsearch.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -98,6 +98,8 @@ output:

Both the `id` and `index` fields can be dynamically set using function interpolations described in xref:configuration:interpolation.adoc#bloblang-queries[Bloblang queries]. When sending batched messages these interpolations are performed per message part.

include::components:partial$external_connectivity_outputs.adoc[]

== AWS

It's possible to enable AWS connectivity with this output using the `aws` fields. However, you may need to set `sniff` and `healthcheck` to false for connections to succeed.
Expand Down
1 change: 1 addition & 0 deletions modules/components/pages/outputs/mongodb.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -84,6 +84,7 @@ output:
--
======

include::components:partial$external_connectivity_outputs.adoc[]

== Performance

Expand Down
2 changes: 2 additions & 0 deletions modules/components/pages/outputs/snowflake_put.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -103,6 +103,8 @@ xref:configuration:interpolation.adoc#bloblang-queries[Bloblang queries]. When u
stage and Snowpipe and are streamed to individual files in their corresponding stage and, optionally, a Snowpipe
`insertFiles` REST API call will be made for each individual file.

include::components:partial$external_connectivity_outputs.adoc[]

== Credentials

Two authentication mechanisms are supported:
Expand Down
2 changes: 2 additions & 0 deletions modules/components/pages/outputs/snowflake_streaming.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -90,6 +90,8 @@ output:
--
======

include::components:partial$external_connectivity_outputs.adoc[]

== Supported data formats for Snowflake columns

The message data from your output must match the columns in the Snowflake table that you want to write data to. The following table shows you the https://docs.snowflake.com/en/sql-reference/intro-summary-data-types[column data types supported by Snowflake^] and how they correspond to the xref:guides:bloblang/methods.adoc#type[Bloblang data types] in Redpanda Connect.
Expand Down
15 changes: 15 additions & 0 deletions modules/components/partials/external_connectivity_inputs.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
ifndef::env-cloud[]

Copy link
Contributor Author

@asimms41 asimms41 Mar 5, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've added this message to just the timeplus input for now. See page previews for cloud and non-cloud versions. I skimmed through the list but wasn't entirely sure which connectors it might apply to, it didn't seem relevant in many cases. Any guidance appreciated: https://github.com/redpanda-data/connect/blob/main/internal/plugins/info.csv

== Enable connectivity from cloud-based data sources

To establish a secure connection between a cloud-based data source and Redpanda Connect, you must add the IP addresses of your Redpanda Connect instances to your firewall rules.

endif::[]

ifdef::env-cloud[]

== Enable connectivity from cloud-based data sources (BYOC only)

To establish a secure connection between a cloud-based data source and Redpanda Connect, you must add the NAT Gateway IP address of your Redpanda cluster to the allowlist of your data source.

endif::[]
15 changes: 15 additions & 0 deletions modules/components/partials/external_connectivity_outputs.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
ifndef::env-cloud[]

== Enable connectivity to cloud-based data sinks
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've added this message to a small set of outputs for now. Again, any guidance on which other data sinks this should be added to would be appreciated.


To establish a secure connection between Redpanda Connect and a cloud-based target system, you must add the IP addresses of your Redpanda Connect instances to your firewall rules.

endif::[]

ifdef::env-cloud[]

== Enable connectivity to cloud-based data sinks (BYOC only)

To establish a secure connection between Redpanda Connect and a cloud-based target system, you must add the NAT Gateway IP address of your Redpanda cluster to the allowlist of your data sink.

endif::[]