-
Notifications
You must be signed in to change notification settings - Fork 606
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
refactor: all network merge controllers
They had lots of common (and broken) code, so use generics to implement the core logic once, and use that in all kinds of merge controllers. This removes lots of code duplication. Fixes flaky unit-tests, and also improves controller performance on conflicts. Signed-off-by: Andrey Smirnov <andrey.smirnov@siderolabs.com>
- Loading branch information
Showing
16 changed files
with
328 additions
and
793 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
142 changes: 142 additions & 0 deletions
142
internal/app/machined/pkg/controllers/network/generic_merge.go
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,142 @@ | ||
| // This Source Code Form is subject to the terms of the Mozilla Public | ||
| // License, v. 2.0. If a copy of the MPL was not distributed with this | ||
| // file, You can obtain one at http://mozilla.org/MPL/2.0/. | ||
|
|
||
| package network | ||
|
|
||
| import ( | ||
| "context" | ||
| "fmt" | ||
| "strings" | ||
|
|
||
| "github.com/cosi-project/runtime/pkg/controller" | ||
| "github.com/cosi-project/runtime/pkg/resource" | ||
| "github.com/cosi-project/runtime/pkg/resource/typed" | ||
| "github.com/cosi-project/runtime/pkg/safe" | ||
| "go.uber.org/zap" | ||
| ) | ||
|
|
||
| type genericMergeFunc[T typed.DeepCopyable[T], E typed.Extension, R typed.Resource[T, E]] func(logger *zap.Logger, in safe.List[*R]) map[resource.ID]*T | ||
|
|
||
| // GenericMergeController initializes a generic merge controller for network resources. | ||
| func GenericMergeController[T typed.DeepCopyable[T], E typed.Extension](namespaceIn, namespaceOut resource.Namespace, mergeFunc genericMergeFunc[T, E, typed.Resource[T, E]]) controller.Controller { | ||
| var zeroE E | ||
|
|
||
| controllerName := strings.ReplaceAll(zeroE.ResourceDefinition().Type, "Spec", "MergeController") | ||
|
|
||
| return &genericMergeController[T, E]{ | ||
| controllerName: controllerName, | ||
| resourceType: zeroE.ResourceDefinition().Type, | ||
| namespaceIn: namespaceIn, | ||
| namespaceOut: namespaceOut, | ||
| mergeFunc: mergeFunc, | ||
| } | ||
| } | ||
|
|
||
| type genericMergeController[T typed.DeepCopyable[T], E typed.Extension] struct { | ||
| controllerName string | ||
| resourceType resource.Type | ||
| namespaceIn resource.Namespace | ||
| namespaceOut resource.Namespace | ||
| mergeFunc genericMergeFunc[T, E, typed.Resource[T, E]] | ||
| } | ||
|
|
||
| func (ctrl *genericMergeController[T, E]) Name() string { | ||
| return ctrl.controllerName | ||
| } | ||
|
|
||
| func (ctrl *genericMergeController[T, E]) Inputs() []controller.Input { | ||
| return []controller.Input{ | ||
| { | ||
| Namespace: ctrl.namespaceIn, | ||
| Type: ctrl.resourceType, | ||
| Kind: controller.InputWeak, | ||
| }, | ||
| { | ||
| Namespace: ctrl.namespaceOut, | ||
| Type: ctrl.resourceType, | ||
| Kind: controller.InputDestroyReady, | ||
| }, | ||
| } | ||
| } | ||
|
|
||
| func (ctrl *genericMergeController[T, E]) Outputs() []controller.Output { | ||
| return []controller.Output{ | ||
| { | ||
| Type: ctrl.resourceType, | ||
| Kind: controller.OutputShared, | ||
| }, | ||
| } | ||
| } | ||
|
|
||
| //nolint:gocyclo | ||
| func (ctrl *genericMergeController[T, E]) Run(ctx context.Context, r controller.Runtime, logger *zap.Logger) error { | ||
| for { | ||
| select { | ||
| case <-ctx.Done(): | ||
| return nil | ||
| case <-r.EventCh(): | ||
| } | ||
|
|
||
| type R = typed.Resource[T, E] | ||
|
|
||
| // list source network configuration resources | ||
| in, err := safe.ReaderList[*R](ctx, r, resource.NewMetadata(ctrl.namespaceIn, ctrl.resourceType, "", resource.VersionUndefined)) | ||
| if err != nil { | ||
| return fmt.Errorf("error listing source network resources: %w", err) | ||
| } | ||
|
|
||
| merged := ctrl.mergeFunc(logger, in) | ||
|
|
||
| // cleanup resources, detecting conflicts on the way | ||
| out, err := safe.ReaderList[*R](ctx, r, resource.NewMetadata(ctrl.namespaceOut, ctrl.resourceType, "", resource.VersionUndefined)) | ||
| if err != nil { | ||
| return fmt.Errorf("error listing output resources: %w", err) | ||
| } | ||
|
|
||
| for res := range out.All() { | ||
| shouldBeDestroyed := false | ||
| if _, ok := merged[res.Metadata().ID()]; !ok { | ||
| shouldBeDestroyed = true | ||
| } | ||
|
|
||
| isTearingDown := res.Metadata().Phase() == resource.PhaseTearingDown | ||
|
|
||
| if shouldBeDestroyed || isTearingDown { | ||
| var okToDestroy bool | ||
|
|
||
| okToDestroy, err = r.Teardown(ctx, res.Metadata()) | ||
| if err != nil { | ||
| return fmt.Errorf("error cleaning up addresses: %w", err) | ||
| } | ||
|
|
||
| if okToDestroy { | ||
| if err = r.Destroy(ctx, res.Metadata()); err != nil { | ||
| return fmt.Errorf("error cleaning up addresses: %w", err) | ||
| } | ||
| } else if !shouldBeDestroyed { | ||
| // resource is not ready to be destroyed yet, skip it | ||
| delete(merged, res.Metadata().ID()) | ||
| } | ||
| } | ||
| } | ||
|
|
||
| var zeroT T | ||
|
|
||
| for id, spec := range merged { | ||
| if err = safe.WriterModify(ctx, r, | ||
| typed.NewResource[T, E](resource.NewMetadata(ctrl.namespaceOut, ctrl.resourceType, id, resource.VersionUndefined), zeroT), | ||
| func(r *R) error { | ||
| *r.TypedSpec() = *spec | ||
|
|
||
| return nil | ||
| }); err != nil { | ||
| return fmt.Errorf("error updating resource: %w", err) | ||
| } | ||
|
|
||
| logger.Debug("merged spec", zap.String("id", id), zap.Any("spec", spec)) | ||
| } | ||
|
|
||
| r.ResetRestartBackoff() | ||
| } | ||
| } |
Oops, something went wrong.