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 425 426 427
|
package diff
import (
"net/http"
"sync"
"sync/atomic"
"time"
"github.com/cenkalti/backoff/v4"
"github.com/kong/deck/crud"
"github.com/kong/deck/state"
"github.com/kong/go-kong/kong"
"github.com/pkg/errors"
)
var (
errEnqueueFailed = errors.New("failed to queue event")
)
func defaultBackOff() backoff.BackOff {
// For various reasons, Kong can temporarily fail to process
// a valid request (e.g. when the database is under heavy load).
// We retry each request up to 3 times on failure, after around
// 1 second, 3 seconds, and 9 seconds (randomized exponential backoff).
exponentialBackoff := backoff.NewExponentialBackOff()
exponentialBackoff.InitialInterval = 1 * time.Second
exponentialBackoff.Multiplier = 3
return backoff.WithMaxRetries(exponentialBackoff, 4)
}
// TODO get rid of the syncer struct and simply have a func for it
// Syncer takes in a current and target state of Kong,
// diffs them, generating a Graph to get Kong from current
// to target state.
type Syncer struct {
currentState *state.KongState
targetState *state.KongState
postProcess crud.Registry
eventChan chan Event
errChan chan error
stopChan chan struct{}
inFlightOps int32
SilenceWarnings bool
StageDelaySec int
once sync.Once
}
// NewSyncer constructs a Syncer.
func NewSyncer(current, target *state.KongState) (*Syncer, error) {
s := &Syncer{}
s.currentState, s.targetState = current, target
s.postProcess.MustRegister("service", &servicePostAction{current})
s.postProcess.MustRegister("route", &routePostAction{current})
s.postProcess.MustRegister("upstream", &upstreamPostAction{current})
s.postProcess.MustRegister("target", &targetPostAction{current})
s.postProcess.MustRegister("certificate", &certificatePostAction{current})
s.postProcess.MustRegister("sni", &sniPostAction{current})
s.postProcess.MustRegister("ca_certificate", &caCertificatePostAction{current})
s.postProcess.MustRegister("plugin", &pluginPostAction{current})
s.postProcess.MustRegister("consumer", &consumerPostAction{current})
s.postProcess.MustRegister("key-auth", &keyAuthPostAction{current})
s.postProcess.MustRegister("hmac-auth", &hmacAuthPostAction{current})
s.postProcess.MustRegister("jwt-auth", &jwtAuthPostAction{current})
s.postProcess.MustRegister("basic-auth", &basicAuthPostAction{current})
s.postProcess.MustRegister("acl-group", &aclGroupPostAction{current})
s.postProcess.MustRegister("oauth2-cred", &oauth2CredPostAction{current})
s.postProcess.MustRegister("mtls-auth", &mtlsAuthPostAction{current})
return s, nil
}
func (sc *Syncer) diff() error {
var err error
err = sc.createUpdate()
if err != nil {
return err
}
err = sc.delete()
if err != nil {
return err
}
return nil
}
func (sc *Syncer) delete() error {
var err error
err = sc.deletePlugins()
if err != nil {
return err
}
err = sc.deleteKeyAuths()
if err != nil {
return err
}
err = sc.deleteHMACAuths()
if err != nil {
return err
}
err = sc.deleteJWTAuths()
if err != nil {
return err
}
err = sc.deleteBasicAuths()
if err != nil {
return err
}
err = sc.deleteOauth2Creds()
if err != nil {
return err
}
err = sc.deleteACLGroups()
if err != nil {
return err
}
err = sc.deleteMTLSAuths()
if err != nil {
return err
}
err = sc.deleteTargets()
if err != nil {
return err
}
err = sc.deleteSNIs()
if err != nil {
return err
}
// barrier for foreign relations
// plugins must be deleted before services, routes and consumers
// routes must be deleted before service can be deleted
// credentials must be deleted before consumers
// targets must be deleted before upstream
// PLEASE NOTE that if the order is not preserved, then decK will error
// out because deleting a child entity whose parent is already deleted
// will return a 404
sc.wait()
err = sc.deleteRoutes()
if err != nil {
return err
}
err = sc.deleteConsumers()
if err != nil {
return err
}
err = sc.deleteUpstreams()
if err != nil {
return err
}
// barrier for foreign relations
// routes must be deleted before services
sc.wait()
err = sc.deleteServices()
if err != nil {
return err
}
// barrier for foreign relations
// services must be deleted before certificates (client_certificate)
sc.wait()
err = sc.deleteCertificates()
if err != nil {
return err
}
// services must be deleted before ca_certificates
err = sc.deleteCACertificates()
if err != nil {
return err
}
// finish delete before returning
sc.wait()
return nil
}
func (sc *Syncer) createUpdate() error {
// TODO write an interface and register by types,
// then execute in a particular order
err := sc.createUpdateCertificates()
if err != nil {
return err
}
err = sc.createUpdateCACertificates()
if err != nil {
return err
}
err = sc.createUpdateConsumers()
if err != nil {
return err
}
err = sc.createUpdateUpstreams()
if err != nil {
return err
}
// barrier for foreign relations
// upstreams must be created before targets
// certificates must be created before SNIs
// consumers must be created before creds of all kinds
// certificates must be created before services (client_certificate)
sc.wait()
err = sc.createUpdateTargets()
if err != nil {
return err
}
err = sc.createUpdateSNIs()
if err != nil {
return err
}
err = sc.createUpdateServices()
if err != nil {
return err
}
err = sc.createUpdateKeyAuths()
if err != nil {
return err
}
err = sc.createUpdateHMACAuths()
if err != nil {
return err
}
err = sc.createUpdateJWTAuths()
if err != nil {
return err
}
err = sc.createUpdateBasicAuths()
if err != nil {
return err
}
err = sc.createUpdateOauth2Creds()
if err != nil {
return err
}
err = sc.createUpdateACLGroups()
if err != nil {
return err
}
err = sc.createUpdateMTLSAuths()
if err != nil {
return err
}
// barrier for foreign relations
// services must be created before routes
sc.wait()
err = sc.createUpdateRoutes()
if err != nil {
return err
}
// barrier for foreign relations
// services, routes and consumers must be created before plugins
sc.wait()
err = sc.createUpdatePlugins()
if err != nil {
return err
}
// finish createUpdate before returning
sc.wait()
return nil
}
func (sc *Syncer) queueEvent(e Event) error {
atomic.AddInt32(&sc.inFlightOps, 1)
select {
case sc.eventChan <- e:
return nil
case <-sc.stopChan:
atomic.AddInt32(&sc.inFlightOps, -1)
return errEnqueueFailed
}
}
func (sc *Syncer) eventCompleted() {
atomic.AddInt32(&sc.inFlightOps, -1)
}
func (sc *Syncer) wait() {
time.Sleep(time.Duration(sc.StageDelaySec) * time.Second)
for atomic.LoadInt32(&sc.inFlightOps) != 0 {
select {
case <-sc.stopChan:
return
default:
time.Sleep(1 * time.Millisecond)
}
}
}
// Run starts a diff and invokes d for every diff.
func (sc *Syncer) Run(done <-chan struct{}, parallelism int, d Do) []error {
if parallelism < 1 {
return append([]error{}, errors.New("parallelism can not be negative"))
}
var wg sync.WaitGroup
const eventBuffer = 10
sc.eventChan = make(chan Event, eventBuffer)
sc.stopChan = make(chan struct{})
sc.errChan = make(chan error)
// run rabbit run
// start the consumers
wg.Add(parallelism)
for i := 0; i < parallelism; i++ {
go func() {
err := sc.eventLoop(d)
if err != nil {
sc.errChan <- err
}
wg.Done()
}()
}
// start the producer
wg.Add(1)
go func() {
err := sc.diff()
if err != nil {
sc.errChan <- err
}
close(sc.eventChan)
wg.Done()
}()
// close the error chan once all done
go func() {
wg.Wait()
close(sc.errChan)
}()
var errs []error
select {
case <-done:
case err, ok := <-sc.errChan:
if ok && err != nil {
if err != errEnqueueFailed {
errs = append(errs, err)
}
}
}
// stop the producer
close(sc.stopChan)
// collect errors
for err := range sc.errChan {
if err != errEnqueueFailed {
errs = append(errs, err)
}
}
return errs
}
// Do is the worker function to sync the diff
// TODO remove crud.Arg
type Do func(a Event) (crud.Arg, error)
func (sc *Syncer) eventLoop(d Do) error {
for event := range sc.eventChan {
// Stop if program is terminated
select {
case <-sc.stopChan:
return nil
default:
}
err := sc.handleEvent(d, event)
sc.eventCompleted()
if err != nil {
return err
}
}
return nil
}
func (sc *Syncer) handleEvent(d Do, event Event) error {
err := backoff.Retry(func() error {
res, err := d(event)
if err != nil {
err = errors.Wrapf(err, "while processing event")
var kongAPIError *kong.APIError
if errors.As(err, &kongAPIError) &&
kongAPIError.Code() == http.StatusInternalServerError {
// Only retry if the request to Kong returned a 500 status code
return err
}
// Do not retry on other status codes
return backoff.Permanent(err)
}
if res == nil {
// Do not retry empty responses
return backoff.Permanent(errors.New("result of event is nil"))
}
_, err = sc.postProcess.Do(event.Kind, event.Op, res)
if err != nil {
// Do not retry program errors
return backoff.Permanent(errors.Wrap(err, "while post processing event"))
}
return nil
}, defaultBackOff())
return err
}
|