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

Fix sql_database_instance to include backup_configuration in create request #13092

Conversation

modular-magician
Copy link
Collaborator

Fixes b/257534640 (TF plan allows google_sql_database_instance.replica to define a backup configuration)

SQL database instances do not allow replicas to enable backups. For example, the following config will fail:

resource "google_sql_database_instance" "main" {
  name             = "main-instance"
  ...
}

resource "google_sql_database_instance" "replica" {
  name             = "replica-instance"

  # Defines instance as a replica
  master_instance_name = "${google_sql_database_instance.main.name}"    
  replica_configuration {
    failover_target = false
  }

  settings {
    ...
    # Enables backups
    backup_configuration {
      enabled = true
      point_in_time_recovery_enabled = true
    }
  }
}

Problem
Previously, config like this would correctly result in an error, but the replica would still be created with the backup_configuration omitted. This caused issues with consecutive terraform apply calls where the first succeeded, but the second failed with no changes to the config.

Root cause
We were using some custom behavior for backup_configuration.binary_log_enabled that removed it from the initial create request, and then added it back to the instance with a subsequent patch request. This behavior had a bug that caused the entire backup_configuration to be removed and not get patched if binary_log_enabled was false for a replica.

Resolution
This PR proposes fixing the issue by leaving the backup_configuration on the create request, so that the server can validate the full configuration before creating any entities. The one exception is binary_log_enabled, which cannot be set to true until after a replica is created. In that case, we make the initial create request with binary_log_enabled = false, and then use the subsequent patch call to set it to true like before.

If this PR is for Terraform, I acknowledge that I have:

  • Searched through the issue tracker for an open issue that this either resolves or contributes to, commented on it to claim it, and written "fixes {url}" or "part of {url}" in this PR description. If there were no relevant open issues, I opened one and commented that I would like to work on it (not necessary for very small changes).
  • Generated Terraform, and ran make test and make lint to ensure it passes unit and linter tests.
  • Ensured that all new fields I added that can be set by a user appear in at least one example (for generated resources) or third_party test (for handwritten resources or update tests).
  • Ran relevant acceptance tests (If the acceptance tests do not yet pass or you are unable to run them, please let your reviewer know).
  • Read the Release Notes Guide before writing my release note below.

Release Note Template for Downstream PRs (will be copied)

sql: fix `googe_sql_database_instance` to include `backup_configuration` in initial create request

Derived from GoogleCloudPlatform/magic-modules#6836

…equest (hashicorp#6836)

Signed-off-by: Modular Magician <magic-modules@google.com>
@modular-magician modular-magician merged commit 111f811 into hashicorp:main Nov 21, 2022
@github-actions
Copy link

I'm going to lock this pull request because it has been closed for 30 days ⏳. This helps our maintainers find and focus on the active issues.
If you have found a problem that seems related to this change, please open a new issue and complete the issue template so we can capture all the details necessary to investigate further.

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Dec 22, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

1 participant