Add docs for managed backup Terraform provider attribute #19182
Conversation
Files changed:
|
✅ Deploy Preview for cockroachdb-api-docs canceled.
|
✅ Deploy Preview for cockroachdb-interactivetutorials-docs canceled.
|
✅ Netlify Preview
To edit notification comments on pull requests, go to your Netlify site configuration. |
kathancox
force-pushed
the
cc-terraform-managed-backups
branch
2 times, most recently
from
5146f74 to
9c022bd
Compare
| - 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. |
There was a problem hiding this comment.
should this just be to reach out to support since we dont let you do it on cloud api anyway?
There was a problem hiding this comment.
I kept this sentence so users can find the terraform provider docs, and also added the link to contact support for modifying the setting again. Hope that's good.
|
@fantapop Would appreciate your review of this content too, thanks so much! |
src/current/_includes/cockroachcloud/backups/provision-cluster-tf-managed-backups.md
Outdated
Show resolved
Hide resolved
src/current/_includes/cockroachcloud/backups/terraform-managed-backups.md
Outdated
Show resolved
Hide resolved
src/current/_includes/cockroachcloud/backups/terraform-managed-backups.md
Outdated
Show resolved
Hide resolved
src/current/_includes/cockroachcloud/backups/provision-cluster-tf-managed-backups.md
Outdated
Show resolved
Hide resolved
| @@ -0,0 +1,9 @@ | |||
| Set the following for the `backup_config` attribute: | |||
|
|
|||
| - `enabled` controls whether managed backups are enabled or disabled. If you modify the `retention_days` setting even when managed backups are disabled, this will use the one possible change for `retention_days`. Possible values for the `enabled` setting are: `true` or `false`. | |||
There was a problem hiding this comment.
if by "one possible change" you are referring to the other callout where we say you can modify the retention policy only once, is it possible to make this a link to that info?
i see it's in an include but perhaps it could be done with an anchor tag just above the include
if it's too hard because each include is moving around i totally get it
however i think "the one possible change" as standalone text may be too subtle, i'm not a careful enough reader of docs when I use a thing, I only noticed because i just read the other thing
There was a problem hiding this comment.
Yes, so I linked the one possible change to the general section on Retention at the top of the page, because this details the "one possible change".
src/current/_includes/cockroachcloud/backups/terraform-managed-backups.md
Show resolved
Hide resolved
kathancox
force-pushed
the
cc-terraform-managed-backups
branch
from
09d5db1 to
1cc7960
Compare
|
TFTRs!! |
Fixes DOC-11779
This PR adds a section to the Standard and Advanced Managed backup pages on using the
backup_configattribute under thecockroach_clusterresource 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