-
Notifications
You must be signed in to change notification settings - Fork 306
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Define the interface for NEG dual stack migration handler
- Loading branch information
1 parent
6216d71
commit bca6ee4
Showing
4 changed files
with
233 additions
and
21 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,120 @@ | ||
| /* | ||
| Copyright 2023 The Kubernetes Authors. | ||
| 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 dualstack | ||
|
|
||
| import ( | ||
| "time" | ||
|
|
||
| "k8s.io/ingress-gce/pkg/neg/types" | ||
| ) | ||
|
|
||
| const ( | ||
| defaultMigrationWaitDuration = 1 * time.Minute | ||
| ) | ||
|
|
||
| // Migrator exposes functions to control the migration of single-stack | ||
| // NEG endpoints to dual-stack NEG endpoints (and vice versa) | ||
| // | ||
| // # Single-stack vs Dual-stack | ||
| // | ||
| // - A NEG endpoint is said to be single-stack if it just has an IPv4 or IPv6 | ||
| // address (but not both.) | ||
| // | ||
| // - A NEG endpoint is said to be dual-stack if it has both IPv4 and IPv6 | ||
| // address. | ||
| // | ||
| // # Migration endpoint | ||
| // | ||
| // An endpoint is said to be a migration-endpoint if its current state is | ||
| // single-stack but desired state is dual-stack (and vice versa.) | ||
| // | ||
| // TODO(gauravkghildiyal): Add details about the heuristics as we go on | ||
| // implementing. | ||
| type Migrator struct { | ||
| // Setting this to false will make all exported functions a no-op. | ||
| enableDualStack bool | ||
| } | ||
|
|
||
| func NewMigrator(enableDualStack bool) *Migrator { | ||
| return &Migrator{enableDualStack: enableDualStack} | ||
| } | ||
|
|
||
| // Filter will modify the `addEndpoints` and `removeEndpoints` in TWO DISTINCT | ||
| // ways: | ||
| // 1. Remove all migration-endpoints, irrespective of whether the migrator is | ||
| // paused or not. | ||
| // 2. If the migrator is not currently paused, it will also start the | ||
| // detachment of a subset of migration-endpoints from a single zone. | ||
| // | ||
| // The returned string represents the zone for which detachment was started. An | ||
| // empty return value signifies that detachment was not started (which is the | ||
| // case when there were no migration-endpoints to begin with, or the migrator | ||
| // was paused.) | ||
| // | ||
| // Refer the comment on [Migrator] for further details and | ||
| // terminologies. | ||
| func (d *Migrator) Filter(addEndpoints, removeEndpoints, committedEndpoints map[string]types.NetworkEndpointSet) string { | ||
| if !d.enableDualStack { | ||
| return "" | ||
| } | ||
|
|
||
| _, migrationEndpointsInRemoveSet := findAndFilterMigrationEndpoints(addEndpoints, removeEndpoints) | ||
|
|
||
| // TODO(gauravkghildiyal): Implement rate limited migration-detachment. | ||
| for zone, endpointSet := range migrationEndpointsInRemoveSet { | ||
| if endpointSet.Len() != 0 { | ||
| removeEndpoints[zone] = removeEndpoints[zone].Union(endpointSet) | ||
| return zone | ||
| } | ||
| } | ||
|
|
||
| return "" | ||
| } | ||
|
|
||
| // Pause will prevent any subsequent Filter() invocations from starting | ||
| // detachment of migration-endpoints. Pause should be invoked before starting | ||
| // any NEG-endpoint detach operations that include migration-endpoints. | ||
| // | ||
| // Invoking Pause on a migrator which is already paused will be a no-op. | ||
| // | ||
| // Pause is usually paired with a Continue() invocation once the NEG-endpoint | ||
| // detach operation completes. | ||
| func (d *Migrator) Pause() { | ||
| if !d.enableDualStack { | ||
| return | ||
| } | ||
| } | ||
|
|
||
| // Continue will unpause the migration. It expects an error as input which | ||
| // specifies the result of the NEG-endpoint detach operation. Depending on | ||
| // whether the detach operation passed or failed, the effect of unpause could be | ||
| // delayed: | ||
| // - If the NEG detach operation failed, the migration will be unpaused | ||
| // immediately before Continue returns. This would allow any resyncs to | ||
| // reattempt the migration. The migrator itself doesn't trigger any sync in | ||
| // this case. | ||
| // - If the NEG detach operation succeeded, a migrationWaitDuration timer will | ||
| // be started, which upon completion will unpause the migration and also | ||
| // trigger another sync. Continue will not keep the caller blocked for the | ||
| // completion of the timer. If Continue is invoked multiple times, only the | ||
| // first continue will trigger a resync. | ||
| func (d *Migrator) Continue(err error) { | ||
| if !d.enableDualStack { | ||
| return | ||
| } | ||
| } | ||
|
|
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,86 @@ | ||
| package dualstack | ||
|
|
||
| import ( | ||
| "testing" | ||
|
|
||
| "github.com/google/go-cmp/cmp" | ||
| "k8s.io/ingress-gce/pkg/neg/types" | ||
| ) | ||
|
|
||
| func TestFilter(t *testing.T) { | ||
| testCases := []struct { | ||
| desc string | ||
| migrator *Migrator | ||
| addEndpoints map[string]types.NetworkEndpointSet | ||
| removeEndpoints map[string]types.NetworkEndpointSet | ||
| committedEndpoints map[string]types.NetworkEndpointSet | ||
| wantAddEndpoints map[string]types.NetworkEndpointSet | ||
| wantRemoveEndpoints map[string]types.NetworkEndpointSet | ||
| wantMigrationZone bool | ||
| }{ | ||
| { | ||
| desc: "migrator should do nothing if enableDualStack is false", | ||
| migrator: &Migrator{enableDualStack: false}, | ||
| addEndpoints: map[string]types.NetworkEndpointSet{ | ||
| "zone1": types.NewNetworkEndpointSet([]types.NetworkEndpoint{ | ||
| {IP: "a", IPv6: "A"}, // migrating | ||
| {IP: "b"}, | ||
| }...), | ||
| }, | ||
| removeEndpoints: map[string]types.NetworkEndpointSet{ | ||
| "zone1": types.NewNetworkEndpointSet([]types.NetworkEndpoint{ | ||
| {IP: "a"}, // migrating | ||
| {IP: "c", IPv6: "C"}, | ||
| }...), | ||
| }, | ||
| committedEndpoints: map[string]types.NetworkEndpointSet{ | ||
| "zone1": types.NewNetworkEndpointSet([]types.NetworkEndpoint{ | ||
| {IPv6: "D"}, | ||
| }...), | ||
| }, | ||
| wantAddEndpoints: map[string]types.NetworkEndpointSet{ | ||
| "zone1": types.NewNetworkEndpointSet([]types.NetworkEndpoint{ | ||
| {IP: "a", IPv6: "A"}, // migrating | ||
| {IP: "b"}, | ||
| }...), | ||
| }, | ||
| wantRemoveEndpoints: map[string]types.NetworkEndpointSet{ | ||
| "zone1": types.NewNetworkEndpointSet([]types.NetworkEndpoint{ | ||
| {IP: "a"}, // migrating | ||
| {IP: "c", IPv6: "C"}, | ||
| }...), | ||
| }, | ||
| }, | ||
| } | ||
|
|
||
| for _, tc := range testCases { | ||
| t.Run(tc.desc, func(t *testing.T) { | ||
| gotAddEndpoints := cloneZoneNetworkEndpointsMap(tc.addEndpoints) | ||
| gotRemoveEndpoints := cloneZoneNetworkEndpointsMap(tc.removeEndpoints) | ||
| gotCommittedEndpoints := cloneZoneNetworkEndpointsMap(tc.committedEndpoints) | ||
| gotMigrationZone := tc.migrator.Filter(gotAddEndpoints, gotRemoveEndpoints, gotCommittedEndpoints) | ||
|
|
||
| if tc.wantMigrationZone && gotMigrationZone == "" { | ||
| t.Errorf("Filter() returned empty migrationZone; want non empty migrationZone") | ||
| } | ||
|
|
||
| if diff := cmp.Diff(tc.wantAddEndpoints, gotAddEndpoints); diff != "" { | ||
| t.Errorf("Filter() returned unexpected diff in addEndpoints (-want +got):\n%s", diff) | ||
| } | ||
| if diff := cmp.Diff(tc.wantRemoveEndpoints, gotRemoveEndpoints); diff != "" { | ||
| t.Errorf("Filter() returned unexpected diff in removeEndpoints (-want +got):\n%s", diff) | ||
| } | ||
| if diff := cmp.Diff(tc.committedEndpoints, gotCommittedEndpoints); diff != "" { | ||
| t.Errorf("Filter() returned unexpected diff in committedEndpoints; want no diff; (-want +got):\n%s", diff) | ||
| } | ||
| }) | ||
| } | ||
| } | ||
|
|
||
| func cloneZoneNetworkEndpointsMap(m map[string]types.NetworkEndpointSet) map[string]types.NetworkEndpointSet { | ||
| clone := make(map[string]types.NetworkEndpointSet) | ||
| for zone, endpointSet := range m { | ||
| clone[zone] = types.NewNetworkEndpointSet(endpointSet.List()...) | ||
| } | ||
| return clone | ||
| } |
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