Skip to content
This repository has been archived by the owner on Nov 27, 2023. It is now read-only.

Introduce ECS emulation mode #544

Merged
merged 5 commits into from
Sep 1, 2020
Merged
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
1 change: 0 additions & 1 deletion cli/cmd/compose/up.go
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,6 @@ func upCommand() *cobra.Command {
upCmd.Flags().StringArrayVarP(&opts.ConfigPaths, "file", "f", []string{}, "Compose configuration files")
upCmd.Flags().StringArrayVarP(&opts.Environment, "environment", "e", []string{}, "Environment variables")
upCmd.Flags().BoolP("detach", "d", true, " Detached mode: Run containers in the background")

return upCmd
}

Expand Down
22 changes: 21 additions & 1 deletion cli/cmd/context/create_ecs.go
Original file line number Diff line number Diff line change
Expand Up @@ -38,24 +38,44 @@ $ docker context create ecs CONTEXT [flags]
}

func createEcsCommand() *cobra.Command {
var localSimulation bool
var opts ecs.ContextParams
cmd := &cobra.Command{
Use: "ecs CONTEXT [flags]",
Short: "Create a context for Amazon ECS",
Args: cobra.ExactArgs(1),
RunE: func(cmd *cobra.Command, args []string) error {
if localSimulation {
return runCreateLocalSimulation(cmd.Context(), args[0], opts)
}
return runCreateEcs(cmd.Context(), args[0], opts)
},
}

addDescriptionFlag(cmd, &opts.Description)
cmd.Flags().BoolVar(&localSimulation, "local-simulation", false, "Create context for ECS local simulation endpoints")
cmd.Flags().StringVar(&opts.Profile, "profile", "", "Profile")
cmd.Flags().StringVar(&opts.Region, "region", "", "Region")
cmd.Flags().StringVar(&opts.AwsID, "key-id", "", "AWS Access Key ID")
cmd.Flags().StringVar(&opts.AwsSecret, "secret-key", "", "AWS Secret Access Key")
return cmd
}

func runCreateLocalSimulation(ctx context.Context, contextName string, opts ecs.ContextParams) error {
if contextExists(ctx, contextName) {
return errors.Wrapf(errdefs.ErrAlreadyExists, "context %q", contextName)
}
cs, err := client.GetCloudService(ctx, store.EcsLocalSimulationContextType)
if err != nil {
return errors.Wrap(err, "cannot connect to ECS backend")
}
data, description, err := cs.CreateContextData(ctx, opts)
if err != nil {
return err
}
return createDockerContext(ctx, contextName, store.EcsLocalSimulationContextType, description, data)
}

func runCreateEcs(ctx context.Context, contextName string, opts ecs.ContextParams) error {
if contextExists(ctx, contextName) {
return errors.Wrapf(errdefs.ErrAlreadyExists, "context %q", contextName)
Expand All @@ -71,7 +91,7 @@ func runCreateEcs(ctx context.Context, contextName string, opts ecs.ContextParam
func getEcsContextData(ctx context.Context, opts ecs.ContextParams) (interface{}, string, error) {
cs, err := client.GetCloudService(ctx, store.EcsContextType)
if err != nil {
return nil, "", errors.Wrap(err, "cannot connect to AWS backend")
return nil, "", errors.Wrap(err, "cannot connect to ECS backend")
}
return cs.CreateContextData(ctx, opts)
}
6 changes: 4 additions & 2 deletions cli/main.go
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,8 @@ import (
"syscall"
"time"

"github.com/docker/compose-cli/cli/cmd/compose"
Copy link
Contributor

Choose a reason for hiding this comment

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

lol our imports are all borked


"github.com/docker/compose-cli/cli/cmd/logout"

"github.com/docker/compose-cli/errdefs"
Expand All @@ -38,12 +40,12 @@ import (
// Backend registrations
_ "github.com/docker/compose-cli/aci"
_ "github.com/docker/compose-cli/ecs"
_ "github.com/docker/compose-cli/ecs/local"
_ "github.com/docker/compose-cli/example"
_ "github.com/docker/compose-cli/local"
"github.com/docker/compose-cli/metrics"

"github.com/docker/compose-cli/cli/cmd"
"github.com/docker/compose-cli/cli/cmd/compose"
contextcmd "github.com/docker/compose-cli/cli/cmd/context"
"github.com/docker/compose-cli/cli/cmd/login"
"github.com/docker/compose-cli/cli/cmd/run"
Expand Down Expand Up @@ -121,12 +123,12 @@ func main() {
cmd.RmCommand(),
cmd.StartCommand(),
cmd.InspectCommand(),
compose.Command(),
login.Command(),
logout.Command(),
cmd.VersionCommand(version),
cmd.StopCommand(),
cmd.SecretCommand(),
compose.Command(),

// Place holders
cmd.EcsCommand(),
Expand Down
5 changes: 5 additions & 0 deletions context/store/store.go
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,11 @@ const (
// EcsContextType is the endpoint key in the context endpoints for an ECS
// backend
EcsContextType = "ecs"

// EcsLocalSimulationContextType is the endpoint key in the context endpoints for an ECS backend
// running local simulation endpoints
EcsLocalSimulationContextType = "ecs-local"

// AciContextType is the endpoint key in the context endpoints for an ACI
// backend
AciContextType = "aci"
Expand Down
3 changes: 1 addition & 2 deletions ecs/backend.go
Original file line number Diff line number Diff line change
Expand Up @@ -22,15 +22,14 @@ import (
"github.com/aws/aws-sdk-go/aws"
"github.com/aws/aws-sdk-go/aws/session"

"github.com/docker/compose-cli/secrets"

"github.com/docker/compose-cli/backend"
"github.com/docker/compose-cli/compose"
"github.com/docker/compose-cli/containers"
apicontext "github.com/docker/compose-cli/context"
"github.com/docker/compose-cli/context/cloud"
"github.com/docker/compose-cli/context/store"
"github.com/docker/compose-cli/errdefs"
"github.com/docker/compose-cli/secrets"
)

const backendType = store.EcsContextType
Expand Down
67 changes: 67 additions & 0 deletions ecs/local/backend.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,67 @@
/*
Copyright 2020 Docker, Inc.

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 local

import (
"context"

"github.com/docker/compose-cli/compose"
"github.com/docker/compose-cli/containers"
"github.com/docker/compose-cli/secrets"
"github.com/docker/docker/client"

"github.com/docker/compose-cli/backend"
"github.com/docker/compose-cli/context/cloud"
"github.com/docker/compose-cli/context/store"
)

const backendType = store.EcsLocalSimulationContextType

func init() {
backend.Register(backendType, backendType, service, getCloudService)
}

type ecsLocalSimulation struct {
moby *client.Client
}

func service(ctx context.Context) (backend.Service, error) {
apiClient, err := client.NewClientWithOpts(client.FromEnv)
if err != nil {
return nil, err
}

return &ecsLocalSimulation{
moby: apiClient,
}, nil
}

func getCloudService() (cloud.Service, error) {
return ecsLocalSimulation{}, nil
}

func (e ecsLocalSimulation) ContainerService() containers.Service {
return nil
}

func (e ecsLocalSimulation) SecretsService() secrets.Service {
return nil
}

func (e ecsLocalSimulation) ComposeService() compose.Service {
return e
}
145 changes: 145 additions & 0 deletions ecs/local/compose.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,145 @@
/*
Copyright 2020 Docker, Inc.

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 local

import (
ndeloof marked this conversation as resolved.
Show resolved Hide resolved
"bufio"
"bytes"
"context"
"fmt"
"io"
"os"
"os/exec"
"path/filepath"
"strings"

"github.com/docker/compose-cli/compose"
"github.com/docker/compose-cli/errdefs"

"github.com/aws/aws-sdk-go/aws"
"github.com/compose-spec/compose-go/types"
"github.com/pkg/errors"
"github.com/sanathkr/go-yaml"
"golang.org/x/mod/semver"
)

func (e ecsLocalSimulation) Up(ctx context.Context, project *types.Project) error {
cmd := exec.Command("docker-compose", "version", "--short")
b := bytes.Buffer{}
b.WriteString("v")
cmd.Stdout = bufio.NewWriter(&b)
err := cmd.Run()
if err != nil {
return errors.Wrap(err, "ECS simulation mode require Docker-compose 1.27")
}
version := semver.MajorMinor(strings.TrimSpace(b.String()))
if version == "" {
return fmt.Errorf("can't parse docker-compose version: %s", b.String())
}
if semver.Compare(version, "v1.27") < 0 {
return fmt.Errorf("ECS simulation mode require Docker-compose 1.27, found %s", version)
}

converted, err := e.Convert(ctx, project)
if err != nil {
return err
}

cmd = exec.Command("docker-compose", "--context", "default", "--project-directory", project.WorkingDir, "--project-name", project.Name, "-f", "-", "up")
cmd.Stdin = strings.NewReader(string(converted))
cmd.Stdout = os.Stdout
cmd.Stderr = os.Stderr
return cmd.Run()
}

func (e ecsLocalSimulation) Convert(ctx context.Context, project *types.Project) ([]byte, error) {
Copy link
Contributor

Choose a reason for hiding this comment

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

Maybe a unit test on the global Convert method ?
Regarding e2e tests, I would feel more confident if we could run a compose up/down in the CI in simulation mode, but this will require docker-compose available on top of the plain docker (and the right version) ; we need to check how to set this up, does not need to be a blocker for this PR

project.Networks["credentials_network"] = types.NetworkConfig{
Driver: "bridge",
Ipam: types.IPAMConfig{
Config: []*types.IPAMPool{
{
Subnet: "169.254.170.0/24",
Gateway: "169.254.170.1",
},
},
},
}

// On Windows, this directory can be found at "%UserProfile%\.aws"
home, err := os.UserHomeDir()
if err != nil {
return nil, err
}

for i, service := range project.Services {
service.Networks["credentials_network"] = &types.ServiceNetworkConfig{
Ipv4Address: fmt.Sprintf("169.254.170.%d", i+3),
}
service.DependsOn = append(service.DependsOn, "ecs-local-endpoints")
service.Environment["AWS_CONTAINER_CREDENTIALS_RELATIVE_URI"] = aws.String("/creds")
service.Environment["ECS_CONTAINER_METADATA_URI"] = aws.String("http://169.254.170.2/v3")
project.Services[i] = service
}

project.Services = append(project.Services, types.ServiceConfig{
Name: "ecs-local-endpoints",
Image: "amazon/amazon-ecs-local-container-endpoints",
Volumes: []types.ServiceVolumeConfig{
{
Type: types.VolumeTypeBind,
Source: "/var/run",
Target: "/var/run",
},
{
Type: types.VolumeTypeBind,
Source: filepath.Join(home, ".aws"),
Target: "/home/.aws",
},
},
Environment: map[string]*string{
"HOME": aws.String("/home"),
"AWS_PROFILE": aws.String("default"),
},
Networks: map[string]*types.ServiceNetworkConfig{
"credentials_network": {
Ipv4Address: "169.254.170.2",
},
},
})

delete(project.Networks, "default")
config := map[string]interface{}{
"services": project.Services,
"networks": project.Networks,
"volumes": project.Volumes,
"secrets": project.Secrets,
"configs": project.Configs,
}
return yaml.Marshal(config)
}

func (e ecsLocalSimulation) Down(ctx context.Context, projectName string) error {
return errors.Wrap(errdefs.ErrNotImplemented, "use docker-compose down")
}

func (e ecsLocalSimulation) Logs(ctx context.Context, projectName string, w io.Writer) error {
return errors.Wrap(errdefs.ErrNotImplemented, "use docker-compose logs")
}

func (e ecsLocalSimulation) Ps(ctx context.Context, projectName string) ([]compose.ServiceStatus, error) {
return nil, errors.Wrap(errdefs.ErrNotImplemented, "use docker-compose ps")
}
43 changes: 43 additions & 0 deletions ecs/local/context.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
/*
Copyright 2020 Docker, Inc.

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 local

import (
"context"

"github.com/docker/compose-cli/context/cloud"
"github.com/docker/compose-cli/ecs"
"github.com/docker/compose-cli/errdefs"
)

var _ cloud.Service = ecsLocalSimulation{}

func (e ecsLocalSimulation) Login(ctx context.Context, params interface{}) error {
return errdefs.ErrNotImplemented
}

func (e ecsLocalSimulation) Logout(ctx context.Context) error {
return errdefs.ErrNotImplemented
}

func (e ecsLocalSimulation) CreateContextData(ctx context.Context, params interface{}) (contextData interface{}, description string, err error) {
opts := params.(ecs.ContextParams)
if opts.Description == "" {
opts.Description = "ECS local endpoints"
}
return struct{}{}, opts.Description, nil
gtardif marked this conversation as resolved.
Show resolved Hide resolved
}
Loading