diff --git a/.github/workflows/documentation.yml b/.github/workflows/documentation.yml index 49bc16c90..e9c637bdd 100644 --- a/.github/workflows/documentation.yml +++ b/.github/workflows/documentation.yml @@ -65,5 +65,6 @@ jobs: go-version: ${{ env.GO_VERSION }} - uses: hashicorp/setup-terraform@v3 - run: go tool tfplugindocs validate + - run: rm -fr ./docs - run: go tool tfplugindocs generate - run: git diff --exit-code docs diff --git a/docs/resources/mongodb_instance.md b/docs/resources/mongodb_instance.md index 81d1ec9ff..190c7fa64 100644 --- a/docs/resources/mongodb_instance.md +++ b/docs/resources/mongodb_instance.md @@ -75,6 +75,24 @@ resource "scaleway_mongodb_instance" "main" { } ``` +### With Snapshot Scheduling + +```terraform +resource "scaleway_mongodb_instance" "main" { + name = "test-mongodb-with-snapshots" + version = "7.0.12" + node_type = "MGDB-PLAY2-NANO" + node_number = 1 + user_name = "my_initial_user" + password = "thiZ_is_v&ry_s3cret" + volume_size_in_gb = 5 + + # Snapshot scheduling configuration + snapshot_schedule_frequency_hours = 24 + snapshot_schedule_retention_days = 7 + is_snapshot_schedule_enabled = true +} +``` ### Restore From Snapshot @@ -107,6 +125,12 @@ The following arguments are supported: - `region` - (Defaults to [provider](../index.md#region) `region`) The [region](../guides/regions_and_zones.md#regions) in which the MongoDB® instance should be created. - `project_id` - (Defaults to [provider](../index.md#project_id) `project_id`) The ID of the project the MongoDB® instance is associated with. +### Snapshot Scheduling + +- `snapshot_schedule_frequency_hours` - (Optional) Snapshot schedule frequency in hours. +- `snapshot_schedule_retention_days` - (Optional) Snapshot schedule retention in days. +- `is_snapshot_schedule_enabled` - (Optional) Enable or disable automatic snapshot scheduling. + ~> **Important** If neither private_network nor public_network is specified, a public network endpoint is created by default. @@ -130,6 +154,9 @@ In addition to all arguments above, the following attributes are exported: - `id` - The ID of the endpoint. - `port` - TCP port of the endpoint. - `dns_records` - List of DNS records for your endpoint. +- `snapshot_schedule_frequency_hours` - Snapshot schedule frequency in hours. +- `snapshot_schedule_retention_days` - Snapshot schedule retention in days. +- `is_snapshot_schedule_enabled` - Whether automatic snapshot scheduling is enabled. - `tls_certificate` - The PEM-encoded TLS certificate for the MongoDB® instance, if available. ## Import diff --git a/docs/resources/rdb_instance.md b/docs/resources/rdb_instance.md index 8deb6a9a5..37be207bc 100644 --- a/docs/resources/rdb_instance.md +++ b/docs/resources/rdb_instance.md @@ -128,6 +128,8 @@ resource "scaleway_rdb_instance" "main" { -> **Note** If nothing is defined, your Database Instance will have a default public load-balancer endpoint. +-> **Note** Managed PostgreSQL and MySQL Database Instances are compatible with the [VPC routing](https://www.scaleway.com/en/docs/network/vpc/concepts/#routing) feature, which allows you to connect one or more Database Instances in a Private Network to resources in other Private Networks of the same VPC. This feature is automatically enabled when your Database Instance is connected to a Private Network within a VPC that has routing enabled. Refer to the [How to manage routing](https://www.scaleway.com/en/docs/network/vpc/how-to/manage-routing/) documentation page for more information about VPC routing. + ## Argument Reference The following arguments are supported: