forked from tektoncd/pipeline
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
TEP-0135: Introduce coscheduling feature flags
Part of [tektoncd#6740][tektoncd#6740]. [TEP-0135][tep-0135] introduces a feature that allows a cluster operator to ensure that all of a PipelineRun's pods are scheduled to the same node. This commit introduces a new feature flag `coscheduling` which works together with the `disable-affinity-assistant` feature flag to determine the Affinity Assistant behavior. The usage of the new feature flag will be added in the follow-up PRs. The details of the `coscheduling` feature flag can be found in the [Configuration][configuration] section of TEP-0135. The details of the `disable-affinity-assistant` feature flag can be found in the [Upgrade and Migration Strategy][strategy] section of TEP-0135. NOTE: this feature is WIP, please do not use on this feature. /kind feature [tektoncd#6740]: tektoncd#6740 [tep-0135]: https://github.com/tektoncd/community/blob/main/teps/0135-coscheduling-pipelinerun-pods.md [configuration]: https://github.com/tektoncd/community/blob/main/teps/0135-coscheduling-pipelinerun-pods.md#configuration [strategy]: https://github.com/tektoncd/community/blob/main/teps/0135-coscheduling-pipelinerun-pods.md#configuration
- Loading branch information
1 parent
b5c2135
commit 617cc41
Showing
8 changed files
with
251 additions
and
1 deletion.
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
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
23 changes: 23 additions & 0 deletions
23
pkg/apis/config/testdata/feature-flags-invalid-coscheduling-affinity-assistant-comb.yaml
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,23 @@ | ||
|
|
||
| # Copyright 2023 The Tekton 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 | ||
| # | ||
| # https://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. | ||
|
|
||
| apiVersion: v1 | ||
| kind: ConfigMap | ||
| metadata: | ||
| name: feature-flags | ||
| namespace: tekton-pipelines | ||
| data: | ||
| coscheduling: "coschedule-workspaces" | ||
| disable-affinity-assistant: "false" |
22 changes: 22 additions & 0 deletions
22
pkg/apis/config/testdata/feature-flags-invalid-coscheduling.yaml
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,22 @@ | ||
|
|
||
| # Copyright 2023 The Tekton 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 | ||
| # | ||
| # https://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. | ||
|
|
||
| apiVersion: v1 | ||
| kind: ConfigMap | ||
| metadata: | ||
| name: feature-flags | ||
| namespace: tekton-pipelines | ||
| data: | ||
| coscheduling: "invalid" |
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,40 @@ | ||
| /* | ||
| Copyright 2023 The Tekton 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 testing | ||
|
|
||
| import ( | ||
| "context" | ||
| "testing" | ||
|
|
||
| "github.com/tektoncd/pipeline/pkg/apis/config" | ||
| corev1 "k8s.io/api/core/v1" | ||
| metav1 "k8s.io/apimachinery/pkg/apis/meta/v1" | ||
| "knative.dev/pkg/logging" | ||
| ) | ||
|
|
||
| // SetFeatureFlags sets the feature-flags ConfigMap values in an existing context (for use in testing) | ||
| func SetFeatureFlags(ctx context.Context, t *testing.T, data map[string]string) context.Context { | ||
| t.Helper() | ||
| s := config.NewStore(logging.FromContext(ctx).Named("config-store")) | ||
| s.OnConfigChanged(&corev1.ConfigMap{ | ||
| ObjectMeta: metav1.ObjectMeta{ | ||
| Name: config.GetFeatureFlagsConfigName(), | ||
| }, | ||
| Data: data, | ||
| }) | ||
| return s.ToContext(ctx) | ||
| } |
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,40 @@ | ||
| package affinityassistant | ||
|
|
||
| import ( | ||
| "context" | ||
|
|
||
| "github.com/tektoncd/pipeline/pkg/apis/config" | ||
| ) | ||
|
|
||
| type AffinityAssitantBehavior string | ||
|
|
||
| const ( | ||
| AffinityAssistantDisabled = AffinityAssitantBehavior("AffinityAssistantDisabled") | ||
| AffinityAssistantPerWorkspace = AffinityAssitantBehavior("AffinityAssistantPerWorkspace") | ||
| AffinityAssistantPerPipelineRun = AffinityAssitantBehavior("AffinityAssistantPerPipelineRun") | ||
| AffinityAssistantPerPipelineRunWithIsolation = AffinityAssitantBehavior("AffinityAssistantPerPipelineRunWithIsolation") | ||
| ) | ||
|
|
||
| // GetAffinityAssistantBehavior returns an AffinityAssitantBehavior based on the | ||
| // combination of "disable-affinity-assistant" and "coscheduling" feature flags | ||
| // TODO(#6740)(WIP): consume this function in the PipelineRun reconciler to determine Affinity Assistant behavior. | ||
| func GetAffinityAssistantBehavior(ctx context.Context) AffinityAssitantBehavior { | ||
| cfg := config.FromContextOrDefaults(ctx) | ||
|
|
||
| if !cfg.FeatureFlags.DisableAffinityAssistant { | ||
| return AffinityAssistantPerWorkspace | ||
| } | ||
|
|
||
| switch cfg.FeatureFlags.Coscheduling { | ||
| case config.CoscheduleWorkspaces: | ||
| return AffinityAssistantPerWorkspace | ||
| case config.CoschedulePipelineRuns: | ||
| return AffinityAssistantPerPipelineRun | ||
| case config.CoscheduleIsolatePipelineRuns: | ||
| return AffinityAssistantPerPipelineRunWithIsolation | ||
| case config.CoscheduleDisabled: | ||
| return AffinityAssistantDisabled | ||
| } | ||
|
|
||
| return "" | ||
| } |
63 changes: 63 additions & 0 deletions
63
pkg/internal/affinityassistant/affinityassistant_types_test.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,63 @@ | ||
| package affinityassistant | ||
|
|
||
| import ( | ||
| "context" | ||
| "testing" | ||
|
|
||
| "github.com/google/go-cmp/cmp" | ||
| cfgtesting "github.com/tektoncd/pipeline/pkg/apis/config/testing" | ||
| "github.com/tektoncd/pipeline/test/diff" | ||
|
|
||
| "github.com/tektoncd/pipeline/pkg/apis/config" | ||
| ) | ||
|
|
||
| func Test_GetAffinityAssistantBehavior(t *testing.T) { | ||
| tcs := []struct { | ||
| name string | ||
| configMap map[string]string | ||
| expect AffinityAssitantBehavior | ||
| }{{ | ||
| name: "affinity-assistant-enabled", | ||
| configMap: map[string]string{ | ||
| "disable-affinity-assistant": "false", | ||
| }, | ||
| expect: AffinityAssistantPerWorkspace, | ||
| }, { | ||
| name: "affinity-assistant-disabled-coscheduling-workspaces", | ||
| configMap: map[string]string{ | ||
| "disable-affinity-assistant": "true", | ||
| "coscheduling": config.CoscheduleWorkspaces, | ||
| }, | ||
| expect: AffinityAssistantPerWorkspace, | ||
| }, { | ||
| name: "affinity-assistant-disabled-coscheduling-pipelineruns", | ||
| configMap: map[string]string{ | ||
| "disable-affinity-assistant": "true", | ||
| "coscheduling": config.CoschedulePipelineRuns, | ||
| }, | ||
| expect: AffinityAssistantPerPipelineRun, | ||
| }, { | ||
| name: "affinity-assistant-disabled-coscheduling-isolate-pipelineruns", | ||
| configMap: map[string]string{ | ||
| "disable-affinity-assistant": "true", | ||
| "coscheduling": config.CoscheduleIsolatePipelineRuns, | ||
| }, | ||
| expect: AffinityAssistantPerPipelineRunWithIsolation, | ||
| }, { | ||
| name: "affinity-assistant-disabled-coscheduling-disabled", | ||
| configMap: map[string]string{ | ||
| "disable-affinity-assistant": "true", | ||
| "coscheduling": config.CoscheduleDisabled, | ||
| }, | ||
| expect: AffinityAssistantDisabled, | ||
| }} | ||
|
|
||
| for _, tc := range tcs { | ||
| ctx := cfgtesting.SetFeatureFlags(context.Background(), t, tc.configMap) | ||
| get := GetAffinityAssistantBehavior(ctx) | ||
|
|
||
| if d := cmp.Diff(tc.expect, get); d != "" { | ||
| t.Errorf("AffinityAssitantBehavior mismatch: %v", diff.PrintWantGot(d)) | ||
| } | ||
| } | ||
| } |