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

set seed sa permissions to folder level #93

Merged
merged 1 commit into from
Dec 23, 2024

Conversation

dudizimber
Copy link
Collaborator

@dudizimber dudizimber commented Dec 23, 2024

fix #92

Summary by CodeRabbit

  • New Features
    • Introduced a new variable for IAM permissions in the bootstrap module.
    • Added a local variable for IAM roles related to various services.
    • Implemented a resource to assign IAM roles to a service account based on the new local variable.

@dudizimber dudizimber linked an issue Dec 23, 2024 that may be closed by this pull request
Copy link

vercel bot commented Dec 23, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
falkordb-dbaas ✅ Ready (Inspect) Visit Preview 💬 Add feedback Dec 23, 2024 9:35am

Copy link

coderabbitai bot commented Dec 23, 2024

Walkthrough

The changes modify the Terraform configuration for GCP bootstrap project setup. A new variable sa_org_iam_permissions is introduced to the bootstrap module, along with a local variable tf_sa_org_perms that defines a list of IAM roles. A new resource block google_folder_iam_member is added to assign these IAM roles to a service account at the folder level, enabling more granular permission management for the infrastructure deployment service account.

Changes

File Change Summary
tofu/gcp/bootstrap/seed_project/main.tf - Added sa_org_iam_permissions variable (empty list)
- Created tf_sa_org_perms local variable with IAM roles
- Introduced google_folder_iam_member resource to assign roles

Poem

🐰 In the realm of cloud and code so bright,
A terraform rabbit takes flight!
Permissions dance, roles align,
Service accounts now intertwine,
GCP's magic, layer by layer,
Infrastructure grows with flair! 🚀


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

@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 (2)
tofu/gcp/bootstrap/seed_project/main.tf (2)

36-45: Document the necessity of high-privilege roles

The defined roles include powerful permissions like securityAdmin and folderAdmin. While these might be necessary, it's important to document why each role is required and ensure they align with the principle of least privilege.

Add comments explaining the necessity of each role:

 locals {
   tf_sa_org_perms = [
+    # Required for managing VPC networks and configurations
     "roles/compute.networkAdmin",
+    # Required for managing shared VPC configurations
     "roles/compute.xpnAdmin",
+    # Required for managing IAM policies and roles
     "roles/iam.securityAdmin",
+    # Required for managing service accounts
     "roles/iam.serviceAccountAdmin",
+    # Required for managing logging configurations
     "roles/logging.configWriter",
+    # Required for managing folder structure and policies
     "roles/resourcemanager.folderAdmin",
   ]
 }

47-51: LGTM! Consider adding explicit dependency

The implementation correctly assigns folder-level permissions using for_each. However, consider adding an explicit dependency on the bootstrap module to ensure proper creation order.

Add depends_on block to ensure the bootstrap module is fully provisioned:

 resource "google_folder_iam_member" "tf_sa_org_perms" {
   for_each = toset(local.tf_sa_org_perms)
   folder   = var.parent_folder_id
   role     = each.value
   member   = "serviceAccount:${module.bootstrap.terraform_sa_email}"
+  depends_on = [module.bootstrap]
 }
🧰 Tools
🪛 checkov (3.2.334)

[HIGH] 47-52: Ensure no roles that enable to impersonate and manage all service accounts are used at a folder level

(CKV_GCP_44)


[HIGH] 47-52: Ensure no roles that enable to impersonate and manage all service accounts are used at a folder level

(CKV_GCP_44)

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 1c68e92 and ccf7bfd.

📒 Files selected for processing (1)
  • tofu/gcp/bootstrap/seed_project/main.tf (2 hunks)
🔇 Additional comments (1)
tofu/gcp/bootstrap/seed_project/main.tf (1)

13-14: LGTM! Verify removal of org-level permissions

Setting sa_org_iam_permissions to an empty list aligns with the goal of moving permissions to folder level, following the principle of least privilege.

Let's verify no org-level permissions remain:

✅ Verification successful

✅ Organization-level permissions removal verified

The change to set sa_org_iam_permissions = [] is correct and safe. The other organization-level IAM configurations found in tofu/gcp/org/cypago/main.tf are unrelated as they belong to a different service account (cypago) and don't affect the bootstrap/seed project's permissions.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Check for any remaining org-level IAM bindings in the codebase
# that might conflict with this change

# Search for org-level IAM configurations
rg -l "google_organization_iam|sa_org_iam_permissions.*=.*\[.*\]" 

Length of output: 135


Script:

#!/bin/bash
# Let's examine the content of these files to understand the org-level IAM configurations
echo "=== Content of tofu/gcp/bootstrap/seed_project/main.tf ==="
rg -A 5 "google_organization_iam|sa_org_iam_permissions.*=.*\[.*\]" "tofu/gcp/bootstrap/seed_project/main.tf"

echo -e "\n=== Content of tofu/gcp/org/cypago/main.tf ==="
rg -A 5 "google_organization_iam|sa_org_iam_permissions.*=.*\[.*\]" "tofu/gcp/org/cypago/main.tf"

Length of output: 1137

@dudizimber dudizimber merged commit 69245ff into main Dec 23, 2024
8 of 9 checks passed
@dudizimber dudizimber deleted the 92-fix-sa-permissions-on-org-level branch December 23, 2024 09:38
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.

fix sa permissions on org level
2 participants