Documentation
¶
Index ¶
- type AirgapStore
- type AppStatusStore
- type AppStore
- type ClusterStore
- type DownstreamStore
- type InstallationStore
- type KotsadmParamsStore
- type LicenseStore
- type Migrations
- type PreflightStore
- type PrometheusStore
- type RegistryStore
- type SessionStore
- type SnapshotStore
- type Store
- type SupportBundleStore
- type TaskStore
- type VersionStore
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type AirgapStore ¶
type AirgapStore interface {
GetPendingAirgapUploadApp() (*airgaptypes.PendingApp, error)
GetAirgapInstallStatus(appID string) (*airgaptypes.InstallStatus, error)
ResetAirgapInstallInProgress(appID string) error
SetAppIsAirgap(appID string, isAirgap bool) error
}
type AppStatusStore ¶
type AppStatusStore interface {
GetAppStatus(appID string) (*appstatustypes.AppStatus, error)
SetAppStatus(appID string, resourceStates []appstatustypes.ResourceState, updatedAt time.Time, sequence int64) error
}
type AppStore ¶
type AppStore interface {
AddAppToAllDownstreams(appID string) error
SetAppInstallState(appID string, state string) error
ListInstalledApps() ([]*apptypes.App, error)
ListInstalledAppSlugs() ([]string, error)
GetAppIDFromSlug(slug string) (appID string, err error)
GetApp(appID string) (*apptypes.App, error)
GetAppFromSlug(slug string) (*apptypes.App, error)
CreateApp(name string, upstreamURI string, licenseData string, isAirgapEnabled bool, skipImagePush bool, registryIsReadOnly bool) (*apptypes.App, error)
ListDownstreamsForApp(appID string) ([]downstreamtypes.Downstream, error)
ListAppsForDownstream(clusterID string) ([]*apptypes.App, error)
GetDownstream(clusterID string) (*downstreamtypes.Downstream, error)
IsGitOpsEnabledForApp(appID string) (bool, error)
SetUpdateCheckerSpec(appID string, updateCheckerSpec string) error
SetSnapshotTTL(appID string, snapshotTTL string) error
SetSnapshotSchedule(appID string, snapshotSchedule string) error
RemoveApp(appID string) error
}
type ClusterStore ¶
type ClusterStore interface {
ListClusters() ([]*downstreamtypes.Downstream, error)
GetClusterIDFromSlug(slug string) (clusterID string, err error)
GetClusterIDFromDeployToken(deployToken string) (clusterID string, err error)
CreateNewCluster(userID string, isAllUsers bool, title string, token string) (clusterID string, err error)
SetInstanceSnapshotTTL(clusterID string, snapshotTTL string) error
SetInstanceSnapshotSchedule(clusterID string, snapshotSchedule string) error
}
type DownstreamStore ¶
type DownstreamStore interface {
GetCurrentSequence(appID string, clusterID string) (int64, error)
GetCurrentParentSequence(appID string, clusterID string) (int64, error)
GetParentSequenceForSequence(appID string, clusterID string, sequence int64) (int64, error)
GetPreviouslyDeployedSequence(appID string, clusterID string) (int64, error)
SetDownstreamVersionReady(appID string, sequence int64) error
SetDownstreamVersionPendingPreflight(appID string, sequence int64) error
UpdateDownstreamVersionStatus(appID string, sequence int64, status string, statusInfo string) error
GetDownstreamVersionStatus(appID string, sequence int64) (string, error)
GetIgnoreRBACErrors(appID string, sequence int64) (bool, error)
GetCurrentVersion(appID string, clusterID string) (*downstreamtypes.DownstreamVersion, error)
GetStatusForVersion(appID string, clusterID string, sequence int64) (string, error)
GetPendingVersions(appID string, clusterID string) ([]downstreamtypes.DownstreamVersion, error)
GetPastVersions(appID string, clusterID string) ([]downstreamtypes.DownstreamVersion, error)
GetDownstreamOutput(appID string, clusterID string, sequence int64) (*downstreamtypes.DownstreamOutput, error)
IsDownstreamDeploySuccessful(appID string, clusterID string, sequence int64) (bool, error)
UpdateDownstreamDeployStatus(appID string, clusterID string, sequence int64, isError bool, output downstreamtypes.DownstreamOutput) error
DeleteDownstreamDeployStatus(appID string, clusterID string, sequence int64) error
}
type InstallationStore ¶
type InstallationStore interface {
GetPendingInstallationStatus() (*installationtypes.InstallStatus, error)
}
type KotsadmParamsStore ¶
type LicenseStore ¶
type LicenseStore interface {
GetLatestLicenseForApp(appID string) (*kotsv1beta1.License, error)
GetLicenseForAppVersion(appID string, sequence int64) (*kotsv1beta1.License, error)
GetAllAppLicenses() ([]*kotsv1beta1.License, error)
// originalLicenseData is the data received from the replicated API that was never marshalled locally so all fields are intact
UpdateAppLicense(appID string, sequence int64, archiveDir string, newLicense *kotsv1beta1.License, originalLicenseData string, failOnVersionCreate bool, gitops gitopstypes.DownstreamGitOps, renderer rendertypes.Renderer) (int64, error)
}
type Migrations ¶
type Migrations interface {
RunMigrations()
}
type PreflightStore ¶
type PreflightStore interface {
SetPreflightProgress(appID string, sequence int64, progress string) error
GetPreflightProgress(appID string, sequence int64) (string, error)
SetPreflightResults(appID string, sequence int64, results []byte) error
GetPreflightResults(appID string, sequence int64) (*preflighttypes.PreflightResult, error)
ResetPreflightResults(appID string, sequence int64) error
SetIgnorePreflightPermissionErrors(appID string, sequence int64) error
}
type PrometheusStore ¶
type RegistryStore ¶
type SessionStore ¶
type SnapshotStore ¶
type SnapshotStore interface {
ListPendingScheduledSnapshots(appID string) ([]snapshottypes.ScheduledSnapshot, error)
UpdateScheduledSnapshot(snapshotID string, backupName string) error
DeletePendingScheduledSnapshots(appID string) error
CreateScheduledSnapshot(snapshotID string, appID string, timestamp time.Time) error
ListPendingScheduledInstanceSnapshots(clusterID string) ([]snapshottypes.ScheduledInstanceSnapshot, error)
UpdateScheduledInstanceSnapshot(snapshotID string, backupName string) error
DeletePendingScheduledInstanceSnapshots(clusterID string) error
CreateScheduledInstanceSnapshot(snapshotID string, clusterID string, timestamp time.Time) error
}
type Store ¶
type Store interface {
Migrations
RegistryStore
SupportBundleStore
PreflightStore
PrometheusStore
AirgapStore
TaskStore
SessionStore
AppStatusStore
AppStore
DownstreamStore
VersionStore
LicenseStore
ClusterStore
SnapshotStore
InstallationStore
KotsadmParamsStore
Init() error // this may need options
WaitForReady(ctx context.Context) error
IsNotFound(err error) bool
}
type SupportBundleStore ¶
type SupportBundleStore interface {
ListSupportBundles(appID string) ([]*supportbundletypes.SupportBundle, error)
GetSupportBundle(bundleID string) (*supportbundletypes.SupportBundle, error)
CreateSupportBundle(bundleID string, appID string, archivePath string, marshalledTree []byte) (*supportbundletypes.SupportBundle, error)
GetSupportBundleArchive(bundleID string) (archivePath string, err error)
GetSupportBundleAnalysis(bundleID string) (*supportbundletypes.SupportBundleAnalysis, error)
SetSupportBundleAnalysis(bundleID string, insights []byte) error
GetRedactions(bundleID string) (troubleshootredact.RedactionList, error)
SetRedactions(bundleID string, redacts troubleshootredact.RedactionList) error
CreateInProgressSupportBundle(supportBundle *types.SupportBundle) error
UpdateSupportBundle(bundle *types.SupportBundle) error
UploadSupportBundle(bundleID string, archivePath string, marshalledTree []byte) error
}
type VersionStore ¶
type VersionStore interface {
IsIdentityServiceSupportedForVersion(appID string, sequence int64) (bool, error)
IsRollbackSupportedForVersion(appID string, sequence int64) (bool, error)
IsSnapshotsSupportedForVersion(a *apptypes.App, sequence int64, renderer rendertypes.Renderer) (bool, error)
GetAppVersionArchive(appID string, sequence int64, dstPath string) error
CreateAppVersionArchive(appID string, sequence int64, archivePath string) error
CreateAppVersion(appID string, currentSequence *int64, filesInDir string, source string, skipPreflights bool, gitops gitopstypes.DownstreamGitOps) (int64, error)
GetAppVersion(string, int64) (*versiontypes.AppVersion, error)
GetAppVersionsAfter(string, int64) ([]*versiontypes.AppVersion, error)
}
Click to show internal directories.
Click to hide internal directories.