Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Deprecate unusable Step/StepTemplate fields #4851

Merged
merged 1 commit into from
May 10, 2022

Conversation

lbernick
Copy link
Member

@lbernick lbernick commented May 9, 2022

Changes

Some fields of Step and StepTemplate only exist because they were inherited from
k8s Container, but they don't make sense in a batch workflow context and/or aren't
actually supported in Tekton. No changes to Sidecar.

This commit deprecates the following fields:

  • Lifecycle, Ports, ReadinessProbe, LivenessProbe, StartupProbe, StdIn, StdInOnce, TTY:
    these don't really have a use in the context of Step
  • TerminationMessagePath and TerminationMessagePolicy: these are extra confusing since Results are
    currently written as TerminationMessages
  • StepTemplate.Name: Steps must have different names.

/kind cleanup

Submitter Checklist

As the author of this PR, please check off the items in this checklist:

  • Docs included if any changes are user facing
  • n/a Tests included if any functionality added or changed
  • Follows the commit message standard
  • Meets the Tekton contributor standards (including
    functionality, content, code)
  • Release notes block below has been filled in
    (if there are no user facing changes, use release note "NONE")

Release Notes

Deprecate unusable/unsupported fields of Step and StepTemplate

Closes #4737

@tekton-robot tekton-robot added release-note Denotes a PR that will be considered when it comes time to generate release notes. kind/cleanup Categorizes issue or PR as related to cleaning up code, process, or technical debt. size/M Denotes a PR that changes 30-99 lines, ignoring generated files. labels May 9, 2022
@tekton-robot tekton-robot requested review from jerop and vdemeester May 9, 2022 19:48
@lbernick
Copy link
Member Author

lbernick commented May 9, 2022

/assign @vdemeester @imjasonh

@imjasonh
Copy link
Member

imjasonh commented May 9, 2022

/lgtm

@tekton-robot tekton-robot added the lgtm Indicates that a PR is ready to be merged. label May 9, 2022
Some fields of Step and StepTemplate only exist because they were inherited from
k8s Container, but they don't make sense in a batch workflow context and/or aren't
actually supported in Tekton. No changes to Sidecar.

This commit deprecates the following fields:
- Lifecycle, Ports, ReadinessProbe, LivenessProbe, StartupProbe, StdIn, StdInOnce, TTY:
these don't really have a use in the context of Step or StepTemplate
- TerminationMessagePath and TerminationMessagePolicy: these are extra confusing since Results are
currently written as TerminationMessages
- StepTemplate.Name: Steps must have different names.
@tekton-robot tekton-robot added size/L Denotes a PR that changes 100-499 lines, ignoring generated files. and removed lgtm Indicates that a PR is ready to be merged. size/M Denotes a PR that changes 30-99 lines, ignoring generated files. labels May 9, 2022
@imjasonh
Copy link
Member

imjasonh commented May 9, 2022

/lgtm

@tekton-robot tekton-robot added the lgtm Indicates that a PR is ready to be merged. label May 9, 2022
@lbernick
Copy link
Member Author

/test pull-tekton-pipeline-integration-tests
/test pull-tekton-pipeline-alpha-integration-tests

@abayer
Copy link
Contributor

abayer commented May 10, 2022

/lgtm

@imjasonh
Copy link
Member

/approve

@tekton-robot
Copy link
Collaborator

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: imjasonh

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:

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

@tekton-robot tekton-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label May 10, 2022
@tekton-robot tekton-robot merged commit 7224f90 into tektoncd:main May 10, 2022
@vdemeester
Copy link
Member

I am late to the party but 2 things:

@lbernick
Copy link
Member Author

Not sure what you mean by this; are you suggesting renaming the struct types? They are owned by k8s. Or are you suggesting renaming the field names but keeping the json tags the same so that serialization/deserialization does not change?

  • Do we want to add an entry to the deprecation file to give a timeframe on when they will be removed ?

I'm actually not sure what an appropriate timeline is here. Our compatibility policy says 9 months but it seems silly to wait 9 months to remove fields that aren't even currently usable.

@vdemeester
Copy link
Member

vdemeester commented May 12, 2022

Or are you suggesting renaming the field names but keeping the json tags the same so that serialization/deserialization does not change?

Yes, this is what I am suggesting 👼🏼

I'm actually not sure what an appropriate timeline is here. Our compatibility policy says 9 months but it seems silly to wait 9 months to remove fields that aren't even currently usable.

I tend to agree with that, but I don't really think we have a alternative. At least, we need to communicate what is the time schedule for those to be removed.

@lbernick
Copy link
Member Author

Or are you suggesting renaming the field names but keeping the json tags the same so that serialization/deserialization does not change?

Yes, this is what I am suggesting 👼🏼

I'm actually not sure what an appropriate timeline is here. Our compatibility policy says 9 months but it seems silly to wait 9 months to remove fields that aren't even currently usable.

I tend to agree with that, but I don't really think we have a alternative. At least, we need to communicate what is the time schedule for those to be removed.

done in #4866

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. kind/cleanup Categorizes issue or PR as related to cleaning up code, process, or technical debt. lgtm Indicates that a PR is ready to be merged. release-note Denotes a PR that will be considered when it comes time to generate release notes. size/L Denotes a PR that changes 100-499 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Owning our *Container* spec
5 participants