portainer

package module

v0.0.0-...-270f78c Latest Latest Go to latest Published: Mar 31, 2023 License: Zlib Imports: 9 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/cloudogu/portainer-ce

Links

Open Source Insights

Documentation ¶

Index ¶

Constants
Variables
type APIKey
type APIKeyID
type AccessPolicy
type AgentPlatform
type AuthenticationMethod
type Authorization
type Authorizations
type AzureCredentials
type CLIFlags
type CLIService
type ComposeStackManager
type Connection
type CryptoService
type CustomTemplate
type CustomTemplateID
type CustomTemplatePlatform
type CustomTemplateVariableDefinition
type DigitalSignatureService
type DockerHub
type DockerSnapshot
type DockerSnapshotRaw
type DockerSnapshotter
type EcrData
type EdgeGroup
type EdgeGroupID
type EdgeJob
type EdgeJobEndpointMeta
type EdgeJobID
type EdgeJobLogsStatus
type EdgeScheduledeprecated
type EdgeStack
type EdgeStackDeploymentType
type EdgeStackID
type EdgeStackStatus
type EdgeStackStatusDetails
type EdgeStackStatusType
type Endpoint
type EndpointAuthorizations
type EndpointGroup
type EndpointGroupID
type EndpointID
type EndpointPostInitMigrations
type EndpointRelation
type EndpointSecuritySettings
type EndpointStatus
type EndpointSyncJob
type EndpointType
type Extension
type ExtensionID
type FDOConfiguration
type FDOProfile
type FDOProfileID
type Feature
type FileService
type GitService
type GitlabRegistryData
type HelmUserRepository
type HelmUserRepositoryID
type InternalAuthSettings
type JobType
type K8sNamespaceAccessPolicy
type K8sNamespaceInfo
type K8sNodeLimits
type K8sNodesLimits
type KubeClient
type KubernetesConfiguration
type KubernetesData
- func KubernetesDefault() KubernetesData
type KubernetesDeployer
type KubernetesFlags
type KubernetesIngressClassConfig
type KubernetesShellPod
type KubernetesSnapshot
type KubernetesSnapshotter
type KubernetesStorageClassConfig
type LDAPGroupSearchSettings
type LDAPSearchSettings
type LDAPService
type LDAPSettings
type LDAPUser
type LicenseInformation
type MembershipRole
type OAuthService
type OAuthSettings
type OAuthUserData
type OpenAMTConfiguration
type OpenAMTDeviceEnabledFeatures
type OpenAMTDeviceInformation
type OpenAMTService
type Pair
type PowerState
type QuayRegistryData
type Registry
type RegistryAccessPolicies
type RegistryAccesses
type RegistryID
type RegistryManagementConfiguration
type RegistryType
type ResourceAccessLevel
type ResourceControl
type ResourceControlID
type ResourceControlType
type ReverseTunnelService
type Role
type RoleID
type SSLSettings
type Schedule
type ScheduleID
type ScriptExecutionJob
type Server
type Settings
type Snapshot
type SnapshotJob
type SnapshotService
type SoftwareEdition
type Stack
type StackAutoUpdate
type StackID
type StackOption
type StackStatus
type StackType
type Status
type SwarmStackManager
type TLSConfiguration
type TLSFileType
type Tag
type TagID
type Team
type TeamAccessPolicies
type TeamID
type TeamMembership
type TeamMembershipID
type TeamResourceAccess
type Template
type TemplateEnv
type TemplateEnvSelect
type TemplateID
type TemplateRepository
type TemplateType
type TemplateVolume
type TokenData
type TunnelDetails
type TunnelServerInfo
type User
type UserAccessPolicies
type UserID
type UserResourceAccess
type UserRole
type UserThemeSettings
type Webhook
type WebhookID
type WebhookType

Constants ¶

View Source

const (
	// APIVersion is the version number of the Portainer API
	APIVersion = "2.17.1"
	// Edition is what this edition of Portainer is called
	Edition = PortainerCE
	// ComposeSyntaxMaxVersion is a maximum supported version of the docker compose syntax
	ComposeSyntaxMaxVersion = "3.9"
	// AssetsServerURL represents the URL of the Portainer asset server
	AssetsServerURL = "https://portainer-io-assets.sfo2.digitaloceanspaces.com"
	// MessageOfTheDayURL represents the URL where Portainer MOTD message can be retrieved
	MessageOfTheDayURL = AssetsServerURL + "/motd.json"
	// VersionCheckURL represents the URL used to retrieve the latest version of Portainer
	VersionCheckURL = "https://api.github.com/repos/portainer/portainer/releases/latest"
	// PortainerAgentHeader represents the name of the header available in any agent response
	PortainerAgentHeader = "Portainer-Agent"
	// PortainerAgentEdgeIDHeader represent the name of the header containing the Edge ID associated to an agent/agent cluster
	PortainerAgentEdgeIDHeader = "X-PortainerAgent-EdgeID"
	// HTTPResponseAgentPlatform represents the name of the header containing the Agent platform
	HTTPResponseAgentPlatform = "Portainer-Agent-Platform"
	// PortainerAgentTargetHeader represent the name of the header containing the target node name
	PortainerAgentTargetHeader = "X-PortainerAgent-Target"
	// PortainerAgentSignatureHeader represent the name of the header containing the digital signature
	PortainerAgentSignatureHeader = "X-PortainerAgent-Signature"
	// PortainerAgentPublicKeyHeader represent the name of the header containing the public key
	PortainerAgentPublicKeyHeader = "X-PortainerAgent-PublicKey"
	// PortainerAgentKubernetesSATokenHeader represent the name of the header containing a Kubernetes SA token
	PortainerAgentKubernetesSATokenHeader = "X-PortainerAgent-SA-Token"
	// PortainerAgentSignatureMessage represents the message used to create a digital signature
	// to be used when communicating with an agent
	PortainerAgentSignatureMessage = "Portainer-App"
	// DefaultSnapshotInterval represents the default interval between each environment snapshot job
	DefaultSnapshotInterval = "5m"
	// DefaultEdgeAgentCheckinIntervalInSeconds represents the default interval (in seconds) used by Edge agents to checkin with the Portainer instance
	DefaultEdgeAgentCheckinIntervalInSeconds = 5
	// DefaultTemplatesURL represents the URL to the official templates supported by Portainer
	DefaultTemplatesURL = "https://raw.githubusercontent.com/portainer/templates/master/templates-2.0.json"
	// DefaultHelmrepositoryURL represents the URL to the official templates supported by Bitnami
	DefaultHelmRepositoryURL = "https://charts.bitnami.com/bitnami"
	// DefaultUserSessionTimeout represents the default timeout after which the user session is cleared
	DefaultUserSessionTimeout = "8h"
	// DefaultUserSessionTimeout represents the default timeout after which the user session is cleared
	DefaultKubeconfigExpiry = "0"
	// DefaultKubectlShellImage represents the default image and tag for the kubectl shell
	DefaultKubectlShellImage = "portainer/kubectl-shell"
	// WebSocketKeepAlive web socket keep alive for edge environments
	WebSocketKeepAlive = 1 * time.Hour
)

View Source

const (
	// EdgeAgentIdle represents an idle state for a tunnel connected to an Edge environment(endpoint).
	EdgeAgentIdle string = "IDLE"
	// EdgeAgentManagementRequired represents a required state for a tunnel connected to an Edge environment(endpoint)
	EdgeAgentManagementRequired string = "REQUIRED"
	// EdgeAgentActive represents an active state for a tunnel connected to an Edge environment(endpoint)
	EdgeAgentActive string = "ACTIVE"
)

View Source

const (
	AzurePathContainerGroups = "/subscriptions/*/providers/Microsoft.ContainerInstance/containerGroups"
	AzurePathContainerGroup  = "/subscriptions/*/resourceGroups/*/providers/Microsoft.ContainerInstance/containerGroups/*"
)

View Source

const (

	// SnapshotJobType is a system job used to create environment(endpoint) snapshots
	SnapshotJobType = 2
)

Variables ¶

View Source

var SupportedFeatureFlags = []Feature{}

List of supported features

Functions ¶

This section is empty.

Types ¶

type APIKeyID ¶

type APIKeyID int

APIKeyID represents an API key identifier

type AccessPolicy ¶

type AccessPolicy struct {
	// Role identifier. Reference the role that will be associated to this access policy
	RoleID RoleID `json:"RoleId" example:"1"`
}

AccessPolicy represent a policy that can be associated to a user or team

type AgentPlatform ¶

type AgentPlatform int

AgentPlatform represents a platform type for an Agent

const (

	// AgentPlatformDocker represent the Docker platform (Standalone/Swarm)
	AgentPlatformDocker AgentPlatform
	// AgentPlatformKubernetes represent the Kubernetes platform
	AgentPlatformKubernetes
)

type AuthenticationMethod ¶

type AuthenticationMethod int

AuthenticationMethod represents the authentication method used to authenticate a user

const (

	// AuthenticationInternal represents the internal authentication method (authentication against Portainer API)
	AuthenticationInternal AuthenticationMethod
	// AuthenticationLDAP represents the LDAP authentication method (authentication against a LDAP server)
	AuthenticationLDAP
	//AuthenticationOAuth represents the OAuth authentication method (authentication against a authorization server)
	AuthenticationOAuth
)

type Authorizations ¶

type Authorizations map[Authorization]bool

Authorizations represents a set of authorizations associated to a role

type AzureCredentials ¶

type AzureCredentials struct {
	// Azure application ID
	ApplicationID string `json:"ApplicationID" example:"eag7cdo9-o09l-9i83-9dO9-f0b23oe78db4"`
	// Azure tenant ID
	TenantID string `json:"TenantID" example:"34ddc78d-4fel-2358-8cc1-df84c8o839f5"`
	// Azure authentication key
	AuthenticationKey string `json:"AuthenticationKey" example:"cOrXoK/1D35w8YQ8nH1/8ZGwzz45JIYD5jxHKXEQknk="`
}

AzureCredentials represents the credentials used to connect to an Azure environment(endpoint).

type CLIFlags ¶

type CLIFlags struct {
	Addr                      *string
	AddrHTTPS                 *string
	TunnelAddr                *string
	TunnelPort                *string
	AdminPassword             *string
	AdminPasswordFile         *string
	Assets                    *string
	Data                      *string
	FeatureFlags              *[]Pair
	DemoEnvironment           *bool
	EnableEdgeComputeFeatures *bool
	EndpointURL               *string
	Labels                    *[]Pair
	Logo                      *string
	NoAnalytics               *bool
	Templates                 *string
	TLS                       *bool
	TLSSkipVerify             *bool
	TLSCacert                 *string
	TLSCert                   *string
	TLSKey                    *string
	HTTPDisabled              *bool
	HTTPEnabled               *bool
	SSL                       *bool
	SSLCert                   *string
	SSLKey                    *string
	Rollback                  *bool
	SnapshotInterval          *string
	BaseURL                   *string
	InitialMmapSize           *int
	MaxBatchSize              *int
	MaxBatchDelay             *time.Duration
	SecretKeyName             *string
	LogLevel                  *string
	LogMode                   *string
}

CLIFlags represents the available flags on the CLI

type CLIService ¶

type CLIService interface {
	ParseFlags(version string) (*CLIFlags, error)
	ValidateFlags(flags *CLIFlags) error
}

CLIService represents a service for managing CLI

type ComposeStackManager ¶

type ComposeStackManager interface {
	ComposeSyntaxMaxVersion() string
	NormalizeStackName(name string) string
	Up(ctx context.Context, stack *Stack, endpoint *Endpoint, forceRereate bool) error
	Down(ctx context.Context, stack *Stack, endpoint *Endpoint) error
	Pull(ctx context.Context, stack *Stack, endpoint *Endpoint) error
}

ComposeStackManager represents a service to manage Compose stacks

type Connection ¶

type Connection interface {
	Open() error
	Close() error

	// write the db contents to filename as json (the schema needs defining)
	ExportRaw(filename string) error

	// TODO: this one is very database specific atm
	BackupTo(w io.Writer) error
	GetDatabaseFileName() string
	GetDatabaseFilePath() string
	GetStorePath() string

	IsEncryptedStore() bool
	NeedsEncryptionMigration() (bool, error)
	SetEncrypted(encrypted bool)

	SetServiceName(bucketName string) error
	GetObject(bucketName string, key []byte, object interface{}) error
	UpdateObject(bucketName string, key []byte, object interface{}) error
	UpdateObjectFunc(bucketName string, key []byte, object any, updateFn func()) error
	DeleteObject(bucketName string, key []byte) error
	DeleteAllObjects(bucketName string, obj interface{}, matching func(o interface{}) (id int, ok bool)) error
	GetNextIdentifier(bucketName string) int
	CreateObject(bucketName string, fn func(uint64) (int, interface{})) error
	CreateObjectWithId(bucketName string, id int, obj interface{}) error
	CreateObjectWithStringId(bucketName string, id []byte, obj interface{}) error
	GetAll(bucketName string, obj interface{}, append func(o interface{}) (interface{}, error)) error
	GetAllWithJsoniter(bucketName string, obj interface{}, append func(o interface{}) (interface{}, error)) error
	ConvertToKey(v int) []byte

	BackupMetadata() (map[string]interface{}, error)
	RestoreMetadata(s map[string]interface{}) error
}

type CryptoService ¶

type CryptoService interface {
	Hash(data string) (string, error)
	CompareHashAndData(hash string, data string) error
}

CryptoService represents a service for encrypting/hashing data

type CustomTemplate ¶

type CustomTemplate struct {
	// CustomTemplate Identifier
	ID CustomTemplateID `json:"Id" example:"1"`
	// Title of the template
	Title string `json:"Title" example:"Nginx"`
	// Description of the template
	Description string `json:"Description" example:"High performance web server"`
	// Path on disk to the repository hosting the Stack file
	ProjectPath string `json:"ProjectPath" example:"/data/custom_template/3"`
	// Path to the Stack file
	EntryPoint string `json:"EntryPoint" example:"docker-compose.yml"`
	// User identifier who created this template
	CreatedByUserID UserID `json:"CreatedByUserId" example:"3"`
	// A note that will be displayed in the UI. Supports HTML content
	Note string `json:"Note" example:"This is my <b>custom</b> template"`
	// Platform associated to the template.
	// Valid values are: 1 - 'linux', 2 - 'windows'
	Platform CustomTemplatePlatform `json:"Platform" example:"1" enums:"1,2"`
	// URL of the template's logo
	Logo string `json:"Logo" example:"https://cloudinovasi.id/assets/img/logos/nginx.png"`
	// Type of created stack (1 - swarm, 2 - compose)
	Type            StackType        `json:"Type" example:"1"`
	ResourceControl *ResourceControl `json:"ResourceControl"`
	Variables       []CustomTemplateVariableDefinition
}

CustomTemplate represents a custom template

type CustomTemplateID ¶

type CustomTemplateID int

CustomTemplateID represents a custom template identifier

type CustomTemplatePlatform ¶

type CustomTemplatePlatform int

CustomTemplatePlatform represents a custom template platform

const (

	// CustomTemplatePlatformLinux represents a custom template for linux
	CustomTemplatePlatformLinux CustomTemplatePlatform
	// CustomTemplatePlatformWindows represents a custom template for windows
	CustomTemplatePlatformWindows
)

type CustomTemplateVariableDefinition ¶

type CustomTemplateVariableDefinition struct {
	Name         string `json:"name" example:"MY_VAR"`
	Label        string `json:"label" example:"My Variable"`
	DefaultValue string `json:"defaultValue" example:"default value"`
	Description  string `json:"description" example:"Description"`
}

CustomTemplateVariableDefinition

type DigitalSignatureService ¶

type DigitalSignatureService interface {
	ParseKeyPair(private, public []byte) error
	GenerateKeyPair() ([]byte, []byte, error)
	EncodedPublicKey() string
	PEMHeaders() (string, string)
	CreateSignature(message string) (string, error)
}

DigitalSignatureService represents a service to manage digital signatures

type DockerHub ¶

type DockerHub struct {
	// Is authentication against DockerHub enabled
	Authentication bool `json:"Authentication" example:"true"`
	// Username used to authenticate against the DockerHub
	Username string `json:"Username" example:"user"`
	// Password used to authenticate against the DockerHub
	Password string `json:"Password,omitempty" example:"passwd"`
}

DockerHub represents all the required information to connect and use the Docker Hub

type DockerSnapshot ¶

type DockerSnapshot struct {
	Time                    int64             `json:"Time"`
	DockerVersion           string            `json:"DockerVersion"`
	Swarm                   bool              `json:"Swarm"`
	TotalCPU                int               `json:"TotalCPU"`
	TotalMemory             int64             `json:"TotalMemory"`
	RunningContainerCount   int               `json:"RunningContainerCount"`
	StoppedContainerCount   int               `json:"StoppedContainerCount"`
	HealthyContainerCount   int               `json:"HealthyContainerCount"`
	UnhealthyContainerCount int               `json:"UnhealthyContainerCount"`
	VolumeCount             int               `json:"VolumeCount"`
	ImageCount              int               `json:"ImageCount"`
	ServiceCount            int               `json:"ServiceCount"`
	StackCount              int               `json:"StackCount"`
	SnapshotRaw             DockerSnapshotRaw `json:"DockerSnapshotRaw"`
	NodeCount               int               `json:"NodeCount"`
	GpuUseAll               bool              `json:"GpuUseAll"`
	GpuUseList              []string          `json:"GpuUseList"`
}

DockerSnapshot represents a snapshot of a specific Docker environment(endpoint) at a specific time

type DockerSnapshotRaw ¶

type DockerSnapshotRaw struct {
	Containers []types.Container       `json:"Containers" swaggerignore:"true"`
	Volumes    volume.VolumeListOKBody `json:"Volumes" swaggerignore:"true"`
	Networks   []types.NetworkResource `json:"Networks" swaggerignore:"true"`
	Images     []types.ImageSummary    `json:"Images" swaggerignore:"true"`
	Info       types.Info              `json:"Info" swaggerignore:"true"`
	Version    types.Version           `json:"Version" swaggerignore:"true"`
}

type DockerSnapshotter ¶

type DockerSnapshotter interface {
	CreateSnapshot(endpoint *Endpoint) (*DockerSnapshot, error)
}

DockerSnapshotter represents a service used to create Docker environment(endpoint) snapshots

type EcrData ¶

type EcrData struct {
	Region string `json:"Region" example:"ap-southeast-2"`
}

EcrData represents data required for ECR registry

type EdgeGroupID ¶

type EdgeGroupID int

EdgeGroupID represents an Edge group identifier

type EdgeJob ¶

type EdgeJob struct {
	// EdgeJob Identifier
	ID             EdgeJobID                          `json:"Id" example:"1"`
	Created        int64                              `json:"Created"`
	CronExpression string                             `json:"CronExpression"`
	Endpoints      map[EndpointID]EdgeJobEndpointMeta `json:"Endpoints"`
	EdgeGroups     []EdgeGroupID                      `json:"EdgeGroups"`
	Name           string                             `json:"Name"`
	ScriptPath     string                             `json:"ScriptPath"`
	Recurring      bool                               `json:"Recurring"`
	Version        int                                `json:"Version"`

	// Field used for log collection of Endpoints belonging to EdgeGroups
	GroupLogsCollection map[EndpointID]EdgeJobEndpointMeta
}

EdgeJob represents a job that can run on Edge environments(endpoints).

type EdgeJobEndpointMeta ¶

type EdgeJobEndpointMeta struct {
	LogsStatus  EdgeJobLogsStatus
	CollectLogs bool
}

EdgeJobEndpointMeta represents a meta data object for an Edge job and Environment(Endpoint) relation

type EdgeJobID ¶

type EdgeJobID int

EdgeJobID represents an Edge job identifier

type EdgeJobLogsStatus ¶

type EdgeJobLogsStatus int

EdgeJobLogsStatus represent status of logs collection job

const (

	// EdgeJobLogsStatusIdle represents an idle log collection job
	EdgeJobLogsStatusIdle EdgeJobLogsStatus
	// EdgeJobLogsStatusPending represents a pending log collection job
	EdgeJobLogsStatusPending
	// EdgeJobLogsStatusCollected represents a completed log collection job
	EdgeJobLogsStatusCollected
)

type EdgeSchedule deprecated

type EdgeSchedule struct {
	// EdgeSchedule Identifier
	ID             ScheduleID   `json:"Id" example:"1"`
	CronExpression string       `json:"CronExpression"`
	Script         string       `json:"Script"`
	Version        int          `json:"Version"`
	Endpoints      []EndpointID `json:"Endpoints"`
}

EdgeSchedule represents a scheduled job that can run on Edge environments(endpoints).

Deprecated: in favor of EdgeJob

type EdgeStackDeploymentType ¶

type EdgeStackDeploymentType int

const (
	// EdgeStackDeploymentCompose represent an edge stack deployed using a compose file
	EdgeStackDeploymentCompose EdgeStackDeploymentType = iota
	// EdgeStackDeploymentKubernetes represent an edge stack deployed using a kubernetes manifest file
	EdgeStackDeploymentKubernetes
)

type EdgeStackStatus ¶

type EdgeStackStatus struct {
	Details    EdgeStackStatusDetails `json:"Details"`
	Error      string                 `json:"Error"`
	EndpointID EndpointID             `json:"EndpointID"`

	// Deprecated
	Type EdgeStackStatusType `json:"Type"`
}

EdgeStackStatus represents an edge stack status

type EdgeStackStatusDetails ¶

type EdgeStackStatusDetails struct {
	Pending             bool
	Ok                  bool
	Error               bool
	Acknowledged        bool
	Remove              bool
	RemoteUpdateSuccess bool
	ImagesPulled        bool
}

type EdgeStackStatusType ¶

type EdgeStackStatusType int

EdgeStackStatusType represents an edge stack status type

const (
	// EdgeStackStatusPending represents a pending edge stack
	EdgeStackStatusPending EdgeStackStatusType = iota
	//EdgeStackStatusOk represents a successfully deployed edge stack
	EdgeStackStatusOk
	//EdgeStackStatusError represents an edge environment(endpoint) which failed to deploy its edge stack
	EdgeStackStatusError
	//EdgeStackStatusAcknowledged represents an acknowledged edge stack
	EdgeStackStatusAcknowledged
	//EdgeStackStatusRemove represents a removed edge stack (status isn't persisted)
	EdgeStackStatusRemove
	// StatusRemoteUpdateSuccess represents a successfully updated edge stack
	EdgeStackStatusRemoteUpdateSuccess
	// EdgeStackStatusImagesPulled represents a successfully images-pulling
	EdgeStackStatusImagesPulled
)

type Endpoint ¶

type Endpoint struct {
	// Environment(Endpoint) Identifier
	ID EndpointID `json:"Id" example:"1"`
	// Environment(Endpoint) name
	Name string `json:"Name" example:"my-environment"`
	// Environment(Endpoint) environment(endpoint) type. 1 for a Docker environment(endpoint), 2 for an agent on Docker environment(endpoint) or 3 for an Azure environment(endpoint).
	Type EndpointType `json:"Type" example:"1"`
	// URL or IP address of the Docker host associated to this environment(endpoint)
	URL string `json:"URL" example:"docker.mydomain.tld:2375"`
	// Environment(Endpoint) group identifier
	GroupID EndpointGroupID `json:"GroupId" example:"1"`
	// URL or IP address where exposed containers will be reachable
	PublicURL        string           `json:"PublicURL" example:"docker.mydomain.tld:2375"`
	Gpus             []Pair           `json:"Gpus"`
	TLSConfig        TLSConfiguration `json:"TLSConfig"`
	AzureCredentials AzureCredentials `json:"AzureCredentials,omitempty"`
	// List of tag identifiers to which this environment(endpoint) is associated
	TagIDs []TagID `json:"TagIds"`
	// The status of the environment(endpoint) (1 - up, 2 - down)
	Status EndpointStatus `json:"Status" example:"1"`
	// List of snapshots
	Snapshots []DockerSnapshot `json:"Snapshots"`
	// List of user identifiers authorized to connect to this environment(endpoint)
	UserAccessPolicies UserAccessPolicies `json:"UserAccessPolicies"`
	// List of team identifiers authorized to connect to this environment(endpoint)
	TeamAccessPolicies TeamAccessPolicies `json:"TeamAccessPolicies"`
	// The identifier of the edge agent associated with this environment(endpoint)
	EdgeID string `json:"EdgeID,omitempty"`
	// The key which is used to map the agent to Portainer
	EdgeKey string `json:"EdgeKey"`
	// The check in interval for edge agent (in seconds)
	EdgeCheckinInterval int `json:"EdgeCheckinInterval" example:"5"`
	// Associated Kubernetes data
	Kubernetes KubernetesData `json:"Kubernetes"`
	// Maximum version of docker-compose
	ComposeSyntaxMaxVersion string `json:"ComposeSyntaxMaxVersion" example:"3.8"`
	// Environment(Endpoint) specific security settings
	SecuritySettings EndpointSecuritySettings
	// The identifier of the AMT Device associated with this environment(endpoint)
	AMTDeviceGUID string `json:"AMTDeviceGUID,omitempty" example:"4c4c4544-004b-3910-8037-b6c04f504633"`
	// LastCheckInDate mark last check-in date on checkin
	LastCheckInDate int64
	// QueryDate of each query with the endpoints list
	QueryDate int64
	// IsEdgeDevice marks if the environment was created as an EdgeDevice
	IsEdgeDevice bool
	// Whether the device has been trusted or not by the user
	UserTrusted bool

	// Whether we need to run any "post init migrations".
	PostInitMigrations EndpointPostInitMigrations `json:"PostInitMigrations"`

	Edge struct {
		// Whether the device has been started in edge async mode
		AsyncMode bool
		// The ping interval for edge agent - used in edge async mode [seconds]
		PingInterval int `json:"PingInterval" example:"60"`
		// The snapshot interval for edge agent - used in edge async mode [seconds]
		SnapshotInterval int `json:"SnapshotInterval" example:"60"`
		// The command list interval for edge agent - used in edge async mode [seconds]
		CommandInterval int `json:"CommandInterval" example:"60"`
	}

	Agent struct {
		Version string `example:"1.0.0"`
	}

	// Deprecated fields
	// Deprecated in DBVersion == 4
	TLS           bool   `json:"TLS,omitempty"`
	TLSCACertPath string `json:"TLSCACert,omitempty"`
	TLSCertPath   string `json:"TLSCert,omitempty"`
	TLSKeyPath    string `json:"TLSKey,omitempty"`

	// Deprecated in DBVersion == 18
	AuthorizedUsers []UserID `json:"AuthorizedUsers"`
	AuthorizedTeams []TeamID `json:"AuthorizedTeams"`

	// Deprecated in DBVersion == 22
	Tags []string `json:"Tags"`
}

Environment(Endpoint) represents a Docker environment(endpoint) with all the info required to connect to it

type EndpointAuthorizations ¶

type EndpointAuthorizations map[EndpointID]Authorizations

EndpointAuthorizations represents the authorizations associated to a set of environments(endpoints)

type EndpointGroup ¶

type EndpointGroup struct {
	// Environment(Endpoint) group Identifier
	ID EndpointGroupID `json:"Id" example:"1"`
	// Environment(Endpoint) group name
	Name string `json:"Name" example:"my-environment-group"`
	// Description associated to the environment(endpoint) group
	Description        string             `json:"Description" example:"Environment(Endpoint) group description"`
	UserAccessPolicies UserAccessPolicies `json:"UserAccessPolicies"`
	TeamAccessPolicies TeamAccessPolicies `json:"TeamAccessPolicies"`
	// List of tags associated to this environment(endpoint) group
	TagIDs []TagID `json:"TagIds"`

	// Deprecated fields
	Labels []Pair `json:"Labels"`

	// Deprecated in DBVersion == 18
	AuthorizedUsers []UserID `json:"AuthorizedUsers"`
	AuthorizedTeams []TeamID `json:"AuthorizedTeams"`

	// Deprecated in DBVersion == 22
	Tags []string `json:"Tags"`
}

EndpointGroup represents a group of environments(endpoints)

type EndpointGroupID ¶

type EndpointGroupID int

EndpointGroupID represents an environment(endpoint) group identifier

type EndpointID ¶

type EndpointID int

EndpointID represents an environment(endpoint) identifier

type EndpointPostInitMigrations ¶

type EndpointPostInitMigrations struct {
	MigrateIngresses bool `json:"MigrateIngresses"`
}

EndpointPostInitMigrations

type EndpointRelation ¶

type EndpointRelation struct {
	EndpointID EndpointID
	EdgeStacks map[EdgeStackID]bool
}

EndpointRelation represents a environment(endpoint) relation object

type EndpointSecuritySettings ¶

type EndpointSecuritySettings struct {
	// Whether non-administrator should be able to use bind mounts when creating containers
	AllowBindMountsForRegularUsers bool `json:"allowBindMountsForRegularUsers" example:"false"`
	// Whether non-administrator should be able to use privileged mode when creating containers
	AllowPrivilegedModeForRegularUsers bool `json:"allowPrivilegedModeForRegularUsers" example:"false"`
	// Whether non-administrator should be able to browse volumes
	AllowVolumeBrowserForRegularUsers bool `json:"allowVolumeBrowserForRegularUsers" example:"true"`
	// Whether non-administrator should be able to use the host pid
	AllowHostNamespaceForRegularUsers bool `json:"allowHostNamespaceForRegularUsers" example:"true"`
	// Whether non-administrator should be able to use device mapping
	AllowDeviceMappingForRegularUsers bool `json:"allowDeviceMappingForRegularUsers" example:"true"`
	// Whether non-administrator should be able to manage stacks
	AllowStackManagementForRegularUsers bool `json:"allowStackManagementForRegularUsers" example:"true"`
	// Whether non-administrator should be able to use container capabilities
	AllowContainerCapabilitiesForRegularUsers bool `json:"allowContainerCapabilitiesForRegularUsers" example:"true"`
	// Whether non-administrator should be able to use sysctl settings
	AllowSysctlSettingForRegularUsers bool `json:"allowSysctlSettingForRegularUsers" example:"true"`
	// Whether host management features are enabled
	EnableHostManagementFeatures bool `json:"enableHostManagementFeatures" example:"true"`
}

EndpointSecuritySettings represents settings for an environment(endpoint)

type EndpointStatus ¶

type EndpointStatus int

EndpointStatus represents the status of an environment(endpoint)

const (

	// EndpointStatusUp is used to represent an available environment(endpoint)
	EndpointStatusUp EndpointStatus
	// EndpointStatusDown is used to represent an unavailable environment(endpoint)
	EndpointStatusDown
)

type EndpointSyncJob ¶

type EndpointSyncJob struct{}

EndpointSyncJob represents a scheduled job that synchronize environments(endpoints) based on an external file Deprecated

type EndpointType ¶

type EndpointType int

EndpointType represents the type of an environment(endpoint)

const (

	// DockerEnvironment represents an environment(endpoint) connected to a Docker environment(endpoint)
	DockerEnvironment EndpointType
	// AgentOnDockerEnvironment represents an environment(endpoint) connected to a Portainer agent deployed on a Docker environment(endpoint)
	AgentOnDockerEnvironment
	// AzureEnvironment represents an environment(endpoint) connected to an Azure environment(endpoint)
	AzureEnvironment
	// EdgeAgentOnDockerEnvironment represents an environment(endpoint) connected to an Edge agent deployed on a Docker environment(endpoint)
	EdgeAgentOnDockerEnvironment
	// KubernetesLocalEnvironment represents an environment(endpoint) connected to a local Kubernetes environment(endpoint)
	KubernetesLocalEnvironment
	// AgentOnKubernetesEnvironment represents an environment(endpoint) connected to a Portainer agent deployed on a Kubernetes environment(endpoint)
	AgentOnKubernetesEnvironment
	// EdgeAgentOnKubernetesEnvironment represents an environment(endpoint) connected to an Edge agent deployed on a Kubernetes environment(endpoint)
	EdgeAgentOnKubernetesEnvironment
)

type Extension ¶

type Extension struct {
	// Extension Identifier
	ID               ExtensionID        `json:"Id" example:"1"`
	Enabled          bool               `json:"Enabled"`
	Name             string             `json:"Name,omitempty"`
	ShortDescription string             `json:"ShortDescription,omitempty"`
	Description      string             `json:"Description,omitempty"`
	DescriptionURL   string             `json:"DescriptionURL,omitempty"`
	Price            string             `json:"Price,omitempty"`
	PriceDescription string             `json:"PriceDescription,omitempty"`
	Deal             bool               `json:"Deal,omitempty"`
	Available        bool               `json:"Available,omitempty"`
	License          LicenseInformation `json:"License,omitempty"`
	Version          string             `json:"Version"`
	UpdateAvailable  bool               `json:"UpdateAvailable"`
	ShopURL          string             `json:"ShopURL,omitempty"`
	Images           []string           `json:"Images,omitempty"`
	Logo             string             `json:"Logo,omitempty"`
}

Extension represents a deprecated Portainer extension

type ExtensionID ¶

type ExtensionID int

ExtensionID represents a extension identifier

type FDOConfiguration ¶

type FDOConfiguration struct {
	Enabled       bool   `json:"enabled"`
	OwnerURL      string `json:"ownerURL"`
	OwnerUsername string `json:"ownerUsername"`
	OwnerPassword string `json:"ownerPassword"`
}

type FDOProfile ¶

type FDOProfile struct {
	ID            FDOProfileID `json:"id"`
	Name          string       `json:"name"`
	FilePath      string       `json:"filePath"`
	NumberDevices int          `json:"numberDevices"`
	DateCreated   int64        `json:"dateCreated"`
}

type Feature ¶

type Feature string

Feature represents a feature that can be enabled or disabled via feature flags

type FileService ¶

type FileService interface {
	GetDockerConfigPath() string
	GetFileContent(trustedRootPath, filePath string) ([]byte, error)
	Copy(fromFilePath string, toFilePath string, deleteIfExists bool) error
	Rename(oldPath, newPath string) error
	RemoveDirectory(directoryPath string) error
	StoreTLSFileFromBytes(folder string, fileType TLSFileType, data []byte) (string, error)
	GetPathForTLSFile(folder string, fileType TLSFileType) (string, error)
	DeleteTLSFile(folder string, fileType TLSFileType) error
	DeleteTLSFiles(folder string) error
	GetStackProjectPath(stackIdentifier string) string
	StoreStackFileFromBytes(stackIdentifier, fileName string, data []byte) (string, error)
	UpdateStoreStackFileFromBytes(stackIdentifier, fileName string, data []byte) (string, error)
	RemoveStackFileBackup(stackIdentifier, fileName string) error
	RollbackStackFile(stackIdentifier, fileName string) error
	GetEdgeStackProjectPath(edgeStackIdentifier string) string
	StoreEdgeStackFileFromBytes(edgeStackIdentifier, fileName string, data []byte) (string, error)
	StoreRegistryManagementFileFromBytes(folder, fileName string, data []byte) (string, error)
	KeyPairFilesExist() (bool, error)
	StoreKeyPair(private, public []byte, privatePEMHeader, publicPEMHeader string) error
	LoadKeyPair() ([]byte, []byte, error)
	WriteJSONToFile(path string, content interface{}) error
	FileExists(path string) (bool, error)
	StoreEdgeJobFileFromBytes(identifier string, data []byte) (string, error)
	GetEdgeJobFolder(identifier string) string
	ClearEdgeJobTaskLogs(edgeJobID, taskID string) error
	GetEdgeJobTaskLogFileContent(edgeJobID, taskID string) (string, error)
	StoreEdgeJobTaskLogFileFromBytes(edgeJobID, taskID string, data []byte) error
	GetBinaryFolder() string
	StoreCustomTemplateFileFromBytes(identifier, fileName string, data []byte) (string, error)
	GetCustomTemplateProjectPath(identifier string) string
	GetTemporaryPath() (string, error)
	GetDatastorePath() string
	GetDefaultSSLCertsPath() (string, string)
	StoreSSLCertPair(cert, key []byte) (string, string, error)
	CopySSLCertPair(certPath, keyPath string) (string, string, error)
	CopySSLCACert(caCertPath string) (string, error)
	StoreFDOProfileFileFromBytes(fdoProfileIdentifier string, data []byte) (string, error)
	StoreMTLSCertificates(cert, caCert, key []byte) (string, string, string, error)
}

FileService represents a service for managing files

type GitService ¶

type GitService interface {
	CloneRepository(destination string, repositoryURL, referenceName, username, password string) error
	LatestCommitID(repositoryURL, referenceName, username, password string) (string, error)
	ListRefs(repositoryURL, username, password string, hardRefresh bool) ([]string, error)
	ListFiles(repositoryURL, referenceName, username, password string, hardRefresh bool, includeExts []string) ([]string, error)
}

GitService represents a service for managing Git

type GitlabRegistryData ¶

type GitlabRegistryData struct {
	ProjectID   int    `json:"ProjectId"`
	InstanceURL string `json:"InstanceURL"`
	ProjectPath string `json:"ProjectPath"`
}

GitlabRegistryData represents data required for gitlab registry to work

type HelmUserRepository ¶

type HelmUserRepository struct {
	// Membership Identifier
	ID HelmUserRepositoryID `json:"Id" example:"1"`
	// User identifier
	UserID UserID `json:"UserId" example:"1"`
	// Helm repository URL
	URL string `json:"URL" example:"https://charts.bitnami.com/bitnami"`
}

HelmUserRepositories stores a Helm repository URL for the given user

type HelmUserRepositoryID ¶

type HelmUserRepositoryID int

type InternalAuthSettings ¶

type InternalAuthSettings struct {
	RequiredPasswordLength int
}

InternalAuthSettings represents settings used for the default 'internal' authentication

type K8sNamespaceAccessPolicy ¶

type K8sNamespaceAccessPolicy struct {
	UserAccessPolicies UserAccessPolicies `json:"UserAccessPolicies"`
	TeamAccessPolicies TeamAccessPolicies `json:"TeamAccessPolicies"`
}

type K8sNamespaceInfo ¶

type K8sNamespaceInfo struct {
	IsSystem  bool `json:"IsSystem"`
	IsDefault bool `json:"IsDefault"`
}

type K8sNodeLimits ¶

type K8sNodeLimits struct {
	CPU    int64 `json:"CPU"`
	Memory int64 `json:"Memory"`
}

type K8sNodesLimits ¶

type K8sNodesLimits map[string]*K8sNodeLimits

type KubeClient ¶

type KubeClient interface {
	SetupUserServiceAccount(userID int, teamIDs []int, restrictDefaultNamespace bool) error
	IsRBACEnabled() (bool, error)
	GetServiceAccount(tokendata *TokenData) (*v1.ServiceAccount, error)
	GetServiceAccountBearerToken(userID int) (string, error)
	CreateUserShellPod(ctx context.Context, serviceAccountName, shellPodImage string) (*KubernetesShellPod, error)
	StartExecProcess(token string, useAdminToken bool, namespace, podName, containerName string, command []string, stdin io.Reader, stdout io.Writer, errChan chan error)

	HasStackName(namespace string, stackName string) (bool, error)
	NamespaceAccessPoliciesDeleteNamespace(namespace string) error
	CreateNamespace(info models.K8sNamespaceDetails) error
	UpdateNamespace(info models.K8sNamespaceDetails) error
	GetNamespaces() (map[string]K8sNamespaceInfo, error)
	GetNamespace(string) (K8sNamespaceInfo, error)
	DeleteNamespace(namespace string) error
	GetConfigMapsAndSecrets(namespace string) ([]models.K8sConfigMapOrSecret, error)
	GetIngressControllers() (models.K8sIngressControllers, error)
	GetMetrics() (models.K8sMetrics, error)
	GetStorage() ([]KubernetesStorageClassConfig, error)
	CreateIngress(namespace string, info models.K8sIngressInfo, owner string) error
	UpdateIngress(namespace string, info models.K8sIngressInfo) error
	GetIngresses(namespace string) ([]models.K8sIngressInfo, error)
	DeleteIngresses(reqs models.K8sIngressDeleteRequests) error
	CreateService(namespace string, service models.K8sServiceInfo) error
	UpdateService(namespace string, service models.K8sServiceInfo) error
	GetServices(namespace string) ([]models.K8sServiceInfo, error)
	DeleteServices(reqs models.K8sServiceDeleteRequests) error
	GetNodesLimits() (K8sNodesLimits, error)
	GetNamespaceAccessPolicies() (map[string]K8sNamespaceAccessPolicy, error)
	UpdateNamespaceAccessPolicies(accessPolicies map[string]K8sNamespaceAccessPolicy) error
	DeleteRegistrySecret(registry *Registry, namespace string) error
	CreateRegistrySecret(registry *Registry, namespace string) error
	IsRegistrySecret(namespace, secretName string) (bool, error)
	ToggleSystemState(namespace string, isSystem bool) error
}

KubeClient represents a service used to query a Kubernetes environment(endpoint)

type KubernetesConfiguration ¶

type KubernetesConfiguration struct {
	UseLoadBalancer                 bool                           `json:"UseLoadBalancer"`
	UseServerMetrics                bool                           `json:"UseServerMetrics"`
	EnableResourceOverCommit        bool                           `json:"EnableResourceOverCommit"`
	ResourceOverCommitPercentage    int                            `json:"ResourceOverCommitPercentage"`
	StorageClasses                  []KubernetesStorageClassConfig `json:"StorageClasses"`
	IngressClasses                  []KubernetesIngressClassConfig `json:"IngressClasses"`
	RestrictDefaultNamespace        bool                           `json:"RestrictDefaultNamespace"`
	IngressAvailabilityPerNamespace bool                           `json:"IngressAvailabilityPerNamespace"`
	AllowNoneIngressClass           bool                           `json:"AllowNoneIngressClass"`
}

KubernetesConfiguration represents the configuration of a Kubernetes environment(endpoint)

type KubernetesData ¶

type KubernetesData struct {
	Snapshots     []KubernetesSnapshot    `json:"Snapshots"`
	Configuration KubernetesConfiguration `json:"Configuration"`
	Flags         KubernetesFlags         `json:"Flags"`
}

KubernetesData contains all the Kubernetes related environment(endpoint) information

func KubernetesDefault ¶

func KubernetesDefault() KubernetesData

type KubernetesDeployer ¶

type KubernetesDeployer interface {
	Deploy(userID UserID, endpoint *Endpoint, manifestFiles []string, namespace string) (string, error)
	Remove(userID UserID, endpoint *Endpoint, manifestFiles []string, namespace string) (string, error)
	ConvertCompose(data []byte) ([]byte, error)
}

KubernetesDeployer represents a service to deploy a manifest inside a Kubernetes environment(endpoint)

type KubernetesFlags ¶

type KubernetesFlags struct {
	IsServerMetricsDetected bool `json:"IsServerMetricsDetected"`
	IsServerStorageDetected bool `json:"IsServerStorageDetected"`
}

type KubernetesIngressClassConfig ¶

type KubernetesIngressClassConfig struct {
	Name              string   `json:"Name"`
	Type              string   `json:"Type"`
	GloballyBlocked   bool     `json:"Blocked"`
	BlockedNamespaces []string `json:"BlockedNamespaces"`
}

KubernetesIngressClassConfig represents a Kubernetes Ingress Class configuration

type KubernetesShellPod ¶

type KubernetesShellPod struct {
	Namespace        string
	PodName          string
	ContainerName    string
	ShellExecCommand string
}

KubernetesShellPod represents a Kubectl Shell details to facilitate pod exec functionality

type KubernetesSnapshot ¶

type KubernetesSnapshot struct {
	Time              int64  `json:"Time"`
	KubernetesVersion string `json:"KubernetesVersion"`
	NodeCount         int    `json:"NodeCount"`
	TotalCPU          int64  `json:"TotalCPU"`
	TotalMemory       int64  `json:"TotalMemory"`
}

KubernetesSnapshot represents a snapshot of a specific Kubernetes environment(endpoint) at a specific time

type KubernetesSnapshotter ¶

type KubernetesSnapshotter interface {
	CreateSnapshot(endpoint *Endpoint) (*KubernetesSnapshot, error)
}

KubernetesSnapshotter represents a service used to create Kubernetes environment(endpoint) snapshots

type KubernetesStorageClassConfig ¶

type KubernetesStorageClassConfig struct {
	Name                 string   `json:"Name"`
	AccessModes          []string `json:"AccessModes"`
	Provisioner          string   `json:"Provisioner"`
	AllowVolumeExpansion bool     `json:"AllowVolumeExpansion"`
}

KubernetesStorageClassConfig represents a Kubernetes Storage Class configuration

type LDAPGroupSearchSettings ¶

type LDAPGroupSearchSettings struct {
	// The distinguished name of the element from which the LDAP server will search for groups
	GroupBaseDN string `json:"GroupBaseDN" example:"dc=ldap,dc=domain,dc=tld"`
	// The LDAP search filter used to select group elements, optional
	GroupFilter string `json:"GroupFilter" example:"(objectClass=account"`
	// LDAP attribute which denotes the group membership
	GroupAttribute string `json:"GroupAttribute" example:"member"`
}

LDAPGroupSearchSettings represents settings used to search for groups in a LDAP server

type LDAPSearchSettings ¶

type LDAPSearchSettings struct {
	// The distinguished name of the element from which the LDAP server will search for users
	BaseDN string `json:"BaseDN" example:"dc=ldap,dc=domain,dc=tld"`
	// Optional LDAP search filter used to select user elements
	Filter string `json:"Filter" example:"(objectClass=account)"`
	// LDAP attribute which denotes the username
	UserNameAttribute string `json:"UserNameAttribute" example:"uid"`
}

LDAPSearchSettings represents settings used to search for users in a LDAP server

type LDAPService ¶

type LDAPService interface {
	AuthenticateUser(username, password string, settings *LDAPSettings) error
	TestConnectivity(settings *LDAPSettings) error
	GetUserGroups(username string, settings *LDAPSettings) ([]string, error)
	SearchGroups(settings *LDAPSettings) ([]LDAPUser, error)
	SearchUsers(settings *LDAPSettings) ([]string, error)
}

LDAPService represents a service used to authenticate users against a LDAP/AD

type LDAPSettings ¶

type LDAPSettings struct {
	// Enable this option if the server is configured for Anonymous access. When enabled, ReaderDN and Password will not be used
	AnonymousMode bool `json:"AnonymousMode" example:"true" validate:"validate_bool"`
	// Account that will be used to search for users
	ReaderDN string `json:"ReaderDN" example:"cn=readonly-account,dc=ldap,dc=domain,dc=tld" validate:"required_if=AnonymousMode false"`
	// Password of the account that will be used to search users
	Password string `json:"Password,omitempty" example:"readonly-password" validate:"required_if=AnonymousMode false"`
	// URL or IP address of the LDAP server
	URL       string           `json:"URL" example:"myldap.domain.tld:389" validate:"hostname_port"`
	TLSConfig TLSConfiguration `json:"TLSConfig"`
	// Whether LDAP connection should use StartTLS
	StartTLS            bool                      `json:"StartTLS" example:"true"`
	SearchSettings      []LDAPSearchSettings      `json:"SearchSettings"`
	GroupSearchSettings []LDAPGroupSearchSettings `json:"GroupSearchSettings"`
	// Automatically provision users and assign them to matching LDAP group names
	AutoCreateUsers bool `json:"AutoCreateUsers" example:"true"`
}

LDAPSettings represents the settings used to connect to a LDAP server

type LicenseInformation ¶

type LicenseInformation struct {
	LicenseKey string `json:"LicenseKey,omitempty"`
	Company    string `json:"Company,omitempty"`
	Expiration string `json:"Expiration,omitempty"`
	Valid      bool   `json:"Valid,omitempty"`
}

LicenseInformation represents information about an extension license

type MembershipRole ¶

type MembershipRole int

MembershipRole represents the role of a user within a team

const (

	// TeamLeader represents a leader role inside a team
	TeamLeader MembershipRole
	// TeamMember represents a member role inside a team
	TeamMember
)

type OAuthService ¶

type OAuthService interface {
	Authenticate(code string, configuration *OAuthSettings) (OAuthUserData, error)
}

OAuthService represents a service used to authenticate users using OAuth

type OAuthSettings ¶

type OAuthSettings struct {
	ClientID             string `json:"ClientID"`
	ClientSecret         string `json:"ClientSecret,omitempty"`
	AccessTokenURI       string `json:"AccessTokenURI"`
	AuthorizationURI     string `json:"AuthorizationURI"`
	ResourceURI          string `json:"ResourceURI"`
	RedirectURI          string `json:"RedirectURI"`
	UserIdentifier       string `json:"UserIdentifier"`
	Scopes               string `json:"Scopes"`
	OAuthAutoCreateUsers bool   `json:"OAuthAutoCreateUsers"`
	DefaultTeamID        TeamID `json:"DefaultTeamID"`
	SSO                  bool   `json:"SSO"`
	LogoutURI            string `json:"LogoutURI"`
	KubeSecretKey        []byte `json:"KubeSecretKey"`
	AdminGroup           string `json:"AdminGroup"`
}

OAuthSettings represents the settings used to authorize with an authorization server

type OAuthUserData ¶

type OAuthUserData struct {
	Username   string        `json:"Username"`
	OAuthToken *oauth2.Token `json:"OAuthToken"`
	Teams      []string      `json:"Teams"`
}

type OpenAMTConfiguration ¶

type OpenAMTConfiguration struct {
	Enabled          bool   `json:"enabled"`
	MPSServer        string `json:"mpsServer"`
	MPSUser          string `json:"mpsUser"`
	MPSPassword      string `json:"mpsPassword"`
	MPSToken         string `json:"mpsToken"` // retrieved from API
	CertFileName     string `json:"certFileName"`
	CertFileContent  string `json:"certFileContent"`
	CertFilePassword string `json:"certFilePassword"`
	DomainName       string `json:"domainName"`
}

OpenAMTConfiguration represents the credentials and configurations used to connect to an OpenAMT MPS server

type OpenAMTDeviceEnabledFeatures ¶

type OpenAMTDeviceEnabledFeatures struct {
	Redirection bool   `json:"redirection"`
	KVM         bool   `json:"KVM"`
	SOL         bool   `json:"SOL"`
	IDER        bool   `json:"IDER"`
	UserConsent string `json:"userConsent"`
}

OpenAMTDeviceEnabledFeatures represents an AMT managed device features information

type OpenAMTDeviceInformation ¶

type OpenAMTDeviceInformation struct {
	GUID             string                        `json:"guid"`
	HostName         string                        `json:"hostname"`
	ConnectionStatus bool                          `json:"connectionStatus"`
	PowerState       PowerState                    `json:"powerState"`
	EnabledFeatures  *OpenAMTDeviceEnabledFeatures `json:"features"`
}

OpenAMTDeviceInformation represents an AMT managed device information

type OpenAMTService ¶

type OpenAMTService interface {
	Configure(configuration OpenAMTConfiguration) error
	DeviceInformation(configuration OpenAMTConfiguration, deviceGUID string) (*OpenAMTDeviceInformation, error)
	EnableDeviceFeatures(configuration OpenAMTConfiguration, deviceGUID string, features OpenAMTDeviceEnabledFeatures) (string, error)
	ExecuteDeviceAction(configuration OpenAMTConfiguration, deviceGUID string, action string) error
}

OpenAMTService represents a service for managing OpenAMT

type PowerState ¶

type PowerState int

PowerState represents an AMT managed device power state

type QuayRegistryData ¶

type QuayRegistryData struct {
	UseOrganisation  bool   `json:"UseOrganisation"`
	OrganisationName string `json:"OrganisationName"`
}

QuayRegistryData represents data required for Quay registry to work

type Registry ¶

type Registry struct {
	// Registry Identifier
	ID RegistryID `json:"Id" example:"1"`
	// Registry Type (1 - Quay, 2 - Azure, 3 - Custom, 4 - Gitlab, 5 - ProGet, 6 - DockerHub, 7 - ECR)
	Type RegistryType `json:"Type" enums:"1,2,3,4,5,6,7"`
	// Registry Name
	Name string `json:"Name" example:"my-registry"`
	// URL or IP address of the Docker registry
	URL string `json:"URL" example:"registry.mydomain.tld:2375"`
	// Base URL, introduced for ProGet registry
	BaseURL string `json:"BaseURL" example:"registry.mydomain.tld:2375"`
	// Is authentication against this registry enabled
	Authentication bool `json:"Authentication" example:"true"`
	// Username or AccessKeyID used to authenticate against this registry
	Username string `json:"Username" example:"registry user"`
	// Password or SecretAccessKey used to authenticate against this registry
	Password                string                           `json:"Password,omitempty" example:"registry_password"`
	ManagementConfiguration *RegistryManagementConfiguration `json:"ManagementConfiguration"`
	Gitlab                  GitlabRegistryData               `json:"Gitlab"`
	Quay                    QuayRegistryData                 `json:"Quay"`
	Ecr                     EcrData                          `json:"Ecr"`
	RegistryAccesses        RegistryAccesses                 `json:"RegistryAccesses"`

	// Deprecated fields
	// Deprecated in DBVersion == 31
	UserAccessPolicies UserAccessPolicies `json:"UserAccessPolicies"`
	// Deprecated in DBVersion == 31
	TeamAccessPolicies TeamAccessPolicies `json:"TeamAccessPolicies"`

	// Deprecated in DBVersion == 18
	AuthorizedUsers []UserID `json:"AuthorizedUsers"`
	// Deprecated in DBVersion == 18
	AuthorizedTeams []TeamID `json:"AuthorizedTeams"`

	// Stores temporary access token
	AccessToken       string `json:"AccessToken,omitempty"`
	AccessTokenExpiry int64  `json:"AccessTokenExpiry,omitempty"`
}

Registry represents a Docker registry with all the info required to connect to it

type RegistryAccessPolicies ¶

type RegistryAccessPolicies struct {
	UserAccessPolicies UserAccessPolicies `json:"UserAccessPolicies"`
	TeamAccessPolicies TeamAccessPolicies `json:"TeamAccessPolicies"`
	Namespaces         []string           `json:"Namespaces"`
}

type RegistryAccesses ¶

type RegistryAccesses map[EndpointID]RegistryAccessPolicies

type RegistryID ¶

type RegistryID int

RegistryID represents a registry identifier

type RegistryManagementConfiguration ¶

type RegistryManagementConfiguration struct {
	Type              RegistryType     `json:"Type"`
	Authentication    bool             `json:"Authentication"`
	Username          string           `json:"Username"`
	Password          string           `json:"Password"`
	TLSConfig         TLSConfiguration `json:"TLSConfig"`
	Ecr               EcrData          `json:"Ecr"`
	AccessToken       string           `json:"AccessToken,omitempty"`
	AccessTokenExpiry int64            `json:"AccessTokenExpiry,omitempty"`
}

RegistryManagementConfiguration represents a configuration that can be used to query the registry API via the registry management extension.

type RegistryType ¶

type RegistryType int

RegistryType represents a type of registry

const (

	// QuayRegistry represents a Quay.io registry
	QuayRegistry RegistryType
	// AzureRegistry represents an ACR registry
	AzureRegistry
	// CustomRegistry represents a custom registry
	CustomRegistry
	// GitlabRegistry represents a gitlab registry
	GitlabRegistry
	// ProGetRegistry represents a proget registry
	ProGetRegistry
	// DockerHubRegistry represents a dockerhub registry
	DockerHubRegistry
	// EcrRegistry represents an ECR registry
	EcrRegistry
)

type ResourceAccessLevel ¶

type ResourceAccessLevel int

ResourceAccessLevel represents the level of control associated to a resource

const (

	// ReadWriteAccessLevel represents an access level with read-write permissions on a resource
	ReadWriteAccessLevel ResourceAccessLevel
)

type ResourceControl ¶

type ResourceControl struct {
	// ResourceControl Identifier
	ID ResourceControlID `json:"Id" example:"1"`
	// Docker resource identifier on which access control will be applied.\
	// In the case of a resource control applied to a stack, use the stack name as identifier
	ResourceID string `json:"ResourceId" example:"617c5f22bb9b023d6daab7cba43a57576f83492867bc767d1c59416b065e5f08"`
	// List of Docker resources that will inherit this access control
	SubResourceIDs []string `json:"SubResourceIds" example:"617c5f22bb9b023d6daab7cba43a57576f83492867bc767d1c59416b065e5f08"`
	// Type of Docker resource. Valid values are: 1- container, 2 -service
	// 3 - volume, 4 - secret, 5 - stack, 6 - config or 7 - custom template
	Type         ResourceControlType  `json:"Type" example:"1"`
	UserAccesses []UserResourceAccess `json:"UserAccesses"`
	TeamAccesses []TeamResourceAccess `json:"TeamAccesses"`
	// Permit access to the associated resource to any user
	Public bool `json:"Public" example:"true"`
	// Permit access to resource only to admins
	AdministratorsOnly bool `json:"AdministratorsOnly" example:"true"`
	System             bool `json:"System"`

	// Deprecated fields
	// Deprecated in DBVersion == 2
	OwnerID     UserID              `json:"OwnerId,omitempty"`
	AccessLevel ResourceAccessLevel `json:"AccessLevel,omitempty"`
}

ResourceControl represent a reference to a Docker resource with specific access controls

type ResourceControlID ¶

type ResourceControlID int

ResourceControlID represents a resource control identifier

type ResourceControlType ¶

type ResourceControlType int

ResourceControlType represents the type of resource associated to the resource control (volume, container, service...)

const (

	// ContainerResourceControl represents a resource control associated to a Docker container
	ContainerResourceControl ResourceControlType
	// ServiceResourceControl represents a resource control associated to a Docker service
	ServiceResourceControl
	// VolumeResourceControl represents a resource control associated to a Docker volume
	VolumeResourceControl
	// NetworkResourceControl represents a resource control associated to a Docker network
	NetworkResourceControl
	// SecretResourceControl represents a resource control associated to a Docker secret
	SecretResourceControl
	// StackResourceControl represents a resource control associated to a stack composed of Docker services
	StackResourceControl
	// ConfigResourceControl represents a resource control associated to a Docker config
	ConfigResourceControl
	// CustomTemplateResourceControl represents a resource control associated to a custom template
	CustomTemplateResourceControl
	// ContainerGroupResourceControl represents a resource control associated to an Azure container group
	ContainerGroupResourceControl
)

type ReverseTunnelService ¶

type ReverseTunnelService interface {
	StartTunnelServer(addr, port string, snapshotService SnapshotService) error
	StopTunnelServer() error
	GenerateEdgeKey(url, host string, endpointIdentifier int) string
	SetTunnelStatusToActive(endpointID EndpointID)
	SetTunnelStatusToRequired(endpointID EndpointID) error
	SetTunnelStatusToIdle(endpointID EndpointID)
	KeepTunnelAlive(endpointID EndpointID, ctx context.Context, maxKeepAlive time.Duration)
	GetTunnelDetails(endpointID EndpointID) TunnelDetails
	GetActiveTunnel(endpoint *Endpoint) (TunnelDetails, error)
	AddEdgeJob(endpointID EndpointID, edgeJob *EdgeJob)
	RemoveEdgeJob(edgeJobID EdgeJobID)
	RemoveEdgeJobFromEndpoint(endpointID EndpointID, edgeJobID EdgeJobID)
}

ReverseTunnelService represents a service used to manage reverse tunnel connections.

type Role ¶

type Role struct {
	// Role Identifier
	ID RoleID `json:"Id" example:"1"`
	// Role name
	Name string `json:"Name" example:"HelpDesk"`
	// Role description
	Description string `json:"Description" example:"Read-only access of all resources in an environment(endpoint)"`
	// Authorizations associated to a role
	Authorizations Authorizations `json:"Authorizations"`
	Priority       int            `json:"Priority"`
}

Role represents a set of authorizations that can be associated to a user or to a team.

type SSLSettings ¶

type SSLSettings struct {
	CertPath    string `json:"certPath"`
	KeyPath     string `json:"keyPath"`
	SelfSigned  bool   `json:"selfSigned"`
	HTTPEnabled bool   `json:"httpEnabled"`
}

SSLSettings represents a pair of SSL certificate and key

type Schedule ¶

type Schedule struct {
	// Schedule Identifier
	ID             ScheduleID `json:"Id" example:"1"`
	Name           string
	CronExpression string
	Recurring      bool
	Created        int64
	JobType        JobType
	EdgeSchedule   *EdgeSchedule
}

Schedule represents a scheduled job. It only contains a pointer to one of the JobRunner implementations based on the JobType. NOTE: The Recurring option is only used by ScriptExecutionJob at the moment Deprecated in favor of EdgeJob

type ScheduleID ¶

type ScheduleID int

ScheduleID represents a schedule identifier. Deprecated in favor of EdgeJob

type ScriptExecutionJob ¶

type ScriptExecutionJob struct {
	Endpoints     []EndpointID
	Image         string
	ScriptPath    string
	RetryCount    int
	RetryInterval int
}

ScriptExecutionJob represents a scheduled job that can execute a script via a privileged container

type Server ¶

type Server interface {
	Start() error
}

Server defines the interface to serve the API

type Settings ¶

type Settings struct {
	// URL to a logo that will be displayed on the login page as well as on top of the sidebar. Will use default Portainer logo when value is empty string
	LogoURL string `json:"LogoURL" example:"https://mycompany.mydomain.tld/logo.png"`
	// A list of label name & value that will be used to hide containers when querying containers
	BlackListedLabels []Pair `json:"BlackListedLabels"`
	// Active authentication method for the Portainer instance. Valid values are: 1 for internal, 2 for LDAP, or 3 for oauth
	AuthenticationMethod AuthenticationMethod `json:"AuthenticationMethod" example:"1"`
	InternalAuthSettings InternalAuthSettings `json:"InternalAuthSettings"`
	LDAPSettings         LDAPSettings         `json:"LDAPSettings"`
	OAuthSettings        OAuthSettings        `json:"OAuthSettings"`
	OpenAMTConfiguration OpenAMTConfiguration `json:"openAMTConfiguration"`
	FDOConfiguration     FDOConfiguration     `json:"fdoConfiguration"`
	FeatureFlagSettings  map[Feature]bool     `json:"FeatureFlagSettings"`
	// The interval in which environment(endpoint) snapshots are created
	SnapshotInterval string `json:"SnapshotInterval" example:"5m"`
	// URL to the templates that will be displayed in the UI when navigating to App Templates
	TemplatesURL string `json:"TemplatesURL" example:"https://raw.githubusercontent.com/portainer/templates/master/templates.json"`
	// The default check in interval for edge agent (in seconds)
	EdgeAgentCheckinInterval int `json:"EdgeAgentCheckinInterval" example:"5"`
	// Show the Kompose build option (discontinued in 2.18)
	ShowKomposeBuildOption bool `json:"ShowKomposeBuildOption" example:"false"`
	// Whether edge compute features are enabled
	EnableEdgeComputeFeatures bool `json:"EnableEdgeComputeFeatures"`
	// The duration of a user session
	UserSessionTimeout string `json:"UserSessionTimeout" example:"5m"`
	// The expiry of a Kubeconfig
	KubeconfigExpiry string `json:"KubeconfigExpiry" example:"24h"`
	// Whether telemetry is enabled
	EnableTelemetry bool `json:"EnableTelemetry" example:"false"`
	// Helm repository URL, defaults to "https://charts.bitnami.com/bitnami"
	HelmRepositoryURL string `json:"HelmRepositoryURL" example:"https://charts.bitnami.com/bitnami"`
	// KubectlImage, defaults to portainer/kubectl-shell
	KubectlShellImage string `json:"KubectlShellImage" example:"portainer/kubectl-shell"`
	// TrustOnFirstConnect makes Portainer accepting edge agent connection by default
	TrustOnFirstConnect bool `json:"TrustOnFirstConnect" example:"false"`
	// EnforceEdgeID makes Portainer store the Edge ID instead of accepting anyone
	EnforceEdgeID bool `json:"EnforceEdgeID" example:"false"`
	// Container environment parameter AGENT_SECRET
	AgentSecret string `json:"AgentSecret"`
	// EdgePortainerURL is the URL that is exposed to edge agents
	EdgePortainerURL string `json:"EdgePortainerUrl"`

	Edge struct {
		// The command list interval for edge agent - used in edge async mode (in seconds)
		CommandInterval int `json:"CommandInterval" example:"5"`
		// The ping interval for edge agent - used in edge async mode (in seconds)
		PingInterval int `json:"PingInterval" example:"5"`
		// The snapshot interval for edge agent - used in edge async mode (in seconds)
		SnapshotInterval int `json:"SnapshotInterval" example:"5"`
		// EdgeAsyncMode enables edge async mode by default
		AsyncMode bool
	}

	// Deprecated fields
	DisplayDonationHeader       bool
	DisplayExternalContributors bool

	// Deprecated fields v26
	EnableHostManagementFeatures              bool `json:"EnableHostManagementFeatures"`
	AllowVolumeBrowserForRegularUsers         bool `json:"AllowVolumeBrowserForRegularUsers"`
	AllowBindMountsForRegularUsers            bool `json:"AllowBindMountsForRegularUsers"`
	AllowPrivilegedModeForRegularUsers        bool `json:"AllowPrivilegedModeForRegularUsers"`
	AllowHostNamespaceForRegularUsers         bool `json:"AllowHostNamespaceForRegularUsers"`
	AllowStackManagementForRegularUsers       bool `json:"AllowStackManagementForRegularUsers"`
	AllowDeviceMappingForRegularUsers         bool `json:"AllowDeviceMappingForRegularUsers"`
	AllowContainerCapabilitiesForRegularUsers bool `json:"AllowContainerCapabilitiesForRegularUsers"`
}

Settings represents the application settings

type Snapshot ¶

type Snapshot struct {
	EndpointID EndpointID          `json:"EndpointId"`
	Docker     *DockerSnapshot     `json:"Docker"`
	Kubernetes *KubernetesSnapshot `json:"Kubernetes"`
}

type SnapshotJob ¶

type SnapshotJob struct{}

SnapshotJob represents a scheduled job that can create environment(endpoint) snapshots

type SnapshotService ¶

type SnapshotService interface {
	Start()
	SetSnapshotInterval(snapshotInterval string) error
	SnapshotEndpoint(endpoint *Endpoint) error
	FillSnapshotData(endpoint *Endpoint) error
}

SnapshotService represents a service for managing environment(endpoint) snapshots

type SoftwareEdition ¶

type SoftwareEdition int

SoftwareEdition represents an edition of Portainer

const (

	// PortainerCE represents the community edition of Portainer
	PortainerCE SoftwareEdition
	// PortainerBE represents the business edition of Portainer
	PortainerBE
	// PortainerEE represents the business edition of Portainer
	PortainerEE
)

type Stack ¶

type Stack struct {
	// Stack Identifier
	ID StackID `json:"Id" example:"1"`
	// Stack name
	Name string `json:"Name" example:"myStack"`
	// Stack type. 1 for a Swarm stack, 2 for a Compose stack
	Type StackType `json:"Type" example:"2"`
	// Environment(Endpoint) identifier. Reference the environment(endpoint) that will be used for deployment
	EndpointID EndpointID `json:"EndpointId" example:"1"`
	// Cluster identifier of the Swarm cluster where the stack is deployed
	SwarmID string `json:"SwarmId" example:"jpofkc0i9uo9wtx1zesuk649w"`
	// Path to the Stack file
	EntryPoint string `json:"EntryPoint" example:"docker-compose.yml"`
	// A list of environment(endpoint) variables used during stack deployment
	Env []Pair `json:"Env"`
	//
	ResourceControl *ResourceControl `json:"ResourceControl"`
	// Stack status (1 - active, 2 - inactive)
	Status StackStatus `json:"Status" example:"1"`
	// Path on disk to the repository hosting the Stack file
	ProjectPath string `example:"/data/compose/myStack_jpofkc0i9uo9wtx1zesuk649w"`
	// The date in unix time when stack was created
	CreationDate int64 `example:"1587399600"`
	// The username which created this stack
	CreatedBy string `example:"admin"`
	// The date in unix time when stack was last updated
	UpdateDate int64 `example:"1587399600"`
	// The username which last updated this stack
	UpdatedBy string `example:"bob"`
	// Only applies when deploying stack with multiple files
	AdditionalFiles []string `json:"AdditionalFiles"`
	// The auto update settings of a git stack
	AutoUpdate *StackAutoUpdate `json:"AutoUpdate"`
	// The stack deployment option
	Option *StackOption `json:"Option"`
	// The git config of this stack
	GitConfig *gittypes.RepoConfig
	// Whether the stack is from a app template
	FromAppTemplate bool `example:"false"`
	// Kubernetes namespace if stack is a kube application
	Namespace string `example:"default"`
	// IsComposeFormat indicates if the Kubernetes stack is created from a Docker Compose file
	IsComposeFormat bool `example:"false"`
}

Stack represents a Docker stack created via docker stack deploy

type StackAutoUpdate ¶

type StackAutoUpdate struct {
	// Auto update interval
	Interval string `example:"1m30s"`
	// A UUID generated from client
	Webhook string `example:"05de31a2-79fa-4644-9c12-faa67e5c49f0"`
	// Autoupdate job id
	JobID string `example:"15"`
}

StackAutoUpdate represents the git auto sync config for stack deployment

type StackID ¶

type StackID int

StackID represents a stack identifier (it must be composed of Name + "_" + SwarmID to create a unique identifier)

type StackOption ¶

type StackOption struct {
	// Prune services that are no longer referenced
	Prune bool `example:"false"`
}

StackOption represents the options for stack deployment

type StackStatus ¶

type StackStatus int

StackStatus represent a status for a stack

const (
	StackStatusActive StackStatus
	StackStatusInactive
)

StackStatus represents a status for a stack

type StackType ¶

type StackType int

StackType represents the type of the stack (compose v2, stack deploy v3)

const (

	// DockerSwarmStack represents a stack managed via docker stack
	DockerSwarmStack StackType
	// DockerComposeStack represents a stack managed via docker-compose
	DockerComposeStack
	// KubernetesStack represents a stack managed via kubectl
	KubernetesStack
)

type Status ¶

type Status struct {
	// Portainer API version
	Version string `json:"Version" example:"2.0.0"`
	// Server Instance ID
	InstanceID string `example:"299ab403-70a8-4c05-92f7-bf7a994d50df"`
}

Status represents the application status

type SwarmStackManager ¶

type SwarmStackManager interface {
	Login(registries []Registry, endpoint *Endpoint) error
	Logout(endpoint *Endpoint) error
	Deploy(stack *Stack, prune bool, pullImage bool, endpoint *Endpoint) error
	Remove(stack *Stack, endpoint *Endpoint) error
	NormalizeStackName(name string) string
}

SwarmStackManager represents a service to manage Swarm stacks

type TLSConfiguration ¶

type TLSConfiguration struct {
	// Use TLS
	TLS bool `json:"TLS" example:"true"`
	// Skip the verification of the server TLS certificate
	TLSSkipVerify bool `json:"TLSSkipVerify" example:"false"`
	// Path to the TLS CA certificate file
	TLSCACertPath string `json:"TLSCACert,omitempty" example:"/data/tls/ca.pem"`
	// Path to the TLS client certificate file
	TLSCertPath string `json:"TLSCert,omitempty" example:"/data/tls/cert.pem"`
	// Path to the TLS client key file
	TLSKeyPath string `json:"TLSKey,omitempty" example:"/data/tls/key.pem"`
}

TLSConfiguration represents a TLS configuration

type TLSFileType ¶

type TLSFileType int

TLSFileType represents a type of TLS file required to connect to a Docker environment(endpoint). It can be either a TLS CA file, a TLS certificate file or a TLS key file

const (
	// TLSFileCA represents a TLS CA certificate file
	TLSFileCA TLSFileType = iota
	// TLSFileCert represents a TLS certificate file
	TLSFileCert
	// TLSFileKey represents a TLS key file
	TLSFileKey
)

type Tag ¶

type Tag struct {
	// Tag identifier
	ID TagID `example:"1"`
	// Tag name
	Name string `json:"Name" example:"org/acme"`
	// A set of environment(endpoint) ids that have this tag
	Endpoints map[EndpointID]bool `json:"Endpoints"`
	// A set of environment(endpoint) group ids that have this tag
	EndpointGroups map[EndpointGroupID]bool `json:"EndpointGroups"`
}

Tag represents a tag that can be associated to a resource

type TagID ¶

type TagID int

TagID represents a tag identifier

type Team ¶

type Team struct {
	// Team Identifier
	ID TeamID `json:"Id" example:"1"`
	// Team name
	Name string `json:"Name" example:"developers"`
}

Team represents a list of user accounts

type TeamAccessPolicies ¶

type TeamAccessPolicies map[TeamID]AccessPolicy

TeamAccessPolicies represent the association of an access policy and a team

type TeamID ¶

type TeamID int

TeamID represents a team identifier

type TeamMembership ¶

type TeamMembership struct {
	// Membership Identifier
	ID TeamMembershipID `json:"Id" example:"1"`
	// User identifier
	UserID UserID `json:"UserID" example:"1"`
	// Team identifier
	TeamID TeamID `json:"TeamID" example:"1"`
	// Team role (1 for team leader and 2 for team member)
	Role MembershipRole `json:"Role" example:"1"`
}

TeamMembership represents a membership association between a user and a team

type TeamMembershipID ¶

type TeamMembershipID int

TeamMembershipID represents a team membership identifier

type TeamResourceAccess ¶

type TeamResourceAccess struct {
	TeamID      TeamID              `json:"TeamId"`
	AccessLevel ResourceAccessLevel `json:"AccessLevel"`
}

TeamResourceAccess represents the level of control on a resource for a specific team

type Template ¶

type Template struct {
	// Mandatory container/stack fields
	// Template Identifier
	ID TemplateID `json:"Id" example:"1"`
	// Template type. Valid values are: 1 (container), 2 (Swarm stack) or 3 (Compose stack)
	Type TemplateType `json:"type" example:"1"`
	// Title of the template
	Title string `json:"title" example:"Nginx"`
	// Description of the template
	Description string `json:"description" example:"High performance web server"`
	// Whether the template should be available to administrators only
	AdministratorOnly bool `json:"administrator_only" example:"true"`

	// Mandatory container fields
	// Image associated to a container template. Mandatory for a container template
	Image string `json:"image" example:"nginx:latest"`

	// Mandatory stack fields
	Repository TemplateRepository `json:"repository"`

	// Mandatory Edge stack fields
	// Stack file used for this template
	StackFile string `json:"stackFile"`

	// Optional stack/container fields
	// Default name for the stack/container to be used on deployment
	Name string `json:"name,omitempty" example:"mystackname"`
	// URL of the template's logo
	Logo string `json:"logo,omitempty" example:"https://cloudinovasi.id/assets/img/logos/nginx.png"`
	// A list of environment(endpoint) variables used during the template deployment
	Env []TemplateEnv `json:"env,omitempty"`
	// A note that will be displayed in the UI. Supports HTML content
	Note string `json:"note,omitempty" example:"This is my <b>custom</b> template"`
	// Platform associated to the template.
	// Valid values are: 'linux', 'windows' or leave empty for multi-platform
	Platform string `json:"platform,omitempty" example:"linux"`
	// A list of categories associated to the template
	Categories []string `json:"categories,omitempty" example:"database"`

	// Optional container fields
	// The URL of a registry associated to the image for a container template
	Registry string `json:"registry,omitempty" example:"quay.io"`
	// The command that will be executed in a container template
	Command string `json:"command,omitempty" example:"ls -lah"`
	// Name of a network that will be used on container deployment if it exists inside the environment(endpoint)
	Network string `json:"network,omitempty" example:"mynet"`
	// A list of volumes used during the container template deployment
	Volumes []TemplateVolume `json:"volumes,omitempty"`
	// A list of ports exposed by the container
	Ports []string `json:"ports,omitempty" example:"8080:80/tcp"`
	// Container labels
	Labels []Pair `json:"labels,omitempty"`
	// Whether the container should be started in privileged mode
	Privileged bool `json:"privileged,omitempty" example:"true"`
	// Whether the container should be started in
	// interactive mode (-i -t equivalent on the CLI)
	Interactive bool `json:"interactive,omitempty" example:"true"`
	// Container restart policy
	RestartPolicy string `json:"restart_policy,omitempty" example:"on-failure"`
	// Container hostname
	Hostname string `json:"hostname,omitempty" example:"mycontainer"`
}

Template represents an application template that can be used as an App Template or an Edge template

type TemplateEnv ¶

type TemplateEnv struct {
	// name of the environment(endpoint) variable
	Name string `json:"name" example:"MYSQL_ROOT_PASSWORD"`
	// Text for the label that will be generated in the UI
	Label string `json:"label,omitempty" example:"Root password"`
	// Content of the tooltip that will be generated in the UI
	Description string `json:"description,omitempty" example:"MySQL root account password"`
	// Default value that will be set for the variable
	Default string `json:"default,omitempty" example:"default_value"`
	// If set to true, will not generate any input for this variable in the UI
	Preset bool `json:"preset,omitempty" example:"false"`
	// A list of name/value that will be used to generate a dropdown in the UI
	Select []TemplateEnvSelect `json:"select,omitempty"`
}

TemplateEnv represents a template environment(endpoint) variable configuration

type TemplateEnvSelect ¶

type TemplateEnvSelect struct {
	// Some text that will displayed as a choice
	Text string `json:"text" example:"text value"`
	// A value that will be associated to the choice
	Value string `json:"value" example:"value"`
	// Will set this choice as the default choice
	Default bool `json:"default" example:"false"`
}

TemplateEnvSelect represents text/value pair that will be displayed as a choice for the template user

type TemplateID ¶

type TemplateID int

TemplateID represents a template identifier

type TemplateRepository ¶

type TemplateRepository struct {
	// URL of a git repository used to deploy a stack template. Mandatory for a Swarm/Compose stack template
	URL string `json:"url" example:"https://github.com/portainer/portainer-compose"`
	// Path to the stack file inside the git repository
	StackFile string `json:"stackfile" example:"./subfolder/docker-compose.yml"`
}

TemplateRepository represents the git repository configuration for a template

type TemplateType ¶

type TemplateType int

TemplateType represents the type of a template

const (

	// ContainerTemplate represents a container template
	ContainerTemplate TemplateType
	// SwarmStackTemplate represents a template used to deploy a Swarm stack
	SwarmStackTemplate
	// ComposeStackTemplate represents a template used to deploy a Compose stack
	ComposeStackTemplate
	// EdgeStackTemplate represents a template used to deploy an Edge stack
	EdgeStackTemplate
)

type TemplateVolume ¶

type TemplateVolume struct {
	// Path inside the container
	Container string `json:"container" example:"/data"`
	// Path on the host
	Bind string `json:"bind,omitempty" example:"/tmp"`
	// Whether the volume used should be readonly
	ReadOnly bool `json:"readonly,omitempty" example:"true"`
}

TemplateVolume represents a template volume configuration

type TokenData ¶

type TokenData struct {
	ID                  UserID
	Username            string
	Role                UserRole
	OAuthToken          *oauth2.Token
	ForceChangePassword bool
}

TokenData represents the data embedded in a JWT token

type TunnelDetails ¶

type TunnelDetails struct {
	Status       string
	LastActivity time.Time
	Port         int
	Jobs         []EdgeJob
	Credentials  string
}

TunnelDetails represents information associated to a tunnel

type TunnelServerInfo ¶

type TunnelServerInfo struct {
	PrivateKeySeed string `json:"PrivateKeySeed"`
}

TunnelServerInfo represents information associated to the tunnel server

type User ¶

type User struct {
	// User Identifier
	ID       UserID `json:"Id" example:"1"`
	Username string `json:"Username" example:"bob"`
	Password string `json:"Password,omitempty" swaggerignore:"true"`
	// User role (1 for administrator account and 2 for regular account)
	Role          UserRole `json:"Role" example:"1"`
	TokenIssueAt  int64    `json:"TokenIssueAt" example:"1"`
	ThemeSettings UserThemeSettings

	// Deprecated
	UserTheme string `example:"dark"`
	// Deprecated in DBVersion == 25
	PortainerAuthorizations Authorizations
	// Deprecated in DBVersion == 25
	EndpointAuthorizations EndpointAuthorizations
	OAuthToken             *oauth2.Token
}

User represents a user account

type UserAccessPolicies ¶

type UserAccessPolicies map[UserID]AccessPolicy

UserAccessPolicies represent the association of an access policy and a user

type UserID ¶

type UserID int

UserID represents a user identifier

type UserResourceAccess ¶

type UserResourceAccess struct {
	UserID      UserID              `json:"UserId"`
	AccessLevel ResourceAccessLevel `json:"AccessLevel"`
}

UserResourceAccess represents the level of control on a resource for a specific user

type UserRole ¶

type UserRole int

UserRole represents the role of a user. It can be either an administrator or a regular user

const (

	// AdministratorRole represents an administrator user role
	AdministratorRole UserRole
	// StandardUserRole represents a regular user role
	StandardUserRole
)

type UserThemeSettings ¶

type UserThemeSettings struct {
	// Color represents the color theme of the UI
	Color string `json:"color" example:"dark" enums:"dark,light,highcontrast,auto"`
	// SubtleUpgradeButton indicates if the upgrade banner should be displayed in a subtle way
	SubtleUpgradeButton bool `json:"subtleUpgradeButton"`
}

UserThemeSettings represents the theme settings for a user

type Webhook ¶

type Webhook struct {
	// Webhook Identifier
	ID          WebhookID   `json:"Id" example:"1"`
	Token       string      `json:"Token"`
	ResourceID  string      `json:"ResourceId"`
	EndpointID  EndpointID  `json:"EndpointId"`
	RegistryID  RegistryID  `json:"RegistryId"`
	WebhookType WebhookType `json:"Type"`
}

Webhook represents a url webhook that can be used to update a service

type WebhookID ¶

type WebhookID int

WebhookID represents a webhook identifier.

type WebhookType ¶

type WebhookType int

WebhookType represents the type of resource a webhook is related to

const (

	// ServiceWebhook is a webhook for restarting a docker service
	ServiceWebhook WebhookType
)

Source Files ¶

View all Source files

Directories ¶

Path	Synopsis
adminmonitor
agent
apikey
archive
aws
ecr
backup
build
chisel
cli
cmd
portainer
crypto
database
boltdb
models
dataservices
apikeyrepository
customtemplate
dockerhub
edgegroup
edgejob
edgestack
endpoint
endpointgroup
endpointrelation
errors
extension
fdoprofile
helmuserrepository
registry
resourcecontrol
role
schedule
settings
snapshot
ssl
stack
tag
team
team/tests
teammembership
tunnelserver
user
version
webhook
datastore
migrator
demo
docker
exec
exectest
filesystem
git
types
hostmanagement
fdo
openamt
http
client
errors
handler
handler/auth
handler/backup
handler/customtemplates
handler/docker
handler/docker/containers
handler/edgegroups
handler/edgejobs
handler/edgestacks
handler/edgetemplates
handler/endpointedge
handler/endpointgroups
handler/endpointproxy
handler/endpoints
handler/file
handler/helm
handler/hostmanagement/fdo
handler/hostmanagement/openamt
handler/kubernetes
handler/ldap
handler/motd
handler/registries
handler/resourcecontrols
handler/roles
handler/settings
handler/ssl
handler/stacks
handler/storybook
handler/system
handler/tags
handler/teammemberships
handler/teams
handler/templates
handler/upload
handler/users
handler/webhooks
handler/websocket
middlewares
models/kubernetes
offlinegate
proxy
proxy/factory
proxy/factory/agent
proxy/factory/azure
proxy/factory/docker
proxy/factory/gitlab
proxy/factory/kubernetes
proxy/factory/utils
security
internal
authorization
edge
edge/cache
edge/edgestacks
edge/types
endpointutils
maps
nodes
randomstring
registryutils
registryutils/access
set
slices
snapshot
ssl
tag
testhelpers
upgrade
url
jwt
kubernetes
cli
privateregistries
validation
ldap
oauth
oauthtest
pkg
libhelm
libhelm/binary
libhelm/binary/test
libhelm/libhelmtest
libhelm/options
libhelm/release
libhelm/time Package time contains a wrapper for time.Time in the standard library and associated methods.	Package time contains a wrapper for time.Time in the standard library and associated methods.
platform
scheduler
stacks
deployments
stackbuilders
stackutils

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL

Documentation ¶

Index ¶

Constants ¶

Variables ¶

Functions ¶

Types ¶

type APIKey ¶

type APIKeyID ¶

type AccessPolicy ¶

type AgentPlatform ¶

type AuthenticationMethod ¶

type Authorization ¶

type Authorizations ¶

type AzureCredentials ¶

type CLIFlags ¶

type CLIService ¶

type ComposeStackManager ¶

type Connection ¶

type CryptoService ¶

type CustomTemplate ¶

type CustomTemplateID ¶

type CustomTemplatePlatform ¶

type CustomTemplateVariableDefinition ¶

type DigitalSignatureService ¶

type DockerHub ¶

type DockerSnapshot ¶

type DockerSnapshotRaw ¶

type DockerSnapshotter ¶

type EcrData ¶

type EdgeGroup ¶

type EdgeGroupID ¶

type EdgeJob ¶

type EdgeJobEndpointMeta ¶

type EdgeJobID ¶

type EdgeJobLogsStatus ¶

type EdgeSchedule deprecated

type EdgeStack ¶

type EdgeStackDeploymentType ¶

type EdgeStackID ¶

type EdgeStackStatus ¶

type EdgeStackStatusDetails ¶

type EdgeStackStatusType ¶

type Endpoint ¶

type EndpointAuthorizations ¶

type EndpointGroup ¶

type EndpointGroupID ¶

type EndpointID ¶

type EndpointPostInitMigrations ¶

type EndpointRelation ¶

type EndpointSecuritySettings ¶

type EndpointStatus ¶

type EndpointSyncJob ¶

type EndpointType ¶

type Extension ¶

type ExtensionID ¶

type FDOConfiguration ¶

type FDOProfile ¶

type FDOProfileID ¶

type Feature ¶

type FileService ¶

type GitService ¶

type GitlabRegistryData ¶

type HelmUserRepository ¶

type HelmUserRepositoryID ¶

type InternalAuthSettings ¶

type JobType ¶

type K8sNamespaceAccessPolicy ¶

type K8sNamespaceInfo ¶

type K8sNodeLimits ¶

type K8sNodesLimits ¶

type KubeClient ¶

type KubernetesConfiguration ¶

type KubernetesData ¶

func KubernetesDefault ¶

type KubernetesDeployer ¶

type KubernetesFlags ¶

type KubernetesIngressClassConfig ¶

type KubernetesShellPod ¶

type KubernetesSnapshot ¶

type KubernetesSnapshotter ¶