mirror of https://github.com/portainer/portainer
418 lines
15 KiB
Go
418 lines
15 KiB
Go
package stacks
|
|
|
|
import (
|
|
"fmt"
|
|
"net/http"
|
|
|
|
httperror "github.com/portainer/libhttp/error"
|
|
"github.com/portainer/libhttp/request"
|
|
portainer "github.com/portainer/portainer/api"
|
|
"github.com/portainer/portainer/api/filesystem"
|
|
"github.com/portainer/portainer/api/git/update"
|
|
"github.com/portainer/portainer/api/http/security"
|
|
"github.com/portainer/portainer/api/stacks/deployments"
|
|
"github.com/portainer/portainer/api/stacks/stackbuilders"
|
|
"github.com/portainer/portainer/api/stacks/stackutils"
|
|
|
|
"github.com/asaskevich/govalidator"
|
|
"github.com/pkg/errors"
|
|
"github.com/rs/zerolog/log"
|
|
)
|
|
|
|
type composeStackFromFileContentPayload struct {
|
|
// Name of the stack
|
|
Name string `example:"myStack" validate:"required"`
|
|
// Content of the Stack file
|
|
StackFileContent string `example:"version: 3\n services:\n web:\n image:nginx" validate:"required"`
|
|
// A list of environment variables used during stack deployment
|
|
Env []portainer.Pair
|
|
// Whether the stack is from a app template
|
|
FromAppTemplate bool `example:"false"`
|
|
}
|
|
|
|
func (payload *composeStackFromFileContentPayload) Validate(r *http.Request) error {
|
|
if govalidator.IsNull(payload.Name) {
|
|
return errors.New("Invalid stack name")
|
|
}
|
|
|
|
if govalidator.IsNull(payload.StackFileContent) {
|
|
return errors.New("Invalid stack file content")
|
|
}
|
|
return nil
|
|
}
|
|
|
|
func createStackPayloadFromComposeFileContentPayload(name string, fileContent string, env []portainer.Pair, fromAppTemplate bool) stackbuilders.StackPayload {
|
|
return stackbuilders.StackPayload{
|
|
Name: name,
|
|
StackFileContent: fileContent,
|
|
Env: env,
|
|
FromAppTemplate: fromAppTemplate,
|
|
}
|
|
}
|
|
|
|
func (handler *Handler) checkAndCleanStackDupFromSwarm(w http.ResponseWriter, r *http.Request, endpoint *portainer.Endpoint, userID portainer.UserID, stack *portainer.Stack) error {
|
|
resourceControl, err := handler.DataStore.ResourceControl().ResourceControlByResourceIDAndType(stackutils.ResourceControlID(stack.EndpointID, stack.Name), portainer.StackResourceControl)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
|
|
// stop scheduler updates of the stack before removal
|
|
if stack.AutoUpdate != nil {
|
|
deployments.StopAutoupdate(stack.ID, stack.AutoUpdate.JobID, handler.Scheduler)
|
|
}
|
|
|
|
err = handler.DataStore.Stack().DeleteStack(stack.ID)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
|
|
if resourceControl != nil {
|
|
err = handler.DataStore.ResourceControl().DeleteResourceControl(resourceControl.ID)
|
|
if err != nil {
|
|
log.Error().
|
|
Str("stack", fmt.Sprintf("%+v", stack)).
|
|
Msg("unable to remove the associated resource control from the database for stack")
|
|
}
|
|
}
|
|
|
|
if exists, _ := handler.FileService.FileExists(stack.ProjectPath); exists {
|
|
err = handler.FileService.RemoveDirectory(stack.ProjectPath)
|
|
if err != nil {
|
|
log.Warn().
|
|
Str("stack", fmt.Sprintf("%+v", stack)).
|
|
Msg("unable to remove stack files from disk for stack")
|
|
}
|
|
}
|
|
|
|
return nil
|
|
}
|
|
|
|
// @id StackCreateDockerStandaloneString
|
|
// @summary Deploy a new compose stack from a text
|
|
// @description Deploy a new stack into a Docker environment specified via the environment identifier.
|
|
// @description **Access policy**: authenticated
|
|
// @tags stacks
|
|
// @security ApiKeyAuth
|
|
// @security jwt
|
|
// @accept json
|
|
// @produce json
|
|
// @param body body composeStackFromFileContentPayload true "stack config"
|
|
// @param endpointId query int true "Identifier of the environment that will be used to deploy the stack"
|
|
// @success 200 {object} portainer.Stack
|
|
// @failure 400 "Invalid request"
|
|
// @failure 500 "Server error"
|
|
// @router /stacks/create/standalone/string [post]
|
|
func (handler *Handler) createComposeStackFromFileContent(w http.ResponseWriter, r *http.Request, endpoint *portainer.Endpoint, userID portainer.UserID) *httperror.HandlerError {
|
|
var payload composeStackFromFileContentPayload
|
|
err := request.DecodeAndValidateJSONPayload(r, &payload)
|
|
if err != nil {
|
|
return httperror.BadRequest("Invalid request payload", err)
|
|
}
|
|
|
|
payload.Name = handler.ComposeStackManager.NormalizeStackName(payload.Name)
|
|
|
|
isUnique, err := handler.checkUniqueStackNameInDocker(endpoint, payload.Name, 0, false)
|
|
if err != nil {
|
|
return httperror.InternalServerError("Unable to check for name collision", err)
|
|
}
|
|
|
|
if !isUnique {
|
|
stacks, err := handler.DataStore.Stack().StacksByName(payload.Name)
|
|
if err != nil {
|
|
return stackExistsError(payload.Name)
|
|
}
|
|
for _, stack := range stacks {
|
|
if stack.Type != portainer.DockerComposeStack && stack.EndpointID == endpoint.ID {
|
|
err := handler.checkAndCleanStackDupFromSwarm(w, r, endpoint, userID, &stack)
|
|
if err != nil {
|
|
return httperror.BadRequest("Invalid request payload", err)
|
|
}
|
|
} else {
|
|
return stackExistsError(payload.Name)
|
|
}
|
|
}
|
|
}
|
|
|
|
securityContext, err := security.RetrieveRestrictedRequestContext(r)
|
|
if err != nil {
|
|
return httperror.InternalServerError("Unable to retrieve info from request context", err)
|
|
}
|
|
|
|
stackPayload := createStackPayloadFromComposeFileContentPayload(payload.Name, payload.StackFileContent, payload.Env, payload.FromAppTemplate)
|
|
|
|
composeStackBuilder := stackbuilders.CreateComposeStackFileContentBuilder(securityContext,
|
|
handler.DataStore,
|
|
handler.FileService,
|
|
handler.StackDeployer)
|
|
|
|
stackBuilderDirector := stackbuilders.NewStackBuilderDirector(composeStackBuilder)
|
|
stack, httpErr := stackBuilderDirector.Build(&stackPayload, endpoint)
|
|
if httpErr != nil {
|
|
return httpErr
|
|
}
|
|
|
|
return handler.decorateStackResponse(w, stack, userID)
|
|
}
|
|
|
|
type composeStackFromGitRepositoryPayload struct {
|
|
// Name of the stack
|
|
Name string `example:"myStack" validate:"required"`
|
|
// URL of a Git repository hosting the Stack file
|
|
RepositoryURL string `example:"https://github.com/openfaas/faas" validate:"required"`
|
|
// Reference name of a Git repository hosting the Stack file
|
|
RepositoryReferenceName string `example:"refs/heads/master"`
|
|
// Use basic authentication to clone the Git repository
|
|
RepositoryAuthentication bool `example:"true"`
|
|
// Username used in basic authentication. Required when RepositoryAuthentication is true.
|
|
RepositoryUsername string `example:"myGitUsername"`
|
|
// Password used in basic authentication. Required when RepositoryAuthentication is true.
|
|
RepositoryPassword string `example:"myGitPassword"`
|
|
// Path to the Stack file inside the Git repository
|
|
ComposeFile string `example:"docker-compose.yml" default:"docker-compose.yml"`
|
|
// Applicable when deploying with multiple stack files
|
|
AdditionalFiles []string `example:"[nz.compose.yml, uat.compose.yml]"`
|
|
// Optional GitOps update configuration
|
|
AutoUpdate *portainer.AutoUpdateSettings
|
|
// A list of environment variables used during stack deployment
|
|
Env []portainer.Pair
|
|
// Whether the stack is from a app template
|
|
FromAppTemplate bool `example:"false"`
|
|
// TLSSkipVerify skips SSL verification when cloning the Git repository
|
|
TLSSkipVerify bool `example:"false"`
|
|
}
|
|
|
|
func createStackPayloadFromComposeGitPayload(name, repoUrl, repoReference, repoUsername, repoPassword string, repoAuthentication bool, composeFile string, additionalFiles []string, autoUpdate *portainer.AutoUpdateSettings, env []portainer.Pair, fromAppTemplate bool, repoSkipSSLVerify bool) stackbuilders.StackPayload {
|
|
return stackbuilders.StackPayload{
|
|
Name: name,
|
|
RepositoryConfigPayload: stackbuilders.RepositoryConfigPayload{
|
|
URL: repoUrl,
|
|
ReferenceName: repoReference,
|
|
Authentication: repoAuthentication,
|
|
Username: repoUsername,
|
|
Password: repoPassword,
|
|
TLSSkipVerify: repoSkipSSLVerify,
|
|
},
|
|
ComposeFile: composeFile,
|
|
AdditionalFiles: additionalFiles,
|
|
AutoUpdate: autoUpdate,
|
|
Env: env,
|
|
FromAppTemplate: fromAppTemplate,
|
|
}
|
|
}
|
|
|
|
func (payload *composeStackFromGitRepositoryPayload) Validate(r *http.Request) error {
|
|
if govalidator.IsNull(payload.Name) {
|
|
return errors.New("Invalid stack name")
|
|
}
|
|
if govalidator.IsNull(payload.RepositoryURL) || !govalidator.IsURL(payload.RepositoryURL) {
|
|
return errors.New("Invalid repository URL. Must correspond to a valid URL format")
|
|
}
|
|
if payload.RepositoryAuthentication && govalidator.IsNull(payload.RepositoryPassword) {
|
|
return errors.New("Invalid repository credentials. Password must be specified when authentication is enabled")
|
|
}
|
|
if err := update.ValidateAutoUpdateSettings(payload.AutoUpdate); err != nil {
|
|
return err
|
|
}
|
|
return nil
|
|
}
|
|
|
|
// @id StackCreateDockerStandaloneRepository
|
|
// @summary Deploy a new compose stack from repository
|
|
// @description Deploy a new stack into a Docker environment specified via the environment identifier.
|
|
// @description **Access policy**: authenticated
|
|
// @tags stacks
|
|
// @security ApiKeyAuth
|
|
// @security jwt
|
|
// @produce json
|
|
// @accept json
|
|
// @param endpointId query int true "Identifier of the environment that will be used to deploy the stack"
|
|
// @param body body composeStackFromGitRepositoryPayload true "stack config"
|
|
// @success 200 {object} portainer.Stack
|
|
// @failure 400 "Invalid request"
|
|
// @failure 500 "Server error"
|
|
// @router /stacks/create/standalone/repository [post]
|
|
func (handler *Handler) createComposeStackFromGitRepository(w http.ResponseWriter, r *http.Request, endpoint *portainer.Endpoint, userID portainer.UserID) *httperror.HandlerError {
|
|
var payload composeStackFromGitRepositoryPayload
|
|
err := request.DecodeAndValidateJSONPayload(r, &payload)
|
|
if err != nil {
|
|
return httperror.BadRequest("Invalid request payload", err)
|
|
}
|
|
|
|
payload.Name = handler.ComposeStackManager.NormalizeStackName(payload.Name)
|
|
if payload.ComposeFile == "" {
|
|
payload.ComposeFile = filesystem.ComposeFileDefaultName
|
|
}
|
|
|
|
isUnique, err := handler.checkUniqueStackNameInDocker(endpoint, payload.Name, 0, false)
|
|
if err != nil {
|
|
return httperror.InternalServerError("Unable to check for name collision", err)
|
|
}
|
|
|
|
if !isUnique {
|
|
stacks, err := handler.DataStore.Stack().StacksByName(payload.Name)
|
|
if err != nil {
|
|
return stackExistsError(payload.Name)
|
|
}
|
|
for _, stack := range stacks {
|
|
if stack.Type != portainer.DockerComposeStack && stack.EndpointID == endpoint.ID {
|
|
err := handler.checkAndCleanStackDupFromSwarm(w, r, endpoint, userID, &stack)
|
|
if err != nil {
|
|
return httperror.BadRequest("Invalid request payload", err)
|
|
}
|
|
} else {
|
|
return stackExistsError(payload.Name)
|
|
}
|
|
}
|
|
}
|
|
|
|
//make sure the webhook ID is unique
|
|
if payload.AutoUpdate != nil && payload.AutoUpdate.Webhook != "" {
|
|
isUnique, err := handler.checkUniqueWebhookID(payload.AutoUpdate.Webhook)
|
|
if err != nil {
|
|
return httperror.InternalServerError("Unable to check for webhook ID collision", err)
|
|
}
|
|
if !isUnique {
|
|
return &httperror.HandlerError{StatusCode: http.StatusConflict, Message: fmt.Sprintf("Webhook ID: %s already exists", payload.AutoUpdate.Webhook), Err: stackutils.ErrWebhookIDAlreadyExists}
|
|
}
|
|
}
|
|
|
|
securityContext, err := security.RetrieveRestrictedRequestContext(r)
|
|
if err != nil {
|
|
return httperror.InternalServerError("Unable to retrieve info from request context", err)
|
|
}
|
|
|
|
stackPayload := createStackPayloadFromComposeGitPayload(payload.Name,
|
|
payload.RepositoryURL,
|
|
payload.RepositoryReferenceName,
|
|
payload.RepositoryUsername,
|
|
payload.RepositoryPassword,
|
|
payload.RepositoryAuthentication,
|
|
payload.ComposeFile,
|
|
payload.AdditionalFiles,
|
|
payload.AutoUpdate,
|
|
payload.Env,
|
|
payload.FromAppTemplate,
|
|
payload.TLSSkipVerify,
|
|
)
|
|
|
|
composeStackBuilder := stackbuilders.CreateComposeStackGitBuilder(securityContext,
|
|
handler.DataStore,
|
|
handler.FileService,
|
|
handler.GitService,
|
|
handler.Scheduler,
|
|
handler.StackDeployer)
|
|
|
|
stackBuilderDirector := stackbuilders.NewStackBuilderDirector(composeStackBuilder)
|
|
stack, httpErr := stackBuilderDirector.Build(&stackPayload, endpoint)
|
|
if httpErr != nil {
|
|
return httpErr
|
|
}
|
|
|
|
return handler.decorateStackResponse(w, stack, userID)
|
|
}
|
|
|
|
type composeStackFromFileUploadPayload struct {
|
|
Name string
|
|
StackFileContent []byte
|
|
Env []portainer.Pair
|
|
}
|
|
|
|
func createStackPayloadFromComposeFileUploadPayload(name string, fileContentBytes []byte, env []portainer.Pair) stackbuilders.StackPayload {
|
|
return stackbuilders.StackPayload{
|
|
Name: name,
|
|
StackFileContentBytes: fileContentBytes,
|
|
Env: env,
|
|
}
|
|
}
|
|
|
|
func decodeRequestForm(r *http.Request) (*composeStackFromFileUploadPayload, error) {
|
|
payload := &composeStackFromFileUploadPayload{}
|
|
name, err := request.RetrieveMultiPartFormValue(r, "Name", false)
|
|
if err != nil {
|
|
return nil, errors.New("Invalid stack name")
|
|
}
|
|
payload.Name = name
|
|
|
|
composeFileContent, _, err := request.RetrieveMultiPartFormFile(r, "file")
|
|
if err != nil {
|
|
return nil, errors.New("Invalid Compose file. Ensure that the Compose file is uploaded correctly")
|
|
}
|
|
payload.StackFileContent = composeFileContent
|
|
|
|
var env []portainer.Pair
|
|
err = request.RetrieveMultiPartFormJSONValue(r, "Env", &env, true)
|
|
if err != nil {
|
|
return nil, errors.New("Invalid Env parameter")
|
|
}
|
|
payload.Env = env
|
|
return payload, nil
|
|
}
|
|
|
|
// @id StackCreateDockerStandaloneFile
|
|
// @summary Deploy a new compose stack from a file
|
|
// @description Deploy a new stack into a Docker environment specified via the environment identifier.
|
|
// @description **Access policy**: authenticated
|
|
// @tags stacks
|
|
// @security ApiKeyAuth
|
|
// @security jwt
|
|
// @accept multipart/form-data
|
|
// @produce json
|
|
// @param Name formData string true "Name of the stack"
|
|
// @param Env formData string false "Environment variables passed during deployment, represented as a JSON array [{'name': 'name', 'value': 'value'}]."
|
|
// @param file formData file false "Stack file"
|
|
// @param endpointId query int true "Identifier of the environment that will be used to deploy the stack"
|
|
// @success 200 {object} portainer.Stack
|
|
// @failure 400 "Invalid request"
|
|
// @failure 500 "Server error"
|
|
// @router /stacks/create/standalone/file [post]
|
|
func (handler *Handler) createComposeStackFromFileUpload(w http.ResponseWriter, r *http.Request, endpoint *portainer.Endpoint, userID portainer.UserID) *httperror.HandlerError {
|
|
payload, err := decodeRequestForm(r)
|
|
if err != nil {
|
|
return httperror.BadRequest("Invalid request payload", err)
|
|
}
|
|
|
|
payload.Name = handler.ComposeStackManager.NormalizeStackName(payload.Name)
|
|
|
|
isUnique, err := handler.checkUniqueStackNameInDocker(endpoint, payload.Name, 0, false)
|
|
if err != nil {
|
|
return httperror.InternalServerError("Unable to check for name collision", err)
|
|
}
|
|
|
|
if !isUnique {
|
|
stacks, err := handler.DataStore.Stack().StacksByName(payload.Name)
|
|
if err != nil {
|
|
return stackExistsError(payload.Name)
|
|
}
|
|
for _, stack := range stacks {
|
|
if stack.Type != portainer.DockerComposeStack && stack.EndpointID == endpoint.ID {
|
|
err := handler.checkAndCleanStackDupFromSwarm(w, r, endpoint, userID, &stack)
|
|
if err != nil {
|
|
return httperror.BadRequest("Invalid request payload", err)
|
|
}
|
|
} else {
|
|
return stackExistsError(payload.Name)
|
|
}
|
|
}
|
|
}
|
|
|
|
securityContext, err := security.RetrieveRestrictedRequestContext(r)
|
|
if err != nil {
|
|
return httperror.InternalServerError("Unable to retrieve info from request context", err)
|
|
}
|
|
|
|
stackPayload := createStackPayloadFromComposeFileUploadPayload(payload.Name, payload.StackFileContent, payload.Env)
|
|
|
|
composeStackBuilder := stackbuilders.CreateComposeStackFileUploadBuilder(securityContext,
|
|
handler.DataStore,
|
|
handler.FileService,
|
|
handler.StackDeployer)
|
|
|
|
stackBuilderDirector := stackbuilders.NewStackBuilderDirector(composeStackBuilder)
|
|
stack, httpErr := stackBuilderDirector.Build(&stackPayload, endpoint)
|
|
if httpErr != nil {
|
|
return httpErr
|
|
}
|
|
|
|
return handler.decorateStackResponse(w, stack, userID)
|
|
}
|