Add cert-manager resources for Istio CA and TLS certificates

[brettcurtis]

Summary by CodeRabbit

• New Features

  • Added new Kubernetes manifest resources for Istio gateway certificate management, including CA certificates and issuers.
  • Introduced a new input variable zone for resource deployment configuration.

• Bug Fixes

  • Updated test configurations to reflect changes in the region and added the zone parameter.

• Documentation

  • Enhanced the README documentation with additional resources and input variable details.
  • Updated documentation to include the new zone variable and its purpose.

[infracost]

💰 Infracost report

Monthly estimate generated

_{This comment will be updated when code changes.}

[coderabbitai]

Caution

Review failed

The pull request is closed.

Walkthrough

The pull request introduces several modifications across multiple Terraform configuration files. Key changes include the addition of new Kubernetes manifest resources related to Istio gateway certificate management, an updated local variable to include a new input variable zone, and enhancements to the documentation in regional/README.md. The changes collectively improve resource definitions and configuration options for deploying Istio-related components.

Changes

File	Change Summary
regional/README.md	Added new resources to the "Resources" table: kubernetes_manifest.istio_gateway_ca_certificate, kubernetes_manifest.istio_gateway_ca_issuer, kubernetes_manifest.istio_gateway_selfsigned_issuer, kubernetes_manifest.istio_gateway_tls. Introduced new input variable zone.
regional/locals.tf	Updated local variable multi_cluster_name to include var.zone in its definition.
regional/main.tf	Added new Kubernetes manifest resources: istio_gateway_ca_certificate, istio_gateway_ca_issuer, istio_gateway_tls, istio_gateway_selfsigned_issuer.
regional/variables.tf	Added new variable zone with description "The zone to deploy the resources to".
tests/default.tftest.hcl	Updated region variable from "mock-region-a" to "mock-region" and added new variable zone with value "mock-zone".
tests/fixtures/default/regional/main.tf	Added new variable zone to the module "test" block.
tests/fixtures/default/regional/variables.tf	Added new variable zone with type string.

Possibly related PRs

• Add cert-manager resources for Istio CA and TLS certificates #22: The changes in this PR add new Kubernetes manifest resources related to Istio gateway certificate management, which directly relates to the new resources added in the main PR for istio_gateway_ca_certificate, istio_gateway_ca_issuer, istio_gateway_tls, and istio_gateway_selfsigned_issuer.

Suggested labels

enhancement

Suggested reviewers

• osinfra-sa

---

🪧 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>, please review it.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• 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 testing code 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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

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 using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai or @coderabbitai title anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• 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/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[coderabbitai]

Actionable comments posted: 4

🧹 Outside diff range and nitpick comments (3)

tests/fixtures/default/regional/variables.tf (1)

23-25: LGTM! Consider adding a description for the new variable.

The addition of the zone variable is consistent with the existing structure and typing in the file. This new variable will likely allow for more granular control over resource deployment locations.

To improve documentation, consider adding a description to the variable declaration. For example:

variable "zone" {
  type        = string
  description = "The zone in which to deploy zone-specific resources."
}

This will provide better context for users of this Terraform module.

regional/variables.tf (1)

179-182: LGTM! Consider clarifying the relationship with node_location.

The addition of the zone variable is appropriate and consistent with other variable declarations. It provides more granular control over resource deployment.

However, there's a potential for confusion with the existing node_location variable. Consider adding a comment to clarify the relationship and usage differences between zone and node_location.

Also, consider whether a default value would be appropriate for the zone variable, similar to how node_location has a default of null.

regional/README.md (1)

74-74: LGTM: New "zone" input variable added.

The addition of the "zone" variable is a good improvement, allowing users to specify the exact zone for resource deployment. This aligns well with best practices for fine-grained control over resource placement.

Minor suggestion: Consider enhancing the description slightly for more clarity:

- | <a name="input_zone"></a> [zone](#input\_zone) | The zone to deploy the resources to | `string` | n/a | yes |
+ | <a name="input_zone"></a> [zone](#input\_zone) | The specific zone within the region to deploy the resources to | `string` | n/a | yes |

This change would make it clearer that the zone is a subdivision of the region, which is already specified in another variable.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 4f0c52e and c993a4b.

📒 Files selected for processing (7)

• regional/README.md (2 hunks)
• regional/locals.tf (1 hunks)
• regional/main.tf (1 hunks)
• regional/variables.tf (1 hunks)
• tests/default.tftest.hcl (1 hunks)
• tests/fixtures/default/regional/main.tf (1 hunks)
• tests/fixtures/default/regional/variables.tf (1 hunks)

🧰 Additional context used

🔇 Additional comments (5)

regional/locals.tf (1)

27-27: LGTM! Verify impact on dependent resources.

The addition of var.zone to multi_cluster_name improves the specificity of cluster naming, which is beneficial for multi-zone setups and aligns with the PR objective. This change enhances the uniqueness of cluster names.

Please ensure that all resources and configurations depending on multi_cluster_name are updated accordingly. Run the following script to identify potential impacts:

tests/default.tftest.hcl (1)

54-55: Review region change and zone addition

1. The region value has been changed from "mock-region-a" to "mock-region". This change makes the region more generic, which could be beneficial for testing across different regions. However, please ensure that this change doesn't break any region-specific tests or assumptions in the module being tested.

2. A new zone variable has been added. This suggests that the tested module now requires or supports zone-level configurations. Please verify that the underlying module has been updated to use this new variable effectively.

To ensure consistency and proper usage of these variables, please run the following verification:

3. There's a potential inconsistency in the gateway_dns variable, which still contains a reference to "mock-region-a". Consider updating this to match the new region value or clarify if this inconsistency is intentional.

Consider updating the gateway_dns variable to use the new region value:

 gateway_dns = {
-  "mock-region-a.mock-environment.mock-subdomain.mock-domain" = {
+  "mock-region.mock-environment.mock-subdomain.mock-domain" = {
     managed_zone = "mock-environment-mock-subdomain-mock-domain"
     project      = "mock-dns-project"
   }
 }

✅ Verification successful

Verification of region and zone changes

All references to 'region' and 'zone' variables have been successfully updated. No remaining references to 'mock-region-a' were found.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Verify the usage of 'region' and 'zone' variables in the module

# Check for usage of 'region' variable
echo "Checking usage of 'region' variable:"
rg --type terraform 'var\.region' ./tests/fixtures/default/regional

# Check for usage of 'zone' variable
echo "Checking usage of 'zone' variable:"
rg --type terraform 'var\.zone' ./tests/fixtures/default/regional

# Check for any remaining references to 'mock-region-a'
echo "Checking for remaining references to 'mock-region-a':"
rg --type terraform 'mock-region-a' ./tests/fixtures/default/regional

Length of output: 606

---

Script:

#!/bin/bash
# Description: Verify the usage of 'region' and 'zone' variables in the module

# Check for usage of 'region' variable in Terraform files
echo "Checking usage of 'region' variable:"
rg 'var\.region' -g '*.tf' ./tests/fixtures/default/regional

# Check for usage of 'zone' variable in Terraform files
echo "Checking usage of 'zone' variable:"
rg 'var\.zone' -g '*.tf' ./tests/fixtures/default/regional

# Check for any remaining references to 'mock-region-a' in Terraform files
echo "Checking for remaining references to 'mock-region-a':"
rg 'mock-region-a' -g '*.tf' ./tests/fixtures/default/regional

Length of output: 613

tests/fixtures/default/regional/main.tf (1)

81-81: LGTM: Addition of zone variable enhances configuration precision.

The addition of the zone variable to the module "test" block is a good improvement. It allows for more granular control over the deployment location, specifying not just the region but also the specific zone within that region.

To ensure this change is fully compatible and utilized, please run the following verification:

This script will help verify that:

1. The zone variable is properly defined in the regional module.
2. The zone variable is being used appropriately within the regional module.
3. Other test fixtures or examples are consistently using the zone variable.

Please review the results to ensure the zone variable is fully integrated and utilized as intended.

regional/README.md (2)

33-34: LGTM: New Istio gateway certificate management resources added.

The addition of these new resources aligns well with the PR objectives. They provide the necessary components for managing certificates in the Istio gateway:

1. CA certificate
2. CA issuer
3. Self-signed issuer
4. TLS

These additions will enhance the certificate management capabilities of the Istio deployment.

Also applies to: 39-40

---

Line range hint 1-74: Documentation updates accurately reflect infrastructure changes.

The changes to this README file effectively document the new resources and input variable added to the Terraform configuration. These updates, including the new Istio gateway certificate management resources and the "zone" input variable, provide users with a clear understanding of the enhanced capabilities and configuration options.

These documentation changes are consistent with the PR objectives of adding cert-manager resources for Istio CA and TLS certificates, and they improve the overall quality and completeness of the Terraform module documentation.

[brettcurtis]

@coderabbitai review

[coderabbitai]

✅ Actions performed

Review triggered.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.