✨ Addons: Add functionality for resolveConflicts: PRESERVE (kubernetes-sigs#5330)

* Add functionality for resolveConflicts: PRESERVE
fixes for test to pass
removed v1beta1 support

* make generate

* updated documentation and code to reflect kubebuilder behavior

* fixed rebase errors

* make generate after rebase

Author: Edmond Ceausu

config/crd/bases/controlplane.cluster.x-k8s.io_awsmanagedcontrolplanes.yaml

@@ -2233,10 +2233,11 @@ spec:
                       default: overwrite
                       description: |-
                         ConflictResolution is used to declare what should happen if there
-                        are parameter conflicts. Defaults to none
+                        are parameter conflicts. Defaults to overwrite
                       enum:
                       - overwrite
                       - none
+                      - preserve
                       type: string
                     name:
                       description: Name is the name of the addon

config/crd/bases/controlplane.cluster.x-k8s.io_awsmanagedcontrolplanetemplates.yaml

@@ -73,10 +73,11 @@ spec:
                               default: overwrite
                               description: |-
                                 ConflictResolution is used to declare what should happen if there
-                                are parameter conflicts. Defaults to none
+                                are parameter conflicts. Defaults to overwrite
                               enum:
                               - overwrite
                               - none
+                              - preserve
                               type: string
                             name:
                               description: Name is the name of the addon

controlplane/eks/api/v1beta2/types.go

@@ -134,9 +134,9 @@ type Addon struct {
 	// +optional
 	Configuration string `json:"configuration,omitempty"`
 	// ConflictResolution is used to declare what should happen if there
-	// are parameter conflicts. Defaults to none
+	// are parameter conflicts. Defaults to overwrite
 	// +kubebuilder:default=overwrite
-	// +kubebuilder:validation:Enum=overwrite;none
+	// +kubebuilder:validation:Enum=overwrite;none;preserve
 	ConflictResolution *AddonResolution `json:"conflictResolution,omitempty"`
 	// ServiceAccountRoleArn is the ARN of an IAM role to bind to the addons service account
 	// +optional
@@ -158,6 +158,10 @@ var (
 	// AddonResolutionNone indicates that if there are parameter conflicts then
 	// resolution will not be done and an error will be reported.
 	AddonResolutionNone = AddonResolution("none")
+
+	// AddonResolutionPreserve indicates that if there are parameter conflicts then
+	// resolution will result in preserving the existing value
+	AddonResolutionPreserve = AddonResolution("preserve")
 )
 
 // AddonStatus defines the status for an addon.

docs/book/src/topics/eks/addons.md

@@ -23,8 +23,15 @@ spec:
       conflictResolution: "overwrite"
 ```
 
+Valid values are:
+```
+none
+overwrite
+preserve
+```
+
 _Note_: For `conflictResolution` `overwrite` is the **default** behaviour. That means, if not otherwise specified, it's
-set to `overwrite`.
+set to `overwrite`. Review [API Documentation](https://docs.aws.amazon.com/eks/latest/APIReference/API_CreateAddon.html#AmazonEKS-CreateAddon-request-resolveConflicts) for detailed behavior.
 
 Additionally, there is a cluster [flavor](https://cluster-api.sigs.k8s.io/clusterctl/commands/generate-cluster.html#flavors)
 called [eks-managedmachinepool-vpccni](https://github.com/kubernetes-sigs/cluster-api-provider-aws/blob/main/templates/cluster-template-eks-managedmachinepool-vpccni.yaml) that you can use with **clusterctl**:
@@ -46,6 +53,8 @@ To update the version of an addon you need to edit the `AWSManagedControlPlane`
 ...
 ```
 
+_Note_: For `conflictResolution` `none`, updating may fail if a change was made to the addon that is unexpected by EKS. Review [API Documentation](https://docs.aws.amazon.com/eks/latest/APIReference/API_UpdateAddon.html#AmazonEKS-UpdateAddon-request-resolveConflicts) for detailed behavior on conflict resolution.
+
 ## Deleting Addons
 
 To delete an addon from a cluster you need to edit the `AWSManagedControlPlane` instance and remove the entry for the addon you want to delete.

pkg/cloud/services/eks/addons.go

@@ -196,12 +196,16 @@ func (s *Service) translateAPIToAddon(addons []ekscontrolplanev1.Addon) []*eksad
 
 	for i := range addons {
 		addon := addons[i]
+		conflict, err := convertConflictResolution(*addon.ConflictResolution)
+		if err != nil {
+			s.scope.Error(err, err.Error())
+		}
 		convertedAddon := &eksaddons.EKSAddon{
 			Name:                  &addon.Name,
 			Version:               &addon.Version,
 			Configuration:         convertConfiguration(addon.Configuration),
 			Tags:                  ngTags(s.scope.Cluster.Name, s.scope.AdditionalTags()),
-			ResolveConflict:       convertConflictResolution(*addon.ConflictResolution),
+			ResolveConflict:       conflict,
 			ServiceAccountRoleARN: addon.ServiceAccountRoleArn,
 			Preserve:              addon.PreserveOnDelete,
 		}
@@ -221,14 +225,21 @@ func (k *EKSClient) WaitUntilAddonDeleted(ctx context.Context, input *eks.Descri
 	return waiter.Wait(ctx, input, maxWait)
 }
 
-func convertConflictResolution(conflict ekscontrolplanev1.AddonResolution) *string {
-	if conflict == ekscontrolplanev1.AddonResolutionNone {
-		res := string(ekstypes.ResolveConflictsNone)
-		return aws.String(res)
-	}
+func convertConflictResolution(conflict ekscontrolplanev1.AddonResolution) (*string, error) {
+	switch conflict {
+	case ekscontrolplanev1.AddonResolutionNone:
+		return aws.String(string(ekstypes.ResolveConflictsNone)), nil
 
-	res := string(ekstypes.ResolveConflictsOverwrite)
-	return aws.String(res)
+	case ekscontrolplanev1.AddonResolutionOverwrite:
+		return aws.String(string(ekstypes.ResolveConflictsOverwrite)), nil
+
+	case ekscontrolplanev1.AddonResolutionPreserve:
+		return aws.String(string(ekstypes.ResolveConflictsPreserve)), nil
+
+	// Defaulting to behavior "Overwrite" as documented
+	default:
+		return aws.String(string(ekstypes.ResolveConflictsOverwrite)), fmt.Errorf("failed to determine adddonResolution; defaulting to Overwrite")
+	}
 }
 
 func convertConfiguration(configuration string) *string {