Skip to content
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

doc: add ports aliugment note in Kafka privatelink guide #31222

Merged
merged 2 commits into from
Feb 4, 2025
Merged

doc: add ports aliugment note in Kafka privatelink guide #31222

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ba0dfb5
doc: add ports aliugment note in Kafka privatelink guide
bobbyiliev Jan 29, 2025
c9c657f
Minor updates
morsapaes Feb 4, 2025
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
4 changes: 2 additions & 2 deletions doc/user/content/ingest-data/postgres/amazon-rds.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -379,7 +379,7 @@ start by selecting the relevant option.
command to create an **in-region** or **cross-region** AWS PrivateLink
connection.

**In-region connections**
↕️ **In-region connections**

To connect to an AWS PrivateLink endpoint service in the **same region** as your
Materialize environment:
Expand All @@ -402,7 +402,7 @@ start by selecting the relevant option.
subnet, look for **Availability Zone ID** (e.g., `use1-az6`),
not **Availability Zone** (e.g., `us-east-1d`).

**Cross-region connections**
↔️ **Cross-region connections**

To connect to an AWS PrivateLink endpoint service in a **different region** to
the one where your Materialize environment is deployed:
Expand Down
17 changes: 15 additions & 2 deletions doc/user/layouts/shortcodes/network-security/privatelink-kafka.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -134,11 +134,14 @@ If no validation error is returned, move to the next step.

## Create a source connection

In Materialize, create a source connection that uses the AWS PrivateLink connection you just configured:
In Materialize, create a source connection that uses the AWS PrivateLink
connection you just configured:

```mzsql
CREATE CONNECTION kafka_connection TO KAFKA (
BROKERS (
-- The port **must exactly match** the port assigned to the broker in
-- the TCP listerner of the NLB.
'b-1.hostname-1:9096' USING AWS PRIVATELINK privatelink_svc (PORT 9001, AVAILABILITY ZONE 'use1-az2'),
'b-2.hostname-2:9096' USING AWS PRIVATELINK privatelink_svc (PORT 9002, AVAILABILITY ZONE 'use1-az1'),
'b-3.hostname-3:9096' USING AWS PRIVATELINK privatelink_svc (PORT 9003, AVAILABILITY ZONE 'use1-az4')
Expand All @@ -151,4 +154,14 @@ CREATE CONNECTION kafka_connection TO KAFKA (
);
```

The `(PORT <port_number>)` value must match the port that you used when creating the **TCP listener** in the Network Load Balancer. Be sure to specify the correct availability zone for each broker.
### Troubleshooting

If you run into connectivity issues during source creation, make sure that:

* The `(PORT <port_number>)` value **exactly matches** the port assigned to the
corresponding broker in the **TCP listener** of the Network Load Balancer.
Misalignment between ports and broker addresses is the most common cause for
connectivity issues.

* For **in-region connections**, the correct availability zone is specified for
each broker.