-
Notifications
You must be signed in to change notification settings - Fork 4
DOC-1435 Add gcloud commands for firewall rules for PSC consumer #377
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.
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
Merged
micheleRP
merged 22 commits into
main
from
DOC-1435-Add-gcloud-commands-for-creating-firewall-rules-for-PSC-consumer
Aug 7, 2025
Merged
Changes from 3 commits
Commits
Show all changes
22 commits
Select commit
Hold shift + click to select a range
cfb0d6f
DOC-1435 Add gcloud commands for creating firewall rules for PSC cons…
micheleRP daf55c4
fix API docs similarly
micheleRP 36c7bcc
Add Glue doc to Cloud (#363)
kbatuigas a4958fb
Update @redpanda-data/docs-extensions-and-macros (#378)
vbotbuildovich ca2f913
docs: fix property alias (#379)
paulohtb6 ae2d15f
Fix heading for AWS Glue entry (#380)
kbatuigas c88a4f1
minor edits
micheleRP 592694c
Paul's review feedback
micheleRP e2bb700
copilot suggestions for consistency
micheleRP c02b991
coderabbit suggestions
micheleRP 16a895f
move step into BYOVPC section
micheleRP 73a2958
DOC-1435 Add gcloud commands for creating firewall rules for PSC cons…
micheleRP 25a2269
fix API docs similarly
micheleRP ee086fe
minor edits
micheleRP b8a5830
Paul's review feedback
micheleRP 0f2ed51
copilot suggestions for consistency
micheleRP 7a627b0
coderabbit suggestions
micheleRP 73b04a4
move step into BYOVPC section
micheleRP ba18788
Merge branch 'DOC-1435-Add-gcloud-commands-for-creating-firewall-rule…
micheleRP e7f7910
fixes from coderabbit
micheleRP 604fd41
minor edit
micheleRP 638e86f
incorporate doc review suggestions
micheleRP File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -2,4 +2,78 @@ | |
| :description: Set up GCP Private Service Connect in the Redpanda Cloud UI. | ||
| :env-dedicated: true | ||
|
|
||
| include::networking:partial$psc-ui.adoc[] | ||
| [NOTE] | ||
| ==== | ||
|
|
||
| * This guide is for configuring GCP Private Service Connect using the Redpanda Cloud UI. To configure and manage Private Service Connect on an existing cluster with *public* networking, you must use the xref:networking:gcp-private-service-connect.adoc[Cloud API for BYOC] or the xref:networking:dedicated/gcp/configure-psc-in-api.adoc[Cloud API for Dedicated]. | ||
| * The latest version of Redpanda GCP Private Service Connect (available March, 2025) supports AZ affinity. This allows requests from Private Service Connect endpoints to stay within the same availability zone, avoiding additional networking costs. | ||
| * DEPRECATION: The original Redpanda GCP Private Service Connect is deprecated and will be removed in a future release. For more information, see xref:manage:maintenance.adoc#deprecated-features[Deprecated features]. | ||
| ==== | ||
|
|
||
|
|
||
| The Redpanda GCP Private Service Connect service provides secure access to Redpanda Cloud from your own VPC network. Traffic over Private Service Connect does not go through the public internet because these connections are treated as their own private GCP service. While your VPC network has access to the Redpanda VPC network, Redpanda cannot access your VPC network. | ||
micheleRP marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| Consider using Private Service Connect if you have multiple VPC networks and could benefit from a more simplified approach to network management. | ||
|
|
||
| [NOTE] | ||
| ==== | ||
| * Each consumer VPC network can have one Private Service Connect endpoint connected to the Redpanda service attachment. | ||
| * Private Service Connect allows overlapping xref:networking:cidr-ranges.adoc[CIDR ranges] in VPC networks. | ||
| * The number of connections is limited only by your Redpanda usage tier. Private Service Connect does not add extra connection limits. | ||
micheleRP marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| * You control from which GCP projects connections are allowed. | ||
| ==== | ||
|
|
||
| == Requirements | ||
micheleRP marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| * Use the https://cloud.google.com/sdk/docs/install[gcloud^] command-line interface (CLI) to create the consumer-side resources, such as a consumer VPC network and forwarding rule, or to modify existing resources to use the Private Service Connect service attachment created for your cluster. | ||
| * The consumer VPC network must be in the same region as your Redpanda cluster. | ||
|
|
||
| == Enable Private Service Connect for existing clusters | ||
|
|
||
| . In the Redpanda Cloud UI, open your https://cloud.redpanda.com/clusters[cluster^], and click **Cluster settings**. | ||
| . Under Private Service Connect, click **Enable**. | ||
| ifdef::env-byoc[] | ||
| . For xref:get-started:cluster-types/byoc/gcp/vpc-byo-gcp.adoc[BYOVPC clusters], you need a NAT subnet with `purpose` set to `PRIVATE_SERVICE_CONNECT`. You also need to create VPC network firewall rules to allow Private Service Connect traffic. You can use the `gcloud` CLI: | ||
| + | ||
| NOTE: The firewall rules support up to 20 Redpanda brokers. If you have more than 20 brokers, or for help enabling Private Service Connect, contact https://support.redpanda.com/hc/en-us/requests/new[Redpanda support^]. | ||
| + | ||
| [,bash] | ||
| ---- | ||
| gcloud compute networks subnets create <subnet-name> \ | ||
| --project=<host-project-id> \ | ||
| --network=<shared-vpc-name> \ | ||
| --region=<region> \ | ||
| --range=<subnet-range> \ | ||
| --purpose=PRIVATE_SERVICE_CONNECT | ||
| ---- | ||
| + | ||
| [,bash] | ||
| ---- | ||
| gcloud compute firewall-rules create redpanda-psc-ingress \ | ||
| --description="Allow access to Redpanda PSC endpoints" \ | ||
| --network="<shared-vpc-name>" \ | ||
| --project="<host-project-id>" \ | ||
| --direction="INGRESS" \ | ||
| --target-tags="redpanda-node" \ | ||
| --source-ranges="10.0.0.0/8,172.16.0.0/12,192.168.0.0/16,100.64.0.0/10" \ | ||
| --allow="tcp:30181,tcp:30282,tcp:30292,tcp:31004,tcp:31082-31101,tcp:31182-31201,tcp:31282-31301,tcp:32092-32111,tcp:32192-32211,tcp:32292-32311" | ||
|
Comment on lines
+57
to
+59
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. are these fixed? if no, we should add them as replaceable snippet and provide these values as an example. |
||
| ---- | ||
micheleRP marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| + | ||
| Provide your values for the following placeholders: | ||
| + | ||
| - `<subnet-name>`: The name of the NAT subnet. | ||
| - `<host-project-id>`: The host GCP project ID. | ||
| - `<shared-vpc-name>`: The name of the VPC network being used for your Redpanda Cloud cluster. | ||
| - `<region>`: The region of the Redpanda Cloud cluster. | ||
| - `<subnet-range>`: The CIDR range of the subnet. The mask should be at least `/29`. Each Private Service Connect connection takes up one IP address from the NAT subnet, so the CIDR must be able to accommodate all projects from which connections to the service attachment will be issued. | ||
| + | ||
| See the GCP documentation for https://cloud.google.com/vpc/docs/configure-private-service-connect-producer#add-subnet-psc[creating a subnet for Private Service Connect^]. | ||
| endif::[] | ||
| . For the accepted consumers list, you need the GCP project IDs from which incoming connections will be accepted. | ||
| . It may take several minutes for your cluster to update. When the update is complete, the Private Service Connect status in **Cluster settings** changes from **In progress** to **Enabled**. | ||
|
|
||
| include::networking:partial$psc-ui.adoc[] | ||
|
|
||
| == Disable Private Service Connect | ||
|
|
||
| In **Cluster settings**, click **Disable**. Existing connections are closed after GCP Private Service Connect is disabled. To connect using Private Service Connect again, you must re-enable the service. | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file was deleted.
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.