Update connect-to-an-advanced-cluster.md #19445
Open
Conversation
This file contains 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
devarshishah3
requested review from
jhatcher9999,
katmayb,
mikeCRL and
jaylim-crl
✅ Deploy Preview for cockroachdb-interactivetutorials-docs canceled.
|
✅ Deploy Preview for cockroachdb-api-docs canceled.
|
✅ Netlify Preview
To edit notification comments on pull requests, go to your Netlify site configuration. |
jaylim-crl
reviewed
Mar 12, 2025
Comment on lines
57
to
58
| - 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 the Service Directory API is not enabled, 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 Cloud requires DNS name in your connection info to match the approved pattern in your cluster’s certificates. With Service Directory and Global Access features enabled, you can simply replace `<ENTER-ENDPOINT-NAME>` in your connection information with the assigned name of the Endpoint name used in the above step. |
There was a problem hiding this comment.
It looks like there's some redundancy here. Did you mean to remove the first sentence entirely?
There was a problem hiding this comment.
@jaylim-crl Could you PTAL, I've made a few small adjustments.
| @@ -54,7 +54,8 @@ 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**. This is not used by CockroachDB {{ site.data.products.cloud }}. | |||
There was a problem hiding this comment.
Can we remove this sentence? We actually do use this value as part of the host name you connect to.
Add clarity on when to use GCP endpoint name
katmayb
force-pushed
the
devarshishah3-patch-6
branch
from
b02ae18 to
34c2c72
Compare
katmayb
approved these changes
Mar 13, 2025
jaylim-crl
reviewed
Mar 13, 2025
| - 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. |
There was a problem hiding this comment.
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?
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
is required when the user clicks the CONNECT modal and has to composes the connection string
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Add clarity on when to use GCP endpoint name