docs: add docs for private endpoint connections #197
Merged
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
carloruiz
force-pushed
the
add-docs-to-private-connect
branch
3 times, most recently
from
9385819
to
5cb8b4d
Compare
mikeCRL
reviewed
Apr 1, 2024
| ## Example Usage | ||
| Private endpoint connections allow customer applications to connect to a CockroachDB Cloud cluster without traversing the public internet. All application-database traffic remains within the cloud-provider network. | ||
|
|
||
| **IMPORTANT:**You must have the following role to successfully handle the resource: |
There was a problem hiding this comment.
Suggested change
| **IMPORTANT:**You must have the following role to successfully handle the resource: | |
| **IMPORTANT:** You must have the following role to successfully handle the resource: |
carloruiz
force-pushed
the
add-docs-to-private-connect
branch
from
5cb8b4d
to
3cf6248
Compare
fantapop
reviewed
Apr 3, 2024
fantapop
reviewed
Apr 4, 2024
| # Establish a connection between the endpoint and the service. | ||
| resource "cockroach_private_endpoint_connection" "connection" { | ||
| cluster_id = cockroach_cluster.my_cluster.id | ||
| endpoint_id = "6133183410995353" |
There was a problem hiding this comment.
Could this just be:
endpoint_id = azurerm_private_endpoint.my_endpoint.id
There was a problem hiding this comment.
This particular declaration is for GCP, which doesn't have a TF resource for private endpoint connections.
fantapop
approved these changes
Apr 4, 2024
carloruiz
force-pushed
the
add-docs-to-private-connect
branch
from
cc03cdf
to
50b33af
Compare
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.
Adds more detailed docs for the
private_endpoint_connectionresource.Commit checklist
make generate)