Skip to content

Commit c9e5bc6

Browse files
DOC-1457 separate Dedicate PSC docs (#334)
* DOC-1457 separate Dedicate PSC docs * remove redundant line * add link to using API for Dedicated * Update modules/networking/partials/psc-ui.adoc Co-authored-by: Paul Zhang <[email protected]> * incorporate Paul's feedback * update AWS privatelink for Dedicated --------- Co-authored-by: Paul Zhang <[email protected]>
1 parent 79da45b commit c9e5bc6

File tree

11 files changed

+370
-183
lines changed

11 files changed

+370
-183
lines changed

modules/ROOT/nav.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -47,8 +47,8 @@
4747
**** xref:networking:azure-private-link.adoc[]
4848
*** xref:networking:dedicated/gcp/index.adoc[GCP]
4949
**** xref:networking:dedicated/gcp/vpc-peering-gcp.adoc[Add a Peering Connection]
50-
**** xref:networking:configure-private-service-connect-in-cloud-ui.adoc[Configure Private Service Connect in the Cloud UI]
51-
**** xref:networking:gcp-private-service-connect.adoc[Configure Private Service Connect with the Cloud API]
50+
**** xref:networking:dedicated/gcp/configure-psc-in-ui.adoc[Configure Private Service Connect in the Cloud UI]
51+
**** xref:networking:dedicated/gcp/configure-psc-in-api.adoc[Configure Private Service Connect with the Cloud API]
5252
5353
* xref:security:index.adoc[Security]
5454
** xref:security:cloud-authentication.adoc[Authentication]

modules/networking/pages/aws-privatelink.adoc

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ export RESOURCE_GROUP_ID=<uuid>
4545

4646
. Call xref:api:ROOT:cloud-controlplane-api.adoc#post-/v1/networks[`POST /v1/networks`] to create a network.
4747
+
48-
Make sure to supply your own values in the following example request. Store the network ID (`network_id`) after the network is created to check whether you can proceed to cluster creation.
48+
Make sure to supply your own values in the following example request. The example uses a BYOC cluser. For a Dedicated cluster, set `"cluster_type": "TYPE_DEDICATED"`. Store the network ID (`network_id`) after the network is created to check whether you can proceed to cluster creation.
4949
+
5050
--
5151
- `name`
@@ -84,11 +84,11 @@ In the example below, make sure to set your own values for the following fields:
8484
+
8585
--
8686
- `zones`: for example, `"usw2-az1","usw2-az2","usw2-az3"`
87-
- `type`: `TYPE_DEDICATED` for Dedicated Cloud clusters, or `TYPE_BYOC` for BYOC clusters
88-
- `tier`: for example, `tier-1-aws-v2-arm`
87+
- `type`: `"TYPE_BYOC"` or `"TYPE_DEDICATED"`
88+
- `tier`: for example, `"tier-1-aws-v2-arm"`
8989
- `name`
9090
- `connect_console`: Whether to enable connections to Redpanda Console (boolean)
91-
- `allowed_principals`: Amazon Resource Names (ARNs) for the AWS principals allowed to access the endpoint service. For example, for all principals in an account, use `arn:aws:iam::account_id:root`. See https://docs.aws.amazon.com/vpc/latest/privatelink/configure-endpoint-service.html#add-remove-permission[Configure an endpoint service^] for details.
91+
- `allowed_principals`: Amazon Resource Names (ARNs) for the AWS principals allowed to access the endpoint service. For example, for all principals in an account, use `"arn:aws:iam::account_id:root"`. See https://docs.aws.amazon.com/vpc/latest/privatelink/configure-endpoint-service.html#add-remove-permission[Configure an endpoint service^] for details.
9292
--
9393
+
9494
[,bash]
@@ -120,7 +120,7 @@ CLUSTER_ID=`curl -vv -X POST \
120120
echo $CLUSTER_ID
121121
----
122122
+
123-
**BYOC clusters:** Check that the cluster operation is completed by calling xref:api:ROOT:cloud-controlplane-api.adoc#get-/v1/operations/-id-[`GET /v1/operations/\{id}`], and passing the operation ID returned from the Create Cluster call.
123+
**BYOC clusters only:** Check that the cluster operation is completed by calling xref:api:ROOT:cloud-controlplane-api.adoc#get-/v1/operations/-id-[`GET /v1/operations/\{id}`], and passing the operation ID returned from the Create Cluster call.
124124
+
125125
When the Create Cluster operation is completed (`STATE_COMPLETED`), run the following `rpk cloud` command to finish setting up your BYOC cluster:
126126
+
@@ -146,7 +146,7 @@ In the example below, make sure to set your own value for the following field:
146146
+
147147
--
148148
- `connect_console`: Whether to enable connections to Redpanda Console (boolean)
149-
- `allowed_principals`: Amazon Resource Names (ARNs) for the AWS principals allowed to access the endpoint service. For example, for all principals in an account, use `arn:aws:iam::account_id:root`. See https://docs.aws.amazon.com/vpc/latest/privatelink/configure-endpoint-service.html#add-remove-permission[Configure an endpoint service^] for details.
149+
- `allowed_principals`: Amazon Resource Names (ARNs) for the AWS principals allowed to access the endpoint service. For example, for all principals in an account, use `"arn:aws:iam::account_id:root"`. See https://docs.aws.amazon.com/vpc/latest/privatelink/configure-endpoint-service.html#add-remove-permission[Configure an endpoint service^] for details.
150150
--
151151
+
152152
[,bash]
@@ -217,7 +217,7 @@ xref:networking:byoc/aws/vpc-peering-aws.adoc[VPC peering] and PrivateLink will
217217
VPC peering and PrivateLink can both be used at the same time if Kafka clients are connecting from distinct VPCs. For example, in a private Redpanda cluster, you can connect your internal Kafka clients over VPC peering, and enable PrivateLink for external services.
218218
====
219219

220-
The VPC region must be the same region where the Redpanda cluster is deployed. Run the following command to create the VPC:
220+
The VPC region must be the same region where the Redpanda cluster is deployed. To create the VPC, run:
221221

222222
[,bash]
223223
----
@@ -235,7 +235,7 @@ You can also use an existing VPC. You need the VPC ID to <<modify-vpc-dns-attrib
235235

236236
=== Modify VPC DNS attributes
237237

238-
Modify the VPC attributes using the following commands:
238+
To modify the VPC attributes, run:
239239

240240
[,bash]
241241
----
@@ -250,7 +250,7 @@ These commands enable DNS hostnames and resolution for instances in the VPC.
250250

251251
=== Create security group
252252

253-
You need the security group ID `security_group_id` from the command output to <<add-security-group-rules,add security group rules>>. Run the following command to create a security group:
253+
You need the security group ID `security_group_id` from the command output to <<add-security-group-rules,add security group rules>>. To create a security group, run:
254254

255255
[,bash]
256256
----
@@ -369,5 +369,5 @@ include::networking:partial$private-links-test-connection.adoc[]
369369
include::shared:partial$suggested-reading.adoc[]
370370

371371
* xref:manage:api/cloud-api-overview.adoc[]
372-
* xref:networking:dedicated/vpc-peering.adoc[]
373372
* xref:networking:byoc/aws/vpc-peering-aws.adoc[]
373+
* xref:networking:dedicated/vpc-peering.adoc[]

modules/networking/pages/azure-private-link.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ After <<get-a-cloud-api-access-token,getting an access token>>, you can <<create
1919
== Requirements
2020

2121
* Install xref:manage:rpk/rpk-install.adoc[`rpk`].
22-
* Install `jq` [https://jqlang.org/download/], which is used to parse JSON values from API responses.
22+
* Install https://jqlang.org/download/[`jq`^], which is used to parse JSON values from API responses.
2323
* You will use the https://learn.microsoft.com/en-us/cli/azure/[Azure CLI^] to authenticate with Azure and configure resources in your Azure account.
2424
* You will use the xref:deploy:deployment-option/cloud/api/cloud-api-overview.adoc[Redpanda Cloud API] to enable the Redpanda Private Link service for your clusters. Follow the steps on this page to <<get-a-cloud-api-access-token, get an access token>>.
2525

@@ -139,7 +139,7 @@ CLUSTER_ID=`curl -vv -X POST \
139139
echo $CLUSTER_ID
140140
----
141141

142-
. **BYOC clusters:** Check that the cluster operation is completed by calling xref:api:ROOT:cloud-controlplane-api.adoc#get-/v1/operations/-id-[`GET /v1/operations/\{id}`], and passing the operation ID returned from the Create Cluster call.
142+
. **BYOC clusters only:** Check that the cluster operation is completed by calling xref:api:ROOT:cloud-controlplane-api.adoc#get-/v1/operations/-id-[`GET /v1/operations/\{id}`], and passing the operation ID returned from the Create Cluster call.
143143
+
144144
When the Create Cluster operation is completed (`STATE_COMPLETED`), run the following `rpk cloud` command to finish setting up your BYOC cluster with Private Link enabled:
145145
+
Lines changed: 2 additions & 105 deletions
Original file line numberDiff line numberDiff line change
@@ -1,109 +1,6 @@
11
= Configure GCP Private Service Connect in the Cloud UI
22
:description: Set up GCP Private Service Connect in the Redpanda Cloud UI.
33
:page-aliases: deploy:deployment-option/cloud/configure-private-service-connect-in-cloud-ui.adoc
4+
:env-byoc: true
45

5-
[NOTE]
6-
====
7-
8-
* This guide is for configuring GCP Private Service Connect using the Redpanda Cloud UI. To configure and manage Private Service on an existing public cluster, you must use the xref:networking:gcp-private-service-connect.adoc[Redpanda Cloud API].
9-
* 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.
10-
* 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].
11-
====
12-
13-
14-
The Redpanda GCP Private Service Connect service provides secure access to Redpanda Cloud from your own VPC. 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 has access to the Redpanda VPC, Redpanda cannot access your VPC.
15-
16-
Consider using the endpoint services if you have multiple VPCs and could benefit from a more simplified approach to network management.
17-
18-
[NOTE]
19-
====
20-
* Each client VPC can have one endpoint connected to Private Service Connect.
21-
* Private Service Connect allows overlapping xref:networking:cidr-ranges.adoc[CIDR ranges] in VPC networks.
22-
* The number of connections is limited only by your Redpanda usage tier. Private Service Connect does not add extra connection limits.
23-
* You control from which GCP projects connections are allowed.
24-
====
25-
26-
== Requirements
27-
28-
* Use the https://cloud.google.com/sdk/docs/install[gcloud^] command-line interface (CLI) to create the consumer-side resources, such as a client VPC and forwarding rule, or to modify existing resources to use the Private Service Connect attachment created for your cluster.
29-
* The client VPC must be in the same region as your Redpanda cluster.
30-
31-
== Enable endpoint service for existing clusters
32-
33-
. In the Redpanda Cloud UI, open your https://cloud.redpanda.com/clusters[cluster^], and click **Cluster settings**.
34-
. Under Private Service Connect, click **Enable**.
35-
. 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 firewall rules to allow Private Service Connect traffic. You can use the `gcloud` CLI:
36-
+
37-
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^].
38-
+
39-
[,bash]
40-
----
41-
gcloud compute networks subnets create <subnet-name> \
42-
--project=<host-project-id> \
43-
--network=<shared-vpc-name> \
44-
--region=<region> \
45-
--range=<subnet-range> \
46-
--purpose=PRIVATE_SERVICE_CONNECT
47-
----
48-
+
49-
[,bash]
50-
----
51-
gcloud compute firewall-rules create redpanda-psc \
52-
--description="Allow access to Redpanda PSC endpoints" \
53-
--network="<shared-vpc-name>" \
54-
--project="<host-project-id>" \
55-
--direction="INGRESS" \
56-
--target-tags="redpanda-node" \
57-
--source-ranges="10.0.0.0/8,172.16.0.0/12,192.168.0.0/16,100.64.0.0/10" \
58-
--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"
59-
----
60-
+
61-
Provide your values for the following placeholders:
62-
+
63-
- `<subnet-name>`: The name of the NAT subnet.
64-
- `<host-project-id>`: The host GCP project ID.
65-
- `<shared-vpc-name>`: The name of the VPC being used for your Redpanda Cloud cluster.
66-
- `<region>`: The region of the Redpanda Cloud cluster.
67-
- `<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.
68-
+
69-
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^].
70-
. For the accepted consumers list, you need the GCP project IDs from which incoming connections will be accepted.
71-
. 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**.
72-
73-
=== Deploy consumer-side resources
74-
75-
For each VPC network, you must complete the following steps to successfully connect to the service and use Kafka API and other Redpanda services such as HTTP Proxy.
76-
77-
. In **Cluster settings**, copy the **Service attachment URL** under **Private Service Connect**. Use this URL to create the Private Service Connect endpoint in GCP.
78-
79-
. Create a private DNS zone. Use the cluster **DNS zone** value as the DNS name.
80-
+
81-
[,bash]
82-
----
83-
gcloud dns --project=<gcp-project-id> managed-zones create <dns-zone-name> --description="<description>" --dns-name="<dns-zone-from-the-ui>" --visibility="private" --networks="<list-of-fully-qualified-names-of-networks-where-the-dns-zone-will-be-visible>"
84-
----
85-
86-
. In the newly-created DNS zone, create a wildcard DNS record using the cluster **DNS record** value.
87-
+
88-
[,bash]
89-
----
90-
gcloud dns --project=<gcp-project-id> record-sets create '*.<dns-zone-from-the-ui>' --zone="<dns-zone-name>" --type="A" --ttl="300" --rrdatas="<psc-endpoint-ip>"
91-
----
92-
93-
. Confirm that your GCP VPC firewall allows traffic to and from the Private Service Connect forwarding rule IP address, on the expected ports.
94-
95-
== Access Redpanda services through VPC endpoint
96-
97-
After you have enabled Private Service Connect for your cluster, your connection URLs are available in the *How to Connect* section of the cluster overview in the Redpanda Cloud UI.
98-
99-
include::networking:partial$private-links-access-rp-services-through-vpc.adoc[]
100-
101-
== Test the connection
102-
103-
You can test the connection to the endpoint service from any VM or container in the consumer VPC. If configuring a client isn't possible right away, you can do these checks using `rpk` or cURL:
104-
105-
include::networking:partial$private-links-test-connection.adoc[]
106-
107-
== Disable endpoint service
108-
109-
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.
6+
include::networking:partial$psc-ui.adoc[]

0 commit comments

Comments
 (0)