EKS: Support tagging node group's underlying ASG

[richardchen331]

What type of PR is this?
/kind feature

What this PR does / why we need it:
There is an open issue on EKS where EKS doesn’t support tagging the underlying ASGs, however it’s quite important for many organizations for compliance, cost. This PR adds such support in CAPA, where user can specify an optional AdditionalAsgTags field in AWSManagedMachinePool and the node group controller will reconcile the underlying ASG tags.

Which issue(s) this PR fixes (optional, in fixes #<issue number>(, fixes #<issue_number>, ...) format, will close the issue(s) when PR gets merged):
Fixes #2881

Special notes for your reviewer:

Checklist:

• squashed commits
• includes documentation
• adds unit tests
• adds or updates e2e tests

Release note:

Support tagging EKS node group's underlying ASG

[k8s-ci-robot]

Thanks for your pull request. Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA).

📝 Please follow instructions at https://git.k8s.io/community/CLA.md#the-contributor-license-agreement to sign the CLA.

It may take a couple minutes for the CLA signature to be fully registered; after that, please reply here with a new comment and we'll verify. Thanks.

---

• If you've already signed a CLA, it's possible we don't have your GitHub username or you're using a different email address. Check your existing CLA data and verify that your email is set on your git commits.
• If you signed the CLA as a corporation, please sign in with your organization's credentials at https://identity.linuxfoundation.org/projects/cncf to be authorized.
• If you have done the above and are still having issues with the CLA being reported as unsigned, please log a ticket with the Linux Foundation Helpdesk: https://support.linuxfoundation.org/
• Should you encounter any issues with the Linux Foundation Helpdesk, send a message to the backup e-mail support address at: login-issues@jira.linuxfoundation.org

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository. I understand the commands that are listed here.

[k8s-ci-robot]

@richardchen331: This issue is currently awaiting triage.

If CAPA/CAPI contributors determines this is a relevant issue, they will accept it by applying the triage/accepted label and provide further guidance.

The triage/accepted label can be added by org members by writing /triage accepted in a comment.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

[k8s-ci-robot]

Welcome @richardchen331!

It looks like this is your first PR to kubernetes-sigs/cluster-api-provider-aws 🎉. Please refer to our pull request process documentation to help your PR have a smooth ride to approval.

You will be prompted by a bot to use commands during the review process. Do not be afraid to follow the prompts! It is okay to experiment. Here is the bot commands documentation.

You can also check if kubernetes-sigs/cluster-api-provider-aws has its own contribution guidelines.

You may want to refer to our testing guide if you run into trouble with your tests not passing.

If you are having difficulty getting your pull request seen, please follow the recommended escalation practices. Also, for tips and tricks in the contribution process you may want to read the Kubernetes contributor cheat sheet. We want to make sure your contribution gets all the attention it needs!

Thank you, and welcome to Kubernetes. 😃

[k8s-ci-robot]

Hi @richardchen331. Thanks for your PR.

I'm waiting for a kubernetes-sigs member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

[shivi28]

Can we index the ranged map as given in the stackoverflow link?

for key := range s.scope.ManagedMachinePool.Spec.AdditionalAsgTags {
    key:= key (Can remove it and check if it still throws error)
    input.Tags = append(input.Tags, &autoscaling.Tag{
		Key:               &key,
		PropagateAtLaunch: &trueVal,
		ResourceId:        asg.Name,
		ResourceType:      &asgType,
		Value:             & s.scope.ManagedMachinePool.Spec.AdditionalAsgTags[key],
	})
}
if _, err := s.AutoscalingClient.CreateOrUpdateTags(input); err != nil {
	return errors.Wrap(err, "failed to reconcile AutoScalingGroup tags for nodegroup")
}

[richardchen331]

I tried to change to this but got error invalid operation: cannot take address of s.scope.ManagedMachinePool.Spec.AdditionalAsgTags[key] (map index expression of type string), so I'll keep it as it for now

[k8s-ci-robot]

Thanks for your pull request. Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA).

📝 Please follow instructions at https://git.k8s.io/community/CLA.md#the-contributor-license-agreement to sign the CLA.

It may take a couple minutes for the CLA signature to be fully registered; after that, please reply here with a new comment and we'll verify. Thanks.

---

• If you've already signed a CLA, it's possible we don't have your GitHub username or you're using a different email address. Check your existing CLA data and verify that your email is set on your git commits.
• If you signed the CLA as a corporation, please sign in with your organization's credentials at https://identity.linuxfoundation.org/projects/cncf to be authorized.
• If you have done the above and are still having issues with the CLA being reported as unsigned, please log a ticket with the Linux Foundation Helpdesk: https://support.linuxfoundation.org/
• Should you encounter any issues with the Linux Foundation Helpdesk, send a message to the backup e-mail support address at: login-issues@jira.linuxfoundation.org

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository. I understand the commands that are listed here.

[richardchen331]

Updated code to remove unspecified ASG tags as well

[richardcase]

Same issue. I will investigate

[richardchen331]

e2e tests passed after rebasing the PR. @richardcase do you mind taking a final look at this PR? Thanks!

[richardcase]

/test pull-cluster-api-provider-aws-e2e-eks

[richardcase]

Probable a flake, so:

/test pull-cluster-api-provider-aws-e2e-eks

[richardcase]

@richardchen331 - Looking at the CAPA logs for the e2e failure i see:

I0117 11:20:31.049787       1 awsmanagedmachinepool_controller.go:175]  "msg"="Reconciling AWSManagedMachinePool"  
I0117 11:20:31.907542       1 tags.go:126]  "msg"="Reconciling ASG tags"  "cluster-name"="cluster-m075u4" "nodegroup-name"="eks-nodes-3eljk4_cluster-m075u4-pool-0"
I0117 11:20:32.057082       1 awsmanagedmachinepool_controller.go:195]  "msg"="Reconciling deletion of AWSManagedMachinePool" 

From the logs it looks like its starting reconciling the ASG tags but then:

• fails during reconciling
• Or more likely we are hittinh a timeout that is causing the cluster to be deleted at the time of reconciling the ASG tags

The timeout is probably more likely due to this in the logs:

   Timed out after 1800.000s.
      
  Expected
      <int>: 1
  to equal
      <int>: 2 

[richardcase]

I've increased the timeout by 5 mins to see it's purely unfortunate timing or if the extra time reveals any errors.

[richardcase]

/test pull-cluster-api-provider-aws-e2e-eks

[richardchen331]

@richardcase Looking at the e2e test log it looks like that:

• The test timed out "Waiting for the machine pool workload nodes to exist" after "Scaling the machine pool up" (log here, test implementation here)
• It timed out because of MachinePool.Status.ReadyReplicas (1) != MachinePool.Spec.Replicas (2)
• Looking at the MP resource and the AWSMMP resource it looks that the cloud resource indeed scaled up, just that one of the node is not ready.
• This doesn't seems to be related to the code change. I'm going to rerun the test and see what happens.

[richardchen331]

/test pull-cluster-api-provider-aws-e2e-eks

[richardcase]

This is strange as the periodic e2e for EKS are passing every night.

I can't see why this change would cause the e2e to fail.

I'll run the e2e locally on your branch to see if it highlights anything.

[richardchen331]

@richardcase I think I found the culprit... So EKS nodes relies on the "kubernetes.io/cluster/cluster-name:owned" tag in order to join the cluster (https://docs.aws.amazon.com/eks/latest/userguide/troubleshooting.html#worker-node-fail), however we are incorrectly updating the ASG tags because ManagedMachinePoolScope.ClusterName() returns the Cluster CR name instead of the actual EKS cluster name. I updated the PR and let's see if tests can pass.

[richardcase]

Ah, we've had that issue in other places. Fingers crossed it wired works and the e2e pass. If it didn't I'll run them locally this morning

[richardcase]

/test pull-cluster-api-provider-aws-e2e-eks

[richardchen331]

/test pull-cluster-api-provider-aws-e2e-eks

[richardcase]

/test pull-cluster-api-provider-aws-e2e-eks

[richardcase]

Thats good the eks e2e passed

[richardcase]

/test pull-cluster-api-provider-aws-test

[richardcase]

The tests are passing, i think this is good to go:

/lgtm
/approve

[k8s-ci-robot]

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: richardcase

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

• OWNERS [richardcase]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment