/
orchestrator.go
374 lines (317 loc) · 9.47 KB
/
orchestrator.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
// Copyright (c) 2019 Cisco and/or its affiliates.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at:
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
package orchestrator
import (
"context"
"os"
"strings"
"sync"
"github.com/go-errors/errors"
"go.ligato.io/cn-infra/v2/datasync"
"go.ligato.io/cn-infra/v2/datasync/resync"
"go.ligato.io/cn-infra/v2/infra"
"go.ligato.io/cn-infra/v2/logging"
"go.ligato.io/cn-infra/v2/rpc/grpc"
"google.golang.org/grpc/reflection"
"google.golang.org/protobuf/proto"
"go.ligato.io/vpp-agent/v3/pkg/models"
kvs "go.ligato.io/vpp-agent/v3/plugins/kvscheduler/api"
"go.ligato.io/vpp-agent/v3/plugins/orchestrator/contextdecorator"
"go.ligato.io/vpp-agent/v3/proto/ligato/generic"
"go.ligato.io/vpp-agent/v3/proto/ligato/kvscheduler"
)
var (
// EnableStatusPublishing enables status publishing.
EnableStatusPublishing = os.Getenv("ENABLE_STATUS_PUBLISHING") != ""
debugOrchestrator = os.Getenv("DEBUG_ORCHESTRATOR") != ""
)
// Plugin implements sync service for GRPC.
type Plugin struct {
Deps
*dispatcher
manager *genericService
reflection bool
// datasync channels
changeChan chan datasync.ChangeEvent
resyncChan chan datasync.ResyncEvent
watchDataReg datasync.WatchRegistration
wg sync.WaitGroup
quit chan struct{}
}
// Deps represents dependencies for the plugin.
type Deps struct {
infra.PluginDeps
GRPC grpc.Server
KVScheduler kvs.KVScheduler
Watcher datasync.KeyValProtoWatcher
StatusPublisher datasync.KeyProtoValWriter
}
// Init registers the service to GRPC server.
func (p *Plugin) Init() (err error) {
p.quit = make(chan struct{})
p.dispatcher = &dispatcher{
log: logging.DefaultRegistry.NewLogger("dispatcher"),
db: newMemStore(),
kvs: p.KVScheduler,
}
// register grpc service
p.manager = &genericService{
log: p.log,
dispatch: p.dispatcher,
}
if grpcServer := p.GRPC.GetServer(); grpcServer != nil {
p.Log.Debugf("registering generic manager and meta service")
generic.RegisterManagerServiceServer(grpcServer, p.manager)
generic.RegisterMetaServiceServer(grpcServer, p.manager)
// register grpc services for reflection
if p.reflection {
p.Log.Debugf("registering grpc reflection service")
reflection.Register(grpcServer)
}
} else {
p.log.Infof("grpc server is not available")
}
p.Log.Infof("Found %d registered models", len(models.RegisteredModels()))
for _, model := range models.RegisteredModels() {
p.debugf("- model: %+v", *model.Spec())
}
var prefixes []string
if nbPrefixes := p.kvs.GetRegisteredNBKeyPrefixes(); len(nbPrefixes) > 0 {
p.log.Infof("Watching %d key prefixes from KVScheduler", len(nbPrefixes))
for _, prefix := range nbPrefixes {
p.debugf("- prefix: %s", prefix)
prefixes = append(prefixes, prefix)
}
} else {
p.log.Warnf("No key prefixes found in KVScheduler (ensure that all KVDescriptors are registered before this)")
}
// initialize datasync channels
p.resyncChan = make(chan datasync.ResyncEvent)
p.changeChan = make(chan datasync.ChangeEvent)
p.watchDataReg, err = p.Watcher.Watch(p.PluginName.String(),
p.changeChan, p.resyncChan, prefixes...)
if err != nil {
return err
}
return nil
}
// AfterInit subscribes to known NB prefixes.
func (p *Plugin) AfterInit() (err error) {
// watch datasync events
p.wg.Add(1)
go p.watchEvents()
statusChan := make(chan *kvscheduler.BaseValueStatus, 100)
p.kvs.WatchValueStatus(statusChan, nil)
// watch KVSchedular status changes
p.wg.Add(1)
go p.watchStatus(statusChan)
return nil
}
func (p *Plugin) Close() (err error) {
close(p.quit)
p.wg.Wait()
return nil
}
// InitialSync will start initial synchronization.
func (p *Plugin) InitialSync() error {
// SB resync
p.Log.Debugf("starting initial SB sync")
txn := p.KVScheduler.StartNBTransaction()
ctx := kvs.WithResync(context.Background(), kvs.DownstreamResync, true)
if _, err := txn.Commit(ctx); err != nil {
return errors.Errorf("initial SB sync failed: %v", err)
}
p.Log.Infof("initial SB sync complete")
// NB resync
p.Log.Debugf("starting initial NB sync")
resync.DefaultPlugin.DoResync() // NB init file data is also resynced here
p.Log.Infof("initial NB sync complete")
return nil
}
func (p *Plugin) watchEvents() {
defer p.wg.Done()
p.Log.Debugf("watching datasync events")
defer p.Log.Debugf("done watching datasync events")
for {
select {
case e := <-p.changeChan:
p.log.Debugf("=> received CHANGE event (%v changes)", len(e.GetChanges()))
var err error
var kvPairs []KeyVal
for _, x := range e.GetChanges() {
kv := KeyVal{
Key: x.GetKey(),
}
if x.GetChangeType() != datasync.Delete {
kv.Val, err = UnmarshalLazyValue(kv.Key, x)
if err != nil {
p.log.Errorf("decoding value for key %q failed: %v", kv.Key, err)
continue
}
}
kvPairs = append(kvPairs, kv)
}
if len(kvPairs) == 0 {
p.log.Warn("no valid kv pairs received in change event")
e.Done(nil)
continue
}
p.log.Debugf("Change with %d items", len(kvPairs))
ctx := e.GetContext()
if ctx == nil {
ctx = context.Background()
}
_, withDataSrc := contextdecorator.DataSrcFromContext(ctx)
if !withDataSrc {
ctx = contextdecorator.DataSrcContext(ctx, "datasync")
}
ctx = kvs.WithRetryDefault(ctx)
_, err = p.PushData(ctx, kvPairs, nil)
e.Done(err)
case e := <-p.resyncChan:
p.log.Debugf("=> received RESYNC event (%v prefixes)", len(e.GetValues()))
var kvPairs []KeyVal
for prefix, iter := range e.GetValues() {
var keyVals []datasync.KeyVal
for x, done := iter.GetNext(); !done; x, done = iter.GetNext() {
key := x.GetKey()
val, err := UnmarshalLazyValue(key, x)
if err != nil {
p.log.Errorf("unmarshal value for key %q failed: %v", key, err)
continue
}
kvPairs = append(kvPairs, KeyVal{
Key: key,
Val: val,
})
p.log.Debugf(" -- key: %s", x.GetKey())
keyVals = append(keyVals, x)
}
if len(keyVals) > 0 {
p.log.Debugf("- %q (%v items)", prefix, len(keyVals))
} else {
p.log.Debugf("- %q (no items)", prefix)
}
for _, x := range keyVals {
p.log.Debugf("\t - %q: (rev: %v)", x.GetKey(), x.GetRevision())
}
}
p.log.Debugf("Resync with %d items", len(kvPairs))
ctx := e.GetContext()
if ctx == nil {
ctx = context.Background()
}
_, withDataSrc := contextdecorator.DataSrcFromContext(ctx)
if !withDataSrc {
ctx = contextdecorator.DataSrcContext(ctx, "datasync")
}
ctx = kvs.WithResync(ctx, kvs.FullResync, true)
ctx = kvs.WithRetryDefault(ctx)
_, err := p.PushData(ctx, kvPairs, nil)
e.Done(err)
case <-p.quit:
return
}
}
}
func (p *Plugin) watchStatus(ch <-chan *kvscheduler.BaseValueStatus) {
defer p.wg.Done()
p.Log.Debugf("watching status changes")
defer p.Log.Debugf("done watching status events")
for {
select {
case s := <-ch:
p.debugf("incoming status change: %15s %v ===> %v (%v) %v",
s.Value.State, s.Value.Details, s.Value.Key, s.Value.LastOperation, s.Value.Error)
for _, dv := range s.DerivedValues {
p.debugf(" \t%15s %v ---> %v (%v) %v",
dv.State, dv.Details, dv.Key, dv.LastOperation, dv.Error)
}
if EnableStatusPublishing {
p.publishStatuses([]Result{
{Key: s.Value.Key, Status: s.Value},
})
}
case <-p.quit:
return
}
}
}
func (p *Plugin) publishStatuses(results []Result) {
if p.StatusPublisher == nil {
return
}
p.debugf("publishing %d statuses", len(results))
for _, res := range results {
statusKey := strings.Replace(res.Key, "config/", "config-status/", 1)
if statusKey == res.Key {
p.debugf("replace for key %q failed", res.Key)
continue
}
if err := p.StatusPublisher.Put(statusKey, res.Status, datasync.WithClientLifetimeTTL()); err != nil {
p.debugf("publishing status for key %q failed: %v", statusKey, err)
}
}
}
func (p *Plugin) debugf(f string, a ...interface{}) {
if debugOrchestrator {
p.log.Debugf(f, a...)
}
}
// UnmarshalLazyValue is helper function for unmarshalling from datasync.LazyValue.
func UnmarshalLazyValue(key string, lazy datasync.LazyValue) (proto.Message, error) {
model, err := models.GetModelForKey(key)
if err != nil {
return nil, err
}
instance := model.NewInstance()
// try to deserialize the value into instance
if err := lazy.GetValue(instance); err != nil {
return nil, err
}
return instance, nil
}
func HasCorrectLabels(want map[string]string, have Labels) bool {
include := make(map[string]string)
exclude := make(map[string]string)
for wk, wl := range want {
if len(wk) > 0 && wk[0] == '!' {
exclude[wk[1:]] = wl
} else {
include[wk] = wl
}
}
for ik, iv := range include {
if hv, ok := have[ik]; !ok || iv != "" && iv != hv {
return false
}
}
for ek, ev := range exclude {
if hv, ok := have[ek]; ok && ev == hv || ok && ev == "" {
return false
}
}
return true
}
func ContainsItemID(want []*generic.Item_ID, have *generic.Item_ID) bool {
if len(want) == 0 {
return true
}
for _, w := range want {
if w.Model == have.Model && w.Name == have.Name {
return true
}
}
return false
}