mirror of https://github.com/portainer/portainer
You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
424 lines
15 KiB
424 lines
15 KiB
package edgestacks
|
|
|
|
import (
|
|
"errors"
|
|
"fmt"
|
|
"net/http"
|
|
"strconv"
|
|
"strings"
|
|
"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"
|
|
"github.com/portainer/portainer/api/dataservices"
|
|
"github.com/portainer/portainer/api/filesystem"
|
|
"github.com/portainer/portainer/api/internal/edge"
|
|
)
|
|
|
|
// @id EdgeStackCreate
|
|
// @summary Create an EdgeStack
|
|
// @description **Access policy**: administrator
|
|
// @tags edge_stacks
|
|
// @security ApiKeyAuth
|
|
// @security jwt
|
|
// @produce json
|
|
// @param method query string true "Creation Method" Enums(file,string,repository)
|
|
// @param body_string body swarmStackFromFileContentPayload true "Required when using method=string"
|
|
// @param body_file body swarmStackFromFileUploadPayload true "Required when using method=file"
|
|
// @param body_repository body swarmStackFromGitRepositoryPayload true "Required when using method=repository"
|
|
// @success 200 {object} portainer.EdgeStack
|
|
// @failure 500
|
|
// @failure 503 "Edge compute features are disabled"
|
|
// @router /edge_stacks [post]
|
|
func (handler *Handler) edgeStackCreate(w http.ResponseWriter, r *http.Request) *httperror.HandlerError {
|
|
method, err := request.RetrieveQueryParameter(r, "method", false)
|
|
if err != nil {
|
|
return &httperror.HandlerError{http.StatusBadRequest, "Invalid query parameter: method", err}
|
|
}
|
|
|
|
edgeStack, err := handler.createSwarmStack(method, r)
|
|
if err != nil {
|
|
return &httperror.HandlerError{http.StatusInternalServerError, "Unable to create Edge stack", err}
|
|
}
|
|
|
|
return response.JSON(w, edgeStack)
|
|
}
|
|
|
|
func (handler *Handler) createSwarmStack(method string, r *http.Request) (*portainer.EdgeStack, error) {
|
|
switch method {
|
|
case "string":
|
|
return handler.createSwarmStackFromFileContent(r)
|
|
case "repository":
|
|
return handler.createSwarmStackFromGitRepository(r)
|
|
case "file":
|
|
return handler.createSwarmStackFromFileUpload(r)
|
|
}
|
|
return nil, errors.New("Invalid value for query parameter: method. Value must be one of: string, repository or file")
|
|
}
|
|
|
|
type swarmStackFromFileContentPayload 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"`
|
|
// List of identifiers of EdgeGroups
|
|
EdgeGroups []portainer.EdgeGroupID `example:"1"`
|
|
// Deployment type to deploy this stack
|
|
// Valid values are: 0 - 'compose', 1 - 'kubernetes'
|
|
// for compose stacks will use kompose to convert to kubernetes manifest for kubernetes environments(endpoints)
|
|
// kubernetes deploytype is enabled only for kubernetes environments(endpoints)
|
|
DeploymentType portainer.EdgeStackDeploymentType `example:"0" enums:"0,1"`
|
|
}
|
|
|
|
func (payload *swarmStackFromFileContentPayload) 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")
|
|
}
|
|
if payload.EdgeGroups == nil || len(payload.EdgeGroups) == 0 {
|
|
return errors.New("Edge Groups are mandatory for an Edge stack")
|
|
}
|
|
return nil
|
|
}
|
|
|
|
func (handler *Handler) createSwarmStackFromFileContent(r *http.Request) (*portainer.EdgeStack, error) {
|
|
var payload swarmStackFromFileContentPayload
|
|
err := request.DecodeAndValidateJSONPayload(r, &payload)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
|
|
err = handler.validateUniqueName(payload.Name)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
|
|
stackID := handler.DataStore.EdgeStack().GetNextIdentifier()
|
|
stack := &portainer.EdgeStack{
|
|
ID: portainer.EdgeStackID(stackID),
|
|
Name: payload.Name,
|
|
DeploymentType: payload.DeploymentType,
|
|
CreationDate: time.Now().Unix(),
|
|
EdgeGroups: payload.EdgeGroups,
|
|
Status: make(map[portainer.EndpointID]portainer.EdgeStackStatus),
|
|
Version: 1,
|
|
}
|
|
|
|
relationConfig, err := fetchEndpointRelationsConfig(handler.DataStore)
|
|
if err != nil {
|
|
return nil, fmt.Errorf("unable to find environment relations in database: %w", err)
|
|
}
|
|
|
|
relatedEndpointIds, err := edge.EdgeStackRelatedEndpoints(stack.EdgeGroups, relationConfig.endpoints, relationConfig.endpointGroups, relationConfig.edgeGroups)
|
|
if err != nil {
|
|
return nil, fmt.Errorf("unable to persist environment relation in database: %w", err)
|
|
}
|
|
|
|
stackFolder := strconv.Itoa(int(stack.ID))
|
|
if stack.DeploymentType == portainer.EdgeStackDeploymentCompose {
|
|
stack.EntryPoint = filesystem.ComposeFileDefaultName
|
|
|
|
projectPath, err := handler.FileService.StoreEdgeStackFileFromBytes(stackFolder, stack.EntryPoint, []byte(payload.StackFileContent))
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
stack.ProjectPath = projectPath
|
|
|
|
err = handler.convertAndStoreKubeManifestIfNeeded(stack, relatedEndpointIds)
|
|
if err != nil {
|
|
return nil, fmt.Errorf("Failed creating and storing kube manifest: %w", err)
|
|
}
|
|
|
|
} else {
|
|
hasDockerEndpoint, err := hasDockerEndpoint(handler.DataStore.Endpoint(), relatedEndpointIds)
|
|
if err != nil {
|
|
return nil, fmt.Errorf("unable to check for existence of docker endpoint: %w", err)
|
|
}
|
|
|
|
if hasDockerEndpoint {
|
|
return nil, fmt.Errorf("edge stack with docker endpoint cannot be deployed with kubernetes config")
|
|
}
|
|
|
|
stack.ManifestPath = filesystem.ManifestFileDefaultName
|
|
|
|
projectPath, err := handler.FileService.StoreEdgeStackFileFromBytes(stackFolder, stack.ManifestPath, []byte(payload.StackFileContent))
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
|
|
stack.ProjectPath = projectPath
|
|
}
|
|
|
|
err = updateEndpointRelations(handler.DataStore.EndpointRelation(), stack.ID, relatedEndpointIds)
|
|
if err != nil {
|
|
return nil, fmt.Errorf("Unable to update endpoint relations: %w", err)
|
|
}
|
|
|
|
err = handler.DataStore.EdgeStack().Create(stack.ID, stack)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
|
|
return stack, nil
|
|
}
|
|
|
|
type swarmStackFromGitRepositoryPayload 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
|
|
FilePathInRepository string `example:"docker-compose.yml" default:"docker-compose.yml"`
|
|
// List of identifiers of EdgeGroups
|
|
EdgeGroups []portainer.EdgeGroupID `example:"1"`
|
|
// Deployment type to deploy this stack
|
|
// Valid values are: 0 - 'compose', 1 - 'kubernetes'
|
|
// for compose stacks will use kompose to convert to kubernetes manifest for kubernetes environments(endpoints)
|
|
// kubernetes deploytype is enabled only for kubernetes environments(endpoints)
|
|
DeploymentType portainer.EdgeStackDeploymentType `example:"0" enums:"0,1"`
|
|
}
|
|
|
|
func (payload *swarmStackFromGitRepositoryPayload) 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.RepositoryUsername) || govalidator.IsNull(payload.RepositoryPassword)) {
|
|
return errors.New("Invalid repository credentials. Username and password must be specified when authentication is enabled")
|
|
}
|
|
if govalidator.IsNull(payload.FilePathInRepository) {
|
|
payload.FilePathInRepository = filesystem.ComposeFileDefaultName
|
|
}
|
|
if payload.EdgeGroups == nil || len(payload.EdgeGroups) == 0 {
|
|
return errors.New("Edge Groups are mandatory for an Edge stack")
|
|
}
|
|
return nil
|
|
}
|
|
|
|
func (handler *Handler) createSwarmStackFromGitRepository(r *http.Request) (*portainer.EdgeStack, error) {
|
|
var payload swarmStackFromGitRepositoryPayload
|
|
err := request.DecodeAndValidateJSONPayload(r, &payload)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
|
|
err = handler.validateUniqueName(payload.Name)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
|
|
stackID := handler.DataStore.EdgeStack().GetNextIdentifier()
|
|
stack := &portainer.EdgeStack{
|
|
ID: portainer.EdgeStackID(stackID),
|
|
Name: payload.Name,
|
|
CreationDate: time.Now().Unix(),
|
|
EdgeGroups: payload.EdgeGroups,
|
|
Status: make(map[portainer.EndpointID]portainer.EdgeStackStatus),
|
|
DeploymentType: payload.DeploymentType,
|
|
Version: 1,
|
|
}
|
|
|
|
projectPath := handler.FileService.GetEdgeStackProjectPath(strconv.Itoa(int(stack.ID)))
|
|
stack.ProjectPath = projectPath
|
|
|
|
repositoryUsername := payload.RepositoryUsername
|
|
repositoryPassword := payload.RepositoryPassword
|
|
if !payload.RepositoryAuthentication {
|
|
repositoryUsername = ""
|
|
repositoryPassword = ""
|
|
}
|
|
|
|
relationConfig, err := fetchEndpointRelationsConfig(handler.DataStore)
|
|
if err != nil {
|
|
return nil, fmt.Errorf("failed fetching relations config: %w", err)
|
|
}
|
|
|
|
relatedEndpointIds, err := edge.EdgeStackRelatedEndpoints(stack.EdgeGroups, relationConfig.endpoints, relationConfig.endpointGroups, relationConfig.edgeGroups)
|
|
if err != nil {
|
|
return nil, fmt.Errorf("unable to retrieve related endpoints: %w", err)
|
|
}
|
|
|
|
err = handler.GitService.CloneRepository(projectPath, payload.RepositoryURL, payload.RepositoryReferenceName, repositoryUsername, repositoryPassword)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
|
|
if stack.DeploymentType == portainer.EdgeStackDeploymentCompose {
|
|
stack.EntryPoint = payload.FilePathInRepository
|
|
|
|
err = handler.convertAndStoreKubeManifestIfNeeded(stack, relatedEndpointIds)
|
|
if err != nil {
|
|
return nil, fmt.Errorf("Failed creating and storing kube manifest: %w", err)
|
|
}
|
|
} else {
|
|
stack.ManifestPath = payload.FilePathInRepository
|
|
}
|
|
|
|
err = updateEndpointRelations(handler.DataStore.EndpointRelation(), stack.ID, relatedEndpointIds)
|
|
if err != nil {
|
|
return nil, fmt.Errorf("Unable to update endpoint relations: %w", err)
|
|
}
|
|
|
|
err = handler.DataStore.EdgeStack().Create(stack.ID, stack)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
|
|
return stack, nil
|
|
}
|
|
|
|
type swarmStackFromFileUploadPayload struct {
|
|
Name string
|
|
StackFileContent []byte
|
|
EdgeGroups []portainer.EdgeGroupID
|
|
DeploymentType portainer.EdgeStackDeploymentType
|
|
}
|
|
|
|
func (payload *swarmStackFromFileUploadPayload) Validate(r *http.Request) error {
|
|
name, err := request.RetrieveMultiPartFormValue(r, "Name", false)
|
|
if err != nil {
|
|
return errors.New("Invalid stack name")
|
|
}
|
|
payload.Name = name
|
|
|
|
composeFileContent, _, err := request.RetrieveMultiPartFormFile(r, "file")
|
|
if err != nil {
|
|
return errors.New("Invalid Compose file. Ensure that the Compose file is uploaded correctly")
|
|
}
|
|
payload.StackFileContent = composeFileContent
|
|
|
|
var edgeGroups []portainer.EdgeGroupID
|
|
err = request.RetrieveMultiPartFormJSONValue(r, "EdgeGroups", &edgeGroups, false)
|
|
if err != nil || len(edgeGroups) == 0 {
|
|
return errors.New("Edge Groups are mandatory for an Edge stack")
|
|
}
|
|
payload.EdgeGroups = edgeGroups
|
|
|
|
deploymentType, err := request.RetrieveNumericMultiPartFormValue(r, "DeploymentType", true)
|
|
if err != nil {
|
|
return errors.New("Invalid deployment type")
|
|
}
|
|
payload.DeploymentType = portainer.EdgeStackDeploymentType(deploymentType)
|
|
|
|
return nil
|
|
}
|
|
|
|
func (handler *Handler) createSwarmStackFromFileUpload(r *http.Request) (*portainer.EdgeStack, error) {
|
|
payload := &swarmStackFromFileUploadPayload{}
|
|
err := payload.Validate(r)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
|
|
err = handler.validateUniqueName(payload.Name)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
|
|
stackID := handler.DataStore.EdgeStack().GetNextIdentifier()
|
|
stack := &portainer.EdgeStack{
|
|
ID: portainer.EdgeStackID(stackID),
|
|
Name: payload.Name,
|
|
DeploymentType: payload.DeploymentType,
|
|
CreationDate: time.Now().Unix(),
|
|
EdgeGroups: payload.EdgeGroups,
|
|
Status: make(map[portainer.EndpointID]portainer.EdgeStackStatus),
|
|
Version: 1,
|
|
}
|
|
|
|
relationConfig, err := fetchEndpointRelationsConfig(handler.DataStore)
|
|
if err != nil {
|
|
return nil, fmt.Errorf("failed fetching relations config: %w", err)
|
|
}
|
|
|
|
relatedEndpointIds, err := edge.EdgeStackRelatedEndpoints(stack.EdgeGroups, relationConfig.endpoints, relationConfig.endpointGroups, relationConfig.edgeGroups)
|
|
if err != nil {
|
|
return nil, fmt.Errorf("unable to retrieve related endpoints: %w", err)
|
|
}
|
|
|
|
stackFolder := strconv.Itoa(int(stack.ID))
|
|
if stack.DeploymentType == portainer.EdgeStackDeploymentCompose {
|
|
stack.EntryPoint = filesystem.ComposeFileDefaultName
|
|
|
|
projectPath, err := handler.FileService.StoreEdgeStackFileFromBytes(stackFolder, stack.EntryPoint, []byte(payload.StackFileContent))
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
stack.ProjectPath = projectPath
|
|
|
|
err = handler.convertAndStoreKubeManifestIfNeeded(stack, relatedEndpointIds)
|
|
if err != nil {
|
|
return nil, fmt.Errorf("Failed creating and storing kube manifest: %w", err)
|
|
}
|
|
|
|
} else {
|
|
stack.ManifestPath = filesystem.ManifestFileDefaultName
|
|
|
|
projectPath, err := handler.FileService.StoreEdgeStackFileFromBytes(stackFolder, stack.ManifestPath, []byte(payload.StackFileContent))
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
stack.ProjectPath = projectPath
|
|
}
|
|
|
|
err = updateEndpointRelations(handler.DataStore.EndpointRelation(), stack.ID, relatedEndpointIds)
|
|
if err != nil {
|
|
return nil, fmt.Errorf("Unable to update endpoint relations: %w", err)
|
|
}
|
|
|
|
err = handler.DataStore.EdgeStack().Create(stack.ID, stack)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
|
|
return stack, nil
|
|
}
|
|
|
|
func (handler *Handler) validateUniqueName(name string) error {
|
|
edgeStacks, err := handler.DataStore.EdgeStack().EdgeStacks()
|
|
if err != nil {
|
|
return err
|
|
}
|
|
|
|
for _, stack := range edgeStacks {
|
|
if strings.EqualFold(stack.Name, name) {
|
|
return errors.New("Edge stack name must be unique")
|
|
}
|
|
}
|
|
return nil
|
|
}
|
|
|
|
// updateEndpointRelations adds a relation between the Edge Stack to the related environments(endpoints)
|
|
func updateEndpointRelations(endpointRelationService dataservices.EndpointRelationService, edgeStackID portainer.EdgeStackID, relatedEndpointIds []portainer.EndpointID) error {
|
|
for _, endpointID := range relatedEndpointIds {
|
|
relation, err := endpointRelationService.EndpointRelation(endpointID)
|
|
if err != nil {
|
|
return fmt.Errorf("unable to find endpoint relation in database: %w", err)
|
|
}
|
|
|
|
relation.EdgeStacks[edgeStackID] = true
|
|
|
|
err = endpointRelationService.UpdateEndpointRelation(endpointID, relation)
|
|
if err != nil {
|
|
return fmt.Errorf("unable to persist endpoint relation in database: %w", err)
|
|
}
|
|
}
|
|
|
|
return nil
|
|
}
|