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.

Sign up for GitHub

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

Jump to bottom

Fix validations for Sidecars to be consistent #7443

Merged
merged 1 commit into from
Nov 30, 2023
Merged

Fix validations for Sidecars to be consistent #7443

merged 1 commit into from
Nov 30, 2023

Conversation

JeromeJu
Copy link
Member

@JeromeJu JeromeJu commented Nov 30, 2023 •
edited
Loading

Changes

This commit fixes the inconsistent validations for Sidecars by adding webhook validations. It previously only validate Sidecar at runtime instead of what's validated for Step at webhook.

It also deletes the docString showing stepTemplate.image and sidecar.image are optional. BUT the labels of these two fields are kept for backwards compatibility purposes.

/kind bug
fixes: #7437

Submitter Checklist

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

  • Has Docs if any changes are user facing, including updates to minimum requirements e.g. Kubernetes version bumps
  • Has Tests included if any functionality added or changed
  • Follows the commit message standard
  • Meets the Tekton contributor standards (including functionality, content, code)
  • Has a kind label. You can add one by adding a comment on this PR that contains /kind <type>. Valid types are bug, cleanup, design, documentation, feature, flake, misc, question, tep
  • Release notes block below has been updated with any user facing changes (API changes, bug fixes, changes requiring upgrade notices or deprecation warnings). See some examples of good release notes.
  • Release notes contains the string "action required" if the change requires additional action from users switching to the new release

Release Notes

sidecars are now validated at admission webhook

@tekton-robot tekton-robot added release-note-none Denotes a PR that doesnt merit a release note. kind/bug Categorizes issue or PR as related to a bug. labels Nov 30, 2023
@tekton-robot tekton-robot added size/M Denotes a PR that changes 30-99 lines, ignoring generated files. release-note Denotes a PR that will be considered when it comes time to generate release notes. and removed release-note-none Denotes a PR that doesnt merit a release note. labels Nov 30, 2023
@dibyom
Copy link
Member

dibyom commented Nov 30, 2023

instead of during runtime

the Validate method can be called from the reconciler as well as the webhook, so I'd just remove this bit from the release note

@tekton-robot
Copy link
Collaborator

The following is the coverage report on the affected files.
Say /test pull-tekton-pipeline-go-coverage to re-run this coverage report

File Old Coverage New Coverage Delta
pkg/apis/pipeline/v1/task_validation.go 98.4% 98.4% 0.0

@tekton-robot
Copy link
Collaborator

The following is the coverage report on the affected files.
Say /test pull-tekton-pipeline-go-coverage-df to re-run this coverage report

File Old Coverage New Coverage Delta
pkg/apis/pipeline/v1/task_validation.go 98.4% 98.4% 0.0

@JeromeJu JeromeJu marked this pull request as draft November 30, 2023 18:38
@tekton-robot tekton-robot added the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Nov 30, 2023
@JeromeJu
Fix validations for Sidecars to be consistent
b97fd65 
This commit fixes the inconsistent validations for Sidecars by adding
webhook validations. It previously only validate Sidecar at runtime
instead of what's validated for Step at webhook.

It also deletes the docString showing  and
 are optional. BUT the labels of these two fields are
kept for backwards compatibility purposes.

/kind bug
fixes: tektoncd#7437
@JeromeJu JeromeJu force-pushed the 7437-sidecar-validation branch from 22e5f97 to b97fd65 Compare November 30, 2023 18:53
@tekton-robot tekton-robot added size/L Denotes a PR that changes 100-499 lines, ignoring generated files. and removed size/M Denotes a PR that changes 30-99 lines, ignoring generated files. labels Nov 30, 2023
@JeromeJu JeromeJu marked this pull request as ready for review November 30, 2023 18:53
@tekton-robot tekton-robot removed the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Nov 30, 2023
@tekton-robot
Copy link
Collaborator

The following is the coverage report on the affected files.
Say /test pull-tekton-pipeline-go-coverage to re-run this coverage report

File Old Coverage New Coverage Delta
pkg/apis/pipeline/v1/task_validation.go 98.4% 98.4% 0.0

@tekton-robot
Copy link
Collaborator

The following is the coverage report on the affected files.
Say /test pull-tekton-pipeline-go-coverage-df to re-run this coverage report

File Old Coverage New Coverage Delta
pkg/apis/pipeline/v1/task_validation.go 98.4% 98.4% 0.0

dibyom
dibyom reviewed Nov 30, 2023
View reviewed changes
test/conversion_test.go
@@ -115,7 +115,6 @@ spec:
volumeMounts:
- name: messages
mountPath: /messages
script: echo test
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

why was this removed?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This was previously invalid syntax which aimed to test as many fields as possible in Task but not tested for sidecar.

@tekton-robot
Copy link
Collaborator

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: dibyom

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 Nov 30, 2023
@JeromeJu
Copy link
Member Author

/cherry-pick release-v0.53.x

@tekton-robot
Copy link
Collaborator

@JeromeJu: once the present PR merges, I will cherry-pick it on top of release-v0.53.x in a new PR and assign it to you.

In response to this:

/cherry-pick release-v0.53.x

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.

Yongxuanzhang
Yongxuanzhang reviewed Nov 30, 2023
View reviewed changes
Copy link
Member

@Yongxuanzhang Yongxuanzhang left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

/lgtm

@tekton-robot tekton-robot added the lgtm Indicates that a PR is ready to be merged. label Nov 30, 2023
@tekton-robot tekton-robot merged commit e2567fb into tektoncd:main Nov 30, 2023
3 checks passed
@tekton-robot
Copy link
Collaborator

@JeromeJu: new pull request created: #7446

In response to this:

/cherry-pick release-v0.53.x

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.

@tekton-robot tekton-robot mentioned this pull request Nov 30, 2023
Merged
@JeromeJu
Copy link
Member Author

JeromeJu commented Dec 1, 2023

/cherry-pick release-v0.50.x

@tekton-robot tekton-robot mentioned this pull request Dec 1, 2023
Merged
@tekton-robot
Copy link
Collaborator

@JeromeJu: new pull request created: #7451

In response to this:

/cherry-pick release-v0.50.x

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@Yongxuanzhang Yongxuanzhang Yongxuanzhang left review comments

@dibyom dibyom dibyom approved these changes

@afrittoli afrittoli Awaiting requested review from afrittoli

@jerop jerop Awaiting requested review from jerop

@pritidesai pritidesai Awaiting requested review from pritidesai

Assignees

@Yongxuanzhang Yongxuanzhang

Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. kind/bug Categorizes issue or PR as related to a bug. 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
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Inconsistent validation for the image field for Sidecar versus Step
4 participants
@JeromeJu @dibyom @tekton-robot @Yongxuanzhang