skip kustomize transformers for paths

[Liujingfang1]

This is a feature request for allowing users to skip paths for transformers.

Kustomize uses a series of transformers to set fields for all resources inside one kustomization directory. Those transformers include

• name prefix transformer
• name suffix transformer
• namespace transformer
• common label transformer
• common annotation transformer

Each of these transformers modifies resource configuration by changing the value of a certain path inside the resource. The paths that a transformer can modify is from a set of configurations. Here are some transformer configurations

namePrefix:
- path: metadata/name

commonLabels:
- path: metadata/labels
  create: true
- path: spec/selector
  create: true
  version: v1
  kind: Service

Kustomize allow users to add extra configurations so that the transformers can perform as expect for non core types. However, if users want to skip a path in certain transformer, they couldn't do that since Kustomize lacks the customization to skip a path.

There have been quite a few requests, which are looking for a feature to skip certain path. Here is the list of those requests.

• Make cluster level kind configurable Make clusterLevelKinds configurable #617
• Do not add namespace to cluster scoped CRDs Do not add namespace to cluster-scoped CRD objects #552
• Skipping nameprefix for some resource kind skipping nameprefix of some resource kinds #519
• Adding labels only to metadata.labels Adding labels only to .metadata.labels #330
• Skip adding labels to certain paths skipping nameprefix of some resource kinds #519
• Unable to disable commonLabels injection using transformer config: Error: conflicting fieldspecs Unable to disable commonLabels injection using transformer config: Error: conflicting fieldspecs #817

[yujunz]

/assign @yujunz

[k8s-ci-robot]

@yujunz: GitHub didn't allow me to assign the following users: yujunz.

Note that only kubernetes-sigs members and repo collaborators can be assigned and that issues/PRs can only have 10 assignees at the same time.
For more information please see the contributor guide

In response to this:

/assign @yujunz

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.

[yujunz]

It seems I can't assign my self for it, @Liujingfang1 😄

[orirawlings]

Does this issue supersede #91? I'm just trying to make sense of the network of linked issues.

[fejta-bot]

Issues go stale after 90d of inactivity.
Mark the issue as fresh with /remove-lifecycle stale.
Stale issues rot after an additional 30d of inactivity and eventually close.

If this issue is safe to close now please do so with /close.

Send feedback to sig-testing, kubernetes/test-infra and/or fejta.
/lifecycle stale

[alenkacz]

@Liujingfang1 is anyone working on this? Would you be interested in community contribution?

[verult]

/remove-lifecycle stale

[jbrette]

@alenkacz @verult @orirawlings @yujunz

Please have a look at:

• KEP: Kustomize FieldSpec skip
• PR: Skip kustomize transformers for paths

[yujunz]

Left some comments in the KEP.

[fejta-bot]

Issues go stale after 90d of inactivity.
Mark the issue as fresh with /remove-lifecycle stale.
Stale issues rot after an additional 30d of inactivity and eventually close.

If this issue is safe to close now please do so with /close.

Send feedback to sig-testing, kubernetes/test-infra and/or fejta.
/lifecycle stale

[fejta-bot]

Stale issues rot after 30d of inactivity.
Mark the issue as fresh with /remove-lifecycle rotten.
Rotten issues close after an additional 30d of inactivity.

If this issue is safe to close now please do so with /close.

Send feedback to sig-testing, kubernetes/test-infra and/or fejta.
/lifecycle rotten

[fejta-bot]

Rotten issues close after 30d of inactivity.
Reopen the issue with /reopen.
Mark the issue as fresh with /remove-lifecycle rotten.

Send feedback to sig-testing, kubernetes/test-infra and/or fejta.
/close

[k8s-ci-robot]

@fejta-bot: Closing this issue.

In response to this:

Rotten issues close after 30d of inactivity.
Reopen the issue with /reopen.
Mark the issue as fresh with /remove-lifecycle rotten.

Send feedback to sig-testing, kubernetes/test-infra and/or fejta.
/close

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.

[micnncim]

/reopen
/remove-lifecycle rotten

Any update? Seems some of parts haven't been implemented yet like:

kustomize/plugin/builtin/prefixsuffixtransformer/PrefixSuffixTransformer.go

Lines 28 to 34 in b2ba82a

	// A Gvk skip list for prefix/suffix modification.
	// hard coded for now - eventually should be part of config.
	var prefixSuffixFieldSpecsToSkip = types.FsSlice{
	{Gvk: resid.Gvk{Kind: "CustomResourceDefinition"}},
	{Gvk: resid.Gvk{Group: "apiregistration.k8s.io", Kind: "APIService"}},
	{Gvk: resid.Gvk{Kind: "Namespace"}},
	}

[k8s-ci-robot]

@micnncim: You can't reopen an issue/PR unless you authored it or you are a collaborator.

In response to this:

/reopen
/remove-lifecycle rotten

Any update? Seems some of parts haven't been implemented yet like

kustomize/plugin/builtin/prefixsuffixtransformer/PrefixSuffixTransformer.go

Lines 28 to 34 in b2ba82a

	// A Gvk skip list for prefix/suffix modification.
	// hard coded for now - eventually should be part of config.
	var prefixSuffixFieldSpecsToSkip = types.FsSlice{
	{Gvk: resid.Gvk{Kind: "CustomResourceDefinition"}},
	{Gvk: resid.Gvk{Group: "apiregistration.k8s.io", Kind: "APIService"}},
	{Gvk: resid.Gvk{Kind: "Namespace"}},
	}

.

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.

[Shell32-Natsu]

@micnncim You can use the explicit way described here to override the fieldSpec for buitlin plugins.

[micnncim]

@Shell32-Natsu I tried it and confirmed it works well as I expected. Thanks!

[mukundjalan]

@Shell32-Natsu the link you provided seems to be broken. Can you please provide reference to the new page for this feature?