Add labels to volumeClaimTemplates in StatefulSets if includeVolumeClaimTemplates is true

[aibarbetta]

Fixes #5389

[k8s-ci-robot]

Hi @aibarbetta. Thanks for your PR.

I'm waiting for a kubernetes-sigs member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

Details

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-sigs/prow repository.

[aibarbetta]

/assign @KnVerey @koba1t
Hi folks, you reviewed this PR in the past. We've discovered that includeTemplates modifies immutable volumeClaimTemplates in StatefulSets (#5389). This is an attempt to decouple label insertion in volumeClaimTemplates to achieve labeling in metadata and templates without preventing updates. Can you take a look and give me your thoughts? Thanks!

[erikgb]

/ok-to-test

[aibarbetta]

/test all

[k8s-triage-robot]

The Kubernetes project currently lacks enough contributors to adequately respond to all PRs.

This bot triages PRs according to the following rules:

• After 90d of inactivity, lifecycle/stale is applied
• After 30d of inactivity since lifecycle/stale was applied, lifecycle/rotten is applied
• After 30d of inactivity since lifecycle/rotten was applied, the PR is closed

You can:

• Mark this PR as fresh with /remove-lifecycle stale
• Close this PR with /close
• Offer to help out with Issue Triage

Please send feedback to sig-contributor-experience at kubernetes/community.

/lifecycle stale

[aibarbetta]

/remove-lifecycle stale

[k8s-triage-robot]

The Kubernetes project currently lacks enough contributors to adequately respond to all PRs.

This bot triages PRs according to the following rules:

• After 90d of inactivity, lifecycle/stale is applied
• After 30d of inactivity since lifecycle/stale was applied, lifecycle/rotten is applied
• After 30d of inactivity since lifecycle/rotten was applied, the PR is closed

You can:

• Mark this PR as fresh with /remove-lifecycle stale
• Close this PR with /close
• Offer to help out with Issue Triage

Please send feedback to sig-contributor-experience at kubernetes/community.

/lifecycle stale

[koba1t]

@aibarbetta

Sorry to delay review. I think this PR almost looks like good!

So, I care about a senario of includeTemplates==false && in includeVolumeClaimTemplates==true case, Could you add testcases that cover below case?

And, Please prepare a PR that update documents of official site!
https://github.com/kubernetes-sigs/cli-experimental

[aibarbetta]

@aibarbetta

Sorry to delay review. I think this PR almost looks like good!

So, I care about a senario of includeTemplates==false && in includeVolumeClaimTemplates==true case, Could you add testcases that cover below case?

And, Please prepare a PR that update documents of official site! https://github.com/kubernetes-sigs/cli-experimental

Hi @koba1t, sure, thanks for getting back to me. I’m tied up with some v1.34 work, but I’ll work on this soon.

[k8s-triage-robot]

The Kubernetes project currently lacks enough active contributors to adequately respond to all PRs.

This bot triages PRs according to the following rules:

• After 90d of inactivity, lifecycle/stale is applied
• After 30d of inactivity since lifecycle/stale was applied, lifecycle/rotten is applied
• After 30d of inactivity since lifecycle/rotten was applied, the PR is closed

You can:

• Mark this PR as fresh with /remove-lifecycle rotten
• Close this PR with /close
• Offer to help out with Issue Triage

Please send feedback to sig-contributor-experience at kubernetes/community.

/lifecycle rotten

[k8s-triage-robot]

The Kubernetes project currently lacks enough active contributors to adequately respond to all issues and PRs.

This bot triages PRs according to the following rules:

• After 90d of inactivity, lifecycle/stale is applied
• After 30d of inactivity since lifecycle/stale was applied, lifecycle/rotten is applied
• After 30d of inactivity since lifecycle/rotten was applied, the PR is closed

You can:

• Reopen this PR with /reopen
• Mark this PR as fresh with /remove-lifecycle rotten
• Offer to help out with Issue Triage

Please send feedback to sig-contributor-experience at kubernetes/community.

/close

[k8s-ci-robot]

@k8s-triage-robot: Closed this PR.

Details

In response to this:

The Kubernetes project currently lacks enough active contributors to adequately respond to all issues and PRs.

This bot triages PRs according to the following rules:

• After 90d of inactivity, lifecycle/stale is applied
• After 30d of inactivity since lifecycle/stale was applied, lifecycle/rotten is applied
• After 30d of inactivity since lifecycle/rotten was applied, the PR is closed

You can:

• Reopen this PR with /reopen
• Mark this PR as fresh with /remove-lifecycle rotten
• Offer to help out with Issue Triage

Please send feedback to sig-contributor-experience at kubernetes/community.

/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-sigs/prow repository.

[aibarbetta]

/reopen

[k8s-ci-robot]

@aibarbetta: Reopened this PR.

Details

In response to this:

/reopen

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-sigs/prow repository.

[k8s-ci-robot]

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

Details

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-sigs/prow repository.

[aibarbetta]

/remove-lifecycle rotten
/label tide/merge-method-squash

[aibarbetta]

@aibarbetta

Sorry to delay review. I think this PR almost looks like good!

So, I care about a senario of includeTemplates==false && in includeVolumeClaimTemplates==true case, Could you add testcases that cover below case?

And, Please prepare a PR that update documents of official site! https://github.com/kubernetes-sigs/cli-experimental

Hi @koba1t, this is ready to review, let me know your thoughts 🙏🏻. The docs update is kubernetes-sigs/cli-experimental#426

[joar]

I found this PR via #5389, I tried to work around this issue by trying to override fieldSpecs in a bunch of different ways, but it always tried to merge instead of override.

The only way that worked for me was to create a custom LabelTransformer with the desired fieldspecs, excluding volumeClaimTemplate, which is a bit excessive:

kustomization.yaml

# …
transformers:
  - labelsNoVolumeClaimTemplate.yaml

labelsNoVolumeClaimTemplate.yaml

apiVersion: builtin
kind: LabelTransformer
metadata:
  name: labelsNoVolumeClaimTemplate

labels:
  env: test
  version: beefcafe

fieldSpecs:
  # 1. Copy from https://github.com/kubernetes-sigs/kustomize/blob/master/api/internal/konfig/builtinpluginconsts/metadatalabels.go
  # 2. Remove volumeClaimTemplate.
  - path: metadata/labels
    create: true

  - path: spec/template/metadata/labels
    create: true
    version: v1
    kind: ReplicationController

  - path: spec/template/metadata/labels
    create: true
    kind: Deployment

  - path: spec/template/metadata/labels
    create: true
    kind: ReplicaSet

  - path: spec/template/metadata/labels
    create: true
    kind: DaemonSet

  - path: spec/template/metadata/labels
    create: true
    group: apps
    kind: StatefulSet

  - path: spec/template/metadata/labels
    create: true
    group: batch
    kind: Job

  - path: spec/jobTemplate/metadata/labels
    create: true
    group: batch
    kind: CronJob

  - path: spec/jobTemplate/spec/template/metadata/labels
    create: true
    group: batch
    kind: CronJob

Looking forward to get this PR merged ❤️

[koba1t]

/lgtm
/approve

[k8s-ci-robot]

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: aibarbetta, koba1t

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

The pull request process is described here

Details

Needs approval from an approver in each of these files:

• OWNERS [koba1t]

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