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.

Sign up for GitHub

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

Jump to bottom

feat: Improved iam-eks-role module (simplified, removed provider_url_sa_pairs, updated docs) #236

Merged
merged 2 commits into from
Apr 25, 2022
Merged

feat: Improved iam-eks-role module (simplified, removed provider_url_sa_pairs, updated docs) #236

merged 2 commits into from
Apr 25, 2022

Conversation

max-rocket-internet
Copy link
Contributor

@max-rocket-internet max-rocket-internet commented Apr 22, 2022 •
edited by antonbabenko

Description

There was some misunderstanding in #184 about the intended use of the iam-eks-role module. I think a lot of it can be put down to that there was an assumption that this module was in some way related to the terraform-aws-eks module, but it is not. So I thought I would come back just to make a few minor adjustments to clear up the confusion 🙂

Fixes #219

The main points were:

From @bryantbiggs:

  1. its not clear to users that the cluster name should be the key of the maps
  2. it restricts users to creating a role in one region while roles are global
  3. most importantly is the lifecycle issue. you cannot specify this role and a cluster and create at the same time. the cluster has to exist first
  4. This module has been design in conjunction with the [terraform-aws-eks]

From @philicious:

imho its not perfectly clear that the key of the map has to match the exact cluster name

So here I am:

  • Clarifying docs for the above points
  • Remove provider_url_sa_pairs option: it's a very advanced option IMO and not for the intended use of this module. Removing it makes it simpler. If people want this option then they can just use iam-assumable-role-with-oidc
  • Adjust outputs to use nicer try
  • Provide 3 clear examples

Motivation and Context

Just to clarify and better document the module.

Breaking Changes

Yes if someone was using provider_url_sa_pairs.

How Has This Been Tested?

  • I have updated at least one of the examples/* to demonstrate and validate my change(s)
  • I have tested it in my environment also

@max-rocket-internet max-rocket-internet changed the title iam-eks-role module changes: more docs, simplification feat: iam-eks-role module changes: more docs, simplification Apr 22, 2022
@max-rocket-internet max-rocket-internet changed the title feat: iam-eks-role module changes: more docs, simplification Feat: iam-eks-role module changes: more docs, simplification Apr 22, 2022
@max-rocket-internet max-rocket-internet changed the title Feat: iam-eks-role module changes: more docs, simplification feat: iam-eks-role module changes: more docs, simplification Apr 22, 2022
@max-rocket-internet max-rocket-internet changed the title feat: iam-eks-role module changes: more docs, simplification feat: Module iam-eks-role changes: more docs, simplification Apr 22, 2022
@max-rocket-internet max-rocket-internet changed the title feat: Module iam-eks-role changes: more docs, simplification feat: Module iam-eks-role changes: more docs, simplification Apr 22, 2022
antonbabenko
antonbabenko approved these changes Apr 25, 2022
View reviewed changes
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.

LGTM

@antonbabenko
Copy link
Member

LGTM, but I wonder what @bryantbiggs thinks about this as he has added another EKS-related module and probably has a better picture of what is what.

@max-rocket-internet
Copy link
Contributor Author

but I wonder what @bryantbiggs thinks about this as he has added another EKS-related module and probably has a better picture of what is what.

The 2 modules are unrelated. The module he added was specifically for cluster admins, this module is for anyone 🙂

bryantbiggs
bryantbiggs approved these changes Apr 25, 2022
View reviewed changes
Copy link
Member

@bryantbiggs bryantbiggs left a comment

Choose a reason for hiding this comment

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

Note: this is technically a breaking change but I believe its mostly used by @max-rocket-internet / Delivery Hero so I will leave it with them

@antonbabenko antonbabenko changed the title feat: Module iam-eks-role changes: more docs, simplification feat: Improved iam-eks-role module (simplified, removed provider_url_sa_pairs, updated docs) Apr 25, 2022
@antonbabenko antonbabenko merged commit d014730 into terraform-aws-modules:master Apr 25, 2022
antonbabenko pushed a commit that referenced this pull request Apr 25, 2022
@semantic-release-bot
chore(release): version 4.23.0 [skip ci]
2113ea9 
## [4.23.0](v4.22.1...v4.23.0) (2022-04-25)

### Features

* Improved iam-eks-role module (simplified, removed provider_url_sa_pairs, updated docs) ([#236](#236)) ([d014730](d014730))
@antonbabenko
Copy link
Member

This PR is included in version 4.23.0 🎉

@max-rocket-internet max-rocket-internet deleted the update_eks_role branch April 26, 2022 09:21
@eherot eherot mentioned this pull request May 3, 2022
Closed
@github-actions
Copy link

github-actions bot commented Nov 8, 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 8, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@antonbabenko antonbabenko antonbabenko approved these changes

@bryantbiggs bryantbiggs bryantbiggs approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Explain the differences between iam-role-for-service-accounts-eks and iam-eks-role modules
3 participants
@max-rocket-internet @antonbabenko @bryantbiggs