2021-07-21 01:56:28 +00:00
|
|
|
package exec
|
|
|
|
|
|
|
|
import (
|
2021-09-06 07:58:26 +00:00
|
|
|
"context"
|
2021-07-21 01:56:28 +00:00
|
|
|
"fmt"
|
2021-12-21 00:45:05 +00:00
|
|
|
"io"
|
2021-07-21 01:56:28 +00:00
|
|
|
"os"
|
|
|
|
"path"
|
|
|
|
"strings"
|
|
|
|
|
2021-08-17 01:12:07 +00:00
|
|
|
"github.com/pkg/errors"
|
2021-09-06 07:58:26 +00:00
|
|
|
|
|
|
|
libstack "github.com/portainer/docker-compose-wrapper"
|
|
|
|
"github.com/portainer/docker-compose-wrapper/compose"
|
|
|
|
|
2021-07-21 01:56:28 +00:00
|
|
|
portainer "github.com/portainer/portainer/api"
|
|
|
|
"github.com/portainer/portainer/api/http/proxy"
|
|
|
|
"github.com/portainer/portainer/api/http/proxy/factory"
|
2021-11-01 11:01:03 +00:00
|
|
|
"github.com/portainer/portainer/api/internal/stackutils"
|
2021-07-21 01:56:28 +00:00
|
|
|
)
|
|
|
|
|
|
|
|
// ComposeStackManager is a wrapper for docker-compose binary
|
|
|
|
type ComposeStackManager struct {
|
2021-09-06 07:58:26 +00:00
|
|
|
deployer libstack.Deployer
|
2021-07-21 01:56:28 +00:00
|
|
|
proxyManager *proxy.Manager
|
|
|
|
}
|
|
|
|
|
|
|
|
// NewComposeStackManager returns a docker-compose wrapper if corresponding binary present, otherwise nil
|
|
|
|
func NewComposeStackManager(binaryPath string, configPath string, proxyManager *proxy.Manager) (*ComposeStackManager, error) {
|
2021-09-06 07:58:26 +00:00
|
|
|
deployer, err := compose.NewComposeDeployer(binaryPath, configPath)
|
2021-07-21 01:56:28 +00:00
|
|
|
if err != nil {
|
|
|
|
return nil, err
|
|
|
|
}
|
|
|
|
|
|
|
|
return &ComposeStackManager{
|
2021-09-06 07:58:26 +00:00
|
|
|
deployer: deployer,
|
2021-07-21 01:56:28 +00:00
|
|
|
proxyManager: proxyManager,
|
|
|
|
}, nil
|
|
|
|
}
|
|
|
|
|
|
|
|
// ComposeSyntaxMaxVersion returns the maximum supported version of the docker compose syntax
|
2021-09-06 07:58:26 +00:00
|
|
|
func (manager *ComposeStackManager) ComposeSyntaxMaxVersion() string {
|
2021-07-21 01:56:28 +00:00
|
|
|
return portainer.ComposeSyntaxMaxVersion
|
|
|
|
}
|
|
|
|
|
|
|
|
// Up builds, (re)creates and starts containers in the background. Wraps `docker-compose up -d` command
|
2022-01-16 21:20:45 +00:00
|
|
|
func (manager *ComposeStackManager) Up(ctx context.Context, stack *portainer.Stack, endpoint *portainer.Endpoint, forceRereate bool) error {
|
2021-09-06 07:58:26 +00:00
|
|
|
url, proxy, err := manager.fetchEndpointProxy(endpoint)
|
2021-07-21 01:56:28 +00:00
|
|
|
if err != nil {
|
2021-09-29 23:58:10 +00:00
|
|
|
return errors.Wrap(err, "failed to fetch environment proxy")
|
2021-07-21 01:56:28 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
if proxy != nil {
|
|
|
|
defer proxy.Close()
|
|
|
|
}
|
|
|
|
|
2022-07-04 01:16:04 +00:00
|
|
|
envFile, err := createEnvFile(stack)
|
2021-07-21 01:56:28 +00:00
|
|
|
if err != nil {
|
2021-08-17 01:12:07 +00:00
|
|
|
return errors.Wrap(err, "failed to create env file")
|
2021-07-21 01:56:28 +00:00
|
|
|
}
|
|
|
|
|
2021-11-01 11:01:03 +00:00
|
|
|
filePaths := stackutils.GetStackFilePaths(stack)
|
2022-07-04 01:16:04 +00:00
|
|
|
err = manager.deployer.Deploy(ctx, stack.ProjectPath, url, stack.Name, filePaths, envFile, forceRereate)
|
2021-08-17 01:12:07 +00:00
|
|
|
return errors.Wrap(err, "failed to deploy a stack")
|
2021-07-21 01:56:28 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
// Down stops and removes containers, networks, images, and volumes. Wraps `docker-compose down --remove-orphans` command
|
2021-09-06 07:58:26 +00:00
|
|
|
func (manager *ComposeStackManager) Down(ctx context.Context, stack *portainer.Stack, endpoint *portainer.Endpoint) error {
|
|
|
|
url, proxy, err := manager.fetchEndpointProxy(endpoint)
|
2021-07-21 01:56:28 +00:00
|
|
|
if err != nil {
|
|
|
|
return err
|
|
|
|
}
|
|
|
|
if proxy != nil {
|
|
|
|
defer proxy.Close()
|
|
|
|
}
|
|
|
|
|
2022-07-04 01:16:04 +00:00
|
|
|
envFile, err := createEnvFile(stack)
|
|
|
|
if err != nil {
|
|
|
|
return errors.Wrap(err, "failed to create env file")
|
2021-12-21 00:45:05 +00:00
|
|
|
}
|
|
|
|
|
2021-11-01 11:01:03 +00:00
|
|
|
filePaths := stackutils.GetStackFilePaths(stack)
|
2022-07-04 01:16:04 +00:00
|
|
|
|
|
|
|
err = manager.deployer.Remove(ctx, stack.ProjectPath, url, stack.Name, filePaths, envFile)
|
2021-09-12 23:11:22 +00:00
|
|
|
return errors.Wrap(err, "failed to remove a stack")
|
2021-07-21 01:56:28 +00:00
|
|
|
}
|
|
|
|
|
2021-08-17 01:12:07 +00:00
|
|
|
// NormalizeStackName returns a new stack name with unsupported characters replaced
|
2021-09-29 23:58:10 +00:00
|
|
|
func (manager *ComposeStackManager) NormalizeStackName(name string) string {
|
2021-10-01 03:56:34 +00:00
|
|
|
return stackNameNormalizeRegex.ReplaceAllString(strings.ToLower(name), "")
|
2021-07-21 01:56:28 +00:00
|
|
|
}
|
|
|
|
|
2021-09-06 07:58:26 +00:00
|
|
|
func (manager *ComposeStackManager) fetchEndpointProxy(endpoint *portainer.Endpoint) (string, *factory.ProxyServer, error) {
|
2021-07-21 01:56:28 +00:00
|
|
|
if strings.HasPrefix(endpoint.URL, "unix://") || strings.HasPrefix(endpoint.URL, "npipe://") {
|
|
|
|
return "", nil, nil
|
|
|
|
}
|
|
|
|
|
2021-09-24 04:56:22 +00:00
|
|
|
proxy, err := manager.proxyManager.CreateAgentProxyServer(endpoint)
|
2021-07-21 01:56:28 +00:00
|
|
|
if err != nil {
|
|
|
|
return "", nil, err
|
|
|
|
}
|
|
|
|
|
2021-10-07 22:59:50 +00:00
|
|
|
return fmt.Sprintf("tcp://127.0.0.1:%d", proxy.Port), proxy, nil
|
2021-07-21 01:56:28 +00:00
|
|
|
}
|
|
|
|
|
2022-07-04 01:16:04 +00:00
|
|
|
// createEnvFile creates a file that would hold both "in-place" and default environment variables.
|
|
|
|
// It will return the name of the file if the stack has "in-place" env vars, otherwise empty string.
|
2021-07-21 01:56:28 +00:00
|
|
|
func createEnvFile(stack *portainer.Stack) (string, error) {
|
|
|
|
if stack.Env == nil || len(stack.Env) == 0 {
|
|
|
|
return "", nil
|
|
|
|
}
|
|
|
|
|
|
|
|
envFilePath := path.Join(stack.ProjectPath, "stack.env")
|
|
|
|
envfile, err := os.OpenFile(envFilePath, os.O_WRONLY|os.O_CREATE|os.O_TRUNC, 0600)
|
|
|
|
if err != nil {
|
|
|
|
return "", err
|
|
|
|
}
|
2022-07-04 01:16:04 +00:00
|
|
|
defer envfile.Close()
|
|
|
|
|
|
|
|
copyDefaultEnvFile(stack, envfile)
|
2021-07-21 01:56:28 +00:00
|
|
|
|
|
|
|
for _, v := range stack.Env {
|
|
|
|
envfile.WriteString(fmt.Sprintf("%s=%s\n", v.Name, v.Value))
|
|
|
|
}
|
|
|
|
|
2021-08-17 01:12:07 +00:00
|
|
|
return "stack.env", nil
|
2021-07-21 01:56:28 +00:00
|
|
|
}
|
2021-12-09 15:09:34 +00:00
|
|
|
|
2022-07-04 01:16:04 +00:00
|
|
|
// copyDefaultEnvFile copies the default .env file if it exists to the provided writer
|
|
|
|
func copyDefaultEnvFile(stack *portainer.Stack, w io.Writer) {
|
|
|
|
defaultEnvFile, err := os.Open(path.Join(path.Join(stack.ProjectPath, path.Dir(stack.EntryPoint)), ".env"))
|
2021-12-09 15:09:34 +00:00
|
|
|
if err != nil {
|
2022-07-04 01:16:04 +00:00
|
|
|
// If cannot open a default file, then don't need to copy it.
|
|
|
|
// We could as well stat it and check if it exists, but this is more efficient.
|
|
|
|
return
|
2021-12-09 15:09:34 +00:00
|
|
|
}
|
|
|
|
|
2022-07-04 01:16:04 +00:00
|
|
|
defer defaultEnvFile.Close()
|
2021-12-09 15:09:34 +00:00
|
|
|
|
2022-07-04 01:16:04 +00:00
|
|
|
if _, err = io.Copy(w, defaultEnvFile); err == nil {
|
|
|
|
io.WriteString(w, "\n")
|
2021-12-09 15:09:34 +00:00
|
|
|
}
|
2022-07-04 01:16:04 +00:00
|
|
|
// If couldn't copy the .env file, then ignore the error and try to continue
|
2021-12-09 15:09:34 +00:00
|
|
|
}
|