dataservices

package
v0.0.0-...-270f78c Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Mar 31, 2023 License: Zlib Imports: 5 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func IsErrObjectNotFound 

func IsErrObjectNotFound(e error) bool

Types

type APIKeyRepository 

type APIKeyRepository interface {
	CreateAPIKey(key *portainer.APIKey) error
	GetAPIKey(keyID portainer.APIKeyID) (*portainer.APIKey, error)
	UpdateAPIKey(key *portainer.APIKey) error
	DeleteAPIKey(ID portainer.APIKeyID) error
	GetAPIKeysByUserID(userID portainer.UserID) ([]portainer.APIKey, error)
	GetAPIKeyByDigest(digest []byte) (*portainer.APIKey, error)
}

APIKeyRepositoryService

type BlocklistedJWTService 

type BlocklistedJWTService interface {
	JWTService
	AddTokenToBlocklist(token string)
}

BlocklistedJWTService represents a service for blocking specific authentication tokens

type CustomTemplateService 

type CustomTemplateService interface {
	GetNextIdentifier() int
	CustomTemplates() ([]portainer.CustomTemplate, error)
	CustomTemplate(ID portainer.CustomTemplateID) (*portainer.CustomTemplate, error)
	Create(customTemplate *portainer.CustomTemplate) error
	UpdateCustomTemplate(ID portainer.CustomTemplateID, customTemplate *portainer.CustomTemplate) error
	DeleteCustomTemplate(ID portainer.CustomTemplateID) error
	BucketName() string
}

CustomTemplateService represents a service to manage custom templates

type DataStore 

type DataStore interface {
	Open() (newStore bool, err error)
	Init() error
	Close() error
	MigrateData() error
	Rollback(force bool) error
	CheckCurrentEdition() error
	BackupTo(w io.Writer) error
	Export(filename string) (err error)
	IsErrObjectNotFound(err error) bool
	CustomTemplate() CustomTemplateService
	EdgeGroup() EdgeGroupService
	EdgeJob() EdgeJobService
	EdgeStack() EdgeStackService
	Endpoint() EndpointService
	EndpointGroup() EndpointGroupService
	EndpointRelation() EndpointRelationService
	FDOProfile() FDOProfileService
	HelmUserRepository() HelmUserRepositoryService
	Registry() RegistryService
	ResourceControl() ResourceControlService
	Role() RoleService
	APIKeyRepository() APIKeyRepository
	Settings() SettingsService
	Snapshot() SnapshotService
	SSLSettings() SSLSettingsService
	Stack() StackService
	Tag() TagService
	TeamMembership() TeamMembershipService
	Team() TeamService
	TunnelServer() TunnelServerService
	User() UserService
	Version() VersionService
	Webhook() WebhookService
}

DataStore defines the interface to manage the data

type EdgeGroupService 

type EdgeGroupService interface {
	EdgeGroups() ([]portainer.EdgeGroup, error)
	EdgeGroup(ID portainer.EdgeGroupID) (*portainer.EdgeGroup, error)
	Create(group *portainer.EdgeGroup) error
	UpdateEdgeGroup(ID portainer.EdgeGroupID, group *portainer.EdgeGroup) error
	UpdateEdgeGroupFunc(ID portainer.EdgeGroupID, updateFunc func(group *portainer.EdgeGroup)) error
	DeleteEdgeGroup(ID portainer.EdgeGroupID) error
	BucketName() string
}

EdgeGroupService represents a service to manage Edge groups

type EdgeJobService 

type EdgeJobService interface {
	EdgeJobs() ([]portainer.EdgeJob, error)
	EdgeJob(ID portainer.EdgeJobID) (*portainer.EdgeJob, error)
	Create(ID portainer.EdgeJobID, edgeJob *portainer.EdgeJob) error
	UpdateEdgeJob(ID portainer.EdgeJobID, edgeJob *portainer.EdgeJob) error
	DeleteEdgeJob(ID portainer.EdgeJobID) error
	GetNextIdentifier() int
	BucketName() string
}

EdgeJobService represents a service to manage Edge jobs

type EdgeStackService 

type EdgeStackService interface {
	EdgeStacks() ([]portainer.EdgeStack, error)
	EdgeStack(ID portainer.EdgeStackID) (*portainer.EdgeStack, error)
	EdgeStackVersion(ID portainer.EdgeStackID) (int, bool)
	Create(id portainer.EdgeStackID, edgeStack *portainer.EdgeStack) error
	UpdateEdgeStack(ID portainer.EdgeStackID, edgeStack *portainer.EdgeStack) error
	UpdateEdgeStackFunc(ID portainer.EdgeStackID, updateFunc func(edgeStack *portainer.EdgeStack)) error
	DeleteEdgeStack(ID portainer.EdgeStackID) error
	GetNextIdentifier() int
	BucketName() string
}

EdgeStackService represents a service to manage Edge stacks

type EndpointGroupService 

type EndpointGroupService interface {
	EndpointGroup(ID portainer.EndpointGroupID) (*portainer.EndpointGroup, error)
	EndpointGroups() ([]portainer.EndpointGroup, error)
	Create(group *portainer.EndpointGroup) error
	UpdateEndpointGroup(ID portainer.EndpointGroupID, group *portainer.EndpointGroup) error
	DeleteEndpointGroup(ID portainer.EndpointGroupID) error
	BucketName() string
}

EndpointGroupService represents a service for managing environment(endpoint) group data

type EndpointRelationService 

type EndpointRelationService interface {
	EndpointRelations() ([]portainer.EndpointRelation, error)
	EndpointRelation(EndpointID portainer.EndpointID) (*portainer.EndpointRelation, error)
	Create(endpointRelation *portainer.EndpointRelation) error
	UpdateEndpointRelation(EndpointID portainer.EndpointID, endpointRelation *portainer.EndpointRelation) error
	UpdateEndpointRelationFunc(EndpointID portainer.EndpointID, updateFunc func(*portainer.EndpointRelation)) error
	DeleteEndpointRelation(EndpointID portainer.EndpointID) error
	BucketName() string
}

EndpointRelationService represents a service for managing environment(endpoint) relations data

type EndpointService 

type EndpointService interface {
	Endpoint(ID portainer.EndpointID) (*portainer.Endpoint, error)
	EndpointIDByEdgeID(edgeID string) (portainer.EndpointID, bool)
	Heartbeat(endpointID portainer.EndpointID) (int64, bool)
	UpdateHeartbeat(endpointID portainer.EndpointID)
	Endpoints() ([]portainer.Endpoint, error)
	Create(endpoint *portainer.Endpoint) error
	UpdateEndpoint(ID portainer.EndpointID, endpoint *portainer.Endpoint) error
	DeleteEndpoint(ID portainer.EndpointID) error
	GetNextIdentifier() int
	BucketName() string
}

EndpointService represents a service for managing environment(endpoint) data

type FDOProfileService 

type FDOProfileService interface {
	FDOProfiles() ([]portainer.FDOProfile, error)
	FDOProfile(ID portainer.FDOProfileID) (*portainer.FDOProfile, error)
	Create(FDOProfile *portainer.FDOProfile) error
	Update(ID portainer.FDOProfileID, FDOProfile *portainer.FDOProfile) error
	Delete(ID portainer.FDOProfileID) error
	GetNextIdentifier() int
	BucketName() string
}

FDOProfileService represents a service to manage FDO Profiles

type HelmUserRepositoryService 

type HelmUserRepositoryService interface {
	HelmUserRepositories() ([]portainer.HelmUserRepository, error)
	HelmUserRepositoryByUserID(userID portainer.UserID) ([]portainer.HelmUserRepository, error)
	Create(record *portainer.HelmUserRepository) error
	UpdateHelmUserRepository(ID portainer.HelmUserRepositoryID, repository *portainer.HelmUserRepository) error
	DeleteHelmUserRepository(ID portainer.HelmUserRepositoryID) error
	BucketName() string
}

HelmUserRepositoryService represents a service to manage HelmUserRepositories

type JWTService 

type JWTService interface {
	GenerateToken(data *portainer.TokenData) (string, error)
	GenerateTokenForOAuth(data *portainer.TokenData, expiryTime *time.Time) (string, error)
	GenerateTokenForKubeconfig(data *portainer.TokenData) (string, error)
	ParseAndVerifyToken(token string) (*portainer.TokenData, error)
	SetUserSessionDuration(userSessionDuration time.Duration)
}

JWTService represents a service for managing JWT tokens

type RegistryService 

type RegistryService interface {
	Registry(ID portainer.RegistryID) (*portainer.Registry, error)
	Registries() ([]portainer.Registry, error)
	Create(registry *portainer.Registry) error
	UpdateRegistry(ID portainer.RegistryID, registry *portainer.Registry) error
	DeleteRegistry(ID portainer.RegistryID) error
	BucketName() string
}

RegistryService represents a service for managing registry data

type ResourceControlService 

type ResourceControlService interface {
	ResourceControl(ID portainer.ResourceControlID) (*portainer.ResourceControl, error)
	ResourceControlByResourceIDAndType(resourceID string, resourceType portainer.ResourceControlType) (*portainer.ResourceControl, error)
	ResourceControls() ([]portainer.ResourceControl, error)
	Create(rc *portainer.ResourceControl) error
	UpdateResourceControl(ID portainer.ResourceControlID, resourceControl *portainer.ResourceControl) error
	DeleteResourceControl(ID portainer.ResourceControlID) error
	BucketName() string
}

ResourceControlService represents a service for managing resource control data

type RoleService 

type RoleService interface {
	Role(ID portainer.RoleID) (*portainer.Role, error)
	Roles() ([]portainer.Role, error)
	Create(role *portainer.Role) error
	UpdateRole(ID portainer.RoleID, role *portainer.Role) error
	BucketName() string
}

RoleService represents a service for managing user roles

type SSLSettingsService 

type SSLSettingsService interface {
	Settings() (*portainer.SSLSettings, error)
	UpdateSettings(settings *portainer.SSLSettings) error
	BucketName() string
}

SSLSettingsService represents a service for managing application settings

type SettingsService 

type SettingsService interface {
	Settings() (*portainer.Settings, error)
	UpdateSettings(settings *portainer.Settings) error
	IsFeatureFlagEnabled(feature portainer.Feature) bool
	BucketName() string
}

SettingsService represents a service for managing application settings

type SnapshotService 

type SnapshotService interface {
	Snapshot(endpointID portainer.EndpointID) (*portainer.Snapshot, error)
	Snapshots() ([]portainer.Snapshot, error)
	UpdateSnapshot(snapshot *portainer.Snapshot) error
	DeleteSnapshot(endpointID portainer.EndpointID) error
	Create(snapshot *portainer.Snapshot) error
	BucketName() string
}

type StackService 

type StackService interface {
	Stack(ID portainer.StackID) (*portainer.Stack, error)
	StackByName(name string) (*portainer.Stack, error)
	StacksByName(name string) ([]portainer.Stack, error)
	Stacks() ([]portainer.Stack, error)
	Create(stack *portainer.Stack) error
	UpdateStack(ID portainer.StackID, stack *portainer.Stack) error
	DeleteStack(ID portainer.StackID) error
	GetNextIdentifier() int
	StackByWebhookID(ID string) (*portainer.Stack, error)
	RefreshableStacks() ([]portainer.Stack, error)
	BucketName() string
}

StackService represents a service for managing stack data

type TagService 

type TagService interface {
	Tags() ([]portainer.Tag, error)
	Tag(ID portainer.TagID) (*portainer.Tag, error)
	Create(tag *portainer.Tag) error
	UpdateTag(ID portainer.TagID, tag *portainer.Tag) error
	UpdateTagFunc(ID portainer.TagID, updateFunc func(tag *portainer.Tag)) error
	DeleteTag(ID portainer.TagID) error
	BucketName() string
}

TagService represents a service for managing tag data

type TeamMembershipService 

type TeamMembershipService interface {
	TeamMembership(ID portainer.TeamMembershipID) (*portainer.TeamMembership, error)
	TeamMemberships() ([]portainer.TeamMembership, error)
	TeamMembershipsByUserID(userID portainer.UserID) ([]portainer.TeamMembership, error)
	TeamMembershipsByTeamID(teamID portainer.TeamID) ([]portainer.TeamMembership, error)
	Create(membership *portainer.TeamMembership) error
	UpdateTeamMembership(ID portainer.TeamMembershipID, membership *portainer.TeamMembership) error
	DeleteTeamMembership(ID portainer.TeamMembershipID) error
	DeleteTeamMembershipByUserID(userID portainer.UserID) error
	DeleteTeamMembershipByTeamID(teamID portainer.TeamID) error
	BucketName() string
	DeleteTeamMembershipByTeamIDAndUserID(teamID portainer.TeamID, userID portainer.UserID) error
}

TeamMembershipService represents a service for managing team membership data

type TeamService 

type TeamService interface {
	Team(ID portainer.TeamID) (*portainer.Team, error)
	TeamByName(name string) (*portainer.Team, error)
	Teams() ([]portainer.Team, error)
	Create(team *portainer.Team) error
	UpdateTeam(ID portainer.TeamID, team *portainer.Team) error
	DeleteTeam(ID portainer.TeamID) error
	BucketName() string
}

TeamService represents a service for managing user data

type TunnelServerService 

type TunnelServerService interface {
	Info() (*portainer.TunnelServerInfo, error)
	UpdateInfo(info *portainer.TunnelServerInfo) error
	BucketName() string
}

TunnelServerService represents a service for managing data associated to the tunnel server

type UserService 

type UserService interface {
	User(ID portainer.UserID) (*portainer.User, error)
	UserByUsername(username string) (*portainer.User, error)
	Users() ([]portainer.User, error)
	UsersByRole(role portainer.UserRole) ([]portainer.User, error)
	Create(user *portainer.User) error
	UpdateUser(ID portainer.UserID, user *portainer.User) error
	DeleteUser(ID portainer.UserID) error
	BucketName() string
}

UserService represents a service for managing user data

type VersionService 

type VersionService interface {
	Edition() (portainer.SoftwareEdition, error)
	InstanceID() (string, error)
	UpdateInstanceID(ID string) error
	Version() (*models.Version, error)
	UpdateVersion(*models.Version) error
}

VersionService represents a service for managing version data

type WebhookService 

type WebhookService interface {
	Webhooks() ([]portainer.Webhook, error)
	Webhook(ID portainer.WebhookID) (*portainer.Webhook, error)
	Create(portainer *portainer.Webhook) error
	UpdateWebhook(ID portainer.WebhookID, webhook *portainer.Webhook) error
	WebhookByResourceID(resourceID string) (*portainer.Webhook, error)
	WebhookByToken(token string) (*portainer.Webhook, error)
	DeleteWebhook(ID portainer.WebhookID) error
	BucketName() string
}

WebhookService represents a service for managing webhook data.

Source Files

View all Source files

Directories

Path Synopsis
tests

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.