mirror of https://github.com/portainer/portainer
209 lines
8.0 KiB
Go
209 lines
8.0 KiB
Go
package stacks
|
|
|
|
import (
|
|
"errors"
|
|
"net/http"
|
|
"strconv"
|
|
"time"
|
|
|
|
"github.com/asaskevich/govalidator"
|
|
httperror "github.com/portainer/libhttp/error"
|
|
"github.com/portainer/libhttp/request"
|
|
"github.com/portainer/libhttp/response"
|
|
portainer "github.com/portainer/portainer/api"
|
|
bolterrors "github.com/portainer/portainer/api/bolt/errors"
|
|
httperrors "github.com/portainer/portainer/api/http/errors"
|
|
"github.com/portainer/portainer/api/http/security"
|
|
"github.com/portainer/portainer/api/internal/stackutils"
|
|
)
|
|
|
|
type updateComposeStackPayload struct {
|
|
// New content of the Stack file
|
|
StackFileContent string `example:"version: 3\n services:\n web:\n image:nginx"`
|
|
// A list of environment variables used during stack deployment
|
|
Env []portainer.Pair
|
|
}
|
|
|
|
func (payload *updateComposeStackPayload) Validate(r *http.Request) error {
|
|
if govalidator.IsNull(payload.StackFileContent) {
|
|
return errors.New("Invalid stack file content")
|
|
}
|
|
return nil
|
|
}
|
|
|
|
type updateSwarmStackPayload struct {
|
|
// New content of the Stack file
|
|
StackFileContent string `example:"version: 3\n services:\n web:\n image:nginx"`
|
|
// A list of environment variables used during stack deployment
|
|
Env []portainer.Pair
|
|
// Prune services that are no longer referenced (only available for Swarm stacks)
|
|
Prune bool `example:"true"`
|
|
}
|
|
|
|
func (payload *updateSwarmStackPayload) Validate(r *http.Request) error {
|
|
if govalidator.IsNull(payload.StackFileContent) {
|
|
return errors.New("Invalid stack file content")
|
|
}
|
|
return nil
|
|
}
|
|
|
|
// @id StackUpdate
|
|
// @summary Update a stack
|
|
// @description Update a stack.
|
|
// @description **Access policy**: restricted
|
|
// @tags stacks
|
|
// @security jwt
|
|
// @accept json
|
|
// @produce json
|
|
// @param id path int true "Stack identifier"
|
|
// @param endpointId query int false "Stacks created before version 1.18.0 might not have an associated endpoint identifier. Use this optional parameter to set the endpoint identifier used by the stack."
|
|
// @param body body updateSwarmStackPayload true "Stack details"
|
|
// @success 200 {object} portainer.Stack "Success"
|
|
// @failure 400 "Invalid request"
|
|
// @failure 403 "Permission denied"
|
|
// @failure 404 "Not found"
|
|
// @failure 500 "Server error"
|
|
// @router /stacks/{id} [put]
|
|
func (handler *Handler) stackUpdate(w http.ResponseWriter, r *http.Request) *httperror.HandlerError {
|
|
stackID, err := request.RetrieveNumericRouteVariableValue(r, "id")
|
|
if err != nil {
|
|
return &httperror.HandlerError{http.StatusBadRequest, "Invalid stack identifier route variable", err}
|
|
}
|
|
|
|
stack, err := handler.DataStore.Stack().Stack(portainer.StackID(stackID))
|
|
if err == bolterrors.ErrObjectNotFound {
|
|
return &httperror.HandlerError{http.StatusNotFound, "Unable to find a stack with the specified identifier inside the database", err}
|
|
} else if err != nil {
|
|
return &httperror.HandlerError{http.StatusInternalServerError, "Unable to find a stack with the specified identifier inside the database", err}
|
|
}
|
|
|
|
// TODO: this is a work-around for stacks created with Portainer version >= 1.17.1
|
|
// The EndpointID property is not available for these stacks, this API endpoint
|
|
// can use the optional EndpointID query parameter to associate a valid endpoint identifier to the stack.
|
|
endpointID, err := request.RetrieveNumericQueryParameter(r, "endpointId", true)
|
|
if err != nil {
|
|
return &httperror.HandlerError{http.StatusBadRequest, "Invalid query parameter: endpointId", err}
|
|
}
|
|
if endpointID != int(stack.EndpointID) {
|
|
stack.EndpointID = portainer.EndpointID(endpointID)
|
|
}
|
|
|
|
endpoint, err := handler.DataStore.Endpoint().Endpoint(stack.EndpointID)
|
|
if err == bolterrors.ErrObjectNotFound {
|
|
return &httperror.HandlerError{http.StatusNotFound, "Unable to find the endpoint associated to the stack inside the database", err}
|
|
} else if err != nil {
|
|
return &httperror.HandlerError{http.StatusInternalServerError, "Unable to find the endpoint associated to the stack inside the database", err}
|
|
}
|
|
|
|
err = handler.requestBouncer.AuthorizedEndpointOperation(r, endpoint)
|
|
if err != nil {
|
|
return &httperror.HandlerError{http.StatusForbidden, "Permission denied to access endpoint", err}
|
|
}
|
|
|
|
resourceControl, err := handler.DataStore.ResourceControl().ResourceControlByResourceIDAndType(stackutils.ResourceControlID(stack.EndpointID, stack.Name), portainer.StackResourceControl)
|
|
if err != nil {
|
|
return &httperror.HandlerError{http.StatusInternalServerError, "Unable to retrieve a resource control associated to the stack", err}
|
|
}
|
|
|
|
securityContext, err := security.RetrieveRestrictedRequestContext(r)
|
|
if err != nil {
|
|
return &httperror.HandlerError{http.StatusInternalServerError, "Unable to retrieve info from request context", err}
|
|
}
|
|
|
|
access, err := handler.userCanAccessStack(securityContext, endpoint.ID, resourceControl)
|
|
if err != nil {
|
|
return &httperror.HandlerError{http.StatusInternalServerError, "Unable to verify user authorizations to validate stack access", err}
|
|
}
|
|
if !access {
|
|
return &httperror.HandlerError{http.StatusForbidden, "Access denied to resource", httperrors.ErrResourceAccessDenied}
|
|
}
|
|
|
|
updateError := handler.updateAndDeployStack(r, stack, endpoint)
|
|
if updateError != nil {
|
|
return updateError
|
|
}
|
|
|
|
err = handler.DataStore.Stack().UpdateStack(stack.ID, stack)
|
|
if err != nil {
|
|
return &httperror.HandlerError{http.StatusInternalServerError, "Unable to persist the stack changes inside the database", err}
|
|
}
|
|
|
|
if stack.GitConfig != nil && stack.GitConfig.Authentication != nil && stack.GitConfig.Authentication.Password != "" {
|
|
// sanitize password in the http response to minimise possible security leaks
|
|
stack.GitConfig.Authentication.Password = ""
|
|
}
|
|
|
|
return response.JSON(w, stack)
|
|
}
|
|
|
|
func (handler *Handler) updateAndDeployStack(r *http.Request, stack *portainer.Stack, endpoint *portainer.Endpoint) *httperror.HandlerError {
|
|
if stack.Type == portainer.DockerSwarmStack {
|
|
return handler.updateSwarmStack(r, stack, endpoint)
|
|
}
|
|
return handler.updateComposeStack(r, stack, endpoint)
|
|
}
|
|
|
|
func (handler *Handler) updateComposeStack(r *http.Request, stack *portainer.Stack, endpoint *portainer.Endpoint) *httperror.HandlerError {
|
|
var payload updateComposeStackPayload
|
|
err := request.DecodeAndValidateJSONPayload(r, &payload)
|
|
if err != nil {
|
|
return &httperror.HandlerError{http.StatusBadRequest, "Invalid request payload", err}
|
|
}
|
|
|
|
stack.Env = payload.Env
|
|
|
|
stackFolder := strconv.Itoa(int(stack.ID))
|
|
_, err = handler.FileService.StoreStackFileFromBytes(stackFolder, stack.EntryPoint, []byte(payload.StackFileContent))
|
|
if err != nil {
|
|
return &httperror.HandlerError{http.StatusInternalServerError, "Unable to persist updated Compose file on disk", err}
|
|
}
|
|
|
|
config, configErr := handler.createComposeDeployConfig(r, stack, endpoint)
|
|
if configErr != nil {
|
|
return configErr
|
|
}
|
|
|
|
stack.UpdateDate = time.Now().Unix()
|
|
stack.UpdatedBy = config.user.Username
|
|
stack.Status = portainer.StackStatusActive
|
|
|
|
err = handler.deployComposeStack(config)
|
|
if err != nil {
|
|
return &httperror.HandlerError{http.StatusInternalServerError, err.Error(), err}
|
|
}
|
|
|
|
return nil
|
|
}
|
|
|
|
func (handler *Handler) updateSwarmStack(r *http.Request, stack *portainer.Stack, endpoint *portainer.Endpoint) *httperror.HandlerError {
|
|
var payload updateSwarmStackPayload
|
|
err := request.DecodeAndValidateJSONPayload(r, &payload)
|
|
if err != nil {
|
|
return &httperror.HandlerError{http.StatusBadRequest, "Invalid request payload", err}
|
|
}
|
|
|
|
stack.Env = payload.Env
|
|
|
|
stackFolder := strconv.Itoa(int(stack.ID))
|
|
_, err = handler.FileService.StoreStackFileFromBytes(stackFolder, stack.EntryPoint, []byte(payload.StackFileContent))
|
|
if err != nil {
|
|
return &httperror.HandlerError{http.StatusInternalServerError, "Unable to persist updated Compose file on disk", err}
|
|
}
|
|
|
|
config, configErr := handler.createSwarmDeployConfig(r, stack, endpoint, payload.Prune)
|
|
if configErr != nil {
|
|
return configErr
|
|
}
|
|
|
|
stack.UpdateDate = time.Now().Unix()
|
|
stack.UpdatedBy = config.user.Username
|
|
stack.Status = portainer.StackStatusActive
|
|
|
|
err = handler.deploySwarmStack(config)
|
|
if err != nil {
|
|
return &httperror.HandlerError{http.StatusInternalServerError, err.Error(), err}
|
|
}
|
|
|
|
return nil
|
|
}
|