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

feat!: Removed support for launch configuration and replace count with for_each #1680

Conversation

bryantbiggs
Copy link
Member

@bryantbiggs bryantbiggs commented Nov 7, 2021

Description

  • Add support for cluster addons
  • Add support for cluster identity provider configuration
  • Create separate, standalone sub-modules for:
    • User data
    • EKS Managed Node Group
    • Self Managed Node Group
    • Fargate Profile
  • Drop support for launch configurations - only launch template will be supported going forward
  • Drop support for managing aws-auth configmap
    • Drop requirement of requiring aws-iam-authenticator
    • Drop requirement of Kubernetes terraform provider
  • Replace list/count usage with maps/for_each
  • Update user data usage to allow users to provide their own template in addition to the various settings and configurations provided for the module provided user data templates
  • Update to allow cohesive suite of settings that are uniform across the node pool types supported and continued support of multiple node group default settings under the root module
  • Update to allow more control over customizations/configurations of (not limited to):
    • Security groups
    • IAM roles
    • Tags
    • User data
    • Launch template
  • More details provided under the UPGRADE-18.0.md document

Motivation and Context

Breaking Changes

How Has This Been Tested?

  • I have tested and validated these changes using one or more of the provided examples/* projects
    • All examples under examples/ have been updated and validated

@daroga0002
Copy link
Contributor

@bryantbiggs I think this feature should be moved to wubmodule
similar to node groups

@github-actions
Copy link

github-actions bot commented Nov 7, 2021

Thank you for your contribution!

The CHANGELOG.md file contents are handled by the maintainers during merge. This is to prevent pull request merge conflicts.
Please see the Contributing Guide for additional pull request review items.

Remove any changes to the CHANGELOG.md file and commit them in this pull request.

@bryantbiggs bryantbiggs force-pushed the refactor/breaking-changes branch 11 times, most recently from a24474b to c54c054 Compare November 13, 2021 14:58
@bryantbiggs
Copy link
Member Author

@daroga0002 / @antonbabenko this is getting close for review if you have time to check it out. I still need to populate the upgrade document and comprehensive list of changes, plus a few other design decisions (i.e. - using the default blocks, security group usage, etc.). I've made some more changes today to align variable usage and descriptions so I need to run through all of the examples yet again tomorrow to re-validate but 🤞🏽 they are working as intended (if not, please let me know).

Let me know if you see any glaring/obvious errors - I'll be working on the upgrade doc and I would like to avoid having to make multiple iterations on it since I know its going to be quite involved.

cc - @barryib / @max-rocket-internet / @dpiddock / @lisfo4ka for any input you may have as well 🙏🏽

Copy link
Member

@antonbabenko antonbabenko left a comment

Choose a reason for hiding this comment

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

I did the first round of reviews and it looks very good. Minor comments here and there.

examples/irsa_autoscale_refresh/charts.tf Outdated Show resolved Hide resolved
examples/irsa_autoscale_refresh/main.tf Outdated Show resolved Hide resolved
modules/_user_data/variables.tf Outdated Show resolved Hide resolved
@antonbabenko
Copy link
Member

I think it is a good idea to have an SVG diagram describing bootstrap logic - https://raw.githubusercontent.com/bryantbiggs/terraform-aws-eks/refactor/breaking-changes/.github/images/user_data.svg

@bryantbiggs
Copy link
Member Author

I think it is a good idea to have an SVG diagram describing bootstrap logic - bryantbiggs/terraform-aws-eks@refactor/breaking-changes/.github/images/user_data.svg (raw)

yes, agreed! the images will be in the final PR but right now I have both a relative link and a fully qualified link. the relative link allows the image to be rendered in this PR just to make sure everything shows up as expected but it won't render on the remote Terraform docs for the module; this is what the fully qualified URL is for. so I was just putting a TODO reminder to remove the relative links before merging so that we have the fully qualified URLs that will show the images on both GitHub and on Terraform's module docs

@bryantbiggs bryantbiggs force-pushed the refactor/breaking-changes branch 4 times, most recently from f6ac71b to 885bb6e Compare December 8, 2021 20:59
@bryantbiggs
Copy link
Member Author

ok this is finally ready for final review. I tried to work out some terraform state mv ... steps but in the end the module wants to replace nearly everything that is moved to the new name due to the extensive use of name_prefix (IAM roles, security groups, launch templates, autoscaling group, EKS node group, etc.). Therefore, I have left out any state mv recommendations from the upgrade guide. Let me know if there are any additional changes/feedback/final validation - @antonbabenko / @terraform-aws-modules/triage-supporters

@bryantbiggs bryantbiggs marked this pull request as ready for review December 8, 2021 21:09
@bryantbiggs bryantbiggs added this to the v18.0.0 milestone Dec 8, 2021
@daroga0002
Copy link
Contributor

@bryantbiggs https://www.terraform.io/docs/language/modules/develop/refactoring.html this can be helpful for migration

Terraform 1.1 introducing this 🎉

@antonbabenko
Copy link
Member

Are we raising minimum requirements from Terraform 0.13 to 1.1 already? :) It will be a surprise for many users, plus refactoring features released yesterday are not battle-tested yet. I think we can come back to this and start using something like this in half a year but not before.

Copy link
Contributor

@daroga0002 daroga0002 left a comment

Choose a reason for hiding this comment

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

few questions:

  • do we remove users/roles feature in aws-auth config? what will be desired way to make it?
  • aws-auth seems be now required to be done outside module what is causing that in case of self nodes it will always require handling this externally (so module can be threated as not sufficient in terms of creating cluster
  • EKS silently create in background SG which is assigned by default to node groups, can we also assign this by default to self nodes so then we will have unified approach and will dont require adding those SGs for DNS and etc.
  • what will happen with legacy module? should it be archived in seperate branch?

Beside some questions and concerns looks pretty well and solving a lot of issues 🎉

.pre-commit-config.yaml Show resolved Hide resolved
examples/user_data/templates/windows_custom.tpl Outdated Show resolved Hide resolved
examples/user_data/versions.tf Show resolved Hide resolved
examples/irsa_autoscale_refresh/main.tf Show resolved Hide resolved
@martijnvdp
Copy link
Contributor

@bryantbiggs awesome work on writing all this! 👏 ❤️

I got excited seeing this, so I tried using this new version of the module! Unfortunately, I hit an issue. Chances are I am doing something wrong, but when I try to pass in dynamic resources to this new version of the module, I get an error: The "for_each" value depends on resource attributes that cannot be determined until apply, so Terraform cannot predict how many instances will be created. To work around this, use the -target argument to first apply only the resources that the for_each depends on. I opened a PR with a minimal example of failing code here: bryantbiggs#1

I think this may be due to Terraform's limitations for for_each? Or I am doing something wrong. Both are possible 😅

workaround is to precreate the iam roles

@antonbabenko antonbabenko changed the title feat: Removed support for launch configuration and replace count with for_each feat!: Removed support for launch configuration and replace count with for_each Jan 5, 2022
bootstrap_extra_args = "-KubeletExtraArgs --node-labels=node.kubernetes.io/lifecycle=spot"

post_bootstrap_user_data = <<-EOT
[string]$Something = 'IStillDoNotKnowAnyPowerShell ¯\_(ツ)_/¯'
Copy link
Member

Choose a reason for hiding this comment

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

:trollface: :trollface: :trollface:

version = ">= 2.0"
}
http = {
source = "terraform-aws-modules/http"
Copy link
Member

Choose a reason for hiding this comment

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

Do you know if there is still a need for this http provider we forked some time ago?

Copy link
Member Author

Choose a reason for hiding this comment

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

No I don't believe we need this anymore - but might be best to just archive it in case others are actually using it even if the EKS module is not

@antonbabenko antonbabenko merged commit ee9f0c6 into terraform-aws-modules:master Jan 5, 2022
@antonbabenko
Copy link
Member

@bryantbiggs I am not sure why this PR didn't trigger a major release action, do you know?

https://github.com/terraform-aws-modules/terraform-aws-eks/runs/4714285326?check_suite_focus=true

@antonbabenko
Copy link
Member

@bryantbiggs I renamed the PR title to include ! to make sure that this should be a breaking release but it didn't seem to help. Weird. https://www.conventionalcommits.org/en/v1.0.0/#commit-message-with--to-draw-attention-to-breaking-change

@mcanevet
Copy link

mcanevet commented Jan 5, 2022

@antonbabenko it's probably because none of the commits (not the PR title) contains a !.

@antonbabenko
Copy link
Member

PR title was "feat!: ...", so it was used as a commit ee9f0c6, too.

@mcanevet
Copy link

mcanevet commented Jan 5, 2022

oh yes, you're right

@bryantbiggs
Copy link
Member Author

well thats really annoying! let me see what I can find out @antonbabenko

bryantbiggs added a commit to bryantbiggs/terraform-aws-eks that referenced this pull request Jan 5, 2022
@bryantbiggs bryantbiggs deleted the refactor/breaking-changes branch January 5, 2022 19:38
@bryantbiggs
Copy link
Member Author

I've opened a PR to fix this here #1736 based on some testing I did today to dive into this issue. tl;dr - default of angular preset does not respect the ! and requires BREAKING CHANGE in the commit footer to trigger a breaking change (feat! is not valid either under this preset which is why nothing was released)

antonbabenko pushed a commit that referenced this pull request Jan 5, 2022
## [18.0.0](v17.24.0...v18.0.0) (2022-01-05)

### ⚠ BREAKING CHANGES

* Removed support for launch configuration and replace `count` with `for_each` (#1680)

### Features

* Removed support for launch configuration and replace `count` with `for_each` ([#1680](#1680)) ([ee9f0c6](ee9f0c6))

### Bug Fixes

* Update preset rule on semantic-release to use conventional commits ([#1736](#1736)) ([be86c0b](be86c0b))
@antonbabenko
Copy link
Member

This PR is included in version 18.0.0 🎉

@lodotek
Copy link

lodotek commented May 2, 2022

I am trying to find out why docs/iam-permissions.md is missing from master. Because it is now missing from master, there is a broken link here: https://learn.hashicorp.com/tutorials/terraform/eks
image

@bryantbiggs
Copy link
Member Author

its not missing, it was removed. The documentation provided is related to how the module is designed, how to configure the module, etc. If you wish to discover what permissions are required for your configuration, you can use IAM access analyzer, https://github.com/iann0036/iamlive, or other similar tools

baibailiha added a commit to baibailiha/terraform-aws-eks that referenced this pull request Sep 13, 2022
## [18.0.0](terraform-aws-modules/terraform-aws-eks@v17.24.0...v18.0.0) (2022-01-05)

### ⚠ BREAKING CHANGES

* Removed support for launch configuration and replace `count` with `for_each` (#1680)

### Features

* Removed support for launch configuration and replace `count` with `for_each` ([#1680](terraform-aws-modules/terraform-aws-eks#1680)) ([17031bd](terraform-aws-modules/terraform-aws-eks@17031bd))

### Bug Fixes

* Update preset rule on semantic-release to use conventional commits ([#1736](terraform-aws-modules/terraform-aws-eks#1736)) ([e26a7d9](terraform-aws-modules/terraform-aws-eks@e26a7d9))
@github-actions
Copy link

github-actions bot commented Nov 9, 2022

I'm going to lock this pull request because it has been closed for 30 days ⏳. This helps our maintainers find and focus on the active issues. If you have found a problem that seems related to this change, please open a new issue and complete the issue template so we can capture all the details necessary to investigate further.

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Nov 9, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.