Merge https://github.com/kubernetes-sigs/cluster-api-provider-aws:v2.10.1 (fd1ef27) into main

.github/workflows/pr-golangci-lint.yaml

@@ -28,7 +28,7 @@ jobs:
       - name: golangci-lint
         uses: golangci/golangci-lint-action@0a35821d5c230e903fcfe077583637dea1b27b47 # tag=v9.0.0
         with:
-          version: v2.1.0
+          version: v2.7.0
           working-directory: ${{matrix.working-directory}}
       - name: Lint API
         run: make lint-api

.golangci.yml

@@ -297,6 +297,38 @@ linters:
         path: .*(api|types|test)\/.*\/.*conversion.*\.go$
         # This rule warns when initialism, variable or package naming conventions are not followed.
         text: "var-naming: don't use underscores in Go names"
+      - linters:
+          - revive
+        path: 'exp/utils/*'
+        text: 'var-naming: avoid meaningless package names'
+      - linters:
+          - revive
+        path: 'cmd/clusterawsadm/cmd/ami/common'
+        text: 'var-naming: avoid meaningless package names'
+      - linters:
+          - revive
+        path: 'cmd/clusterawsadm/cmd/util'
+        text: 'var-naming: avoid meaningless package names'
+      - linters:
+          - revive
+        path: 'pkg/utils'
+        text: 'var-naming: avoid meaningless package names'
+      - linters:
+          - revive
+        path: 'pkg/cloud/services/common/'
+        text: 'var-naming: avoid meaningless package names'
+      - linters:
+          - revive
+        path: 'test/e2e/shared/'
+        text: 'var-naming: avoid meaningless package names'
+      - linters:
+          - revive
+        text: 'avoid package names that conflict with Go standard library package names'
+        path: 'pkg/internal/bytes/'
+      - linters:
+          - revive
+        text: 'avoid package names that conflict with Go standard library package names'
+        path: 'pkg/hash/'
       - linters:
           - unparam
         text: always receives
@@ -330,6 +362,9 @@ linters:
       - linters:
           - staticcheck
         text: 'SA1019: "sigs.k8s.io/cluster-api/(.*)" is deprecated: This package is deprecated and is going to be removed when support for v1beta1 will be dropped.'
+      - linters:
+          - staticcheck
+        text: "s.scope.ControlPlaneLoadBalancer is deprecated"
     paths:
       - third_party$
       - builtin$

api/v1beta1/types.go

@@ -32,6 +32,7 @@ type AWSResourceReference struct {
 
 	// ARN of resource.
 	// +optional
+	//
 	// Deprecated: This field has no function and is going to be removed in the next release.
 	ARN *string `json:"arn,omitempty"`
 

api/v1beta2/awsmachine_types.go

@@ -251,18 +251,22 @@ type AWSMachineSpec struct {
 	HostID *string `json:"hostID,omitempty"`
 
 	// HostAffinity specifies the dedicated host affinity setting for the instance.
-	// When HostAffinity is set to host, an instance started onto a specific host always restarts on the same host if stopped.
-	// When HostAffinity is set to default, and you stop and restart the instance, it can be restarted on any available host.
-	// When HostAffinity is defined, HostID is required.
+	// When HostAffinity is set to "host", an instance started onto a specific host always restarts on the same host if stopped:
+	// - If HostID is set, the instance launches on the specific host and must return to that same host after any stop/start (Targeted & Pinned).
+	// - If HostID is not set, the instance gets launched on any available and must returns to the same host after any stop/start (Auto-placed & Pinned).
+	// When HostAffinity is set to "default" (the default value), the instance (when restarted) can return on any available host:
+	// - If HostID is set, the instance launches on the specified host now, but (when restarted) can return to any available hosts (Targeted & Flexible).
+	// - If HostID is not set, the instance launches on any available host now, and (when restarted) can return to any available hosts (Auto-placed & Flexible).
+	// If HostAffinity is not specified, it defaults to "default".
 	// +optional
 	// +kubebuilder:validation:Enum:=default;host
-	// +kubebuilder:default=host
+	// +kubebuilder:default=default
 	HostAffinity *string `json:"hostAffinity,omitempty"`
 
 	// DynamicHostAllocation enables automatic allocation of a single dedicated host.
-	// This field is mutually exclusive with HostID and always allocates exactly one host.
 	// Cost effectiveness of allocating a single instance on a dedicated host may vary
 	// depending on the instance type and the region.
+	// This field is mutually exclusive with HostID and always allocates exactly one host.
 	// +optional
 	DynamicHostAllocation *DynamicHostAllocationSpec `json:"dynamicHostAllocation,omitempty"`
 

api/v1beta2/awsmachine_webhook.go

@@ -481,6 +481,7 @@ func (r *AWSMachine) validateHostAllocation() field.ErrorList {
 	hasHostID := r.Spec.HostID != nil && len(*r.Spec.HostID) > 0
 	hasDynamicHostAllocation := r.Spec.DynamicHostAllocation != nil
 
+	// If both hostID and dynamicHostAllocation are specified, return an error
 	if hasHostID && hasDynamicHostAllocation {
 		allErrs = append(allErrs, field.Forbidden(field.NewPath("spec.hostID"), "hostID and dynamicHostAllocation are mutually exclusive"), field.Forbidden(field.NewPath("spec.dynamicHostAllocation"), "hostID and dynamicHostAllocation are mutually exclusive"))
 	}

api/v1beta2/awsmachine_webhook_test.go

@@ -469,7 +469,61 @@ func TestAWSMachineCreate(t *testing.T) {
 			wantErr: true,
 		},
 		{
-			name: "configure host affinity with Host ID",
+			name: "hostAffinity=invalid is invalid",
+			machine: &AWSMachine{
+				Spec: AWSMachineSpec{
+					InstanceType: "test",
+					HostAffinity: ptr.To("invalid"),
+				},
+			},
+			wantErr: true,
+		},
+		{
+			name: "hostAffinity=host does not require hostID or dynamicHostAllocation",
+			machine: &AWSMachine{
+				Spec: AWSMachineSpec{
+					InstanceType: "test",
+					HostAffinity: ptr.To("host"),
+				},
+			},
+			wantErr: false,
+		},
+		{
+			name: "hostAffinity=host with hostID is valid",
+			machine: &AWSMachine{
+				Spec: AWSMachineSpec{
+					InstanceType: "test",
+					HostAffinity: ptr.To("host"),
+					HostID:       ptr.To("h-09dcf61cb388b0149"),
+				},
+			},
+			wantErr: false,
+		},
+		{
+			name: "hostAffinity=host with dynamicHostAllocation is valid",
+			machine: &AWSMachine{
+				Spec: AWSMachineSpec{
+					InstanceType: "test",
+					HostAffinity: ptr.To("host"),
+					DynamicHostAllocation: &DynamicHostAllocationSpec{
+						Tags: map[string]string{"env": "test"},
+					},
+				},
+			},
+			wantErr: false,
+		},
+		{
+			name: "hostAffinity=default without hostID and dynamicHostAllocation is valid",
+			machine: &AWSMachine{
+				Spec: AWSMachineSpec{
+					InstanceType: "test",
+					HostAffinity: ptr.To("default"),
+				},
+			},
+			wantErr: false,
+		},
+		{
+			name: "hostAffinity=default with hostID is valid",
 			machine: &AWSMachine{
 				Spec: AWSMachineSpec{
 					InstanceType: "test",
@@ -480,11 +534,77 @@ func TestAWSMachineCreate(t *testing.T) {
 			wantErr: false,
 		},
 		{
-			name: "configure host affinity with invalid affinity",
+			name: "hostAffinity=default with dynamicHostAllocation is valid",
 			machine: &AWSMachine{
 				Spec: AWSMachineSpec{
 					InstanceType: "test",
-					HostAffinity: ptr.To("invalid"),
+					HostAffinity: ptr.To("default"),
+					DynamicHostAllocation: &DynamicHostAllocationSpec{
+						Tags: map[string]string{"env": "test"},
+					},
+				},
+			},
+			wantErr: false,
+		},
+		{
+			name: "hostAffinity omitted (=default) without hostID and dynamicHostAllocation is valid",
+			machine: &AWSMachine{
+				Spec: AWSMachineSpec{
+					InstanceType: "test",
+				},
+			},
+			wantErr: false,
+		},
+		{
+			name: "hostAffinity omitted (=default) with hostID is valid",
+			machine: &AWSMachine{
+				Spec: AWSMachineSpec{
+					InstanceType: "test",
+					HostID:       ptr.To("h-09dcf61cb388b0149"),
+				},
+			},
+			wantErr: false,
+		},
+		{
+			name: "hostAffinity omitted (=default) with dynamicHostAllocation is valid",
+			machine: &AWSMachine{
+				Spec: AWSMachineSpec{
+					InstanceType: "test",
+					DynamicHostAllocation: &DynamicHostAllocationSpec{
+						Tags: map[string]string{"env": "test"},
+					},
+				},
+			},
+			wantErr: false,
+		},
+		{
+			name: "hostAffinity=host with both hostID and dynamicHostAllocation is not valid (mutually exclusive)",
+			machine: &AWSMachine{
+				Spec: AWSMachineSpec{
+					InstanceType: "test",
+					HostAffinity: ptr.To("host"),
+					HostID:       aws.String("h-1234567890abcdef0"),
+					DynamicHostAllocation: &DynamicHostAllocationSpec{
+						Tags: map[string]string{
+							"Environment": "test",
+						},
+					},
+				},
+			},
+			wantErr: true,
+		},
+		{
+			name: "hostAffinity=default with both hostID and dynamicHostAllocation is not valid (mutually exclusive)",
+			machine: &AWSMachine{
+				Spec: AWSMachineSpec{
+					InstanceType: "test",
+					HostAffinity: ptr.To("default"),
+					HostID:       aws.String("h-1234567890abcdef0"),
+					DynamicHostAllocation: &DynamicHostAllocationSpec{
+						Tags: map[string]string{
+							"Environment": "test",
+						},
+					},
 				},
 			},
 			wantErr: true,
@@ -557,45 +677,6 @@ func TestAWSMachineCreate(t *testing.T) {
 			},
 			wantErr: true,
 		},
-		{
-			name: "hostID and dynamicHostAllocation are mutually exclusive",
-			machine: &AWSMachine{
-				Spec: AWSMachineSpec{
-					InstanceType: "test",
-					HostID:       aws.String("h-1234567890abcdef0"),
-					DynamicHostAllocation: &DynamicHostAllocationSpec{
-						Tags: map[string]string{
-							"Environment": "test",
-						},
-					},
-				},
-			},
-			wantErr: true,
-		},
-		{
-			name: "hostID alone is valid",
-			machine: &AWSMachine{
-				Spec: AWSMachineSpec{
-					InstanceType: "test",
-					HostID:       aws.String("h-1234567890abcdef0"),
-				},
-			},
-			wantErr: false,
-		},
-		{
-			name: "dynamicHostAllocation alone is valid",
-			machine: &AWSMachine{
-				Spec: AWSMachineSpec{
-					InstanceType: "test",
-					DynamicHostAllocation: &DynamicHostAllocationSpec{
-						Tags: map[string]string{
-							"Environment": "test",
-						},
-					},
-				},
-			},
-			wantErr: false,
-		},
 	}
 	for _, tt := range tests {
 		t.Run(tt.name, func(t *testing.T) {

api/v1beta2/awsmachinetemplate_webhook.go

@@ -186,6 +186,11 @@ func (r *AWSMachineTemplate) validateHostAllocation() field.ErrorList {
 		allErrs = append(allErrs, field.Forbidden(field.NewPath("spec.template.spec.hostID"), "hostID and dynamicHostAllocation are mutually exclusive"), field.Forbidden(field.NewPath("spec.template.spec.dynamicHostAllocation"), "hostID and dynamicHostAllocation are mutually exclusive"))
 	}
 
+	// When hostAffinity is "host", either hostID or dynamicHostAllocation must be specified
+	if spec.HostAffinity != nil && *spec.HostAffinity == "host" && !hasHostID && !hasDynamicHostAllocation {
+		allErrs = append(allErrs, field.Required(field.NewPath("spec.template.spec.hostID"), "hostID or dynamicHostAllocation must be set when hostAffinity is 'host'"))
+	}
+
 	return allErrs
 }
 

api/v1beta2/awsmachinetemplate_webhook_test.go

@@ -100,6 +100,70 @@ func TestAWSMachineTemplateValidateCreate(t *testing.T) {
 			},
 			wantError: true,
 		},
+		{
+			name: "hostAffinity=host requires hostID or dynamicHostAllocation",
+			inputTemplate: &AWSMachineTemplate{
+				ObjectMeta: metav1.ObjectMeta{},
+				Spec: AWSMachineTemplateSpec{
+					Template: AWSMachineTemplateResource{
+						Spec: AWSMachineSpec{
+							InstanceType: "test",
+							HostAffinity: ptr.To("host"),
+						},
+					},
+				},
+			},
+			wantError: true,
+		},
+		{
+			name: "hostAffinity=host with hostID is valid",
+			inputTemplate: &AWSMachineTemplate{
+				ObjectMeta: metav1.ObjectMeta{},
+				Spec: AWSMachineTemplateSpec{
+					Template: AWSMachineTemplateResource{
+						Spec: AWSMachineSpec{
+							InstanceType: "test",
+							HostAffinity: ptr.To("host"),
+							HostID:       ptr.To("h-09dcf61cb388b0149"),
+						},
+					},
+				},
+			},
+			wantError: false,
+		},
+		{
+			name: "hostAffinity=host with dynamicHostAllocation is valid",
+			inputTemplate: &AWSMachineTemplate{
+				ObjectMeta: metav1.ObjectMeta{},
+				Spec: AWSMachineTemplateSpec{
+					Template: AWSMachineTemplateResource{
+						Spec: AWSMachineSpec{
+							InstanceType: "test",
+							HostAffinity: ptr.To("host"),
+							DynamicHostAllocation: &DynamicHostAllocationSpec{
+								Tags: map[string]string{"env": "test"},
+							},
+						},
+					},
+				},
+			},
+			wantError: false,
+		},
+		{
+			name: "hostAffinity=default without hostID is valid",
+			inputTemplate: &AWSMachineTemplate{
+				ObjectMeta: metav1.ObjectMeta{},
+				Spec: AWSMachineTemplateSpec{
+					Template: AWSMachineTemplateResource{
+						Spec: AWSMachineSpec{
+							InstanceType: "test",
+							HostAffinity: ptr.To("default"),
+						},
+					},
+				},
+			},
+			wantError: false,
+		},
 	}
 	for _, tt := range tests {
 		t.Run(tt.name, func(t *testing.T) {

api/v1beta2/types.go

@@ -275,9 +275,12 @@ type Instance struct {
 	MarketType MarketType `json:"marketType,omitempty"`
 
 	// HostAffinity specifies the dedicated host affinity setting for the instance.
-	// When hostAffinity is set to host, an instance started onto a specific host always restarts on the same host if stopped.
-	// When hostAffinity is set to default, and you stop and restart the instance, it can be restarted on any available host.
-	// When HostAffinity is defined, HostID is required.
+	// When HostAffinity is set to "host", an instance started onto a specific host always restarts on the same host if stopped:
+	// - If HostID is set, the instance launches on the specific host and must return to that same host after any stop/start (Targeted & Pinned).
+	// - If HostID is not set, the instance gets launched on any available and must returns to the same host after any stop/start (Auto-placed & Pinned).
+	// When HostAffinity is set to "default" (the default value), the instance (when restarted) can return on any available host:
+	// - If HostID is set, the instance launches on the specified host now, but (when restarted) can return to any available hosts (Targeted & Flexible).
+	// - If HostID is not set, the instance launches on any available host now, and (when restarted) can return to any available hosts (Auto-placed & Flexible).
 	// +optional
 	// +kubebuilder:validation:Enum:=default;host
 	HostAffinity *string `json:"hostAffinity,omitempty"`