Skip to content
This repository has been archived by the owner on Jan 8, 2024. It is now read-only.

Fix bring-your-own-alb for plugin/ecs #4457

Merged
merged 13 commits into from
Feb 1, 2023
Merged

Fix bring-your-own-alb for plugin/ecs #4457

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
13 commits
Select commit Hold shift + click to select a range
cd2d5d5
Allow bringing your own alb listener
izaaklauer Jan 25, 2023
82374c2
changelog
izaaklauer Jan 25, 2023
a011631
docs
izaaklauer Jan 25, 2023
8f6f0e5
First pass at removing the alb listener as input
izaaklauer Jan 26, 2023
5254429
Allowing bring-your-own-alb for ecs
izaaklauer Jan 27, 2023
13444be
Changelog and docs
izaaklauer Jan 27, 2023
ec027df
Always setting listener config, as we manage the listener.
izaaklauer Jan 27, 2023
dec90fd
Allowing successful "releases" when deployments don't use an alb.
izaaklauer Jan 27, 2023
6470259
Fixing changelog number
izaaklauer Jan 27, 2023
c090257
Update builtin/aws/ecs/platform.go
izaaklauer Jan 27, 2023
42da790
Removing listener_arn field
izaaklauer Jan 27, 2023
d75b0b6
Fixing tests
izaaklauer Jan 27, 2023
a99fff4
Allow users to bring their own alb _and_ specify a cert
izaaklauer Jan 27, 2023
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
81 changes: 43 additions & 38 deletions builtin/aws/ecs/platform.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -690,7 +690,7 @@ func (p *Platform) resourceServiceCreate(
deploymentId DeploymentId,
state *Resource_Service,

// Outputs of other resource creation processes
// Outputs of other resource creation processes
taskDefinition *Resource_TaskDefinition,
cluster *Resource_Cluster,
targetGroup *Resource_TargetGroup,
Expand Down Expand Up @@ -1054,7 +1054,7 @@ func (p *Platform) resourceAlbListenerCreate(
}
log.Info("load-balancer defined", "dns-name", alb.DnsName)

s.Update("Looking for listeners for ALB %q", alb.Name)
s.Update("Looking for listeners for ALB %q", alb.Arn)
Copy link
Contributor Author

Choose a reason for hiding this comment

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

The name might not be defined if the user specified an arn.

listeners, err := elbsrv.DescribeListenersWithContext(ctx, &elbv2.DescribeListenersInput{
LoadBalancerArn: &alb.Arn,
})
Expand Down Expand Up @@ -1367,7 +1367,7 @@ func (p *Platform) resourceTaskDefinitionCreate(
deployConfig *component.DeploymentConfig,
state *Resource_TaskDefinition,

// Outputs of other resource creation processes
// Outputs of other resource creation processes
executionRole *Resource_ExecutionRole,
taskRole *Resource_TaskRole,
logGroup *Resource_LogGroup,
Expand Down Expand Up @@ -1628,24 +1628,28 @@ func (p *Platform) resourceAlbCreate(
subnets *Resource_AlbSubnets, // Required because we need to know which VPC we're in, and subnets discover it.
state *Resource_Alb,
) error {
s := sg.Add("Initiating ALB creation")
defer s.Abort()

if p.config.DisableALB {
log.Debug("ALB disabled - skipping target group creation")
s.Update("ALB disabled - skipping ALB")
s.Done()
return nil
}

albConfig := p.config.ALB

if albConfig != nil && albConfig.ListenerARN != "" {
log.Debug("Existing ALB listener specified - no need to create or discover an ALB")
if albConfig != nil && albConfig.LoadBalancerArn != "" {
s.Update("Existing ALB specified - no need to create or discover an ALB")
s.Done()
state.Managed = false
state.Arn = albConfig.LoadBalancerArn
return nil
}

// If not using an existing listener, the load balancer is owned by waypoint
state.Managed = true

s := sg.Add("Initiating ALB creation")
defer s.Abort()

var certs []*elbv2.Certificate
if albConfig != nil && albConfig.CertificateId != "" {
certs = append(certs, &elbv2.Certificate{
Expand Down Expand Up @@ -1701,6 +1705,16 @@ func (p *Platform) resourceAlbCreate(
Subnets: subnetIds,
SecurityGroups: securityGroupIds,
Scheme: &scheme,
Tags: []*elbv2.Tag{
{
Key: aws.String("waypoint_managed"),
Value: aws.String("true"),
},
{
Key: aws.String("waypoint_app"),
Value: aws.String(src.App),
},
},
})
if err != nil {
return status.Errorf(codes.Internal, "failed to create ALB %q: %s", lbName, err)
Expand Down Expand Up @@ -2497,34 +2511,29 @@ func (p *Platform) loadResourceManagerState(
}
rm.Resource("target group").SetState(&targetGroupResource)

// Restore state of ALB listener. Difficult because it may only be defined on the load balancer.
// Restore state of ALB listener by inspecting the load balancer
var listenerResource Resource_Alb_Listener
listenerResource.TargetGroup = &targetGroupResource
if p.config.ALB != nil && p.config.ALB.ListenerARN != "" {
listenerResource.Arn = p.config.ALB.ListenerARN
listenerResource.Managed = false
log.Debug("Using existing listener", "arn", listenerResource.Arn)
} else {
listenerResource.Managed = true
s.Update("Describing load balancer %s", deployment.LoadBalancerArn)
sess, err := p.getSession(log)
if err != nil {
return status.Errorf(codes.Internal, "failed to get aws session: %s", err)
}
elbsrv := elbv2.New(sess)

listeners, err := elbsrv.DescribeListenersWithContext(ctx, &elbv2.DescribeListenersInput{
LoadBalancerArn: &deployment.LoadBalancerArn,
})
if err != nil {
return status.Errorf(codes.Internal, "failed to describe listeners for ALB %q: %s", deployment.LoadBalancerArn, err)
}
if len(listeners.Listeners) == 0 {
s.Update("No listeners found for ALB %q", deployment.LoadBalancerArn)
} else {
listenerResource.Arn = *listeners.Listeners[0].ListenerArn
s.Update("Found existing listener (ARN: %q)", listenerResource.Arn)
}
listenerResource.Managed = false // Impossible to know now if we created this initially, so this is the safe choice
s.Update("Describing load balancer %s", deployment.LoadBalancerArn)
sess, err := p.getSession(log)
if err != nil {
return status.Errorf(codes.Internal, "failed to get aws session: %s", err)
}
elbsrv := elbv2.New(sess)

listeners, err := elbsrv.DescribeListenersWithContext(ctx, &elbv2.DescribeListenersInput{
LoadBalancerArn: &deployment.LoadBalancerArn,
})
if err != nil {
return status.Errorf(codes.Internal, "failed to describe listeners for ALB %q: %s", deployment.LoadBalancerArn, err)
}
if len(listeners.Listeners) == 0 {
s.Update("No listeners found for ALB %q", deployment.LoadBalancerArn)
} else {
listenerResource.Arn = *listeners.Listeners[0].ListenerArn
s.Update("Found existing listener (ARN: %q)", listenerResource.Arn)
}
rm.Resource("alb listener").SetState(&listenerResource)

Expand Down Expand Up @@ -2614,10 +2623,6 @@ type ALBConfig struct {
// Fully qualified domain name of the record to create in the target zone id
FQDN string `hcl:"domain_name,optional"`

// When set, waypoint will configure the target group into the specified
// ALB Listener ARN. This allows for usage of existing ALBs.
ListenerARN string `hcl:"listener_arn,optional"`

// When set, waypoint will configure the target group into the load balancer.
// This allows for usage of existing ALBs.
LoadBalancerArn string `hcl:"load_balancer_arn"`
Expand Down
14 changes: 1 addition & 13 deletions embedJson/gen/platform-aws-ecs.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -370,23 +370,11 @@
"Example": "",
"SubFields": null
},
{
"Field": "listener_arn",
"Type": "string",
"Synopsis": "",
"Summary": "",
"Optional": true,
"Default": "",
"EnvVar": "",
"Category": false,
"Example": "",
"SubFields": null
},
{
"Field": "load_balancer_arn",
"Type": "string",
"Synopsis": "the ARN on an existing ALB to configure",
"Summary": "when this is set, Waypoint will use this ALB instead of creating it's own. A target group will still be created for each deployment, and will be added to a listener on the configured ALB port (Waypoint will the listener if it doesn't exist). This allows users to configure their ALB outside Waypoint but still have Waypoint hook the application to that ALB",
"Summary": "when this is set, Waypoint will use this ALB instead of creating its own. A target group will still be created for each deployment, and will be added to a listener on the configured ALB port (Waypoint will the listener if it doesn't exist). This allows users to configure their ALB outside Waypoint but still have Waypoint hook the application to that ALB",
"Optional": false,
"Default": "",
"EnvVar": "",
Expand Down
7 changes: 1 addition & 6 deletions website/content/partials/components/platform-aws-ecs.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,16 +60,11 @@ Used when listener_arn is not set. If set, the created ALB will have a scheme of
- Type: **bool**
- **Optional**

##### alb.listener_arn

- Type: **string**
- **Optional**

##### alb.load_balancer_arn

The ARN on an existing ALB to configure.

When this is set, Waypoint will use this ALB instead of creating it's own. A target group will still be created for each deployment, and will be added to a listener on the configured ALB port (Waypoint will the listener if it doesn't exist). This allows users to configure their ALB outside Waypoint but still have Waypoint hook the application to that ALB.
When this is set, Waypoint will use this ALB instead of creating its own. A target group will still be created for each deployment, and will be added to a listener on the configured ALB port (Waypoint will the listener if it doesn't exist). This allows users to configure their ALB outside Waypoint but still have Waypoint hook the application to that ALB.

- Type: **string**

Expand Down