-
Notifications
You must be signed in to change notification settings - Fork 88
/
store_interface.go
223 lines (198 loc) · 10.5 KB
/
store_interface.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
package store
import (
"context"
"time"
kotsv1beta1 "github.com/replicatedhq/kots/kotskinds/apis/kots/v1beta1"
airgaptypes "github.com/replicatedhq/kots/pkg/airgap/types"
downstreamtypes "github.com/replicatedhq/kots/pkg/api/downstream/types"
versiontypes "github.com/replicatedhq/kots/pkg/api/version/types"
apptypes "github.com/replicatedhq/kots/pkg/app/types"
appstatetypes "github.com/replicatedhq/kots/pkg/appstate/types"
gitopstypes "github.com/replicatedhq/kots/pkg/gitops/types"
snapshottypes "github.com/replicatedhq/kots/pkg/kotsadmsnapshot/types"
installationtypes "github.com/replicatedhq/kots/pkg/online/types"
preflighttypes "github.com/replicatedhq/kots/pkg/preflight/types"
registrytypes "github.com/replicatedhq/kots/pkg/registry/types"
rendertypes "github.com/replicatedhq/kots/pkg/render/types"
sessiontypes "github.com/replicatedhq/kots/pkg/session/types"
"github.com/replicatedhq/kots/pkg/store/types"
supportbundletypes "github.com/replicatedhq/kots/pkg/supportbundle/types"
usertypes "github.com/replicatedhq/kots/pkg/user/types"
troubleshootredact "github.com/replicatedhq/troubleshoot/pkg/redact"
)
type Store interface {
Migrations
RegistryStore
SupportBundleStore
PreflightStore
PrometheusStore
AirgapStore
TaskStore
SessionStore
AppStatusStore
AppStore
DownstreamStore
VersionStore
LicenseStore
UserStore
ClusterStore
SnapshotStore
InstallationStore
KotsadmParamsStore
EmbeddedStore
Init() error // this may need options
WaitForReady(ctx context.Context) error
IsNotFound(err error) bool
}
type Migrations interface {
RunMigrations()
}
type RegistryStore interface {
GetRegistryDetailsForApp(appID string) (registrytypes.RegistrySettings, error)
UpdateRegistry(appID string, hostname string, username string, password string, namespace string, isReadOnly bool) error
GetAppIDsFromRegistry(hostname string) ([]string, error)
}
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 *supportbundletypes.SupportBundle) error
UpdateSupportBundle(bundle *supportbundletypes.SupportBundle) error
UploadSupportBundle(bundleID string, archivePath string, marshalledTree []byte) error
}
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 interface {
GetPrometheusAddress() (address string, err error)
SetPrometheusAddress(address string) error
}
type AirgapStore interface {
GetPendingAirgapUploadApp() (*airgaptypes.PendingApp, error)
GetAirgapInstallStatus(appID string) (*airgaptypes.InstallStatus, error)
ResetAirgapInstallInProgress(appID string) error
SetAppIsAirgap(appID string, isAirgap bool) error
}
type TaskStore interface {
SetTaskStatus(taskID string, message string, status string) error
UpdateTaskStatusTimestamp(taskID string) error
ClearTaskStatus(taskID string) error
GetTaskStatus(taskID string) (status string, message string, err error)
}
type SessionStore interface {
CreateSession(user *usertypes.User, issuedAt time.Time, expiresAt time.Time, roles []string) (*sessiontypes.Session, error)
DeleteSession(sessionID string) error
GetSession(sessionID string) (*sessiontypes.Session, error)
}
type AppStatusStore interface {
GetAppStatus(appID string) (*appstatetypes.AppStatus, error)
SetAppStatus(appID string, resourceStates appstatetypes.ResourceStates, updatedAt time.Time, sequence int64) error
}
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
SetSemverAutoDeploy(appID string, semverAutoDeploy apptypes.SemverAutoDeploy) error
SetSnapshotTTL(appID string, snapshotTTL string) error
SetSnapshotSchedule(appID string, snapshotSchedule string) error
RemoveApp(appID string) error
SetAppChannelChanged(appID string, channelChanged bool) error
}
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) (types.DownstreamVersionStatus, error)
GetIgnoreRBACErrors(appID string, sequence int64) (bool, error)
GetCurrentVersion(appID string, clusterID string) (*downstreamtypes.DownstreamVersion, error)
GetStatusForVersion(appID string, clusterID string, sequence int64) (types.DownstreamVersionStatus, error)
GetAppVersions(appID string, clusterID string) (*downstreamtypes.DownstreamVersions, error)
// Same as GetAppVersions, but finds a cluster where app is deployed
FindAppVersions(appID string) (*downstreamtypes.DownstreamVersions, 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 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 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)
CreateAppVersionArchive(appID string, sequence int64, archivePath string) error
GetAppVersionArchive(appID string, sequence int64, dstPath string) error
GetAppVersionBaseSequence(appID string, versionLabel string) (int64, error)
GetAppVersionBaseArchive(appID string, versionLabel string) (string, int64, error)
CreateAppVersion(appID string, baseSequence *int64, filesInDir string, source string, skipPreflights bool, gitops gitopstypes.DownstreamGitOps) (int64, error)
GetAppVersion(appID string, sequence int64) (*versiontypes.AppVersion, error)
GetLatestAppVersion(appID string) (*versiontypes.AppVersion, error)
GetAppVersionsAfter(appID string, sequence int64) ([]*versiontypes.AppVersion, error)
UpdateAppVersionInstallationSpec(appID string, sequence int64, spec kotsv1beta1.Installation) error
GetNextAppSequence(appID string) (int64, error)
GetCurrentUpdateCursor(appID string, channelID string) (string, string, error)
}
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, channelChanged bool, failOnVersionCreate bool, gitops gitopstypes.DownstreamGitOps, renderer rendertypes.Renderer) (int64, error)
UpdateAppLicenseSyncNow(appID string) error
}
type UserStore interface {
GetSharedPasswordBcrypt() ([]byte, error)
FlagInvalidPassword() error
FlagSuccessfulLogin() error
}
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 InstallationStore interface {
GetPendingInstallationStatus() (*installationtypes.InstallStatus, error)
}
type KotsadmParamsStore interface {
IsKotsadmIDGenerated() (bool, error)
SetIsKotsadmIDGenerated() error
}
type EmbeddedStore interface {
GetEmbeddedClusterAuthToken() (string, error)
SetEmbeddedClusterAuthToken(token string) error
}