edgestacks

Documentation

Index

• type Service
  • func NewService(dataStore dataservices.DataStore) *Service
  • func (service *Service) BuildEdgeStack(name string, deploymentType portainer.EdgeStackDeploymentType, ...) (*portainer.EdgeStack, error)
  • func (service *Service) DeleteEdgeStack(edgeStackID portainer.EdgeStackID, ...) error
  • func (service *Service) PersistEdgeStack(stack *portainer.EdgeStack, storeManifest edgetypes.StoreManifestFunc) (*portainer.EdgeStack, error)

Types

type Service

type Service struct {
	// contains filtered or unexported fields
}

Service represents a service for managing edge stacks.

func NewService

func NewService(dataStore dataservices.DataStore) *Service

NewService returns a new instance of a service.

func (*Service) BuildEdgeStack

func (service *Service) BuildEdgeStack(name string,
	deploymentType portainer.EdgeStackDeploymentType,
	edgeGroups []portainer.EdgeGroupID,
	registries []portainer.RegistryID,
	useManifestNamespaces bool,
) (*portainer.EdgeStack, error)

BuildEdgeStack builds the initial edge stack object PersistEdgeStack is required to be called after this to persist the edge stack

func (*Service) DeleteEdgeStack

func (service *Service) DeleteEdgeStack(edgeStackID portainer.EdgeStackID, relatedEdgeGroupsIds []portainer.EdgeGroupID) error

DeleteEdgeStack deletes the edge stack from the database and its relations

func (*Service) PersistEdgeStack

func (service *Service) PersistEdgeStack(
	stack *portainer.EdgeStack,
	storeManifest edgetypes.StoreManifestFunc) (*portainer.EdgeStack, error)

PersistEdgeStack persists the edge stack in the database and its relations