Merge pull request #16936 from justinsb/filter_instance_groups

k8s-ci-robot · web-flow · commit 763d3919c9ab · 2024-11-09T20:56:43.000Z
Allow updating the cluster one instance group at a time
diff --git a/cmd/kops/update_cluster.go b/cmd/kops/update_cluster.go
@@ -27,13 +27,15 @@ import (
 
 	"github.com/spf13/cobra"
 	"github.com/spf13/viper"
+	"k8s.io/apimachinery/pkg/util/sets"
 	"k8s.io/client-go/tools/clientcmd"
 	"k8s.io/klog/v2"
 	"k8s.io/kops/cmd/kops/util"
 	"k8s.io/kops/pkg/apis/kops"
 	"k8s.io/kops/pkg/assets"
 	"k8s.io/kops/pkg/commands/commandutils"
 	"k8s.io/kops/pkg/kubeconfig"
+	"k8s.io/kops/pkg/predicates"
 	"k8s.io/kops/upup/pkg/fi"
 	"k8s.io/kops/upup/pkg/fi/cloudup"
 	"k8s.io/kops/upup/pkg/fi/utils"
@@ -75,6 +77,14 @@ type UpdateClusterOptions struct {
 	user          string
 	internal      bool
 
+	// InstanceGroups is the list of instance groups to update;
+	// if not specified, all instance groups will be updated
+	InstanceGroups []string
+
+	// InstanceGroupRoles is the list of roles we should update
+	// if not specified, all instance groups will be updated
+	InstanceGroupRoles []string
+
 	Phase string
 
 	// LifecycleOverrides is a slice of taskName=lifecycle name values.  This slice is used
@@ -106,6 +116,11 @@ func NewCmdUpdateCluster(f *util.Factory, out io.Writer) *cobra.Command {
 	options := &UpdateClusterOptions{}
 	options.InitDefaults()
 
+	allRoles := make([]string, 0, len(kops.AllInstanceGroupRoles))
+	for _, r := range kops.AllInstanceGroupRoles {
+		allRoles = append(allRoles, r.ToLowerString())
+	}
+
 	cmd := &cobra.Command{
 		Use:               "cluster [CLUSTER]",
 		Short:             updateClusterShort,
@@ -132,6 +147,12 @@ func NewCmdUpdateCluster(f *util.Factory, out io.Writer) *cobra.Command {
 	cmd.RegisterFlagCompletionFunc("user", completeKubecfgUser)
 	cmd.Flags().BoolVar(&options.internal, "internal", options.internal, "Use the cluster's internal DNS name. Implies --create-kube-config")
 	cmd.Flags().BoolVar(&options.AllowKopsDowngrade, "allow-kops-downgrade", options.AllowKopsDowngrade, "Allow an older version of kOps to update the cluster than last used")
+	cmd.Flags().StringSliceVar(&options.InstanceGroups, "instance-group", options.InstanceGroups, "Instance groups to update (defaults to all if not specified)")
+	cmd.RegisterFlagCompletionFunc("instance-group", completeInstanceGroup(f, &options.InstanceGroups, &options.InstanceGroupRoles))
+	cmd.Flags().StringSliceVar(&options.InstanceGroupRoles, "instance-group-roles", options.InstanceGroupRoles, "Instance group roles to update ("+strings.Join(allRoles, ",")+")")
+	cmd.RegisterFlagCompletionFunc("instance-group-roles", func(cmd *cobra.Command, args []string, toComplete string) ([]string, cobra.ShellCompDirective) {
+		return sets.NewString(allRoles...).Delete(options.InstanceGroupRoles...).List(), cobra.ShellCompDirectiveNoFileComp
+	})
 	cmd.Flags().StringVar(&options.Phase, "phase", options.Phase, "Subset of tasks to run: "+strings.Join(cloudup.Phases.List(), ", "))
 	cmd.RegisterFlagCompletionFunc("phase", func(cmd *cobra.Command, args []string, toComplete string) ([]string, cobra.ShellCompDirective) {
 		return cloudup.Phases.List(), cobra.ShellCompDirectiveNoFileComp
@@ -285,24 +306,32 @@ func RunUpdateCluster(ctx context.Context, f *util.Factory, out io.Writer, c *Up
 		lifecycleOverrideMap[taskName] = lifecycleOverride
 	}
 
+	var instanceGroupFilters []predicates.Predicate[*kops.InstanceGroup]
+	if len(c.InstanceGroups) != 0 {
+		instanceGroupFilters = append(instanceGroupFilters, matchInstanceGroupNames(c.InstanceGroups))
+	} else if len(c.InstanceGroupRoles) != 0 {
+		instanceGroupFilters = append(instanceGroupFilters, matchInstanceGroupRoles(c.InstanceGroupRoles))
+	}
+
 	cloud, err := cloudup.BuildCloud(cluster)
 	if err != nil {
 		return nil, err
 	}
 
 	applyCmd := &cloudup.ApplyClusterCmd{
-		Cloud:              cloud,
-		Clientset:          clientset,
-		Cluster:            cluster,
-		DryRun:             isDryrun,
-		AllowKopsDowngrade: c.AllowKopsDowngrade,
-		RunTasksOptions:    &c.RunTasksOptions,
-		OutDir:             c.OutDir,
-		Phase:              phase,
-		TargetName:         targetName,
-		LifecycleOverrides: lifecycleOverrideMap,
-		GetAssets:          c.GetAssets,
-		DeletionProcessing: deletionProcessing,
+		Cloud:               cloud,
+		Clientset:           clientset,
+		Cluster:             cluster,
+		DryRun:              isDryrun,
+		AllowKopsDowngrade:  c.AllowKopsDowngrade,
+		RunTasksOptions:     &c.RunTasksOptions,
+		OutDir:              c.OutDir,
+		InstanceGroupFilter: predicates.AllOf(instanceGroupFilters...),
+		Phase:               phase,
+		TargetName:          targetName,
+		LifecycleOverrides:  lifecycleOverrideMap,
+		GetAssets:           c.GetAssets,
+		DeletionProcessing:  deletionProcessing,
 	}
 
 	applyResults, err := applyCmd.Run(ctx)
@@ -518,3 +547,31 @@ func completeLifecycleOverrides(cmd *cobra.Command, args []string, toComplete st
 	}
 	return completions, cobra.ShellCompDirectiveNoFileComp
 }
+
+// matchInstanceGroupNames returns a predicate that matches instance groups by name
+func matchInstanceGroupNames(names []string) predicates.Predicate[*kops.InstanceGroup] {
+	return func(ig *kops.InstanceGroup) bool {
+		for _, name := range names {
+			if ig.ObjectMeta.Name == name {
+				return true
+			}
+		}
+		return false
+	}
+}
+
+// matchInstanceGroupRoles returns a predicate that matches instance groups by role
+func matchInstanceGroupRoles(roles []string) predicates.Predicate[*kops.InstanceGroup] {
+	return func(ig *kops.InstanceGroup) bool {
+		for _, role := range roles {
+			instanceGroupRole, ok := kops.ParseInstanceGroupRole(role, true)
+			if !ok {
+				continue
+			}
+			if ig.Spec.Role == instanceGroupRole {
+				return true
+			}
+		}
+		return false
+	}
+}
diff --git a/docs/cli/kops_update_cluster.md b/docs/cli/kops_update_cluster.md
diff --git a/pkg/model/awsmodel/autoscalinggroup_test.go b/pkg/model/awsmodel/autoscalinggroup_test.go
@@ -65,9 +65,10 @@ func TestRootVolumeOptimizationFlag(t *testing.T) {
 	b := AutoscalingGroupModelBuilder{
 		AWSModelContext: &AWSModelContext{
 			KopsModelContext: &model.KopsModelContext{
-				IAMModelContext: iam.IAMModelContext{Cluster: cluster},
-				SSHPublicKeys:   k,
-				InstanceGroups:  igs,
+				IAMModelContext:   iam.IAMModelContext{Cluster: cluster},
+				SSHPublicKeys:     k,
+				AllInstanceGroups: igs,
+				InstanceGroups:    igs,
 			},
 		},
 		BootstrapScriptBuilder: &model.BootstrapScriptBuilder{
@@ -177,15 +178,17 @@ func TestAPIServerAdditionalSecurityGroupsWithNLB(t *testing.T) {
 	b := AutoscalingGroupModelBuilder{
 		AWSModelContext: &AWSModelContext{
 			KopsModelContext: &model.KopsModelContext{
-				IAMModelContext: iam.IAMModelContext{Cluster: cluster},
-				SSHPublicKeys:   [][]byte{[]byte(sshPublicKeyEntry)},
-				InstanceGroups:  igs,
+				IAMModelContext:   iam.IAMModelContext{Cluster: cluster},
+				SSHPublicKeys:     [][]byte{[]byte(sshPublicKeyEntry)},
+				AllInstanceGroups: igs,
+				InstanceGroups:    igs,
 			},
 		},
 		BootstrapScriptBuilder: &model.BootstrapScriptBuilder{
 			KopsModelContext: &model.KopsModelContext{
-				IAMModelContext: iam.IAMModelContext{Cluster: cluster},
-				InstanceGroups:  igs,
+				IAMModelContext:   iam.IAMModelContext{Cluster: cluster},
+				AllInstanceGroups: igs,
+				InstanceGroups:    igs,
 			},
 			Lifecycle: fi.LifecycleSync,
 		},
diff --git a/pkg/model/awsmodel/iam.go b/pkg/model/awsmodel/iam.go
@@ -65,7 +65,7 @@ func (b *IAMModelBuilder) Build(c *fi.CloudupModelBuilderContext) error {
 
 	// Collect Instance Profile ARNs and their associated Instance Group roles
 	sharedProfileARNsToIGRole := make(map[string]kops.InstanceGroupRole)
-	for _, ig := range b.InstanceGroups {
+	for _, ig := range b.AllInstanceGroups {
 		if ig.Spec.IAM != nil && ig.Spec.IAM.Profile != nil {
 			specProfile := fi.ValueOf(ig.Spec.IAM.Profile)
 			if matchingRole, ok := sharedProfileARNsToIGRole[specProfile]; ok {
diff --git a/pkg/model/azuremodel/testing.go b/pkg/model/azuremodel/testing.go
@@ -32,8 +32,9 @@ func newTestAzureModelContext() *AzureModelContext {
 			IAMModelContext: iam.IAMModelContext{
 				Cluster: cluster,
 			},
-			InstanceGroups: []*kops.InstanceGroup{ig},
-			SSHPublicKeys:  [][]byte{[]byte("ssh-rsa ...")},
+			AllInstanceGroups: []*kops.InstanceGroup{ig},
+			InstanceGroups:    []*kops.InstanceGroup{ig},
+			SSHPublicKeys:     [][]byte{[]byte("ssh-rsa ...")},
 		},
 	}
 }
diff --git a/pkg/model/bootstrapscript_test.go b/pkg/model/bootstrapscript_test.go
@@ -170,8 +170,9 @@ func TestBootstrapUserData(t *testing.T) {
 
 		bs := &BootstrapScriptBuilder{
 			KopsModelContext: &KopsModelContext{
-				IAMModelContext: iam.IAMModelContext{Cluster: cluster},
-				InstanceGroups:  []*kops.InstanceGroup{group},
+				IAMModelContext:   iam.IAMModelContext{Cluster: cluster},
+				AllInstanceGroups: []*kops.InstanceGroup{group},
+				InstanceGroups:    []*kops.InstanceGroup{group},
 			},
 			NodeUpConfigBuilder: &nodeupConfigBuilder{cluster: cluster},
 			NodeUpAssets: map[architectures.Architecture]*assets.MirroredAsset{
diff --git a/pkg/model/components/etcdmanager/model_test.go b/pkg/model/components/etcdmanager/model_test.go
@@ -81,8 +81,9 @@ func LoadKopsModelContext(basedir string) (*model.KopsModelContext, error) {
 	}
 
 	kopsContext := &model.KopsModelContext{
-		IAMModelContext: iam.IAMModelContext{Cluster: spec.Cluster},
-		InstanceGroups:  spec.InstanceGroups,
+		IAMModelContext:   iam.IAMModelContext{Cluster: spec.Cluster},
+		AllInstanceGroups: spec.InstanceGroups,
+		InstanceGroups:    spec.InstanceGroups,
 	}
 
 	return kopsContext, nil
diff --git a/pkg/model/components/kubeapiserver/model_test.go b/pkg/model/components/kubeapiserver/model_test.go
@@ -74,8 +74,9 @@ func LoadKopsModelContext(basedir string) (*model.KopsModelContext, error) {
 	}
 
 	kopsContext := &model.KopsModelContext{
-		IAMModelContext: iam.IAMModelContext{Cluster: spec.Cluster},
-		InstanceGroups:  spec.InstanceGroups,
+		IAMModelContext:   iam.IAMModelContext{Cluster: spec.Cluster},
+		AllInstanceGroups: spec.InstanceGroups,
+		InstanceGroups:    spec.InstanceGroups,
 	}
 
 	return kopsContext, nil
diff --git a/pkg/model/components/kubescheduler/model_test.go b/pkg/model/components/kubescheduler/model_test.go
@@ -77,8 +77,9 @@ func LoadKopsModelContext(basedir string) (*model.KopsModelContext, error) {
 	}
 
 	kopsContext := &model.KopsModelContext{
-		IAMModelContext: iam.IAMModelContext{Cluster: spec.Cluster},
-		InstanceGroups:  spec.InstanceGroups,
+		IAMModelContext:   iam.IAMModelContext{Cluster: spec.Cluster},
+		AllInstanceGroups: spec.InstanceGroups,
+		InstanceGroups:    spec.InstanceGroups,
 	}
 
 	for _, u := range spec.AdditionalObjects {
diff --git a/pkg/model/context.go b/pkg/model/context.go
@@ -47,9 +47,18 @@ const (
 // KopsModelContext is the kops model
 type KopsModelContext struct {
 	iam.IAMModelContext
+
+	// AllInstanceGroups is the list of instance groups in the cluster.
+	// Generally most tasks should use InstanceGroups instead,
+	// but we sometimes need the full list for example when configuring cluster-wide IAM.
+	AllInstanceGroups []*kops.InstanceGroup
+
+	// InstanceGroups is the list of instance groups in the cluster that are being processed.
+	// This is a filtered list of AllInstanceGroups.
 	InstanceGroups []*kops.InstanceGroup
-	Region         string
-	SSHPublicKeys  [][]byte
+
+	Region        string
+	SSHPublicKeys [][]byte
 
 	// AdditionalObjects holds cluster-asssociated configuration objects, other than the Cluster and InstanceGroups.
 	AdditionalObjects kubemanifest.ObjectList
@@ -92,7 +101,7 @@ func (b *KopsModelContext) GatherSubnets(ig *kops.InstanceGroup) ([]*kops.Cluste
 
 // FindInstanceGroup returns the instance group with the matching Name (or nil if not found)
 func (b *KopsModelContext) FindInstanceGroup(name string) *kops.InstanceGroup {
-	for _, ig := range b.InstanceGroups {
+	for _, ig := range b.AllInstanceGroups {
 		if ig.ObjectMeta.Name == name {
 			return ig
 		}
diff --git a/pkg/model/openstackmodel/servergroup_test.go b/pkg/model/openstackmodel/servergroup_test.go
@@ -1531,9 +1531,10 @@ func createBuilderForCluster(cluster *kops.Cluster, instanceGroups []*kops.Insta
 	sshPublicKey := []byte("ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQDF2sghZsClUBXJB4mBMIw8rb0hJWjg1Vz4eUeXwYmTdi92Gf1zNc5xISSip9Y+PWX/jJokPB7tgPnMD/2JOAKhG1bi4ZqB15pYRmbbBekVpM4o4E0dx+czbqjiAm6wlccTrINK5LYenbucAAQt19eH+D0gJwzYUK9SYz1hWnlGS+qurt2bz7rrsG73lN8E2eiNvGtIXqv3GabW/Hea3acOBgCUJQWUDTRu0OmmwxzKbFN/UpNKeRaHlCqwZWjVAsmqA8TX8LIocq7Np7MmIBwt7EpEeZJxThcmC8DEJs9ClAjD+jlLIvMPXKC3JWCPgwCLGxHjy7ckSGFCSzbyPduh")
 
 	modelContext := &model.KopsModelContext{
-		IAMModelContext: iam.IAMModelContext{Cluster: cluster},
-		InstanceGroups:  instanceGroups,
-		SSHPublicKeys:   [][]byte{sshPublicKey},
+		IAMModelContext:   iam.IAMModelContext{Cluster: cluster},
+		AllInstanceGroups: instanceGroups,
+		InstanceGroups:    instanceGroups,
+		SSHPublicKeys:     [][]byte{sshPublicKey},
 	}
 	openstackModelContext := &OpenstackModelContext{
 		KopsModelContext: modelContext,
@@ -1569,8 +1570,9 @@ func RunGoldenTest(t *testing.T, basedir string, testCase serverGroupModelBuilde
 	clusterLifecycle := fi.LifecycleSync
 	bootstrapScriptBuilder := &model.BootstrapScriptBuilder{
 		KopsModelContext: &model.KopsModelContext{
-			IAMModelContext: iam.IAMModelContext{Cluster: testCase.cluster},
-			InstanceGroups:  testCase.instanceGroups,
+			IAMModelContext:   iam.IAMModelContext{Cluster: testCase.cluster},
+			AllInstanceGroups: testCase.instanceGroups,
+			InstanceGroups:    testCase.instanceGroups,
 		},
 		NodeUpConfigBuilder: &nodeupConfigBuilder{},
 		NodeUpAssets: map[architectures.Architecture]*assets.MirroredAsset{
diff --git a/pkg/predicates/function.go b/pkg/predicates/function.go
@@ -0,0 +1,47 @@
+/*
+Copyright 2024 The Kubernetes Authors.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
+package predicates
+
+// Predicate is a predicate function for a type.
+type Predicate[T any] func(T) bool
+
+// AllOf returns a predicate that is true if all of the given predicates are true.
+func AllOf[T any](predicates ...Predicate[T]) Predicate[T] {
+	return func(t T) bool {
+		for _, predicate := range predicates {
+			if !predicate(t) {
+				return false
+			}
+		}
+		return true
+	}
+}
+
+// Filter returns a slice of elements that match the predicate.
+func Filter[T any](slice []T, predicate Predicate[T]) []T {
+	if predicate == nil {
+		return slice
+	}
+
+	var result []T
+	for _, element := range slice {
+		if predicate(element) {
+			result = append(result, element)
+		}
+	}
+	return result
+}
diff --git a/upup/pkg/fi/cloudup/apply_cluster.go b/upup/pkg/fi/cloudup/apply_cluster.go
diff --git a/upup/pkg/fi/cloudup/bootstrapchannelbuilder_test.go b/upup/pkg/fi/cloudup/bootstrapchannelbuilder_test.go
diff --git a/upup/pkg/fi/cloudup/template_functions.go b/upup/pkg/fi/cloudup/template_functions.go

Original file line number	Diff line number	Diff line change
`@@ -32,8 +32,9 @@ func newTestAzureModelContext() *AzureModelContext {`
`32`	`32`	`IAMModelContext: iam.IAMModelContext{`
`33`	`33`	`Cluster: cluster,`
`34`	`34`	`},`
`35`		`- InstanceGroups: []*kops.InstanceGroup{ig},`
`36`		`- SSHPublicKeys: [][]byte{[]byte("ssh-rsa ...")},`
	`35`	`+ AllInstanceGroups: []*kops.InstanceGroup{ig},`
	`36`	`+ InstanceGroups: []*kops.InstanceGroup{ig},`
	`37`	`+ SSHPublicKeys: [][]byte{[]byte("ssh-rsa ...")},`
`37`	`38`	`},`
`38`	`39`	`}`
`39`	`40`	`}`
Original file line number	Diff line number	Diff line change
`@@ -81,8 +81,9 @@ func LoadKopsModelContext(basedir string) (*model.KopsModelContext, error) {`
`81`	`81`	`}`
`82`	`82`
`83`	`83`	`kopsContext := &model.KopsModelContext{`
`84`		`- IAMModelContext: iam.IAMModelContext{Cluster: spec.Cluster},`
`85`		`- InstanceGroups: spec.InstanceGroups,`
	`84`	`+ IAMModelContext: iam.IAMModelContext{Cluster: spec.Cluster},`
	`85`	`+ AllInstanceGroups: spec.InstanceGroups,`
	`86`	`+ InstanceGroups: spec.InstanceGroups,`
`86`	`87`	`}`
`87`	`88`
`88`	`89`	`return kopsContext, nil`
Original file line number	Diff line number	Diff line change
`@@ -74,8 +74,9 @@ func LoadKopsModelContext(basedir string) (*model.KopsModelContext, error) {`
`74`	`74`	`}`
`75`	`75`
`76`	`76`	`kopsContext := &model.KopsModelContext{`
`77`		`- IAMModelContext: iam.IAMModelContext{Cluster: spec.Cluster},`
`78`		`- InstanceGroups: spec.InstanceGroups,`
	`77`	`+ IAMModelContext: iam.IAMModelContext{Cluster: spec.Cluster},`
	`78`	`+ AllInstanceGroups: spec.InstanceGroups,`
	`79`	`+ InstanceGroups: spec.InstanceGroups,`
`79`	`80`	`}`
`80`	`81`
`81`	`82`	`return kopsContext, nil`
Original file line number	Diff line number	Diff line change
`@@ -77,8 +77,9 @@ func LoadKopsModelContext(basedir string) (*model.KopsModelContext, error) {`
`77`	`77`	`}`
`78`	`78`
`79`	`79`	`kopsContext := &model.KopsModelContext{`
`80`		`- IAMModelContext: iam.IAMModelContext{Cluster: spec.Cluster},`
`81`		`- InstanceGroups: spec.InstanceGroups,`
	`80`	`+ IAMModelContext: iam.IAMModelContext{Cluster: spec.Cluster},`
	`81`	`+ AllInstanceGroups: spec.InstanceGroups,`
	`82`	`+ InstanceGroups: spec.InstanceGroups,`
`82`	`83`	`}`
`83`	`84`
`84`	`85`	`for _, u := range spec.AdditionalObjects {`