docs: Inform multiple region support not an option for iam-role-eks

[sepulworld]

Description

Improve docs for iam-eks-role - inform user that this sub module will not work for multiple regions

Motivation and Context

Will help save time if the end user has a multi region setup. This module doesn't support creating a role for multiple EKS clusters in more than 1 region.

Breaking Changes

None

How Has This Been Tested?

Docs change for clarity

projects

• I have executed pre-commit run -a on my pull request

[bryantbiggs]

Can we update/combine this with the 2nd bullet since I think they are related. It supports multiple clusters, but the caveat is that it does not support multiple regions due to the use of the aws_eks_cluster data source

Suggested change

	- Does not support multiple regions, consider using [iam-assumable-role-with-oidc](https://github.com/terraform-aws-modules/terraform-aws-iam/blob/master/modules/iam-assumable-role-with-oidc/) if role needs to support clusters in multiple regions
	- Does not support multiple regions, consider using [iam-role-for-service-accounts-eks](https://github.com/terraform-aws-modules/terraform-aws-iam/blob/master/modules/iam-role-for-service-accounts-eks/) if role needs to support clusters in multiple regions

cc @max-rocket-internet

[max-rocket-internet]

Hey 👋

@sepulworld

inform user that this sub module will not work for multiple regions

There is a note already in the README that says "The EKS cluster needs to exist first, in the current AWS account and region". I think that's pretty clear, no?

consider using iam-role-for-service-accounts-eks

I don't think this is great advice since the iam-role-for-service-accounts-eks module is stated for "commonly used controllers/custom resources" (quite specific) whereas iam-role-eks has no specific use case like this, it's simply to create a general IRSA role that could be used for anything. The existing readme already details differences compared to iam-assumable-role-with-oidc, perhaps we recommend using this for multi-region?

[sepulworld]

👋 hi @max-rocket-internet ``` There is a note already in the README <https://github.com/terraform- aws-modules/terraform-aws-iam/blob/master/modules/iam-eks- role/README.md> that says "The EKS cluster needs to exist first, in the current AWS account and region". I think that's pretty clear, no?" ``` I think it needs to be near the top in the bullet point section. ``` "iam-assumable-role-with-oidc <https://github.com/terraform-aws- modules/terraform-aws-iam/blob/master/modules/iam-assumable-role-with- oidc/>, perhaps we recommend using this for multi-region?" ``` The user is looking for an EKS specific IAM role and the above suggested doesn’t provide namespace and service input integrations does it?  iam-role-for-service-accounts-eks This role works great also for custom resources, not just common controllers. So if I need an eks role for my business application this works great and covers multiple regions. I would steer users to this sub module (if they are looking for an EKS service role multi region) over the general OIDC module you noted Feel free to close this PR of you think things are clear enough. I wasted a bit of time and figured a bullet point near top highlighting the non multi region support would save others time. Also, I moved to the module I suggested and all is well.  Thanks!

[max-rocket-internet]

@sepulworld cool, merge it 👍

[antonbabenko]

This PR is included in version 5.5.6 🎉

[github-actions]

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.