docker_compose_stack.go

package exec

import (
	"context"

	"github.com/portainer/agent"
	libstack "github.com/portainer/portainer/pkg/libstack"
	"github.com/portainer/portainer/pkg/libstack/compose"
	"github.com/rs/zerolog/log"
)

// DockerComposeStackService represents a service for managing stacks by using the Docker binary.
type DockerComposeStackService struct {
	deployer libstack.Deployer
}

// NewDockerComposeStackService initializes a new DockerStackService service.
// It also updates the configuration of the Docker CLI binary.
func NewDockerComposeStackService(binaryPath string) (*DockerComposeStackService, error) {
	deployer, err := compose.NewComposeDeployer(binaryPath, "")
	if err != nil {
		return nil, err
	}

	service := &DockerComposeStackService{
		deployer: deployer,
	}

	return service, nil
}

// Deploy executes the docker stack deploy command.
func (service *DockerComposeStackService) Deploy(ctx context.Context, name string, filePaths []string, options agent.DeployOptions) error {

	if options.Task != "" {
		log.Debug().
			Str("task name", options.Task).
			Msg("Detected short lived task run")

		return service.deployer.Run(ctx, filePaths, options.Task, libstack.RunOptions{
			Options: libstack.Options{
				ProjectName: name,
				WorkingDir:  options.WorkingDir,
				Env:         options.Env,
			},
			Remove: true,
		})
	}

	return service.deployer.Deploy(ctx, filePaths, libstack.DeployOptions{
		Options: libstack.Options{
			ProjectName: name,
			WorkingDir:  options.WorkingDir,
			Env:         options.Env,
		},
	})
}

// Pull executes the docker pull command.
func (service *DockerComposeStackService) Pull(ctx context.Context, name string, filePaths []string, options agent.PullOptions) error {
	return service.deployer.Pull(ctx, filePaths, libstack.Options{
		ProjectName: name,
		WorkingDir:  options.WorkingDir,
		Env:         options.Env,
	})
}

// Remove executes the docker stack rm command.
func (service *DockerComposeStackService) Remove(ctx context.Context, name string, filePaths []string, options agent.RemoveOptions) error {
	return service.deployer.Remove(ctx, name, filePaths, libstack.Options{
		ProjectName: name,
		WorkingDir:  options.WorkingDir,
		Env:         options.Env,
	})
}

// Validate executes docker config command to validate file format
func (service *DockerComposeStackService) Validate(ctx context.Context, name string, filePaths []string, options agent.ValidateOptions) error {
	return service.deployer.Validate(ctx, filePaths, libstack.Options{
		WorkingDir: options.WorkingDir,
		Env:        options.Env,
	})
}

func (service *DockerComposeStackService) WaitForStatus(ctx context.Context, name string, status libstack.Status) <-chan string {
	return service.deployer.WaitForStatus(ctx, name, status)
}