Skip to content
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

Adding a warning to the README about the need to use a recent version of the provider for private endpoints #218

Merged
merged 11 commits into from
Jun 20, 2024

Conversation

marksoper
Copy link
Collaborator

Adding a warning to the README about the need to use a recent version of the provider for private endpoints to avoid a recently discovered bug in older versions.

Commit checklist

  • Changelog
  • Doc gen (make generate)
  • Integration test(s)
  • Acceptance test(s)
  • Example(s)

Adding a warning to the README about the need to use a recent version of the provider for private endpoints to avoid a recently discovered bug in older versions.
@@ -6,6 +6,14 @@ description: |-
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.
---

# _Warning_: Use of *private endpoints* requires >=v1.7.6
If you intend to use this provider to provision [private endpoints](https://github.com/cockroachdb/terraform-provider-cockroach/blob/main/docs/resources/private_endpoint_connection.md):
Copy link
Collaborator

Choose a reason for hiding this comment

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

The docs are generated from the output in the resources. You'll need to update here and here. and then run make generate to build the docs.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

ok thanks!

@marksoper
Copy link
Collaborator Author

Warnings about using latest provider for private endpoints

@marksoper marksoper closed this Jun 20, 2024
@marksoper marksoper reopened this Jun 20, 2024
@marksoper marksoper merged commit dcacd8a into main Jun 20, 2024
6 of 8 checks passed
@marksoper marksoper deleted the marksoper-patch-private-endpoint-version-warning branch June 20, 2024 16:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants