Added a different style of defining processes and using option all

Author: Skarlso

config/crd/bases/infrastructure.cluster.x-k8s.io_awsmachinepools.yaml

@@ -851,26 +851,31 @@ spec:
                   for the given ASG. This is constantly reconciled. If a process is
                   removed from this list it will automatically be resumed.
                 properties:
-                  addToLoadBalancer:
-                    type: boolean
-                  alarmNotification:
-                    type: boolean
                   all:
                     type: boolean
-                  azRebalance:
-                    type: boolean
-                  healthCheck:
-                    type: boolean
-                  instanceRefresh:
-                    type: boolean
-                  launch:
-                    type: boolean
-                  replaceUnhealthy:
-                    type: boolean
-                  scheduledActions:
-                    type: boolean
-                  terminate:
-                    type: boolean
+                  processes:
+                    description: Processes defines the processes which can be enabled
+                      or disabled individually.
+                    properties:
+                      addToLoadBalancer:
+                        type: boolean
+                      alarmNotification:
+                        type: boolean
+                      azRebalance:
+                        type: boolean
+                      healthCheck:
+                        type: boolean
+                      instanceRefresh:
+                        type: boolean
+                      launch:
+                        type: boolean
+                      replaceUnhealthy:
+                        type: boolean
+                      scheduledActions:
+                        type: boolean
+                      terminate:
+                        type: boolean
+                    type: object
                 type: object
             required:
             - awsLaunchTemplate

docs/book/src/topics/suspend-asg-processes.md

@@ -26,9 +26,10 @@ spec:
     instanceType: "${AWS_CONTROL_PLANE_MACHINE_TYPE}"
     sshKeyName: "${AWS_SSH_KEY_NAME}"  
   suspendProcesses:
-    launch: true
-    alarmNotification: true
-    azRebalance: true
+    processes:
+        launch: true
+        alarmNotification: true
+        azRebalance: true
 ---
 ```
 
@@ -52,7 +53,8 @@ spec:
     instanceType: "${AWS_CONTROL_PLANE_MACHINE_TYPE}"
     sshKeyName: "${AWS_SSH_KEY_NAME}"  
   suspendProcesses:
-    launch: true
+    processes:
+      launch: true
 ---
 ```
 
@@ -80,3 +82,24 @@ spec:
   suspendProcesses:
     all: true
 ```
+
+To exclude individual processes from `all` simply add them with value `false`:
+
+```yaml
+apiVersion: infrastructure.cluster.x-k8s.io/v1beta2
+kind: AWSMachinePool
+metadata:
+  name: capa-mp-0
+spec:
+  minSize: 1
+  maxSize: 10
+  availabilityZones:
+    - "${AWS_AVAILABILITY_ZONE}"
+  awsLaunchTemplate:
+    instanceType: "${AWS_CONTROL_PLANE_MACHINE_TYPE}"
+    sshKeyName: "${AWS_SSH_KEY_NAME}"  
+  suspendProcesses:
+    all: true
+    processes:
+      launch: false
+```

exp/api/v1beta2/awsmachinepool_types.go

@@ -93,33 +93,43 @@ type AWSMachinePoolSpec struct {
 
 // SuspendProcessesTypes contains user friendly auto-completable values for suspended process names.
 type SuspendProcessesTypes struct {
-	All               bool `json:"all,omitempty"`
-	Launch            bool `json:"launch,omitempty"`
-	Terminate         bool `json:"terminate,omitempty"`
-	AddToLoadBalancer bool `json:"addToLoadBalancer,omitempty"`
-	AlarmNotification bool `json:"alarmNotification,omitempty"`
-	AZRebalance       bool `json:"azRebalance,omitempty"`
-	HealthCheck       bool `json:"healthCheck,omitempty"`
-	InstanceRefresh   bool `json:"instanceRefresh,omitempty"`
-	ReplaceUnhealthy  bool `json:"replaceUnhealthy,omitempty"`
-	ScheduledActions  bool `json:"scheduledActions,omitempty"`
+	All       bool       `json:"all,omitempty"`
+	Processes *Processes `json:"processes,omitempty"`
+}
+
+// Processes defines the processes which can be enabled or disabled individually.
+type Processes struct {
+	Launch            *bool `json:"launch,omitempty"`
+	Terminate         *bool `json:"terminate,omitempty"`
+	AddToLoadBalancer *bool `json:"addToLoadBalancer,omitempty"`
+	AlarmNotification *bool `json:"alarmNotification,omitempty"`
+	AZRebalance       *bool `json:"azRebalance,omitempty"`
+	HealthCheck       *bool `json:"healthCheck,omitempty"`
+	InstanceRefresh   *bool `json:"instanceRefresh,omitempty"`
+	ReplaceUnhealthy  *bool `json:"replaceUnhealthy,omitempty"`
+	ScheduledActions  *bool `json:"scheduledActions,omitempty"`
 }
 
 // ConvertSetValuesToStringSlice converts all the values that are set into a string slice for further processing.
 func (s *SuspendProcessesTypes) ConvertSetValuesToStringSlice() []string {
 	if s == nil {
 		return nil
 	}
-	e := reflect.ValueOf(s).Elem()
 
+	if s.Processes == nil {
+		s.Processes = &Processes{}
+	}
+
+	e := reflect.ValueOf(s.Processes).Elem()
 	var result []string
 	for i := 0; i < e.NumField(); i++ {
 		if s.All {
-			if e.Type().Field(i).Name == "All" {
+			if !e.Field(i).IsNil() && !*e.Field(i).Interface().(*bool) {
+				// don't enable if explicitly set to false.
 				continue
 			}
 			result = append(result, e.Type().Field(i).Name)
-		} else if e.Field(i).Bool() {
+		} else if !e.Field(i).IsNil() && *e.Field(i).Interface().(*bool) {
 			result = append(result, e.Type().Field(i).Name)
 		}
 	}

exp/api/v1beta2/zz_generated.deepcopy.go

@@ -253,8 +253,10 @@ func TestAWSMachinePoolReconciler(t *testing.T) {
 			setSuspendedProcesses := func(t *testing.T, g *WithT) {
 				t.Helper()
 				ms.AWSMachinePool.Spec.SuspendProcesses = &expinfrav1.SuspendProcessesTypes{
-					Launch:    true,
-					Terminate: true,
+					Processes: &expinfrav1.Processes{
+						Launch:    pointer.Bool(true),
+						Terminate: pointer.Bool(true),
+					},
 				}
 			}
 			t.Run("it should suspend these processes", func(t *testing.T) {
@@ -304,6 +306,34 @@ func TestAWSMachinePoolReconciler(t *testing.T) {
 					"ScheduledActions",
 				}).Return(nil).AnyTimes()
 
+				_, err := reconciler.reconcileNormal(context.Background(), ms, cs, cs)
+				g.Expect(err).To(Succeed())
+			})
+			t.Run("and one or more processes are disabled, it should not list those", func(t *testing.T) {
+				g := NewWithT(t)
+				setup(t, g)
+				defer teardown(t, g)
+				setSuspendedProcesses(t, g)
+				ms.AWSMachinePool.Spec.SuspendProcesses.Processes = &expinfrav1.Processes{
+					Launch:      pointer.Bool(false),
+					AZRebalance: pointer.Bool(true), // this should still be included but not twice...
+				}
+				ec2Svc.EXPECT().ReconcileLaunchTemplate(gomock.Any(), gomock.Any(), gomock.Any()).Return(nil)
+				asgSvc.EXPECT().GetASGByName(gomock.Any()).Return(nil, nil)
+				asgSvc.EXPECT().CreateASG(gomock.Any()).Return(&expinfrav1.AutoScalingGroup{
+					Name: "name",
+				}, nil)
+				asgSvc.EXPECT().SuspendProcesses("name", []string{
+					"Terminate",
+					"AddToLoadBalancer",
+					"AlarmNotification",
+					"AZRebalance",
+					"HealthCheck",
+					"InstanceRefresh",
+					"ReplaceUnhealthy",
+					"ScheduledActions",
+				}).Return(nil).AnyTimes()
+
 				_, err := reconciler.reconcileNormal(context.Background(), ms, cs, cs)
 				g.Expect(err).To(Succeed())
 			})
@@ -313,8 +343,10 @@ func TestAWSMachinePoolReconciler(t *testing.T) {
 				t.Helper()
 
 				ms.AWSMachinePool.Spec.SuspendProcesses = &expinfrav1.SuspendProcessesTypes{
-					Launch:    true,
-					Terminate: true,
+					Processes: &expinfrav1.Processes{
+						Launch:    pointer.Bool(true),
+						Terminate: pointer.Bool(true),
+					},
 				}
 			}
 			t.Run("it should suspend and resume processes that are desired to be suspended and desired to be resumed", func(t *testing.T) {
@@ -624,8 +656,10 @@ func TestASGNeedsUpdates(t *testing.T) {
 								Overrides: nil,
 							},
 							SuspendProcesses: &expinfrav1.SuspendProcessesTypes{
-								Launch:    true,
-								Terminate: true,
+								Processes: &expinfrav1.Processes{
+									Launch:    pointer.Bool(true),
+									Terminate: pointer.Bool(true),
+								},
 							},
 						},
 					},