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

Allow users to specify network tags for the default node pool #1123

Merged
merged 3 commits into from
Jan 12, 2022
Merged

Allow users to specify network tags for the default node pool #1123

merged 3 commits into from
Jan 12, 2022

Conversation

tomasgareau
Copy link
Contributor

Addresses #1118.

This will apply the following tags to the default node pool:

  • the cluster_network_tag (gke-${var.name})
  • the pool variant of the cluster_network_tag (gke-${var.name}-default-pool)
  • user-specified tags in var.node_pools_tags["all"]
  • user-specified tags in var.node_pools_tags["default-pool"]

This may be needed for private clusters in VPC networks with a "default-deny-all" firewall rule that use network tags to define exceptions for e.g., egress to the master_ipv4_cidr_block.

Two quick notes/questions:

  • I deviated slightly from @morgante's suggestion in the related issue (adding the network tags from the first pool in the cluster config like for the service account): node_pools_tags is a map-of-lists unlike node_pools, which is a list-of-maps. The "first" pool here wouldn't be well defined -- I think the approach I went with is more natural in any case.
  • Are there any existing tests where we'd like to add coverage for this?
    • It's unfortunately a bit difficult for me to spin up tests as described in CONTRIBUTING.md (we have an org policy that blocks the creation of service account keys), so I'm afraid the only testing I have of the above is manually spinning up an instance in our existing env and confirming that it contained the desired tags.
    • For some tests it seems like I could add an it "has the expected network tags" do block to the default pool checks (e.g., simple_regional)

This adds the following tags to the default pool:
* the cluster_network_tag (gke-${var.name})
* the pool-specific network tag (gke-${var.name}-default-pool)
* user-specified tags from var.node_pools_tags["all"]\
* user-specified tags from var.node_pools_tags["default-pool"]
@tomasgareau tomasgareau requested review from bharathkkb, Jberlinsky and a team as code owners January 12, 2022 20:46
@comment-bot-dev
Copy link

comment-bot-dev commented Jan 12, 2022

Thanks for the PR! 🚀
✅ Lint checks have passed.

lookup(local.node_pools_tags, "default_values", [true, true])[0] ? [local.cluster_network_tag] : [],
lookup(local.node_pools_tags, "default_values", [true, true])[1] ? ["${local.cluster_network_tag}-default-pool"] : [],
lookup(local.node_pools_tags, "all", []),
lookup(local.node_pools_tags, "default-pool", []),
Copy link
Contributor

Choose a reason for hiding this comment

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

Thanks for working on this!

I deviated slightly from @morgante's suggestion in the related issue (adding the network tags from the first pool in the cluster config like for the service account): node_pools_tags is a map-of-lists unlike node_pools, which is a list-of-maps. The "first" pool here wouldn't be well defined -- I think the approach I went with is more natural in any case.

I'd like to avoid introducing a new "default-pool" concept because we already have precedent for using the first node pool as the default pool (example). In this case, what we should do is retrieve the name of the first node pool (from var.node_pools) and use the network tags associated with that node pool (in var.node_pools_tags).

Copy link
Contributor Author

@tomasgareau tomasgareau Jan 12, 2022

Choose a reason for hiding this comment

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

Ah, I see -- makes sense! I've changed the "default-pool" lookup to var.node_pools[0].name in 0391098 -- from what I can see

  • node_pools[0] should always exist
  • node_pools entries are assumed to have the attribute name

so I have no error checking for the cases where either of these aren't true. Let me know if either is not the case.

Did we want to keep the "${local.cluster_network_tag}-default-pool" tag?

Copy link
Contributor

Choose a reason for hiding this comment

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

Looks good, yeah you shouldn't need error checking.

Did we want to keep the "${local.cluster_network_tag}-default-pool" tag?

Yes, I think it's helpful.

@morgante morgante merged commit b8b8547 into terraform-google-modules:master Jan 12, 2022
CPL-markus pushed a commit to WALTER-GROUP/terraform-google-kubernetes-engine that referenced this pull request Jul 15, 2024
…erraform-google-modules#1123)

* Modify cluster template to allow setting network tags on default-pool

This adds the following tags to the default pool:
* the cluster_network_tag (gke-${var.name})
* the pool-specific network tag (gke-${var.name}-default-pool)
* user-specified tags from var.node_pools_tags["all"]\
* user-specified tags from var.node_pools_tags["default-pool"]

* Build autogen template to apply changes in cluster.tf.impl

* Use network tags from the first node pool
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