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

Add docs for managed backup Terraform provider attribute #19182

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

kathancox
Copy link
Contributor

@kathancox kathancox commented Nov 26, 2024

Fixes DOC-11779

This PR adds a section to the Standard and Advanced Managed backup pages on using the backup_config attribute under the cockroach_cluster resource for the CC Terraform Provider.

Also, added a short supplement to the TF Configuration step on the general Cloud Terraform docs to point out that users can configure managed backups using TF and linking to the full details on the Managed Backups page.

Rendered Preview

See the standard and advanced tabs for both pages.

Provision a cluster with Terraform
Managed Backups

Copy link

github-actions bot commented Nov 26, 2024

Copy link

netlify bot commented Nov 26, 2024

Deploy Preview for cockroachdb-api-docs canceled.

Name Link
🔨 Latest commit 9c022bd
🔍 Latest deploy log https://app.netlify.com/sites/cockroachdb-api-docs/deploys/67462c88cc81fa0008c0df38

Copy link

netlify bot commented Nov 26, 2024

Deploy Preview for cockroachdb-interactivetutorials-docs canceled.

Name Link
🔨 Latest commit 9c022bd
🔍 Latest deploy log https://app.netlify.com/sites/cockroachdb-interactivetutorials-docs/deploys/67462c88ea9887000891c875

Copy link

netlify bot commented Nov 26, 2024

Netlify Preview

Name Link
🔨 Latest commit 9c022bd
🔍 Latest deploy log https://app.netlify.com/sites/cockroachdb-docs/deploys/67462c88b7b86600085ecdeb
😎 Deploy Preview https://deploy-preview-19182--cockroachdb-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@kathancox kathancox marked this pull request as ready for review November 26, 2024 20:30
Copy link

@alicia-l2 alicia-l2 left a comment

Choose a reason for hiding this comment

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

lgtm! had one question. thank you!

- If the initial value of the `retention_days` attribute is the default value `30`, you'll be able to modify the backup retention setting once more.
- If the initial value is not the default, you will not be able to modify `retention_days` again. You can refrain from including `retention_days` in the Terraform configuration and instead manage the retention in the Cloud Console.

For more details on modifying `retention_days` more than once, refer to the [Updating Backup Retention](https://github.com/cockroachdb/terraform-provider-cockroach/blob/main/docs/guides/updating-backup-retention.md) documentation in the Terraform provider for CockroachDB {{ site.data.products.cloud }} Repository.

Choose a reason for hiding this comment

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

should this just be to reach out to support since we dont let you do it on cloud api anyway?

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.

2 participants