Skip to content

Commit b06a96d

Browse files
Hsing-Hui HsuPettitWesley
authored andcommitted
Add --ecs-params flag to compose commands
1 parent 7dc7f46 commit b06a96d

6 files changed

Lines changed: 173 additions & 10 deletions

File tree

‎ecs-cli/modules/cli/compose/entity/entity_helper.go‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -58,6 +58,7 @@ func GetOrCreateTaskDefinition(entity ProjectEntity) (*ecs.TaskDefinition, error
5858
ContainerDefinitions: taskDefinition.ContainerDefinitions,
5959
Volumes: taskDefinition.Volumes,
6060
TaskRoleArn: taskDefinition.TaskRoleArn,
61+
NetworkMode: taskDefinition.NetworkMode,
6162
}, entity.TaskDefinitionCache())
6263

6364
if err != nil {

‎ecs-cli/modules/cli/compose/project/project.go‎

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -20,10 +20,10 @@ import (
2020
"github.com/aws/amazon-ecs-cli/ecs-cli/modules/cli/compose/entity/service"
2121
"github.com/aws/amazon-ecs-cli/ecs-cli/modules/cli/compose/entity/task"
2222

23+
"github.com/aws/amazon-ecs-cli/ecs-cli/modules/commands"
2324
"github.com/aws/amazon-ecs-cli/ecs-cli/modules/utils/compose"
2425
"github.com/docker/libcompose/config"
2526
"github.com/docker/libcompose/project"
26-
"github.com/aws/amazon-ecs-cli/ecs-cli/modules/commands"
2727
)
2828

2929
// Project is the starting point for the compose app to interact with and issue commands
@@ -130,15 +130,18 @@ func (p *ecsProject) parseCompose() error {
130130
return p.context.SetProjectName()
131131
}
132132

133-
// transformTaskDefinition converts the compose yml and ecs-fields yml into an ECS task definition
133+
// transformTaskDefinition converts the compose yml and ecs-params yml into an ECS task definition
134134
func (p *ecsProject) transformTaskDefinition() error {
135135
context := p.context
136136

137137
// convert to task definition
138138
logrus.Debug("Transforming yaml to task definition...")
139139
taskDefinitionName := utils.GetTaskDefinitionName(context.ECSParams.ComposeProjectNamePrefix, context.Context.ProjectName)
140+
140141
taskRoleArn := context.CLIContext.GlobalString(command.TaskRoleArnFlag)
141-
taskDefinition, err := utils.ConvertToTaskDefinition(taskDefinitionName, &context.Context, p.ServiceConfigs(), taskRoleArn)
142+
ecsParamsFileName := context.CLIContext.GlobalString(command.ECSParamsFileNameFlag)
143+
144+
taskDefinition, err := utils.ConvertToTaskDefinition(taskDefinitionName, &context.Context, p.ServiceConfigs(), taskRoleArn, ecsParamsFileName)
142145
if err != nil {
143146
return err
144147
}

‎ecs-cli/modules/commands/compose/compose_command.go‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,18 +32,22 @@ import (
3232
// ecs-cli compose create : creates ECS.TaskDefinition or gets from FS cache
3333
// ecs-cli compose start : invokes ECS.RunTask if count(running tasks) == 0
3434
// ecs-cli compose up : compose create ; compose start and does a deployment of new compose yml if changes were found
35+
//
3536
// List containers in or view details of the project:
3637
// ecs-cli compose ps : calls ECS.ListTasks (running and stopped) filtered with Task group: this project
38+
//
3739
// Modify containers
3840
// ecs-cli compose scale : calls ECS.RunTask/StopTask based on the count
3941
// ecs-cli compose run : calls ECS.RunTask with overrides
42+
//
4043
// Stop and delete the project
4144
// ecs-cli compose stop : calls ECS.StopTask and ECS deletes them (rm)
4245
//* --------------------------------------------------- */
4346

4447
const (
4548
composeFileNameDefaultValue = "docker-compose.yml"
4649
composeOverrideFileNameDefaultValue = "docker-compose.override.yml"
50+
ecsParamsFileNameDefaultValue = "ecs-params.yml"
4751
containerNameFlag = "name"
4852
)
4953

@@ -96,6 +100,10 @@ func composeFlags() []cli.Flag {
96100
Name: command.TaskRoleArnFlag,
97101
Usage: "[Optional] Specifies the short name or full Amazon Resource Name (ARN) of the IAM role that containers in this task can assume. All containers in this task are granted the permissions that are specified in this role.",
98102
},
103+
cli.StringFlag{
104+
Name: command.ECSParamsFileNameFlag,
105+
Usage: "[Optional] Specifies ecs-params file to use. Defaults to " + ecsParamsFileNameDefaultValue + " file, if one exists.",
106+
},
99107
}
100108
}
101109

‎ecs-cli/modules/commands/flags.go‎

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -63,9 +63,10 @@ const (
6363
UntaggedFlag = "untagged"
6464

6565
// Compose
66-
ProjectNameFlag = "project-name"
67-
ComposeFileNameFlag = "file"
68-
TaskRoleArnFlag = "task-role-arn"
66+
ProjectNameFlag = "project-name"
67+
ComposeFileNameFlag = "file"
68+
TaskRoleArnFlag = "task-role-arn"
69+
ECSParamsFileNameFlag = "ecs-params"
6970

7071
// Compose Service
7172
CreateServiceCommandName = "create"

‎ecs-cli/modules/utils/compose/convert_task_definition.go‎

Lines changed: 58 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,8 +15,8 @@ package utils
1515

1616
import (
1717
"encoding/json"
18-
"errors"
1918
"fmt"
19+
"os"
2020
"reflect"
2121
"strconv"
2222
"strings"
@@ -27,6 +27,9 @@ import (
2727
"github.com/docker/libcompose/config"
2828
"github.com/docker/libcompose/project"
2929
"github.com/docker/libcompose/yaml"
30+
"github.com/pkg/errors"
31+
goyaml "gopkg.in/yaml.v2"
32+
"io/ioutil"
3033
)
3134

3235
const (
@@ -49,6 +52,16 @@ var supportedComposeYamlOptions = []string{
4952

5053
var supportedComposeYamlOptionsMap = getSupportedComposeYamlOptionsMap()
5154

55+
type ECSParams struct {
56+
Version string
57+
TaskDefinition ecsTaskDef `yaml:"task_definition"`
58+
}
59+
60+
type ecsTaskDef struct {
61+
NetworkMode string `yaml:"ecs_network_mode"`
62+
TaskRoleArn string `yaml:"task_role_arn"`
63+
}
64+
5265
type volumes struct {
5366
volumeWithHost map[string]string
5467
volumeEmptyHost []string
@@ -64,7 +77,7 @@ func getSupportedComposeYamlOptionsMap() map[string]bool {
6477

6578
// ConvertToTaskDefinition transforms the yaml configs to its ecs equivalent (task definition)
6679
func ConvertToTaskDefinition(taskDefinitionName string, context *project.Context,
67-
serviceConfigs *config.ServiceConfigs, taskRoleArn string) (*ecs.TaskDefinition, error) {
80+
serviceConfigs *config.ServiceConfigs, taskRoleArn string, ecsParamsFileName string) (*ecs.TaskDefinition, error) {
6881

6982
if serviceConfigs.Len() == 0 {
7083
return nil, errors.New("cannot create a task definition with no containers; invalid service config")
@@ -92,15 +105,58 @@ func ConvertToTaskDefinition(taskDefinitionName string, context *project.Context
92105
containerDefinitions = append(containerDefinitions, containerDef)
93106
}
94107

108+
ecsParams, err := readECSParams(ecsParamsFileName)
109+
if err != nil {
110+
return nil, err
111+
}
112+
113+
var networkMode string
114+
if ecsParams != nil {
115+
networkMode = ecsParams.TaskDefinition.NetworkMode
116+
// The task-role-arn flag should take precedence over a taskRoleArn value specified in ECS fields file
117+
if taskRoleArn == "" {
118+
taskRoleArn = ecsParams.TaskDefinition.TaskRoleArn
119+
}
120+
}
121+
122+
if networkMode == "" {
123+
networkMode = "bridge"
124+
}
125+
95126
taskDefinition := &ecs.TaskDefinition{
96127
Family: aws.String(taskDefinitionName),
97128
ContainerDefinitions: containerDefinitions,
98129
Volumes: convertToECSVolumes(volumes),
99130
TaskRoleArn: aws.String(taskRoleArn),
131+
NetworkMode: aws.String(networkMode),
100132
}
133+
101134
return taskDefinition, nil
102135
}
103136

137+
func readECSParams(filename string) (*ECSParams, error) {
138+
if filename == "" {
139+
defaultFilename := "ecs-params.yml"
140+
if _, err := os.Stat(defaultFilename); err == nil {
141+
filename = defaultFilename
142+
} else {
143+
return nil, nil
144+
}
145+
}
146+
ecsParamsData, err := ioutil.ReadFile(filename)
147+
if err != nil {
148+
return nil, errors.Wrapf(err, "Error reading file '%v'", filename)
149+
}
150+
151+
ecsParams := &ECSParams{}
152+
153+
if err = goyaml.Unmarshal([]byte(ecsParamsData), &ecsParams); err != nil {
154+
return nil, errors.Wrapf(err, "Error unmarshalling yaml data from ECS params file: %v", filename)
155+
}
156+
157+
return ecsParams, nil
158+
}
159+
104160
// logUnsupportedConfigFields adds a WARNING to the customer about the fields that are unused.
105161
func logUnsupportedConfigFields(project *project.Project) {
106162
if project.VolumeConfigs != nil && len(project.VolumeConfigs) > 0 {

‎ecs-cli/modules/utils/compose/convert_task_definition_test.go‎

Lines changed: 96 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@ package utils
1515

1616
import (
1717
"fmt"
18+
"io/ioutil"
1819
"os"
1920
"reflect"
2021
"strconv"
@@ -114,6 +115,73 @@ func TestConvertToTaskDefinition(t *testing.T) {
114115
assert.Equal(t, taskRoleArn, aws.StringValue(taskDefinition.TaskRoleArn), "Expected taskRoleArn to match")
115116
}
116117

118+
func TestConvertToTaskDefinitionWithECSParams(t *testing.T) {
119+
ecsParamsString := `version: 1
120+
task_definition:
121+
ecs_network_mode: host
122+
task_role_arn: arn:aws:iam::123456789012:role/my_role`
123+
124+
content := []byte(ecsParamsString)
125+
126+
tmpfile, err := ioutil.TempFile("", "ecs-params")
127+
assert.NoError(t, err, "Could not create ecs fields tempfile")
128+
129+
defer os.Remove(tmpfile.Name())
130+
131+
_, err = tmpfile.Write(content)
132+
assert.NoError(t, err, "Could not write data to ecs fields tempfile")
133+
134+
err = tmpfile.Close()
135+
assert.NoError(t, err, "Could not close tempfile")
136+
137+
ecsParamsFileName := tmpfile.Name()
138+
139+
taskDefinition, err := convertToTaskDefWithEcsParamsInTest(t, "name", &config.ServiceConfig{}, "", ecsParamsFileName)
140+
141+
if assert.NoError(t, err) {
142+
assert.Equal(t, "host", aws.StringValue(taskDefinition.NetworkMode), "Expected network mode to match")
143+
assert.Equal(t, "arn:aws:iam::123456789012:role/my_role", aws.StringValue(taskDefinition.TaskRoleArn), "Expected task role ARN to match")
144+
}
145+
}
146+
147+
func TestConvertToTaskDefinitionWithECSParamsAndTaskRoleArnFlag(t *testing.T) {
148+
ecsParamsString := `version: 1
149+
task_definition:
150+
ecs_network_mode: host
151+
task_role_arn: arn:aws:iam::123456789012:role/tweedledee`
152+
153+
content := []byte(ecsParamsString)
154+
155+
tmpfile, err := ioutil.TempFile("", "ecs-params")
156+
assert.NoError(t, err, "Could not create ecs fields tempfile")
157+
158+
defer os.Remove(tmpfile.Name())
159+
160+
_, err = tmpfile.Write(content)
161+
assert.NoError(t, err, "Could not write data to ecs fields tempfile")
162+
163+
err = tmpfile.Close()
164+
assert.NoError(t, err, "Could not close tempfile")
165+
166+
ecsParamsFileName := tmpfile.Name()
167+
taskRoleArn := "arn:aws:iam::123456789012:role/tweedledum"
168+
169+
taskDefinition, err := convertToTaskDefWithEcsParamsInTest(t, "name", &config.ServiceConfig{}, taskRoleArn, ecsParamsFileName)
170+
171+
if assert.NoError(t, err) {
172+
assert.Equal(t, "host", aws.StringValue(taskDefinition.NetworkMode), "Expected network mode to match")
173+
assert.Equal(t, "arn:aws:iam::123456789012:role/tweedledum", aws.StringValue(taskDefinition.TaskRoleArn), "Expected task role arn to match")
174+
}
175+
}
176+
177+
func TestConvertToTaskDefinitionWithECSParamsWithNoSuchFileError(t *testing.T) {
178+
ecsParamsFileName := "ecs-params.yml"
179+
taskRoleArn := "arn:aws:iam::123456789012:role/tweedledum"
180+
181+
_, err := convertToTaskDefWithEcsParamsInTest(t, "name", &config.ServiceConfig{}, taskRoleArn, ecsParamsFileName)
182+
assert.Error(t, err)
183+
}
184+
117185
func TestConvertToTaskDefinitionWithDnsSearch(t *testing.T) {
118186
dnsSearchDomains := []string{"search.example.com"}
119187

@@ -531,13 +599,39 @@ func convertToTaskDefinitionInTest(t *testing.T, name string, serviceConfig *con
531599
EnvironmentLookup: envLookup,
532600
ResourceLookup: resourceLookup,
533601
}
534-
taskDefinition, err := ConvertToTaskDefinition(taskDefName, context, serviceConfigs, taskRoleArn)
602+
taskDefinition, err := ConvertToTaskDefinition(taskDefName, context, serviceConfigs, taskRoleArn, "")
535603
if err != nil {
536604
t.Errorf("Expected to convert [%v] serviceConfigs without errors. But got [%v]", serviceConfig, err)
537605
}
538606
return taskDefinition
539607
}
540608

609+
func convertToTaskDefWithEcsParamsInTest(t *testing.T, name string, serviceConfig *config.ServiceConfig, taskRoleArn string, ecsParamsFileName string) (*ecs.TaskDefinition, error) {
610+
serviceConfigs := config.NewServiceConfigs()
611+
serviceConfigs.Add(name, serviceConfig)
612+
613+
taskDefName := "ProjectName"
614+
envLookup, err := GetDefaultEnvironmentLookup()
615+
if err != nil {
616+
t.Fatal("Unexpected error setting up environment lookup")
617+
}
618+
resourceLookup, err := GetDefaultResourceLookup()
619+
if err != nil {
620+
t.Fatal("Unexpected error setting up resource lookup")
621+
}
622+
context := &project.Context{
623+
Project: &project.Project{},
624+
EnvironmentLookup: envLookup,
625+
ResourceLookup: resourceLookup,
626+
}
627+
taskDefinition, err := ConvertToTaskDefinition(taskDefName, context, serviceConfigs, taskRoleArn, ecsParamsFileName)
628+
if err != nil {
629+
return nil, err
630+
}
631+
632+
return taskDefinition, nil
633+
}
634+
541635
func TestIsZeroForEmptyConfig(t *testing.T) {
542636
serviceConfig := &config.ServiceConfig{}
543637

@@ -640,7 +734,7 @@ func TestMemReservationHigherThanMemLimit(t *testing.T) {
640734
EnvironmentLookup: envLookup,
641735
ResourceLookup: resourceLookup,
642736
}
643-
_, err = ConvertToTaskDefinition(taskDefName, context, serviceConfigs, "")
737+
_, err = ConvertToTaskDefinition(taskDefName, context, serviceConfigs, "", "")
644738
assert.EqualError(t, err, "mem_limit should not be less than mem_reservation")
645739
}
646740

0 commit comments

Comments
 (0)