-
Notifications
You must be signed in to change notification settings - Fork 830
/
store.go
424 lines (394 loc) · 13.1 KB
/
store.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
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
/*
Copyright (c) 2024 Seldon Technologies Ltd.
Use of this software is governed by
(1) the license included in the LICENSE file or
(2) if the license included in the LICENSE file is the Business Source License 1.1,
the Change License after the Change Date as each is defined in accordance with the LICENSE file.
*/
package pipeline
import (
"os"
"path/filepath"
"sync"
"github.com/mitchellh/copystructure"
"github.com/sirupsen/logrus"
"github.com/seldonio/seldon-core/apis/go/v2/mlops/scheduler"
"github.com/seldonio/seldon-core/scheduler/v2/pkg/coordinator"
"github.com/seldonio/seldon-core/scheduler/v2/pkg/store"
)
const (
pendingSyncsQueueSize int = 1000
addPipelineEventSource = "pipeline.store.addpipeline"
removePipelineEventSource = "pipeline.store.removepipeline"
setStatusPipelineEventSource = "pipeline.store.setstatus"
SetModelStatusPipelineEventSource = "pipeline.store.setmodelstatus"
pipelineDbFolder = "pipelinedb"
modelEventHandlerName = "pipeline.store.models"
)
type PipelineHandler interface {
AddPipeline(pipeline *scheduler.Pipeline) error
RemovePipeline(name string) error
GetPipelineVersion(name string, version uint32, uid string) (*PipelineVersion, error)
GetPipeline(name string) (*Pipeline, error)
GetPipelines() ([]*Pipeline, error)
SetPipelineState(name string, version uint32, uid string, state PipelineStatus, reason string, source string) error
GetAllRunningPipelineVersions() []coordinator.PipelineEventMsg
}
type PipelineStore struct {
logger logrus.FieldLogger
mu sync.RWMutex
eventHub *coordinator.EventHub
pipelines map[string]*Pipeline
db *PipelineDBManager
modelStatusHandler ModelStatusHandler
}
func NewPipelineStore(logger logrus.FieldLogger, eventHub *coordinator.EventHub, store store.ModelStore) *PipelineStore {
ps := &PipelineStore{
logger: logger.WithField("source", "pipelineStore"),
eventHub: eventHub,
pipelines: make(map[string]*Pipeline),
db: nil,
modelStatusHandler: ModelStatusHandler{
logger: logger.WithField("source", "PipelineModelStatusHandler"),
store: store,
modelReferences: map[string]map[string]void{},
},
}
if eventHub != nil {
eventHub.RegisterModelEventHandler(
modelEventHandlerName,
pendingSyncsQueueSize,
ps.logger,
ps.handleModelEvents,
)
}
return ps
}
func getPipelineDbFolder(basePath string) string {
return filepath.Join(basePath, pipelineDbFolder)
}
func (ps *PipelineStore) InitialiseOrRestoreDB(path string) error {
logger := ps.logger.WithField("func", "initialiseDB")
pipelineDbPath := getPipelineDbFolder(path)
logger.Infof("Initialise DB at %s", pipelineDbPath)
err := os.MkdirAll(pipelineDbPath, os.ModePerm)
if err != nil {
return err
}
db, err := newPipelineDbManager(pipelineDbPath, ps.logger)
if err != nil {
return err
}
ps.db = db
// If database already existed we can restore else this is a noop
err = ps.db.restore(ps.restorePipeline)
if err != nil {
return err
}
return nil
}
func (ps *PipelineStore) restorePipeline(pipeline *Pipeline) {
logger := ps.logger.WithField("func", "restorePipeline")
logger.Infof("Adding pipeline %s with state %s", pipeline.GetLatestPipelineVersion().String(), pipeline.GetLatestPipelineVersion().State.Status.String())
ps.mu.Lock()
err := ps.modelStatusHandler.addPipelineModelStatus(pipeline)
if err != nil {
logger.WithError(err).Errorf("Failed to set pipeline state for pipeline %s", pipeline.Name)
}
ps.pipelines[pipeline.Name] = pipeline
ps.mu.Unlock()
pv := pipeline.GetLatestPipelineVersion()
if ps.eventHub != nil {
ps.eventHub.PublishPipelineEvent(addPipelineEventSource, coordinator.PipelineEventMsg{
PipelineName: pv.Name,
PipelineVersion: pv.Version,
UID: pv.UID,
})
}
}
func validateAndAddPipelineVersion(req *scheduler.Pipeline, pipeline *Pipeline) error {
pv, err := CreatePipelineVersionFromProto(req)
if err != nil {
return err
}
pv.Version = pipeline.LastVersion + 1
err = validate(pv)
if err != nil {
return err
}
pv.State.setState(PipelineCreate, "")
pipeline.LastVersion = pipeline.LastVersion + 1
pipeline.Versions = append(pipeline.Versions, pv)
return nil
}
func (ps *PipelineStore) AddPipeline(req *scheduler.Pipeline) error {
evt, err := ps.addPipelineImpl(req)
if err != nil {
return err
}
if ps.eventHub != nil && evt != nil {
ps.eventHub.PublishPipelineEvent(addPipelineEventSource, *evt)
}
return nil
}
func (ps *PipelineStore) addPipelineImpl(req *scheduler.Pipeline) (*coordinator.PipelineEventMsg, error) {
logger := ps.logger.WithField("func", "AddPipeline")
ps.mu.Lock()
defer ps.mu.Unlock()
var pipeline *Pipeline
var ok bool
if pipeline, ok = ps.pipelines[req.Name]; !ok {
pipeline = &Pipeline{
Name: req.Name,
LastVersion: 0,
}
} else {
lastPipeline := pipeline.GetLatestPipelineVersion()
switch lastPipeline.State.Status {
case PipelineTerminate, PipelineTerminating, PipelineTerminated:
pipeline = &Pipeline{
Name: req.Name,
LastVersion: 0,
}
default:
// Handle repeat Kubernetes resource calls for same generation
if req.GetKubernetesMeta() != nil &&
lastPipeline.KubernetesMeta != nil &&
req.GetKubernetesMeta().Generation > 0 &&
lastPipeline.KubernetesMeta.Generation > 0 {
if req.GetKubernetesMeta().Generation == lastPipeline.KubernetesMeta.Generation {
logger.Infof("Pipeline %s kubernetes meta generation matches %d so will ignore", req.Name, req.KubernetesMeta.Generation)
return nil, nil
}
}
}
}
err := validateAndAddPipelineVersion(req, pipeline)
if err != nil {
return nil, err
}
err = ps.modelStatusHandler.addPipelineModelStatus(pipeline)
if err != nil {
return nil, err
}
ps.pipelines[req.Name] = pipeline
if ps.db != nil {
err = ps.db.save(pipeline)
if err != nil {
return nil, err
}
}
pv := pipeline.GetLatestPipelineVersion()
return &coordinator.PipelineEventMsg{
PipelineName: pv.Name,
PipelineVersion: pv.Version,
UID: pv.UID,
}, nil
}
func (ps *PipelineStore) RemovePipeline(name string) error {
logger := ps.logger.WithField("func", "RemovePipeline")
logger.Debugf("Attempt to remove pipeline %s", name)
evt, err := ps.removePipelineImpl(name)
if err != nil {
return err
}
if ps.eventHub != nil && evt != nil {
ps.eventHub.PublishPipelineEvent(removePipelineEventSource, *evt)
}
return nil
}
func (ps *PipelineStore) removePipelineImpl(name string) (*coordinator.PipelineEventMsg, error) {
ps.mu.Lock()
defer ps.mu.Unlock()
if pipeline, ok := ps.pipelines[name]; ok {
lastPipelineVersion := pipeline.GetLatestPipelineVersion()
if lastPipelineVersion == nil {
return nil, &PipelineVersionNotFoundErr{pipeline: name, version: pipeline.LastVersion - 1}
}
lastState := lastPipelineVersion.State
switch lastState.Status {
case PipelineTerminating:
return nil, &PipelineTerminatingErr{pipeline: name}
case PipelineTerminated:
return nil, &PipelineAlreadyTerminatedErr{pipeline: name}
default:
pipeline.Deleted = true
lastPipelineVersion.State.setState(PipelineTerminate, "pipeline removed")
if err := ps.db.save(pipeline); err != nil {
ps.logger.WithError(err).Errorf("Failed to save pipeline %s", name)
return nil, err
}
return &coordinator.PipelineEventMsg{
PipelineName: lastPipelineVersion.Name,
PipelineVersion: lastPipelineVersion.Version,
UID: lastPipelineVersion.UID,
}, nil
}
} else {
return nil, &PipelineNotFoundErr{pipeline: name}
}
}
func (ps *PipelineStore) GetPipelineVersion(name string, versionNumber uint32, uid string) (*PipelineVersion, error) {
ps.mu.RLock()
defer ps.mu.RUnlock()
if pipeline, ok := ps.pipelines[name]; ok {
if pipelineVersion := pipeline.GetPipelineVersion(versionNumber); pipelineVersion != nil {
if pipelineVersion.UID == uid {
copiedPipelineVersion, err := copystructure.Copy(pipelineVersion)
if err != nil {
return nil, err
}
return copiedPipelineVersion.(*PipelineVersion), nil
} else {
return nil, &PipelineVersionUidMismatchErr{pipeline: name, version: versionNumber, uidActual: pipelineVersion.UID, uidExpected: uid}
}
} else {
return nil, &PipelineVersionNotFoundErr{pipeline: name, version: versionNumber}
}
} else {
return nil, &PipelineNotFoundErr{pipeline: name}
}
}
func (ps *PipelineStore) GetPipeline(name string) (*Pipeline, error) {
ps.mu.RLock()
defer ps.mu.RUnlock()
if pipeline, ok := ps.pipelines[name]; ok {
copiedPipeline, err := copystructure.Copy(pipeline)
if err != nil {
return nil, err
}
return copiedPipeline.(*Pipeline), nil
} else {
return nil, &PipelineNotFoundErr{pipeline: name}
}
}
func (ps *PipelineStore) GetAllRunningPipelineVersions() []coordinator.PipelineEventMsg {
ps.mu.RLock()
defer ps.mu.RUnlock()
var events []coordinator.PipelineEventMsg
for _, p := range ps.pipelines {
pv := p.GetLatestPipelineVersion()
switch pv.State.Status {
// we consider PipelineTerminating as running as it is still active
case PipelineCreate, PipelineCreating, PipelineReady, PipelineTerminating:
events = append(events, coordinator.PipelineEventMsg{
PipelineName: pv.Name,
PipelineVersion: pv.Version,
UID: pv.UID,
})
}
}
return events
}
func (ps *PipelineStore) GetPipelines() ([]*Pipeline, error) {
ps.mu.RLock()
defer ps.mu.RUnlock()
foundPipelines := []*Pipeline{}
for _, p := range ps.pipelines {
copied, err := copystructure.Copy(p)
if err != nil {
return nil, err
}
foundPipelines = append(foundPipelines, copied.(*Pipeline))
}
return foundPipelines, nil
}
func (ps *PipelineStore) terminateOldUnterminatedPipelinesIfNeeded(pipeline *Pipeline) []*coordinator.PipelineEventMsg {
var evts []*coordinator.PipelineEventMsg
for _, pv := range pipeline.Versions {
if pv.Version != pipeline.LastVersion {
switch pv.State.Status {
case PipelineTerminating, PipelineTerminate, PipelineTerminated:
continue
default:
pv.State.setState(PipelineTerminate, "")
evts = append(evts, &coordinator.PipelineEventMsg{
PipelineName: pv.Name,
PipelineVersion: pv.Version,
UID: pv.UID,
})
}
}
}
return evts
}
func (ps *PipelineStore) SetPipelineState(name string, versionNumber uint32, uid string, status PipelineStatus, reason string, source string) error {
logger := ps.logger.WithField("func", "SetPipelineState")
logger.Debugf("Attempt to set state on pipeline %s:%d status:%s", name, versionNumber, status.String())
evts, err := ps.setPipelineStateImpl(name, versionNumber, uid, status, reason)
if err != nil {
return err
}
if ps.eventHub != nil {
for _, evt := range evts {
evt.Source = source
ps.eventHub.PublishPipelineEvent(setStatusPipelineEventSource, *evt)
}
}
return nil
}
func (ps *PipelineStore) setPipelineStateImpl(name string, versionNumber uint32, uid string, status PipelineStatus, reason string) ([]*coordinator.PipelineEventMsg, error) {
var evts []*coordinator.PipelineEventMsg
ps.mu.Lock()
defer ps.mu.Unlock()
if pipeline, ok := ps.pipelines[name]; ok {
if pipelineVersion := pipeline.GetPipelineVersion(versionNumber); pipelineVersion != nil {
if pipelineVersion.UID == uid {
pipelineVersion.State.setState(status, reason)
evts = append(evts, &coordinator.PipelineEventMsg{
PipelineName: pipelineVersion.Name,
PipelineVersion: pipelineVersion.Version,
UID: pipelineVersion.UID,
})
if status == PipelineReady {
evts = append(evts, ps.terminateOldUnterminatedPipelinesIfNeeded(pipeline)...)
}
if !pipeline.Deleted && ps.db != nil {
err := ps.db.save(pipeline)
if err != nil {
return evts, err
}
}
return evts, nil
} else {
return evts, &PipelineVersionUidMismatchErr{
pipeline: name,
version: versionNumber,
uidActual: pipelineVersion.UID,
uidExpected: uid,
}
}
} else {
return evts, &PipelineVersionNotFoundErr{pipeline: name, version: versionNumber}
}
} else {
return evts, &PipelineNotFoundErr{pipeline: name}
}
}
func (ps *PipelineStore) handleModelEvents(event coordinator.ModelEventMsg) {
logger := ps.logger.WithField("func", "handleModelEvents")
logger.Infof("Received event %s", event.String())
go func() {
ps.modelStatusHandler.mu.RLock()
defer ps.modelStatusHandler.mu.RUnlock()
refs := ps.modelStatusHandler.modelReferences[event.ModelName]
if len(refs) > 0 {
model, err := ps.modelStatusHandler.store.GetModel(event.ModelName)
if err != nil {
logger.Warningf("Failed to get model %s from store", event.ModelName)
return
}
ps.mu.Lock()
evts := updatePipelinesFromModelAvailability(refs, event.ModelName, model != nil && model.GetLastAvailableModel() != nil, ps.pipelines, ps.logger)
ps.mu.Unlock()
// Publish events for modified pipelines
if ps.eventHub != nil {
for _, evt := range evts {
ps.eventHub.PublishPipelineEvent(SetModelStatusPipelineEventSource, *evt)
}
}
} else {
logger.Debugf("No references in pipelines for model %s", event.ModelName)
}
}()
}