Option to customize NamespaceTransformer overwrite behaviour #4708

KnVerey · 2022-07-12T23:49:06Z

Resolves #880 (the no. 2 issue by upvotes as of today)
Split out of #4704, which will be rebased on top of this

We can't change the default, since that would be enormously disruptive to our users. Instead, this PR proposes a new option for the transformer to enable it to behave in the desired manner. This option are exposed explicitly via the transformer's configuration resource, which can be used in the transformers field. While using resource-specific annotations to configure transformers is an interesting idea that may be appropriate in some cases, my opinion is that transformer-level is better granularity for these particular options. I also considered a selection-base solution as suggested here, but at that point I think folks should reach for replacements instead, now that they exist.

apiVersion: builtin
kind: NamespaceTransformer
metadata:
  name: notImportantHere
  namespace: test
unsetOnly: true # new
fieldSpecs:
- path: metadata/name
  kind: Namespace
  create: true

k8s-ci-robot · 2022-07-12T23:49:27Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: KnVerey

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

~~OWNERS~~ [KnVerey]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

KnVerey · 2022-07-12T23:59:12Z

@natasha41575 I split this out of #4704 for ease of review, and because the role binding case has less code but more to discuss (i.e. this: #4704 (comment)).

This one is ready for review.

KnVerey · 2022-07-13T00:01:33Z

api/filters/namespace/namespace.go

@@ -19,6 +19,9 @@ type Filter struct {
 	// FsSlice contains the FieldSpecs to locate the namespace field
 	FsSlice types.FsSlice `json:"fieldSpecs,omitempty" yaml:"fieldSpecs,omitempty"`

+	// SkipExisting means only blank namespace fields will be set
+	SkipExisting bool `json:"skipExisting" yaml:"skipExisting"`


Naming suggestions welcome! ( I want it to have negative polarity though, so false when missing give the current default behaviour)

An alternative idea I had was EmptyOnly or BlankOnly - it doesn't reverse the polarity but reverses the wording to focus on the fact that this will only set empty/blank namespace fields. I like this slightly better because it highlights what does get changed, rather than what is skipped.

I'll defer to what you choose though, I think either way is fine.

I like EmptyOnly. Another option could be UnsetOnly, which are more specific to namespace scoped resources. This resource are set to "default" in deployment.

👍 I like UnsetOnly.

natasha41575 · 2022-07-13T23:19:23Z

.golangci.yml

@@ -37,7 +37,7 @@ linters:
    - gocyclo
 #    - godot
 #    - godox
-    - goerr113
+#    - goerr113


I'm glad we're disabling this, it's been slightly annoying to work with

Feel free to question the set of linters I enabled when they really don't align with the style in this codebase and/or value is low. I erred on the side of enabling more of them, without necessarily having a clear picture of the implications.

natasha41575 · 2022-07-13T23:23:41Z

api/filters/filtersutil/setters.go

+		return false
+	}
+	if key == "" {
+		// scalar node


nit: Would it be worth adding a check here that the node is actually a scalar node?

natasha41575 · 2022-07-13T23:25:17Z

api/filters/filtersutil/setters_test.go

+	fn := filtersutil.TrackableSetter{}.SetEntryIfEmpty("foo", "false", yaml.NodeTagBool)
+	rn := yaml.NewListRNode("nope")
+	rn.AppendToFieldPath("dummy", "path")
+	assert.EqualError(t, fn(rn), "wrong Node Kind for dummy.path expected: MappingNode was SequenceNode: value: {- nope}")


This is outside the scope of this PR, but I hope we can improve this error message some day

natasha41575 · 2022-07-13T23:26:07Z

api/filters/nameref/nameref.go

@@ -337,19 +337,16 @@ func (f Filter) selectReferral(
 		return candidates[0], nil
 	}
 	ids := getIds(candidates)
-	f.failureDetails(candidates)
-	return nil, fmt.Errorf(" found multiple possible referrals: %s", ids)
+	return nil, fmt.Errorf(" found multiple possible referrals: %s\n%s", ids, f.failureDetails(candidates))


Why is there an extra space at the beginning of this error?

I dunno... there was before too. Probably just a typo.

natasha41575 · 2022-07-13T23:28:29Z

api/filters/namespace/namespace.go

+	case roleBindingKind, clusterRoleBindingKind:
+		return true
+	default:
+		return false


the switch statement seems a bit overkill for this check, couldn't we simply return gvk.Kind == roleBindingKind || gvk.Kind == clusterRoleBindingKind?

k8s-ci-robot · 2022-07-14T17:50:38Z

@KnVerey: This PR has multiple commits, and the default merge method is: merge.
You can request commits to be squashed using the label: tide/merge-method-squash

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

natasha41575

apart from the lint error, this LGTM

natasha41575 · 2022-07-14T18:45:45Z

api/filters/namespace/namespace.go

-	// SkipExisting means only blank namespace fields will be set
-	SkipExisting bool `json:"skipExisting" yaml:"skipExisting"`
+	// UnsetOnly means only blank namespace fields will be set
+	UnsetOnly bool `json:"UnsetOnly" yaml:"UnsetOnly"`


should be lowercase

UnsetOnly bool `json:"unsetOnly" yaml:"unsetOnly"`

🤦‍♀️

natasha41575 · 2022-07-14T18:54:32Z

/lgtm

Option to customize NamespaceTransformer overwrite behaviour

01f6787

k8s-ci-robot added cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. size/L Denotes a PR that changes 100-499 lines, ignoring generated files. labels Jul 12, 2022

k8s-ci-robot requested review from natasha41575 and yuwenma July 12, 2022 23:49

k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Jul 12, 2022

KnVerey commented Jul 13, 2022

View reviewed changes

natasha41575 reviewed Jul 13, 2022

View reviewed changes

natasha41575 reviewed Jul 14, 2022

View reviewed changes

Code review feedback

de7b103

KnVerey force-pushed the ns_transformer_overwrite_option branch from f2b1438 to de7b103 Compare July 14, 2022 18:52

KnVerey added the tide/merge-method-squash Denotes a PR that should be squashed by tide when it merges. label Jul 14, 2022

k8s-ci-robot assigned natasha41575 Jul 14, 2022

k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Jul 14, 2022

k8s-ci-robot merged commit 0c6e827 into kubernetes-sigs:master Jul 14, 2022

KnVerey deleted the ns_transformer_overwrite_option branch July 14, 2022 19:58

KnVerey mentioned this pull request Jul 29, 2022

Add docs for new advanced NamespaceTransformer config options kubernetes-sigs/cli-experimental#290

Merged

revero-doug mentioned this pull request Nov 21, 2022

Support deploying to multiple kubernetes contexts GoogleContainerTools/skaffold#915

Closed

ybettan mentioned this pull request Mar 27, 2023

Create a validation webhook kubernetes-sigs/kernel-module-management#348

Merged

alpeb mentioned this pull request Apr 24, 2023

Add support for Linkerd 2.13 fluxcd/flagger#1417

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Option to customize NamespaceTransformer overwrite behaviour #4708

Option to customize NamespaceTransformer overwrite behaviour #4708

KnVerey commented Jul 12, 2022 •

edited

k8s-ci-robot commented Jul 12, 2022

KnVerey commented Jul 12, 2022

KnVerey Jul 13, 2022

natasha41575 Jul 13, 2022 •

edited

yuwenma Jul 14, 2022

KnVerey Jul 14, 2022

natasha41575 Jul 13, 2022

KnVerey Jul 14, 2022

natasha41575 Jul 13, 2022

natasha41575 Jul 13, 2022

natasha41575 Jul 13, 2022

KnVerey Jul 14, 2022

natasha41575 Jul 13, 2022

k8s-ci-robot commented Jul 14, 2022

natasha41575 left a comment

natasha41575 Jul 14, 2022

KnVerey Jul 14, 2022

natasha41575 commented Jul 14, 2022

Option to customize NamespaceTransformer overwrite behaviour #4708

Option to customize NamespaceTransformer overwrite behaviour #4708

Conversation

KnVerey commented Jul 12, 2022 • edited

k8s-ci-robot commented Jul 12, 2022

KnVerey commented Jul 12, 2022

Choose a reason for hiding this comment

natasha41575 Jul 13, 2022 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

k8s-ci-robot commented Jul 14, 2022

natasha41575 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

natasha41575 commented Jul 14, 2022

KnVerey commented Jul 12, 2022 •

edited

natasha41575 Jul 13, 2022 •

edited