Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Move IAM Service Account Tasks to actions package #7140

Closed
wants to merge 6 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions pkg/actions/addon/tasks.go
Original file line number Diff line number Diff line change
Expand Up @@ -119,15 +119,15 @@ type deleteAddonIAMTask struct {
func (t *deleteAddonIAMTask) Describe() string { return t.info }

func (t *deleteAddonIAMTask) Do(errorCh chan error) error {
defer close(errorCh)

errMsg := fmt.Sprintf("deleting addon IAM %q", *t.stack.StackName)
if t.wait {
if err := t.stackManager.DeleteStackBySpecSync(t.ctx, t.stack, errorCh); err != nil {
return fmt.Errorf("%s: %w", errMsg, err)
}
return nil
}

defer close(errorCh)
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Closing error channel to early here was nullifying the effect of the --wait flag

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It actually introduced a bug - #7177. Going to address it in a separate PR.

if _, err := t.stackManager.DeleteStackBySpec(t.ctx, t.stack); err != nil {
return fmt.Errorf("%s: %w", errMsg, err)
}
Expand Down
8 changes: 7 additions & 1 deletion pkg/actions/cluster/owned.go
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ import (
"github.com/kris-nova/logger"

"github.com/weaveworks/eksctl/pkg/actions/addon"
"github.com/weaveworks/eksctl/pkg/actions/irsa"
"github.com/weaveworks/eksctl/pkg/actions/nodegroup"
api "github.com/weaveworks/eksctl/pkg/apis/eksctl.io/v1alpha5"
"github.com/weaveworks/eksctl/pkg/cfn/manager"
Expand All @@ -27,6 +28,7 @@ type OwnedCluster struct {
stackManager manager.StackManager
newClientSet func() (kubernetes.Interface, error)
newNodeGroupManager func(cfg *api.ClusterConfig, ctl *eks.ClusterProvider, clientSet kubernetes.Interface) NodeGroupDrainer
newIRSARemover func(clientSetGetter kubernetes.ClientSetGetter, stackManager irsa.StackManager) irsa.DeleteTasksBuilder
}

func NewOwnedCluster(ctx context.Context, cfg *api.ClusterConfig, ctl *eks.ClusterProvider, clusterStack *manager.Stack, stackManager manager.StackManager) (*OwnedCluster, error) {
Expand All @@ -45,6 +47,9 @@ func NewOwnedCluster(ctx context.Context, cfg *api.ClusterConfig, ctl *eks.Clust
newNodeGroupManager: func(cfg *api.ClusterConfig, ctl *eks.ClusterProvider, clientSet kubernetes.Interface) NodeGroupDrainer {
return nodegroup.New(cfg, ctl, clientSet, instanceSelector)
},
newIRSARemover: func(clientSetGetter kubernetes.ClientSetGetter, stackManager irsa.StackManager) irsa.DeleteTasksBuilder {
return irsa.NewRemover(clientSetGetter, stackManager)
},
}, nil
}

Expand Down Expand Up @@ -121,7 +126,8 @@ func (c *OwnedCluster) Delete(ctx context.Context, _, podEvictionWaitPeriod time
return c.ctl.NewOpenIDConnectManager(ctx, c.cfg)
}
newTasksToDeleteAddonIAM := addon.NewRemover(c.stackManager).DeleteAddonIAMTasks
tasks, err := c.stackManager.NewTasksToDeleteClusterWithNodeGroups(ctx, c.clusterStack, allStacks, clusterOperable, newOIDCManager, newTasksToDeleteAddonIAM, c.ctl.Status.ClusterInfo.Cluster, kubernetes.NewCachedClientSet(clientSet), wait, force, func(errs chan error, _ string) error {
newTasksToDeleteIAMServiceAccounts := c.newIRSARemover(kubernetes.NewCachedClientSet(clientSet), c.stackManager).DeleteIAMServiceAccountsTasks
tasks, err := c.stackManager.NewTasksToDeleteClusterWithNodeGroups(ctx, c.clusterStack, allStacks, clusterOperable, newOIDCManager, newTasksToDeleteAddonIAM, newTasksToDeleteIAMServiceAccounts, c.ctl.Status.ClusterInfo.Cluster, wait, force, func(errs chan error, _ string) error {
logger.Info("trying to cleanup dangling network interfaces")
stack, err := c.stackManager.DescribeClusterStack(ctx)
if err != nil {
Expand Down
8 changes: 7 additions & 1 deletion pkg/actions/cluster/unowned.go
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ import (
"github.com/pkg/errors"

"github.com/weaveworks/eksctl/pkg/actions/addon"
"github.com/weaveworks/eksctl/pkg/actions/irsa"
"github.com/weaveworks/eksctl/pkg/actions/nodegroup"
api "github.com/weaveworks/eksctl/pkg/apis/eksctl.io/v1alpha5"
"github.com/weaveworks/eksctl/pkg/cfn/manager"
Expand All @@ -28,6 +29,7 @@ type UnownedCluster struct {
stackManager manager.StackManager
newClientSet func() (kubernetes.Interface, error)
newNodeGroupManager func(cfg *api.ClusterConfig, ctl *eks.ClusterProvider, clientSet kubernetes.Interface) NodeGroupDrainer
newIRSARemover func(clientSetGetter kubernetes.ClientSetGetter, stackManager irsa.StackManager) irsa.DeleteTasksBuilder
}

func NewUnownedCluster(ctx context.Context, cfg *api.ClusterConfig, ctl *eks.ClusterProvider, stackManager manager.StackManager) (*UnownedCluster, error) {
Expand All @@ -45,6 +47,9 @@ func NewUnownedCluster(ctx context.Context, cfg *api.ClusterConfig, ctl *eks.Clu
newNodeGroupManager: func(cfg *api.ClusterConfig, ctl *eks.ClusterProvider, clientSet kubernetes.Interface) NodeGroupDrainer {
return nodegroup.New(cfg, ctl, clientSet, instanceSelector)
},
newIRSARemover: func(clientSetGetter kubernetes.ClientSetGetter, stackManager irsa.StackManager) irsa.DeleteTasksBuilder {
return irsa.NewRemover(clientSetGetter, stackManager)
},
}, nil
}

Expand Down Expand Up @@ -174,7 +179,8 @@ func (c *UnownedCluster) deleteIAMAndOIDC(ctx context.Context, wait bool, cluste
newOIDCManager := func() (*iamoidc.OpenIDConnectManager, error) {
return c.ctl.NewOpenIDConnectManager(ctx, c.cfg)
}
serviceAccountAndOIDCTasks, err := c.stackManager.NewTasksToDeleteOIDCProviderWithIAMServiceAccounts(ctx, newOIDCManager, c.ctl.Status.ClusterInfo.Cluster, clientSetGetter, force)
newTasksToDeleteIAMServiceAccounts := c.newIRSARemover(clientSetGetter, c.stackManager).DeleteIAMServiceAccountsTasks
serviceAccountAndOIDCTasks, err := c.stackManager.NewTasksToDeleteOIDCProviderWithIAMServiceAccounts(ctx, newOIDCManager, newTasksToDeleteIAMServiceAccounts, c.ctl.Status.ClusterInfo.Cluster, force)
if err != nil {
return err
}
Expand Down
104 changes: 101 additions & 3 deletions pkg/actions/irsa/create.go
Original file line number Diff line number Diff line change
@@ -1,17 +1,115 @@
package irsa

import (
"context"
"fmt"

"github.com/kris-nova/logger"
"github.com/pkg/errors"
v1 "k8s.io/apimachinery/pkg/apis/meta/v1"

api "github.com/weaveworks/eksctl/pkg/apis/eksctl.io/v1alpha5"
iamoidc "github.com/weaveworks/eksctl/pkg/iam/oidc"
"github.com/weaveworks/eksctl/pkg/kubernetes"
"github.com/weaveworks/eksctl/pkg/utils/tasks"
)

func (a *Manager) CreateIAMServiceAccount(iamServiceAccounts []*api.ClusterIAMServiceAccount, plan bool) error {
taskTree := a.stackManager.NewTasksToCreateIAMServiceAccounts(iamServiceAccounts, a.oidcManager, kubernetes.NewCachedClientSet(a.clientSet))
var (
managedByKubernetesLabelKey = "app.kubernetes.io/managed-by"
managedByKubernetesLabelValue = "eksctl"
maybeCreateServiceAccountOrUpdateMetadata = kubernetes.MaybeCreateServiceAccountOrUpdateMetadata
)

//go:generate go run github.com/maxbrunsfeld/counterfeiter/v6 -generate
//counterfeiter:generate -o fakes/fake_create_tasks_builder.go . CreateTasksBuilder
type CreateTasksBuilder interface {
CreateIAMServiceAccountsTasks(ctx context.Context, serviceAccounts []*api.ClusterIAMServiceAccount) *tasks.TaskTree
}

type Creator struct {
clusterName string
region string

clientSetGetter kubernetes.ClientSetGetter
oidcManager *iamoidc.OpenIDConnectManager
stackManager StackManager
}

func NewCreator(
clusterName string,
region string,
clientSetGetter kubernetes.ClientSetGetter,
oidcManager *iamoidc.OpenIDConnectManager,
stackManager StackManager) *Creator {
return &Creator{
clusterName: clusterName,
region: region,
clientSetGetter: clientSetGetter,
oidcManager: oidcManager,
stackManager: stackManager,
}
}

func (c *Creator) CreateIAMServiceAccounts(ctx context.Context, serviceAccounts []*api.ClusterIAMServiceAccount, plan bool) error {
taskTree := c.CreateIAMServiceAccountsTasks(ctx, serviceAccounts)
taskTree.PlanMode = plan

err := doTasks(taskTree, actionCreate)

logPlanModeWarning(plan && len(iamServiceAccounts) > 0)
logPlanModeWarning(plan && len(serviceAccounts) > 0)

return err
}

func (c *Creator) CreateIAMServiceAccountsTasks(ctx context.Context, serviceAccounts []*api.ClusterIAMServiceAccount) *tasks.TaskTree {
taskTree := &tasks.TaskTree{Parallel: true}

for i := range serviceAccounts {
sa := serviceAccounts[i]
saTasks := &tasks.TaskTree{
Parallel: false,
IsSubTask: true,
}

if sa.AttachRoleARN == "" {
saTasks.Append(&createIAMRoleForServiceAccountTask{
ctx: ctx,
info: fmt.Sprintf("create IAM role for serviceaccount %q", sa.NameString()),
clusterName: c.clusterName,
region: c.region,
stackManager: c.stackManager,
sa: sa,
oidc: c.oidcManager,
})
} else {
logger.Debug("attachRoleARN was provided, skipping role creation")
sa.Status = &api.ClusterIAMServiceAccountStatus{
RoleARN: &sa.AttachRoleARN,
}
}

if sa.Labels == nil {
sa.Labels = make(map[string]string)
}
sa.Labels[managedByKubernetesLabelKey] = managedByKubernetesLabelValue
if !api.IsEnabled(sa.RoleOnly) {
saTasks.Append(&kubernetesTask{
info: fmt.Sprintf("create serviceaccount %q", sa.NameString()),
kubernetes: c.clientSetGetter,
objectMeta: sa.ClusterIAMMeta.AsObjectMeta(),
call: func(clientSet kubernetes.Interface, objectMeta v1.ObjectMeta) error {
sa.SetAnnotations()
objectMeta.SetAnnotations(sa.AsObjectMeta().Annotations)
objectMeta.SetLabels(sa.AsObjectMeta().Labels)
if err := maybeCreateServiceAccountOrUpdateMetadata(clientSet, objectMeta); err != nil {
return errors.Wrapf(err, "failed to create service account %s/%s", objectMeta.GetNamespace(), objectMeta.GetName())
}
return nil
},
})
}

taskTree.Append(saTasks)
}
return taskTree
}
97 changes: 97 additions & 0 deletions pkg/actions/irsa/create_test.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,97 @@
package irsa_test

import (
"context"

"github.com/aws/aws-sdk-go-v2/aws"
. "github.com/onsi/ginkgo/v2"

. "github.com/onsi/gomega"

"github.com/weaveworks/eksctl/pkg/actions/irsa"
api "github.com/weaveworks/eksctl/pkg/apis/eksctl.io/v1alpha5"
)

var _ = Describe("Create", func() {

Describe("CreateIAMServiceAccountsTasks", func() {
var (
clusterName = "test-cluster"
roleName = "test-role-name"
roleARN = "test-role-arn"
region = "us-west-2"
creator *irsa.Creator
)

BeforeEach(func() {
creator = irsa.NewCreator(clusterName, region, nil, nil, nil)
})

When("attachRoleARN is provided and RoleOnly is true", func() {
It("returns a empty tasktree", func() {
serviceAccounts := []*api.ClusterIAMServiceAccount{
{
RoleName: roleName,
AttachRoleARN: roleARN,
RoleOnly: aws.Bool(true),
},
}
taskTree := creator.CreateIAMServiceAccountsTasks(context.Background(), serviceAccounts)
Expect(taskTree.Parallel).To(Equal(true))
Expect(taskTree.IsSubTask).To(Equal(false))
Expect(len(taskTree.Tasks)).To(Equal(1))
Expect(taskTree.Tasks[0].Describe()).To(Equal("no tasks"))
})
})

When("attachRoleARN is provided and RoleOnly is false", func() {
It("returns a tasktree with all expected tasks", func() {
serviceAccounts := []*api.ClusterIAMServiceAccount{
{
RoleName: roleName,
AttachRoleARN: roleARN,
},
}
taskTree := creator.CreateIAMServiceAccountsTasks(context.Background(), serviceAccounts)
Expect(taskTree.Parallel).To(Equal(true))
Expect(taskTree.IsSubTask).To(Equal(false))
Expect(len(taskTree.Tasks)).To(Equal(1))
Expect(taskTree.Tasks[0].Describe()).To(ContainSubstring("create serviceaccount"))
})
})

When("attachRoleARN is not provided and RoleOnly is true", func() {
It("returns a tasktree with all expected tasks", func() {
serviceAccounts := []*api.ClusterIAMServiceAccount{
{
RoleName: roleName,
RoleOnly: aws.Bool(true),
},
}
taskTree := creator.CreateIAMServiceAccountsTasks(context.Background(), serviceAccounts)
Expect(taskTree.Parallel).To(Equal(true))
Expect(taskTree.IsSubTask).To(Equal(false))
Expect(len(taskTree.Tasks)).To(Equal(1))
Expect(taskTree.Tasks[0].Describe()).To(ContainSubstring("create IAM role for serviceaccount"))
})
})

When("attachRoleARN is not provided and RoleOnly is false", func() {
It("returns a tasktree with all expected tasks", func() {
serviceAccounts := []*api.ClusterIAMServiceAccount{
{
RoleName: roleName,
RoleOnly: aws.Bool(false),
},
}
taskTree := creator.CreateIAMServiceAccountsTasks(context.Background(), serviceAccounts)
Expect(taskTree.Parallel).To(Equal(true))
Expect(taskTree.IsSubTask).To(Equal(false))
Expect(len(taskTree.Tasks)).To(Equal(1))
Expect(taskTree.Tasks[0].Describe()).To(ContainSubstring("2 sequential sub-tasks"))
Expect(taskTree.Tasks[0].Describe()).To(ContainSubstring("create IAM role for serviceaccount"))
Expect(taskTree.Tasks[0].Describe()).To(ContainSubstring("create serviceaccount"))
})
})
})
})
Loading