mirror of
https://github.com/portainer/portainer.git
synced 2025-07-19 13:29:41 +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
90 lines
3.5 KiB
Go
90 lines
3.5 KiB
Go
package webhooks
|
|
|
|
import (
|
|
"context"
|
|
"errors"
|
|
"net/http"
|
|
"strings"
|
|
|
|
dockertypes "github.com/docker/docker/api/types"
|
|
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"
|
|
)
|
|
|
|
// @summary Execute a webhook
|
|
// @description Acts on a passed in token UUID to restart the docker service
|
|
// @tags webhooks
|
|
// @accept json
|
|
// @produce json
|
|
// @param token path string true "Webhook token"
|
|
// @success 202 "Webhook executed"
|
|
// @failure 400
|
|
// @failure 500
|
|
// @router /webhooks/{token} [post]
|
|
func (handler *Handler) webhookExecute(w http.ResponseWriter, r *http.Request) *httperror.HandlerError {
|
|
|
|
webhookToken, err := request.RetrieveRouteVariableValue(r, "token")
|
|
|
|
if err != nil {
|
|
return &httperror.HandlerError{http.StatusInternalServerError, "Invalid service id parameter", err}
|
|
}
|
|
|
|
webhook, err := handler.DataStore.Webhook().WebhookByToken(webhookToken)
|
|
|
|
if err == bolterrors.ErrObjectNotFound {
|
|
return &httperror.HandlerError{http.StatusNotFound, "Unable to find a webhook with this token", err}
|
|
} else if err != nil {
|
|
return &httperror.HandlerError{http.StatusInternalServerError, "Unable to retrieve webhook from the database", err}
|
|
}
|
|
|
|
resourceID := webhook.ResourceID
|
|
endpointID := webhook.EndpointID
|
|
webhookType := webhook.WebhookType
|
|
|
|
endpoint, err := handler.DataStore.Endpoint().Endpoint(portainer.EndpointID(endpointID))
|
|
if err == bolterrors.ErrObjectNotFound {
|
|
return &httperror.HandlerError{http.StatusNotFound, "Unable to find an endpoint with the specified identifier inside the database", err}
|
|
} else if err != nil {
|
|
return &httperror.HandlerError{http.StatusInternalServerError, "Unable to find an endpoint with the specified identifier inside the database", err}
|
|
}
|
|
|
|
imageTag, _ := request.RetrieveQueryParameter(r, "tag", true)
|
|
|
|
switch webhookType {
|
|
case portainer.ServiceWebhook:
|
|
return handler.executeServiceWebhook(w, endpoint, resourceID, imageTag)
|
|
default:
|
|
return &httperror.HandlerError{http.StatusInternalServerError, "Unsupported webhook type", errors.New("Webhooks for this resource are not currently supported")}
|
|
}
|
|
}
|
|
|
|
func (handler *Handler) executeServiceWebhook(w http.ResponseWriter, endpoint *portainer.Endpoint, resourceID string, imageTag string) *httperror.HandlerError {
|
|
dockerClient, err := handler.DockerClientFactory.CreateClient(endpoint, "")
|
|
if err != nil {
|
|
return &httperror.HandlerError{http.StatusInternalServerError, "Error creating docker client", err}
|
|
}
|
|
defer dockerClient.Close()
|
|
|
|
service, _, err := dockerClient.ServiceInspectWithRaw(context.Background(), resourceID, dockertypes.ServiceInspectOptions{InsertDefaults: true})
|
|
if err != nil {
|
|
return &httperror.HandlerError{http.StatusInternalServerError, "Error looking up service", err}
|
|
}
|
|
|
|
service.Spec.TaskTemplate.ForceUpdate++
|
|
|
|
if imageTag != "" {
|
|
service.Spec.TaskTemplate.ContainerSpec.Image = strings.Split(service.Spec.TaskTemplate.ContainerSpec.Image, ":")[0] + ":" + imageTag
|
|
} else {
|
|
service.Spec.TaskTemplate.ContainerSpec.Image = strings.Split(service.Spec.TaskTemplate.ContainerSpec.Image, "@sha")[0]
|
|
}
|
|
|
|
_, err = dockerClient.ServiceUpdate(context.Background(), resourceID, service.Version, service.Spec, dockertypes.ServiceUpdateOptions{QueryRegistry: true})
|
|
|
|
if err != nil {
|
|
return &httperror.HandlerError{http.StatusInternalServerError, "Error updating service", err}
|
|
}
|
|
return response.Empty(w)
|
|
}
|