types

package
v3.0.0 Latest Latest
Warning

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

Go to latest
Published: Nov 14, 2026 License: BSD-3-Clause Imports: 6 Imported by: 0

Documentation

Index

Constants

View Source
const (
	VersionEndpoint    = "/api/version"
	AppVersionEndpoint = "/api/app/version"
)

Variables

View Source
var (
	KnownPaginatedResources = []string{
		"containers",
		"images",
		"volumes",
		"networks",
		"projects",
		"agents",
		"registries",
		"templates",
		"repos",
		"gitops-syncs",
		"users",
		"roles",
		"events",
		"apikeys",
	}
)

Functions

func Activities

func Activities(envID string) string

func ActivitiesHistory

func ActivitiesHistory(envID string) string

func Activity

func Activity(envID, activityID string) string

func ActivityAction

func ActivityAction(envID, activityID, action string) string

func ApiKey

func ApiKey(id string) string

func ApiKeys

func ApiKeys() string

func AuthFederated

func AuthFederated() string

func AuthLogout

func AuthLogout() string

func AuthMe

func AuthMe() string

func AuthMeApiKey

func AuthMeApiKey(id string) string

func AuthMeApiKeys

func AuthMeApiKeys() string

func AuthPassword

func AuthPassword() string

func AuthRefresh

func AuthRefresh() string

func AuthenticationSettings

func AuthenticationSettings() string

func Backup

func Backup(id string) string

func BackupAction

func BackupAction(id, action string) string

func BackupUpload

func BackupUpload(id string) string

func Backups

func Backups() string

func BackupsDiscover

func BackupsDiscover() string

func BackupsPolicies

func BackupsPolicies() string

func BackupsRecoveryKey

func BackupsRecoveryKey() string

func BackupsRecoveryKeyGenerate

func BackupsRecoveryKeyGenerate() string

func BackupsS3

func BackupsS3() string

func BackupsS3Destination

func BackupsS3Destination(id string) string

func BackupsS3DestinationAction

func BackupsS3DestinationAction(id, action string) string

func BackupsS3DestinationInUse

func BackupsS3DestinationInUse(id string) string

func BackupsS3Options

func BackupsS3Options() string

func BackupsS3Test

func BackupsS3Test() string

func Container

func Container(envID, containerID string) string

func ContainerAction

func ContainerAction(envID, containerID, action string) string

func ContainerAutoUpdate

func ContainerAutoUpdate(envID, containerID string) string

func ContainerCommit

func ContainerCommit(envID, containerID string) string

func ContainerConfig

func ContainerConfig(envID, containerID string) string

func ContainerRedeploy

func ContainerRedeploy(envID, containerID string) string

func ContainerRegistries

func ContainerRegistries() string

func ContainerRegistriesPullUsage

func ContainerRegistriesPullUsage() string

func ContainerRegistry

func ContainerRegistry(id string) string

func ContainerRegistryAction

func ContainerRegistryAction(id, action string) string

func ContainerUpdate

func ContainerUpdate(envID, containerID string) string

func Containers

func Containers(envID string) string

func ContainersCounts

func ContainersCounts(envID string) string

func Environment

func Environment(id string) string

func EnvironmentDeployment

func EnvironmentDeployment(envID string) string

func EnvironmentTest

func EnvironmentTest(envID string) string

func EnvironmentTunnelRestart

func EnvironmentTunnelRestart(envID string) string

func EnvironmentVersion

func EnvironmentVersion(envID string) string

func Environments

func Environments() string

func Event

func Event(id string) string

func Events

func Events() string

func EventsEnvironment

func EventsEnvironment(envID string) string

func EventsStats

func EventsStats() string

func FederatedCredential

func FederatedCredential(id string) string

func FederatedCredentials

func FederatedCredentials() string

func GitOpsSync

func GitOpsSync(envID, syncID string) string

func GitOpsSyncAction

func GitOpsSyncAction(envID, syncID, action string) string

func GitOpsSyncBackupHistory

func GitOpsSyncBackupHistory(envID, syncID string) string

func GitOpsSyncBackupPreview

func GitOpsSyncBackupPreview(envID, syncID string) string

func GitOpsSyncBackupResolve

func GitOpsSyncBackupResolve(envID, syncID string) string

func GitOpsSyncFiles

func GitOpsSyncFiles(envID, syncID string) string

func GitOpsSyncStatus

func GitOpsSyncStatus(envID, syncID string) string

func GitOpsSyncs

func GitOpsSyncs(envID string) string

func GitOpsSyncsImport

func GitOpsSyncsImport(envID string) string

func GitRepositories

func GitRepositories() string

func GitRepository

func GitRepository(id string) string

func GitRepositoryAction

func GitRepositoryAction(id, action string) string

func GitRepositoryBranches

func GitRepositoryBranches(id string) string

func GitRepositoryFiles

func GitRepositoryFiles(id string) string

func Image

func Image(envID, imageID string) string

func ImageAttestations

func ImageAttestations(envID, name string) string

func ImageBuild

func ImageBuild(envID, buildID string) string

func ImageBuilds

func ImageBuilds(envID string) string

func ImageExport

func ImageExport(envID, name string) string

func ImageHistory

func ImageHistory(envID, name string) string

func ImageTag

func ImageTag(envID, name string) string

func ImageUpdatesCheck

func ImageUpdatesCheck(envID, imageRef string) string

func ImageUpdatesCheckAction

func ImageUpdatesCheckAction(envID, action string) string

func ImageUpdatesCheckById

func ImageUpdatesCheckById(envID, imageID string) string

func ImageUpdatesSummary

func ImageUpdatesSummary(envID string) string

func ImageVulnerabilities

func ImageVulnerabilities(envID, imageID string) string

func ImageVulnerabilitiesList

func ImageVulnerabilitiesList(envID, imageID string) string

func ImageVulnerabilitiesScan

func ImageVulnerabilitiesScan(envID, imageID string) string

func ImageVulnerabilitiesSummary

func ImageVulnerabilitiesSummary(envID, imageID string) string

func Images

func Images(envID string) string

func ImagesBuild

func ImagesBuild(envID string) string

func ImagesCounts

func ImagesCounts(envID string) string

func ImagesPrune

func ImagesPrune(envID string) string

func ImagesPull

func ImagesPull(envID string) string

func ImagesSearch

func ImagesSearch(envID string) string

func ImagesUpload

func ImagesUpload(envID string) string

func ImagesVulnerabilitiesSummaries

func ImagesVulnerabilitiesSummaries(envID string) string

func JobAction

func JobAction(envID, jobID, action string) string

func JobSchedules

func JobSchedules(envID string) string

func Jobs

func Jobs(envID string) string

func ManagerSettings

func ManagerSettings() string

func Network

func Network(envID, networkID string) string

func NetworkAction

func NetworkAction(envID, networkID, action string) string

func Networks

func Networks(envID string) string

func NetworksCounts

func NetworksCounts(envID string) string

func NetworksPrune

func NetworksPrune(envID string) string

func NetworksTopology

func NetworksTopology(envID string) string

func NormalizePaginatedResource

func NormalizePaginatedResource(resource string) string

func NormalizePaginatedResources

func NormalizePaginatedResources(resources map[string]PaginationResourceConfig) map[string]PaginationResourceConfig

func NotificationSettingsProvider

func NotificationSettingsProvider(provider string) string

func NotificationSettingsProviderAction

func NotificationSettingsProviderAction(provider, action string) string

func NotificationsSettings

func NotificationsSettings() string

func OIDCDeviceCode

func OIDCDeviceCode() string

func OIDCDeviceToken

func OIDCDeviceToken() string

func OIDCStatus

func OIDCStatus() string

func OidcRoleMapping

func OidcRoleMapping(id string) string

func OidcRoleMappings

func OidcRoleMappings() string

func PodmanAutoUpdate

func PodmanAutoUpdate(envID string) string

func PodmanKube

func PodmanKube(envID, action string) string

func PodmanPod

func PodmanPod(envID, podID string) string

func PodmanPodAction

func PodmanPodAction(envID, podID, action string) string

func PodmanPods

func PodmanPods(envID string) string

func PodmanQuadlet

func PodmanQuadlet(envID, name string) string

func PodmanQuadletAction

func PodmanQuadletAction(envID, name, action string) string

func PodmanQuadlets

func PodmanQuadlets(envID string) string

func PodmanSecret

func PodmanSecret(envID, secretID string) string

func PodmanSecrets

func PodmanSecrets(envID string) string

func PodmanStatus

func PodmanStatus(envID string) string

func Project

func Project(envID, projectID string) string

func ProjectAction

func ProjectAction(envID, projectID, action string, services []string) string

func ProjectBuild

func ProjectBuild(envID, projectID string) string

func ProjectDeploy

func ProjectDeploy(envID, projectID, action string) string

func ProjectTags

func ProjectTags(envID, projectID string) string

func ProjectWorkspace

func ProjectWorkspace(envID, projectID string) string

func ProjectWorkspaceFile

func ProjectWorkspaceFile(envID, projectID string) string

func ProjectWorkspaceFileDownload

func ProjectWorkspaceFileDownload(envID, projectID string) string

func Projects

func Projects(envID string) string

func ProjectsCounts

func ProjectsCounts(envID string) string

func ProjectsTags

func ProjectsTags(envID string) string

func Role

func Role(id string) string

func Roles

func Roles() string

func RolesAvailablePermissions

func RolesAvailablePermissions() string

func Settings

func Settings(envID string) string

func SettingsPublic

func SettingsPublic(envID string) string

func SystemContainersAction

func SystemContainersAction(envID, action string) string

func SystemConvert

func SystemConvert(envID string) string

func SystemDockerInfo

func SystemDockerInfo(envID string) string

func SystemPrune

func SystemPrune(envID string) string

func SystemUpgrade

func SystemUpgrade(envID string) string

func SystemUpgradeCheck

func SystemUpgradeCheck(envID string) string

func SystemUpgradeJobCurrent

func SystemUpgradeJobCurrent(envID string) string

func SystemUpgradeJobs

func SystemUpgradeJobs(envID string) string

func Template

func Template(id string) string

func TemplateAction

func TemplateAction(id, action string) string

func TemplateContent

func TemplateContent(id string) string

func TemplateFetch

func TemplateFetch() string

func TemplateRegistry

func TemplateRegistry(id string) string

func Templates

func Templates() string

func TemplatesAll

func TemplatesAll() string

func TemplatesDefault

func TemplatesDefault() string

func TemplatesRegistries

func TemplatesRegistries() string

func UpdaterHistory

func UpdaterHistory(envID string) string

func UpdaterRun

func UpdaterRun(envID string) string

func UpdaterStatus

func UpdaterStatus(envID string) string

func UploadSession

func UploadSession(envID, kind, uploadID string) string

func UploadSessionChunk

func UploadSessionChunk(envID, kind, uploadID string, index int) string

func UploadSessions

func UploadSessions(envID, kind string) string

func User

func User(id string) string

func UserRoleAssignments

func UserRoleAssignments(userID string) string

func Users

func Users() string

func Variable

func Variable(id string) string

func Variables

func Variables() string

func VariablesSync

func VariablesSync() string

func Volume

func Volume(envID, volumeName string) string

func VolumeBackup

func VolumeBackup(envID, backupID string) string

func VolumeBackupAction

func VolumeBackupAction(envID, volumeName, backupID, action string) string

func VolumeBackupDownload

func VolumeBackupDownload(envID, backupID string) string

func VolumeBackupFiles

func VolumeBackupFiles(envID, backupID string) string

func VolumeBackupPolicy

func VolumeBackupPolicy(envID, volumeName string) string

func VolumeBackupUpload

func VolumeBackupUpload(envID, backupID string) string

func VolumeBackupUploadRestore

func VolumeBackupUploadRestore(envID, volumeName string) string

func VolumeBackups

func VolumeBackups(envID, volumeName string) string

func VolumeRename

func VolumeRename(envID, volumeName string) string

func VolumeUsage

func VolumeUsage(envID, volumeName string) string

func VolumeWorkspace

func VolumeWorkspace(envID, volumeName string) string

func VolumeWorkspaceFile

func VolumeWorkspaceFile(envID, volumeName string) string

func VolumeWorkspaceFileDownload

func VolumeWorkspaceFileDownload(envID, volumeName string) string

func Volumes

func Volumes(envID string) string

func VolumesCounts

func VolumesCounts(envID string) string

func VolumesPrune

func VolumesPrune(envID string) string

func VolumesSizes

func VolumesSizes(envID string) string

func VulnerabilitiesAll

func VulnerabilitiesAll(envID string) string

func VulnerabilitiesIgnored

func VulnerabilitiesIgnored(envID string) string

func VulnerabilitiesScannerStatus

func VulnerabilitiesScannerStatus(envID string) string

func VulnerabilitiesSummary

func VulnerabilitiesSummary(envID string) string

func VulnerabilityIgnored

func VulnerabilityIgnored(envID, ignoreID string) string

func Webhook

func Webhook(envID, webhookID string) string

func WebhookTrigger

func WebhookTrigger(token string) string

func Webhooks

func Webhooks(envID string) string

Types

type Config

type Config struct {
	Pagination        PaginationConfig `yaml:"pagination,omitempty"`
	ServerURL         string           `yaml:"server_url"`
	APIKey            string           `yaml:"api_key,omitempty"`
	JWTToken          string           `yaml:"-"`
	RefreshToken      string           `yaml:"-"`
	FederatedAudience string           `yaml:"federated_audience,omitempty"`
	LogLevel          string           `yaml:"log_level,omitempty"`
	CLIUpdateChannel  string           `yaml:"cli_update_channel,omitempty"`
	Previews          PreviewsConfig   `yaml:"previews"`
}

func (*Config) Clone

func (c *Config) Clone() *Config

func (*Config) HasAuth

func (c *Config) HasAuth() bool

func (*Config) IsConfigured

func (c *Config) IsConfigured() bool

func (*Config) LimitFor

func (c *Config) LimitFor(resource string) int

func (*Config) SetDefaultLimit

func (c *Config) SetDefaultLimit(limit int)

func (*Config) SetResourceLimit

func (c *Config) SetResourceLimit(resource string, limit int)

func (*Config) Validate

func (c *Config) Validate() error

func (*Config) ValidateServerURL

func (c *Config) ValidateServerURL() error

type PaginationConfig

type PaginationConfig struct {
	Resources map[string]PaginationResourceConfig `yaml:"resources,omitempty"`
	Default   PaginationResourceConfig            `yaml:"default,omitempty"`
}

type PaginationResourceConfig

type PaginationResourceConfig struct {
	Limit int `yaml:"limit,omitempty"`
}

type PreviewsConfig

type PreviewsConfig struct {
	NewSelfUpdater bool `yaml:"newSelfUpdater"`
}

Jump to

Keyboard shortcuts

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