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: Ignore tag changes to customer-ns after eks instantiation #342

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

theishshah
Copy link

@theishshah theishshah commented Feb 26, 2025

Fixes INFRA-581

Summary by CodeRabbit

  • Chores
    • Updated resource configuration management to preserve external metadata updates, ensuring that manual adjustments remain intact without triggering unnecessary system actions.

@theishshah theishshah requested a review from j7m4 February 26, 2025 00:06
Copy link

coderabbitai bot commented Feb 26, 2025

Walkthrough

A new lifecycle block is added to the EKS module configuration in the Terraform file. This block utilizes the ignore_changes directive on the tags attribute. Consequently, Terraform will not trigger any plan or apply actions when the tags are altered externally, thereby preventing automatic reversion of those modifications. No changes to exported or public entities were made.

Changes

File Change Summary
modules/app_eks/main.tf Added a lifecycle block to the eks module with an ignore_changes directive for the tags attribute.

Sequence Diagram(s)

sequenceDiagram
    participant Dev as Developer
    participant TF as Terraform
    participant EKS as EKS Module

    Dev->>TF: Run terraform plan/apply
    TF->>EKS: Load module configuration (including lifecycle block)
    EKS-->>TF: Return current state (including tags)
    TF-->>TF: Check for changes on tags flagging them to ignore
    TF->>Dev: Apply changes without reverting external tag modifications
Loading

Poem

I’m a bunny of code, so spry and light,
Skipping through changes in the digital night,
With tags left alone in their free-flowing spree,
Terraform dances while I hop with glee!
Hoppity hops and a joyful byte 🐇✨


📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 998a33d and 3836908.

📒 Files selected for processing (1)
  • modules/app_eks/main.tf (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • modules/app_eks/main.tf

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
🪧 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 generate docstrings to generate docstrings for this PR. (Beta)
  • @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 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.

Copy link

linear bot commented Feb 26, 2025

j7m4
j7m4 previously approved these changes Feb 26, 2025
Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

🧹 Nitpick comments (1)
modules/app_eks/main.tf (1)

83-86: Lifecycle Block for Tag Changes:
The new lifecycle block correctly instructs Terraform to ignore changes to the tags attribute. This aligns well with the PR objective of preventing external modifications to tags (especially those related to customer-ns) from triggering unintended changes after EKS instantiation.

Suggestion: Consider adding an inline comment just above the lifecycle block to document the rationale behind ignoring tag changes. This can help future maintainers quickly understand the context and the purpose of this configuration.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 3d486d9 and 998a33d.

📒 Files selected for processing (1)
  • modules/app_eks/main.tf (1 hunks)
🧰 Additional context used
🪛 GitHub Actions: Terraform Lint and Format Check
modules/app_eks/main.tf

[warning] 1-1: The set-output command is deprecated and will be disabled soon. Please upgrade to using Environment Files.


[warning] 1-1: The set-output command is deprecated and will be disabled soon. Please upgrade to using Environment Files.


[warning] 1-1: The set-output command is deprecated and will be disabled soon. Please upgrade to using Environment Files.

@theishshah theishshah changed the title fix: ignore tag changes to customer-ns after eks instantiation fix: Ignore tag changes to customer-ns after eks instantiation Feb 26, 2025
Copy link
Contributor

@dacbd dacbd left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@j7m4
Copy link
Contributor

j7m4 commented Feb 26, 2025

image

Doesn't work with modules see docs.

https://developer.hashicorp.com/terraform/language/modules/syntax#meta-arguments

The aws provider resources are not available in this repo either. The lifecycle block should work at the provider level (core, aws, single tenant):

https://registry.terraform.io/providers/hashicorp/aws/latest/docs/guides/resource-tagging#ignoring-changes-in-all-resources

@j7m4 j7m4 dismissed their stale review February 26, 2025 04:12

Per comment from @dacbd , this will need changes. My reply has a suggested solution

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants