mirror of https://github.com/portainer/portainer
116 lines
4.7 KiB
Go
116 lines
4.7 KiB
Go
package stacks
|
|
|
|
import (
|
|
"context"
|
|
"errors"
|
|
"net/http"
|
|
|
|
httperror "github.com/portainer/libhttp/error"
|
|
"github.com/portainer/libhttp/request"
|
|
"github.com/portainer/libhttp/response"
|
|
portainer "github.com/portainer/portainer/api"
|
|
httperrors "github.com/portainer/portainer/api/http/errors"
|
|
"github.com/portainer/portainer/api/http/security"
|
|
"github.com/portainer/portainer/api/internal/stackutils"
|
|
)
|
|
|
|
// @id StackStop
|
|
// @summary Stops a stopped Stack
|
|
// @description Stops a stopped Stack.
|
|
// @description **Access policy**: authenticated
|
|
// @tags stacks
|
|
// @security ApiKeyAuth
|
|
// @security jwt
|
|
// @param id path int true "Stack identifier"
|
|
// @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}/stop [post]
|
|
func (handler *Handler) stackStop(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}
|
|
}
|
|
|
|
securityContext, err := security.RetrieveRestrictedRequestContext(r)
|
|
if err != nil {
|
|
return &httperror.HandlerError{http.StatusInternalServerError, "Unable to retrieve info from request context", err}
|
|
}
|
|
|
|
stack, err := handler.DataStore.Stack().Stack(portainer.StackID(stackID))
|
|
if handler.DataStore.IsErrObjectNotFound(err) {
|
|
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}
|
|
}
|
|
|
|
if stack.Type == portainer.KubernetesStack {
|
|
return &httperror.HandlerError{StatusCode: http.StatusBadRequest, Message: "Stopping a kubernetes stack is not supported", Err: err}
|
|
}
|
|
|
|
endpoint, err := handler.DataStore.Endpoint().Endpoint(stack.EndpointID)
|
|
if handler.DataStore.IsErrObjectNotFound(err) {
|
|
return &httperror.HandlerError{http.StatusNotFound, "Unable to find an environment with the specified identifier inside the database", err}
|
|
} else if err != nil {
|
|
return &httperror.HandlerError{http.StatusInternalServerError, "Unable to find an environment with the specified identifier inside the database", err}
|
|
}
|
|
|
|
err = handler.requestBouncer.AuthorizedEndpointOperation(r, endpoint)
|
|
if err != nil {
|
|
return &httperror.HandlerError{http.StatusForbidden, "Permission denied to access environment", 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}
|
|
}
|
|
|
|
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}
|
|
}
|
|
|
|
if stack.Status == portainer.StackStatusInactive {
|
|
return &httperror.HandlerError{http.StatusBadRequest, "Stack is already inactive", errors.New("Stack is already inactive")}
|
|
}
|
|
|
|
// stop scheduler updates of the stack before stopping
|
|
if stack.AutoUpdate != nil && stack.AutoUpdate.JobID != "" {
|
|
stopAutoupdate(stack.ID, stack.AutoUpdate.JobID, *handler.Scheduler)
|
|
stack.AutoUpdate.JobID = ""
|
|
}
|
|
|
|
err = handler.stopStack(stack, endpoint)
|
|
if err != nil {
|
|
return &httperror.HandlerError{http.StatusInternalServerError, "Unable to stop stack", err}
|
|
}
|
|
|
|
stack.Status = portainer.StackStatusInactive
|
|
err = handler.DataStore.Stack().UpdateStack(stack.ID, stack)
|
|
if err != nil {
|
|
return &httperror.HandlerError{http.StatusInternalServerError, "Unable to update stack status", 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) stopStack(stack *portainer.Stack, endpoint *portainer.Endpoint) error {
|
|
switch stack.Type {
|
|
case portainer.DockerComposeStack:
|
|
return handler.ComposeStackManager.Down(context.TODO(), stack, endpoint)
|
|
case portainer.DockerSwarmStack:
|
|
return handler.SwarmStackManager.Remove(stack, endpoint)
|
|
}
|
|
return nil
|
|
}
|