Force CIS related PostgreSQL database flags

[brettcurtis]

Fixes #14
Fixes #17

Summary by CodeRabbit

• New Features

  • Introduced input variable for custom PostgreSQL database flags in Cloud SQL instances.
  • Implemented CIS GCP v1.3.0 compliance flags for enhanced PostgreSQL database security.

• Improvements

  • Updated Cloud SQL instances to handle database flags dynamically based on the database version.

• Bug Fixes

  • Fixed sensitive data exposure in outputs by marking them as sensitive.

• Refactor

  • Renamed database_flags variable to postgres_database_flags for clarity.

• Chores

  • Upgraded pre-commit hook to the latest version for improved code formatting.

[coderabbitai]

Warning

Rate Limit Exceeded

@brettcurtis has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 26 minutes and 17 seconds before requesting another review.

How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.
Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.
Please see our FAQ for further information.

Commits

Files that changed from the base of the PR and between 3c347b5 and af6816f.

Walkthrough

The series of changes introduces a new input variable for PostgreSQL database flags, ensuring Cloud SQL instances comply with the latest CIS benchmarks. It includes renaming a variable for clarity, adjusting database flags for enhanced security, employing a conditional logic for database flags based on the version, and marking output data as sensitive. Additionally, tooling updates have been made to maintain the codebase with the latest practices.

Changes

File Path	Change Summary
.regional/README.md, .../variables.tf	Introduced postgres_database_flags variable; renamed database_flags to postgres_database_flags.
regional/locals.tf, .../default_cloud_sql/main.tf	Added CIS GCP v1.3.0 compliant PostgreSQL flags; renamed and pruned flag entries; included deadlock_timeout.
regional/main.tf	Updated database_flags block to use conditional logic based on database_version.
regional/outputs.tf, .../shared/outputs.tf	Set output declarations as sensitive with sensitive = true.
.pre-commit-config.yaml	Upgraded pre-commit-terraform hook version from v1.83.6 to v1.86.0.

Related issues

• Issue osinfra-io/terraform-google-cloud-sql#14 - The changes in this PR appear to address the objectives of enforcing CIS-related PostgreSQL database flags, providing documentation, customization, and maintaining backward compatibility, which aligns with the issue's goals.

Poem

🐇 In the burrow of the code, tweaks and twirls,
Flags unfurled, security unfurls.
With a hop and a commit, the updates take flight,
A rabbit's touch, making databases tight. 🌟

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

• X
• Mastodon
• Reddit
• LinkedIn

---

Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>.
  • Generate unit-tests for this file.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit tests for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai generate interesting stats about this repository from git and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @coderabbitai read src/utils.ts and generate unit tests.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• The JSON schema for the configuration file is available here.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/coderabbit-overrides.v2.json

CodeRabbit Discord Community

Join our Discord Community to get help, request features, and share feedback.

[infracost]

Infracost report

💰 Monthly cost will not change

Governance checks

🟢 50 passed

48 FinOps policies, 1 Tagging policy, and 1 Guardrail passed.

_{View in Infracost Cloud. This comment will be updated when code changes.}

[coderabbitai]

Review Status

Actionable comments generated: 0

Configuration used: CodeRabbit UI

Commits

Files that changed from the base of the PR and between fe75bee and 3c347b5.

Files selected for processing (8)

• .pre-commit-config.yaml (1 hunks)
• regional/README.md (2 hunks)
• regional/locals.tf (1 hunks)
• regional/main.tf (1 hunks)
• regional/outputs.tf (1 hunks)
• regional/variables.tf (1 hunks)
• test/fixtures/default_cloud_sql/main.tf (1 hunks)
• test/fixtures/shared/outputs.tf (1 hunks)

Additional comments: 10

test/fixtures/shared/outputs.tf (2)

• 5-5: Sensitive data should be handled with care. Marking the client_cert output as sensitive is a good practice.
• 10-10: Sensitive data should be handled with care. Marking the instance_server_ca_cert output as sensitive is a good practice.

test/fixtures/default_cloud_sql/main.tf (1)

• 7-14: The addition of postgres_database_flags with a deadlock_timeout set to 2000 aligns with the PR's objective to comply with CIS GCP benchmarks.

regional/outputs.tf (2)

• 6-6: Sensitive data should be handled with care. Marking the client_cert output as sensitive is a good practice.
• 12-12: Sensitive data should be handled with care. Marking the instance_server_ca_cert output as sensitive is a good practice.

regional/locals.tf (1)

• 16-52: The addition of PostgreSQL database flags for CIS GCP v1.3.0 compliance is a critical security enhancement. Ensure that these flags are supported by the PostgreSQL version in use and that they do not conflict with any existing settings.

.pre-commit-config.yaml (1)

• 24-24: Updating the pre-commit-terraform hook version to v1.86.0 is a maintenance update that should help keep the codebase consistent with the latest standards.

regional/main.tf (1)

• 22-22: The use of a ternary operator to conditionally apply postgres_database_flags based on the database_version is a good approach to ensure that the flags are only applied to PostgreSQL instances.

regional/variables.tf (1)

• 24-24: Renaming the variable from database_flags to postgres_database_flags improves clarity and specificity, aligning with the PR's objectives.

regional/README.md (1)

• 47-47: The documentation update to include the new postgres_database_flags input variable is necessary for users to understand how to use the module with the new changes.