Skip to content

Update connect-to-an-advanced-cluster.md #19445

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

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

Update connect-to-an-advanced-cluster.md #19445

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
43eed20
Update connect-to-an-advanced-cluster.md
devarshishah3 Mar 12, 2025
34c2c72
Rebase and edits
katmayb Mar 12, 2025
550868c
Apply suggestions from code review
katmayb Mar 13, 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
10 changes: 6 additions & 4 deletions src/current/cockroachcloud/connect-to-an-advanced-cluster.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,9 @@ Private connectivity can be configured only after a cluster is created.
- Set **Target** to **Published service**.
- Set **Target service** to the value you copied from CockroachDB {{ site.data.products.cloud }} Console. If the endpoint's configured target service does not match, validation will fail.
- Provide a value for **Endpoint name**. You will need to provide this **Endpoint name** when connecting to the cluster using the command line, a connection string, or connection parameters.
- If it is not enabled, enable the Service Directory API, click **Enable global access**, and create a namespace in each region where your cluster is deployed.
- If it is not enabled, enable the Service Directory API. Click **Enable global access**, and create a namespace in each region where your cluster is deployed.

When Service Directory and Global access are enabled, GCP automatically maps your private endpoint IPs to approved DNS names. CockroachDB {{ site.data.products.cloud }} requires DNS names in your connection information to match the approved pattern in your cluster’s certificates. Replace `<ENTER-ENDPOINT-NAME>` in your connection information with the assigned **Endpoint name** used in the previous step.
Copy link

Choose a reason for hiding this comment

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

It looks like we have not introduced <ENTER-ENDPOINT-NAME> at this point, and the user is still configuring their private endpoint. Should we remove the last sentence?

Copy link
Contributor

Choose a reason for hiding this comment

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

Hmm, @devarshishah3 as per @jaylim-crl's comment above, are you referring to entering the endpoint name in the CockroachDB Cloud Console here? If so, I can clarify.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

is required when the user clicks the CONNECT modal and has to composes the connection string

- Click **Add endpoint**.
- After the endpoint is created, copy the connection ID.
1. Return to the CockroachDB {{ site.data.products.cloud }} Console browser tab and click **Validate**.
Expand Down Expand Up @@ -163,7 +165,7 @@ To download a supported version of the SQL shell instead of the full binary, vis
1. Select the **Command Line** tab.
1. If CockroachDB is not installed locally, copy the command to download and install it. In your terminal, run the command.
1. If the CA certificate for the cluster is not downloaded locally, copy the command to download it. In your terminal, run the command.
1. Copy the [`cockroach sql`]({% link {{site.current_cloud_version}}/cockroach-sql.md %}) command, which will be used in the next step (and to connect to your cluster in the future). Click **Close**.
1. Copy the [`cockroach sql`]({% link {{site.current_cloud_version}}/cockroach-sql.md %}) command, which will be used in the next step (and to connect to your cluster in the future). If you are connecting using a private endpoint in GCP, replace `<ENTER-ENDPOINT-NAME>` in the command with the assigned GCP endpoint name. Click **Close**.
1. In your terminal, enter the copied `cockroach sql` command and connection string to start the [built-in SQL client]({% link {{site.current_cloud_version}}/cockroach-sql.md %}).

1. Enter the SQL user's password and enter.
Expand All @@ -190,7 +192,7 @@ To connect to your cluster from your application:

1. Select the **Connection string** tab.
1. If the CA certificate for the cluster is not downloaded locally, copy the command to download it. In your terminal, run the command.
1. Copy the connection string, which begins with `postgresql://`. This will be used to connect your application to CockroachDB {{ site.data.products.advanced }}.
1. Copy the connection string, which begins with `postgresql://`. This will be used to connect your application to CockroachDB {{ site.data.products.advanced }}. If you are connecting using private endpoint in GCP, replace `<ENTER-ENDPOINT-NAME>` in the connection string with the assigned GCP endpoint name.
1. Add your copied connection string to your application code. For information about connecting to CockroachDB {{ site.data.products.advanced }} with a [supported client]({% link {{ site.current_cloud_version }}/third-party-database-tools.md %}), see [Connect to a CockroachDB Cluster]({% link {{ site.current_cloud_version }}/connect-to-the-database.md %}).
1. Click **Close**.

Expand All @@ -215,7 +217,7 @@ To connect to your cluster with a [CockroachDB-compatible tool]({% link {{site.c
--------------|------------
`{username}` | The [SQL user]({% link cockroachcloud/managing-access.md %}#create-a-sql-user) connecting to the cluster.
`{password}` | The password for the SQL user connecting to the cluster.
`{host}` | The host on which the CockroachDB node is running.
`{host}` | The host on which the CockroachDB node is running. If you are connecting using a private endpoint in GCP, replace `<ENTER-ENDPOINT-NAME>` in this connection parameter with the assigned GCP endpoint name.
`{port}` | The port at which the CockroachDB node is listening.
`{database}` | The name of the (existing) database.

Expand Down
Loading