Support tweaking NodeGroupVersion update requests (#96)

Prior to this patch, the eks-controller wasn't able to set the
ReleaseVersion, LaunchTemplate or the force attribute when making
an `UpdateNodeGroupVersion` API Call.

This patch correctly sets the ReleaseVersion and LaunchTemplate in the
API request, and introduces a new annotation allowing users to set the
Force attribute to true.

We're adding a new annotation
`eks.services.k8s.aws/force-update-version` - when set to true, the
controller will toggle the Force boolean in the update request.

Signed-off-by: Amine Hilaly <[email protected]>

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.

Author: a-hilaly

README.md

@@ -19,6 +19,7 @@ Currently, the `eks-controller` is GA and supports the following resources:
 - `FargateProfile`
 - `Addon`
 - `PodIdentityAssociation`
+- `AccessEntry`
 
 A detailed list of the resources supported specifications can be found in the
 [references][ack-references] section.
@@ -40,6 +41,11 @@ behavior of the controller. The following annotations are supported:
 
       If not set, the controller will default to `ack-eks-controller`.
 
+    - `eks.services.k8s.aws/force-update-version`: used to force the version
+      update of the nodegroup. If set to `true`, and the controller detects a
+      a change in the nodegroup, it will set the `force` attribute to `true`
+      in the `UpdateNodeGroupConfig` API call.
+
 ## Contributing
 
 We welcome community contributions and pull requests.

apis/v1alpha1/annotation.go

@@ -34,6 +34,13 @@ var (
 	// the value is not one of the above, the controller will default to managing the desired size
 	// as if the annotation was set to "controller".
 	DesiredSizeManagedByAnnotation = fmt.Sprintf("%s/desired-size-managed-by", GroupVersion.Group)
+	// ForceNodeGroupUpdateVersionAnnotation is the annotation key used to force an update of the
+	// nodegroup version. This annotation can only be set on a nodegroup custom resource.
+	// The value of this annotation must be a boolean value. If the value is "true", the controller
+	// will force an update of the nodegroup version to the value specified in the `version` field
+	// of the `spec` object. If the value is "false", the controller will not force an update of the
+	// nodegroup version.
+	ForceNodeGroupUpdateVersionAnnotation = fmt.Sprintf("%s/force-update-version", GroupVersion.Group)
 )
 
 const (

pkg/resource/nodegroup/hook.go

@@ -17,6 +17,7 @@ import (
 	"context"
 	"fmt"
 	"reflect"
+	"strconv"
 	"time"
 
 	ackcompare "github.com/aws-controllers-k8s/runtime/pkg/compare"
@@ -25,6 +26,7 @@ import (
 	ackrtlog "github.com/aws-controllers-k8s/runtime/pkg/runtime/log"
 	svcsdk "github.com/aws/aws-sdk-go/service/eks"
 	corev1 "k8s.io/api/core/v1"
+	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 
 	svcapitypes "github.com/aws-controllers-k8s/eks-controller/apis/v1alpha1"
 )
@@ -363,18 +365,40 @@ func newUpdateTaintsPayload(
 	return &payload
 }
 
+func newUpdateNodegroupVersionPayload(
+	desired *resource,
+) *svcsdk.UpdateNodegroupVersionInput {
+	input := &svcsdk.UpdateNodegroupVersionInput{
+		NodegroupName:  desired.ko.Spec.Name,
+		ClusterName:    desired.ko.Spec.ClusterName,
+		Version:        desired.ko.Spec.Version,
+		ReleaseVersion: desired.ko.Spec.ReleaseVersion,
+	}
+
+	if desired.ko.Spec.LaunchTemplate != nil {
+		input.SetLaunchTemplate(&svcsdk.LaunchTemplateSpecification{
+			Id:      desired.ko.Spec.LaunchTemplate.ID,
+			Name:    desired.ko.Spec.LaunchTemplate.Name,
+			Version: desired.ko.Spec.LaunchTemplate.Version,
+		})
+	}
+
+	if getUpdateNodeGroupForceAnnotation(desired.ko.ObjectMeta) {
+		input.SetForce(true)
+	}
+
+	return input
+}
+
 func (rm *resourceManager) updateVersion(
 	ctx context.Context,
 	r *resource,
 ) (err error) {
 	rlog := ackrtlog.FromContext(ctx)
 	exit := rlog.Trace("rm.updateVersion")
 	defer exit(err)
-	input := &svcsdk.UpdateNodegroupVersionInput{
-		NodegroupName: r.ko.Spec.Name,
-		ClusterName:   r.ko.Spec.ClusterName,
-		Version:       r.ko.Spec.Version,
-	}
+
+	input := newUpdateNodegroupVersionPayload(r)
 
 	_, err = rm.sdkapi.UpdateNodegroupVersionWithContext(ctx, input)
 	rm.metrics.RecordAPICall("UPDATE", "UpdateNodegroupVersion", err)
@@ -385,6 +409,29 @@ func (rm *resourceManager) updateVersion(
 	return nil
 }
 
+const (
+	defaultUpgradeNodeGroupVersion = false
+)
+
+// GetDeleteForce returns whether the nodegroup should be deleted forcefully.
+//
+// https://docs.aws.amazon.com/eks/latest/APIReference/API_UpdateNodegroupVersion.html
+func getUpdateNodeGroupForceAnnotation(
+	m metav1.ObjectMeta,
+) bool {
+	resAnnotations := m.GetAnnotations()
+	forceVersionUpdate, ok := resAnnotations[svcapitypes.ForceNodeGroupUpdateVersionAnnotation]
+	if !ok {
+		return defaultUpgradeNodeGroupVersion
+	}
+
+	forceVersionUpdateBool, err := strconv.ParseBool(forceVersionUpdate)
+	if err != nil {
+		return defaultUpgradeNodeGroupVersion
+	}
+
+	return forceVersionUpdateBool
+}
 func (rm *resourceManager) newUpdateScalingConfigPayload(
 	desired, latest *resource,
 ) *svcsdk.NodegroupScalingConfig {

pkg/resource/nodegroup/hook_test.go

@@ -422,3 +422,108 @@ func Test_resourceManager_newUpdateScalingConfigPayload_ManagedByDefault(t *test
 		})
 	}
 }
+
+func Test_newUpdateNodegroupPayload(t *testing.T) {
+	type args struct {
+		r *resource
+	}
+	tests := []struct {
+		name               string
+		args               args
+		wantVersion        string
+		wantForce          bool
+		wantLaunchTemplate bool
+	}{
+		{
+			name: "version only",
+			args: args{
+				r: &resource{
+					ko: &v1alpha1.Nodegroup{
+						Spec: v1alpha1.NodegroupSpec{
+							Version: aws.String("1.21"),
+						},
+					},
+				},
+			},
+			wantVersion:        "1.21",
+			wantForce:          false,
+			wantLaunchTemplate: false,
+		},
+		{
+			name: "all fields",
+			args: args{
+				r: &resource{
+					ko: &v1alpha1.Nodegroup{
+						Spec: v1alpha1.NodegroupSpec{
+							Version:        aws.String("1.21"),
+							ReleaseVersion: aws.String("someversion"),
+							LaunchTemplate: &v1alpha1.LaunchTemplateSpecification{
+								ID: aws.String("id"),
+							},
+						},
+					},
+				},
+			},
+			wantVersion:        "1.21",
+			wantForce:          false,
+			wantLaunchTemplate: true,
+		},
+		{
+			name: "force update annotation false",
+			args: args{
+				r: &resource{
+					ko: &v1alpha1.Nodegroup{
+						ObjectMeta: metav1.ObjectMeta{
+							Annotations: map[string]string{
+								"eks.services.k8s.aws/force-update-version": "false",
+							},
+						},
+						Spec: v1alpha1.NodegroupSpec{
+							Version: aws.String("1.21"),
+						},
+					},
+				},
+			},
+			wantVersion:        "1.21",
+			wantForce:          false,
+			wantLaunchTemplate: false,
+		},
+		{
+			name: "force update annotation true",
+			args: args{
+				r: &resource{
+					ko: &v1alpha1.Nodegroup{
+						ObjectMeta: metav1.ObjectMeta{
+							Annotations: map[string]string{
+								"eks.services.k8s.aws/force-update-version": "true",
+							},
+						},
+						Spec: v1alpha1.NodegroupSpec{
+							Version: aws.String("1.21"),
+						},
+					},
+				},
+			},
+			wantVersion:        "1.21",
+			wantForce:          true,
+			wantLaunchTemplate: false,
+		},
+	}
+	for _, tt := range tests {
+		t.Run(tt.name, func(t *testing.T) {
+			got := newUpdateNodegroupVersionPayload(tt.args.r)
+			assert.Equal(t, tt.wantVersion, *got.Version)
+			if tt.wantForce {
+				assert.NotNil(t, got.Force)
+				assert.True(t, *got.Force)
+			} else {
+				assert.Nil(t, got.Force)
+			}
+			if tt.wantLaunchTemplate {
+				assert.NotNil(t, got.LaunchTemplate)
+			} else {
+				assert.Nil(t, got.LaunchTemplate)
+			}
+		})
+	}
+}