From faaf387964c01128edd312e181b3b4f2b2b9b639 Mon Sep 17 00:00:00 2001 From: Angela Simms Date: Wed, 5 Mar 2025 14:44:49 +0000 Subject: [PATCH] Add connectivity message --- modules/components/pages/inputs/timeplus.adoc | 2 ++ .../components/pages/outputs/elasticsearch.adoc | 2 ++ modules/components/pages/outputs/mongodb.adoc | 1 + .../components/pages/outputs/snowflake_put.adoc | 2 ++ .../pages/outputs/snowflake_streaming.adoc | 2 ++ .../partials/external_connectivity_inputs.adoc | 15 +++++++++++++++ .../partials/external_connectivity_outputs.adoc | 15 +++++++++++++++ 7 files changed, 39 insertions(+) create mode 100644 modules/components/partials/external_connectivity_inputs.adoc create mode 100644 modules/components/partials/external_connectivity_outputs.adoc diff --git a/modules/components/pages/inputs/timeplus.adoc b/modules/components/pages/inputs/timeplus.adoc index cf14e0e7..6f51c314 100644 --- a/modules/components/pages/inputs/timeplus.adoc +++ b/modules/components/pages/inputs/timeplus.adoc @@ -97,6 +97,8 @@ Replace the following placeholders with your own values: -- ====== +include::components:partial$external_connectivity_inputs.adoc[] + == Fields === `query` diff --git a/modules/components/pages/outputs/elasticsearch.adoc b/modules/components/pages/outputs/elasticsearch.adoc index 77d1956e..10f471d5 100644 --- a/modules/components/pages/outputs/elasticsearch.adoc +++ b/modules/components/pages/outputs/elasticsearch.adoc @@ -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. diff --git a/modules/components/pages/outputs/mongodb.adoc b/modules/components/pages/outputs/mongodb.adoc index 7d1dad64..47ee921b 100644 --- a/modules/components/pages/outputs/mongodb.adoc +++ b/modules/components/pages/outputs/mongodb.adoc @@ -84,6 +84,7 @@ output: -- ====== +include::components:partial$external_connectivity_outputs.adoc[] == Performance diff --git a/modules/components/pages/outputs/snowflake_put.adoc b/modules/components/pages/outputs/snowflake_put.adoc index 63879143..117575db 100644 --- a/modules/components/pages/outputs/snowflake_put.adoc +++ b/modules/components/pages/outputs/snowflake_put.adoc @@ -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: diff --git a/modules/components/pages/outputs/snowflake_streaming.adoc b/modules/components/pages/outputs/snowflake_streaming.adoc index 7009e552..88292484 100644 --- a/modules/components/pages/outputs/snowflake_streaming.adoc +++ b/modules/components/pages/outputs/snowflake_streaming.adoc @@ -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. diff --git a/modules/components/partials/external_connectivity_inputs.adoc b/modules/components/partials/external_connectivity_inputs.adoc new file mode 100644 index 00000000..42e834b9 --- /dev/null +++ b/modules/components/partials/external_connectivity_inputs.adoc @@ -0,0 +1,15 @@ +ifndef::env-cloud[] + +== 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::[] \ No newline at end of file diff --git a/modules/components/partials/external_connectivity_outputs.adoc b/modules/components/partials/external_connectivity_outputs.adoc new file mode 100644 index 00000000..5c11da74 --- /dev/null +++ b/modules/components/partials/external_connectivity_outputs.adoc @@ -0,0 +1,15 @@ +ifndef::env-cloud[] + +== Enable connectivity to cloud-based data sinks + +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::[]