feat: add healthcheck path to app manifest

Closes #597.

internal/pkg/deploy/cloudformation/stack/lb_fargate_app.go

@@ -31,6 +31,7 @@ const (
 	LBFargateParamContainerImageKey = "ContainerImage"
 	LBFargateParamContainerPortKey  = "ContainerPort"
 	LBFargateRulePathKey            = "RulePath"
+	LBFargateHealthCheckPathKey     = "HealthCheckPath"
 	LBFargateTaskCPUKey             = "TaskCPU"
 	LBFargateTaskMemoryKey          = "TaskMemory"
 	LBFargateTaskCountKey           = "TaskCount"
@@ -141,6 +142,10 @@ func (c *LBFargateStackConfig) Parameters() []*cloudformation.Parameter {
 			ParameterKey:   aws.String(LBFargateRulePathKey),
 			ParameterValue: aws.String(templateParams.App.Path),
 		},
+		{
+			ParameterKey:   aws.String(LBFargateHealthCheckPathKey),
+			ParameterValue: aws.String(templateParams.App.HealthCheckPath),
+		},
 		{
 			ParameterKey:   aws.String(LBFargateTaskCPUKey),
 			ParameterValue: aws.String(strconv.Itoa(templateParams.App.CPU)),

internal/pkg/deploy/cloudformation/stack/lb_fargate_app_test.go

@@ -292,6 +292,10 @@ func TestLBFargateStackConfig_Parameters(t *testing.T) {
 					ParameterKey:   aws.String(LBFargateRulePathKey),
 					ParameterValue: aws.String("frontend"),
 				},
+				{
+					ParameterKey:   aws.String(LBFargateHealthCheckPathKey),
+					ParameterValue: aws.String("/"),
+				},
 				{
 					ParameterKey:   aws.String(LBFargateTaskCPUKey),
 					ParameterValue: aws.String("256"),

internal/pkg/manifest/lb_fargate_manifest.go

@@ -56,6 +56,7 @@ type LogsConfig struct {
 // RoutingRule holds the path to route requests to the service.
 type RoutingRule struct {
 	Path string `yaml:"path"`
+	HealthCheckPath string `yaml:"healthcheck"`
 }
 
 // AutoScalingConfig is the configuration to scale the service with target tracking scaling policies.
@@ -74,8 +75,10 @@ type LBFargateManifestProps struct {
 	Port uint16
 }
 
-// NewLoadBalancedFargateManifest creates a new public load balanced web service with an exposed port of 80, receives
-// all the requests from the load balancer and has a single task with minimal CPU and Memory thresholds.
+// NewLoadBalancedFargateManifest creates a new public load balanced web
+// service, receives all the requests from the load balancer, has a single task
+// with minimal CPU and Memory thresholds, and sets the default health check
+// path to "/"
 func NewLoadBalancedFargateManifest(input *LBFargateManifestProps) *LBFargateManifest {
 	return &LBFargateManifest{
 		AppManifest: AppManifest{
@@ -91,6 +94,7 @@ func NewLoadBalancedFargateManifest(input *LBFargateManifestProps) *LBFargateMan
 		LBFargateConfig: LBFargateConfig{
 			RoutingRule: RoutingRule{
 				Path: input.Path,
+				HealthCheckPath: "/",
 			},
 			ContainersConfig: ContainersConfig{
 				CPU:    256,
@@ -146,6 +150,7 @@ func (m *LBFargateManifest) EnvConf(envName string) LBFargateConfig {
 	conf := LBFargateConfig{
 		RoutingRule: RoutingRule{
 			Path: m.Path,
+			HealthCheckPath: m.HealthCheckPath,
 		},
 		ContainersConfig: ContainersConfig{
 			CPU:       m.CPU,
@@ -162,6 +167,9 @@ func (m *LBFargateManifest) EnvConf(envName string) LBFargateConfig {
 	if target.RoutingRule.Path != "" {
 		conf.RoutingRule.Path = target.RoutingRule.Path
 	}
+	if target.RoutingRule.HealthCheckPath != "" {
+		conf.RoutingRule.HealthCheckPath = target.RoutingRule.HealthCheckPath
+	}
 	if target.CPU != 0 {
 		conf.CPU = target.CPU
 	}

internal/pkg/manifest/lb_fargate_manifest_test.go

@@ -70,7 +70,10 @@ func TestLBFargateManifest_EnvConf(t *testing.T) {
 	}{
 		"with no existing environments": {
 			inDefaultConfig: LBFargateConfig{
-				RoutingRule: RoutingRule{Path: "/awards/*"},
+				RoutingRule: RoutingRule{
+					Path: "/awards/*",
+					HealthCheckPath: "/",
+				},
 				ContainersConfig: ContainersConfig{
 					CPU:    1024,
 					Memory: 1024,
@@ -80,7 +83,10 @@ func TestLBFargateManifest_EnvConf(t *testing.T) {
 			inEnvNameToQuery: "prod-iad",
 
 			wantedConfig: LBFargateConfig{
-				RoutingRule: RoutingRule{Path: "/awards/*"},
+				RoutingRule: RoutingRule{
+					Path: "/awards/*",
+					HealthCheckPath: "/",
+				},
 				ContainersConfig: ContainersConfig{
 					CPU:    1024,
 					Memory: 1024,
@@ -90,7 +96,10 @@ func TestLBFargateManifest_EnvConf(t *testing.T) {
 		},
 		"with partial overrides": {
 			inDefaultConfig: LBFargateConfig{
-				RoutingRule: RoutingRule{Path: "/awards/*"},
+				RoutingRule: RoutingRule{
+					Path: "/awards/*",
+					HealthCheckPath: "/",
+				},
 				ContainersConfig: ContainersConfig{
 					CPU:    1024,
 					Memory: 1024,
@@ -127,7 +136,10 @@ func TestLBFargateManifest_EnvConf(t *testing.T) {
 			},
 
 			wantedConfig: LBFargateConfig{
-				RoutingRule: RoutingRule{Path: "/awards/*"},
+				RoutingRule: RoutingRule{
+					Path: "/awards/*",
+					HealthCheckPath: "/",
+				},
 				ContainersConfig: ContainersConfig{
 					CPU:    2046,
 					Memory: 1024,
@@ -150,7 +162,10 @@ func TestLBFargateManifest_EnvConf(t *testing.T) {
 		},
 		"with complete override": {
 			inDefaultConfig: LBFargateConfig{
-				RoutingRule: RoutingRule{Path: "/awards/*"},
+				RoutingRule: RoutingRule{
+					Path: "/awards/*",
+					HealthCheckPath: "/",
+				},
 				ContainersConfig: ContainersConfig{
 					CPU:    1024,
 					Memory: 1024,
@@ -166,7 +181,10 @@ func TestLBFargateManifest_EnvConf(t *testing.T) {
 			inEnvNameToQuery: "prod-iad",
 			inEnvOverride: map[string]LBFargateConfig{
 				"prod-iad": {
-					RoutingRule: RoutingRule{Path: "/frontend*"},
+					RoutingRule: RoutingRule{
+						Path: "/frontend*",
+						HealthCheckPath: "/healthcheck",
+					},
 					ContainersConfig: ContainersConfig{
 						CPU:    2046,
 						Memory: 2046,
@@ -190,7 +208,10 @@ func TestLBFargateManifest_EnvConf(t *testing.T) {
 			},
 
 			wantedConfig: LBFargateConfig{
-				RoutingRule: RoutingRule{Path: "/frontend*"},
+				RoutingRule: RoutingRule{
+					Path: "/frontend*",
+					HealthCheckPath: "/healthcheck",
+				},
 				ContainersConfig: ContainersConfig{
 					CPU:    2046,
 					Memory: 2046,

templates/lb-fargate-service/cf.yml

@@ -41,6 +41,9 @@ Parameters:
     Description: 'URL of the addons nested stack template within the S3 bucket.'
     Type: String
     Default: ""
+  HealthCheckPath:
+    Type: String
+    Default: '{{.App.HealthCheckPath}}'
 Conditions:
   HTTPLoadBalancer:
     !Not
@@ -275,6 +278,7 @@ Resources:
       HealthCheckIntervalSeconds: 10 # Default is 30.
       HealthyThresholdCount: 2       # Default is 5.
       HealthCheckTimeoutSeconds: 5
+      HealthCheckPath: !Ref HealthCheckPath
       Port: !Ref ContainerPort
       Protocol: HTTP
       TargetGroupAttributes:

templates/lb-fargate-service/manifest.yml

@@ -16,6 +16,8 @@ image:
 http:
   # Requests to this path will be forwarded to your service.
   path: '{{.Path}}'
+  # # You can specify a custom health check path. The default is "/"
+  # healthcheck: '{{.HealthCheckPath}}'
 
 # Number of CPU units for the task.
 cpu: {{.CPU}}

templates/lb-fargate-service/params.json

@@ -11,7 +11,8 @@
     "TaskCount": "{{.App.Count}}",
     "HTTPSEnabled": "{{.HTTPSEnabled}}",
     "LogRetention": "30",
-    "AddonsTemplateURL": ""
+    "AddonsTemplateURL": "",
+    "HealthCheckPath": "{{.App.HealthCheckPath}}"
   },
   "Tags": {
     "ecs-project": "{{.Env.Project}}",