portainer/api/libcompose/compose_stack.go

package libcompose

import (
	"context"
	"path"
	"path/filepath"

	"github.com/portainer/libcompose/docker"
	"github.com/portainer/libcompose/docker/client"
	"github.com/portainer/libcompose/docker/ctx"
	"github.com/portainer/libcompose/lookup"
	"github.com/portainer/libcompose/project"
	"github.com/portainer/libcompose/project/options"
	"github.com/portainer/portainer"
)

// ComposeStackManager represents a service for managing compose stacks.
type ComposeStackManager struct {
	dataPath string
}

// NewComposeStackManager initializes a new ComposeStackManager service.
func NewComposeStackManager(dataPath string) *ComposeStackManager {
	return &ComposeStackManager{
		dataPath: dataPath,
	}
}

// Up will deploy a compose stack (equivalent of docker-compose up)
func (manager *ComposeStackManager) Up(stack *portainer.Stack, endpoint *portainer.Endpoint) error {
	clientFactory, err := client.NewDefaultFactory(client.Options{
		TLS:         endpoint.TLSConfig.TLS,
		TLSVerify:   endpoint.TLSConfig.TLSSkipVerify,
		Host:        endpoint.URL,
		TLSCAFile:   endpoint.TLSCACertPath,
		TLSCertFile: endpoint.TLSCertPath,
		TLSKeyFile:  endpoint.TLSKeyPath,
		APIVersion:  "1.24",
	})
	if err != nil {
		return err
	}

	composeFilePath := path.Join(stack.ProjectPath, stack.EntryPoint)
	proj, err := docker.NewProject(&ctx.Context{
		ConfigDir: manager.dataPath,
		Context: project.Context{
			ComposeFiles: []string{composeFilePath},
			EnvironmentLookup: &lookup.EnvfileLookup{
				Path: filepath.Join(stack.ProjectPath, ".env"),
			},
			ProjectName: stack.Name,
		},
		ClientFactory: clientFactory,
	}, nil)
	if err != nil {
		return err
	}

	return proj.Up(context.Background(), options.Up{})
}

// Down will shutdown a compose stack (equivalent of docker-compose down)
func (manager *ComposeStackManager) Down(stack *portainer.Stack, endpoint *portainer.Endpoint) error {
	clientFactory, err := client.NewDefaultFactory(client.Options{
		TLS:         endpoint.TLSConfig.TLS,
		TLSVerify:   endpoint.TLSConfig.TLSSkipVerify,
		Host:        endpoint.URL,
		TLSCAFile:   endpoint.TLSCACertPath,
		TLSCertFile: endpoint.TLSCertPath,
		TLSKeyFile:  endpoint.TLSKeyPath,
		APIVersion:  "1.24",
	})
	if err != nil {
		return err
	}

	composeFilePath := path.Join(stack.ProjectPath, stack.EntryPoint)
	proj, err := docker.NewProject(&ctx.Context{
		Context: project.Context{
			ComposeFiles: []string{composeFilePath},
			ProjectName:  stack.Name,
		},
		ClientFactory: clientFactory,
	}, nil)
	if err != nil {
		return err
	}

	return proj.Down(context.Background(), options.Down{RemoveVolume: false, RemoveOrphans: true})
}