mirror of
https://github.com/portainer/portainer.git
synced 2025-07-19 05:19:39 +02:00
* feat(api): introduce swagger * feat(api): anottate api * chore(api): tag endpoints * chore(api): remove tags * chore(api): add docs for oauth auth * chore(api): document create endpoint api * chore(api): document endpoint inspect and list * chore(api): document endpoint update and snapshots * docs(endpointgroups): document groups api * docs(auth): document auth api * chore(build): introduce a yarn script to build api docs * docs(api): document auth * docs(customtemplates): document customtemplates api * docs(tags): document api * docs(api): document the use of token * docs(dockerhub): document dockerhub api * docs(edgegroups): document edgegroups api * docs(edgejobs): document api * docs(edgestacks): doc api * docs(http/upload): add security * docs(api): document edge templates * docs(edge): document edge jobs * docs(endpointgroups): change description * docs(endpoints): document missing apis * docs(motd): doc api * docs(registries): doc api * docs(resourcecontrol): api doc * docs(role): add swagger docs * docs(settings): add swagger docs * docs(api/status): add swagger docs * docs(api/teammembership): add swagger docs * docs(api/teams): add swagger docs * docs(api/templates): add swagger docs * docs(api/users): add swagger docs * docs(api/webhooks): add swagger docs * docs(api/webscokets): add swagger docs * docs(api/stacks): swagger * docs(api): fix missing apis * docs(swagger): regen * chore(build): remove docs from build * docs(api): update tags * docs(api): document tags * docs(api): add description * docs(api): rename jwt token * docs(api): add info about types * docs(api): document types * docs(api): update request types annotation * docs(api): doc registry and resource control * chore(docs): add snippet * docs(api): add description to role * docs(api): add types for settings * docs(status): add types * style(swagger): remove documented code * docs(http/upload): update docs with types * docs(http/tags): add types * docs(api/custom_templates): add types * docs(api/teammembership): add types * docs(http/teams): add types * docs(http/stacks): add types * docs(edge): add types to edgestack * docs(http/teammembership): remove double returns * docs(api/user): add types * docs(http): fixes to make file built * chore(snippets): add scope to swagger snippet * chore(deps): install swag * chore(swagger): remove handler * docs(api): add description * docs(api): ignore docs folder * docs(api): add contributing guidelines * docs(api): cleanup handler * chore(deps): require swaggo * fix(auth): fix typo * fix(docs): make http ids pascal case * feat(edge): add ids to http handlers * fix(docs): add ids * fix(docs): show correct api version * chore(deps): remove swaggo dependency * chore(docs): add install script for swag
173 lines
5.9 KiB
Go
173 lines
5.9 KiB
Go
package edgestacks
|
|
|
|
import (
|
|
"errors"
|
|
"net/http"
|
|
"strconv"
|
|
|
|
"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"
|
|
"github.com/portainer/portainer/api/internal/edge"
|
|
)
|
|
|
|
type updateEdgeStackPayload struct {
|
|
StackFileContent string
|
|
Version *int
|
|
Prune *bool
|
|
EdgeGroups []portainer.EdgeGroupID
|
|
}
|
|
|
|
func (payload *updateEdgeStackPayload) Validate(r *http.Request) error {
|
|
if govalidator.IsNull(payload.StackFileContent) {
|
|
return errors.New("Invalid stack file content")
|
|
}
|
|
if payload.EdgeGroups != nil && len(payload.EdgeGroups) == 0 {
|
|
return errors.New("Edge Groups are mandatory for an Edge stack")
|
|
}
|
|
return nil
|
|
}
|
|
|
|
// @id EdgeStackUpdate
|
|
// @summary Update an EdgeStack
|
|
// @description
|
|
// @tags edge_stacks
|
|
// @security jwt
|
|
// @accept json
|
|
// @produce json
|
|
// @param id path string true "EdgeStack Id"
|
|
// @param body body updateEdgeStackPayload true "EdgeStack data"
|
|
// @success 200 {object} portainer.EdgeStack
|
|
// @failure 500
|
|
// @failure 400
|
|
// @failure 503 Edge compute features are disabled
|
|
// @router /edge_stacks/{id} [put]
|
|
func (handler *Handler) edgeStackUpdate(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.EdgeStack().EdgeStack(portainer.EdgeStackID(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}
|
|
}
|
|
|
|
var payload updateEdgeStackPayload
|
|
err = request.DecodeAndValidateJSONPayload(r, &payload)
|
|
if err != nil {
|
|
return &httperror.HandlerError{http.StatusBadRequest, "Invalid request payload", err}
|
|
}
|
|
|
|
if payload.EdgeGroups != nil {
|
|
endpoints, err := handler.DataStore.Endpoint().Endpoints()
|
|
if err != nil {
|
|
return &httperror.HandlerError{http.StatusInternalServerError, "Unable to retrieve endpoints from database", err}
|
|
}
|
|
|
|
endpointGroups, err := handler.DataStore.EndpointGroup().EndpointGroups()
|
|
if err != nil {
|
|
return &httperror.HandlerError{http.StatusInternalServerError, "Unable to retrieve endpoint groups from database", err}
|
|
}
|
|
|
|
edgeGroups, err := handler.DataStore.EdgeGroup().EdgeGroups()
|
|
if err != nil {
|
|
return &httperror.HandlerError{http.StatusInternalServerError, "Unable to retrieve edge groups from database", err}
|
|
}
|
|
|
|
oldRelated, err := edge.EdgeStackRelatedEndpoints(stack.EdgeGroups, endpoints, endpointGroups, edgeGroups)
|
|
if err != nil {
|
|
return &httperror.HandlerError{http.StatusInternalServerError, "Unable to retrieve edge stack related endpoints from database", err}
|
|
}
|
|
|
|
newRelated, err := edge.EdgeStackRelatedEndpoints(payload.EdgeGroups, endpoints, endpointGroups, edgeGroups)
|
|
if err != nil {
|
|
return &httperror.HandlerError{http.StatusInternalServerError, "Unable to retrieve edge stack related endpoints from database", err}
|
|
}
|
|
|
|
oldRelatedSet := EndpointSet(oldRelated)
|
|
newRelatedSet := EndpointSet(newRelated)
|
|
|
|
endpointsToRemove := map[portainer.EndpointID]bool{}
|
|
for endpointID := range oldRelatedSet {
|
|
if !newRelatedSet[endpointID] {
|
|
endpointsToRemove[endpointID] = true
|
|
}
|
|
}
|
|
|
|
for endpointID := range endpointsToRemove {
|
|
relation, err := handler.DataStore.EndpointRelation().EndpointRelation(endpointID)
|
|
if err != nil {
|
|
return &httperror.HandlerError{http.StatusInternalServerError, "Unable to find endpoint relation in database", err}
|
|
}
|
|
|
|
delete(relation.EdgeStacks, stack.ID)
|
|
|
|
err = handler.DataStore.EndpointRelation().UpdateEndpointRelation(endpointID, relation)
|
|
if err != nil {
|
|
return &httperror.HandlerError{http.StatusInternalServerError, "Unable to persist endpoint relation in database", err}
|
|
}
|
|
}
|
|
|
|
endpointsToAdd := map[portainer.EndpointID]bool{}
|
|
for endpointID := range newRelatedSet {
|
|
if !oldRelatedSet[endpointID] {
|
|
endpointsToAdd[endpointID] = true
|
|
}
|
|
}
|
|
|
|
for endpointID := range endpointsToAdd {
|
|
relation, err := handler.DataStore.EndpointRelation().EndpointRelation(endpointID)
|
|
if err != nil {
|
|
return &httperror.HandlerError{http.StatusInternalServerError, "Unable to find endpoint relation in database", err}
|
|
}
|
|
|
|
relation.EdgeStacks[stack.ID] = true
|
|
|
|
err = handler.DataStore.EndpointRelation().UpdateEndpointRelation(endpointID, relation)
|
|
if err != nil {
|
|
return &httperror.HandlerError{http.StatusInternalServerError, "Unable to persist endpoint relation in database", err}
|
|
}
|
|
}
|
|
|
|
stack.EdgeGroups = payload.EdgeGroups
|
|
|
|
}
|
|
|
|
if payload.Prune != nil {
|
|
stack.Prune = *payload.Prune
|
|
}
|
|
|
|
stackFolder := strconv.Itoa(int(stack.ID))
|
|
_, err = handler.FileService.StoreEdgeStackFileFromBytes(stackFolder, stack.EntryPoint, []byte(payload.StackFileContent))
|
|
if err != nil {
|
|
return &httperror.HandlerError{http.StatusInternalServerError, "Unable to persist updated Compose file on disk", err}
|
|
}
|
|
|
|
if payload.Version != nil && *payload.Version != stack.Version {
|
|
stack.Version = *payload.Version
|
|
stack.Status = map[portainer.EndpointID]portainer.EdgeStackStatus{}
|
|
}
|
|
|
|
err = handler.DataStore.EdgeStack().UpdateEdgeStack(stack.ID, stack)
|
|
if err != nil {
|
|
return &httperror.HandlerError{http.StatusInternalServerError, "Unable to persist the stack changes inside the database", err}
|
|
}
|
|
|
|
return response.JSON(w, stack)
|
|
}
|
|
|
|
func EndpointSet(endpointIDs []portainer.EndpointID) map[portainer.EndpointID]bool {
|
|
set := map[portainer.EndpointID]bool{}
|
|
|
|
for _, endpointID := range endpointIDs {
|
|
set[endpointID] = true
|
|
}
|
|
|
|
return set
|
|
}
|