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

Annotations: Log validation error. #13093

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Annotations: Log validation error. #13093

wants to merge 1 commit into from

Conversation

gnarlex
Copy link

@gnarlex gnarlex commented Mar 26, 2025

What this PR does / why we need it:

When an annotations is validated, it only prints that the given value is invalid, but not why it's invalid.
This makes it harder for operators to fix issues, as they have to read the source code, to see which characters are allowed and which aren't.

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • CVE Report (Scanner found CVE and adding report)
  • Breaking change (fix or feature that would cause existing functionality to change)
  • Documentation only

How Has This Been Tested?

Verified manually.

Checklist:

  • My change requires a change to the documentation.
  • I have updated the documentation accordingly.
  • I've read the CONTRIBUTION guide
  • I have added unit and/or e2e tests to cover my changes.
  • All new and existing tests passed.

@gnarlex
fix(ingress): print original annotation validation error
9d3ad94 
Otherwise operators will have to read the source code, to see what characters are allowed and what aren't.
@linux-foundation-easycla Linux Foundation: EasyCLA
Copy link

linux-foundation-easycla bot commented Mar 26, 2025 •
edited
Loading

CLA Signed


The committers listed above are authorized under a signed CLA.

@k8s-ci-robot k8s-ci-robot added the cncf-cla: no Indicates the PR's author has not signed the CNCF CLA. label Mar 26, 2025
@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: gnarlex
Once this PR has been reviewed and has the lgtm label, please assign cpanato for approval. For more information see the Code Review Process.

The full list of commands accepted by this bot can be found 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

@k8s-ci-robot k8s-ci-robot added the needs-triage Indicates an issue or PR lacks a `triage/foo` label and requires one. label Mar 26, 2025
@k8s-ci-robot
Copy link
Contributor

Welcome @gnarlex!

It looks like this is your first PR to kubernetes/ingress-nginx 🎉. Please refer to our pull request process documentation to help your PR have a smooth ride to approval.

You will be prompted by a bot to use commands during the review process. Do not be afraid to follow the prompts! It is okay to experiment. Here is the bot commands documentation.

You can also check if kubernetes/ingress-nginx has its own contribution guidelines.

You may want to refer to our testing guide if you run into trouble with your tests not passing.

If you are having difficulty getting your pull request seen, please follow the recommended escalation practices. Also, for tips and tricks in the contribution process you may want to read the Kubernetes contributor cheat sheet. We want to make sure your contribution gets all the attention it needs!

Thank you, and welcome to Kubernetes. 😃

@k8s-ci-robot k8s-ci-robot added needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. needs-kind Indicates a PR lacks a `kind/foo` label and requires one. labels Mar 26, 2025
@k8s-ci-robot
Copy link
Contributor

Hi @gnarlex. Thanks for your PR.

I'm waiting for a kubernetes 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.

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 k8s-ci-robot added needs-priority size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. labels Mar 26, 2025
@netlify Netlify
Copy link

netlify bot commented Mar 26, 2025 •
edited
Loading

✅ Deploy Preview for kubernetes-ingress-nginx canceled.

Name Link
🔨 Latest commit 9d3ad94
🔍 Latest deploy log https://app.netlify.com/sites/kubernetes-ingress-nginx/deploys/67e428b34c60eb0009b2f601

@k8s-ci-robot k8s-ci-robot added cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. and removed cncf-cla: no Indicates the PR's author has not signed the CNCF CLA. labels Mar 26, 2025
@gnarlex gnarlex changed the title feat(ingress): print original annotation validation error fix(ingress): print original annotation validation error Mar 26, 2025
Gacko
Gacko requested changes Mar 26, 2025
View reviewed changes
Copy link
Member

@Gacko Gacko left a comment

Choose a reason for hiding this comment

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

Can you please add examples how the result looks like? Also I'd not consider this a fix as your change is not making the code work as it was expected to work, but rather improves debugging - so is an improvement. Anyway...

/retitle Annotations: Log validation error.
/triage accepted
/kind feature
/priority backlog
/hold

internal/ingress/annotations/parser/validators.go
@@ -240,7 +240,7 @@ func checkAnnotation(name string, ing *networking.Ingress, fields AnnotationFiel
// We don't run validation against empty values
if EnableAnnotationValidation && annotationValue != "" {
if err := validateFunc(annotationValue); err != nil {
klog.Warningf("validation error on ingress %s/%s: annotation %s contains invalid value %s", ing.GetNamespace(), ing.GetName(), name, annotationValue)
klog.Warningf("validation error on ingress %s/%s: annotation %s contains invalid value %s. err: %s", ing.GetNamespace(), ing.GetName(), name, annotationValue, err)
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
klog.Warningf("validation error on ingress %s/%s: annotation %s contains invalid value %s. err: %s", ing.GetNamespace(), ing.GetName(), name, annotationValue, err)
klog.Warningf("validation error on ingress %s/%s: annotation %s contains invalid value %s: %s", ing.GetNamespace(), ing.GetName(), name, annotationValue, err)

@k8s-ci-robot k8s-ci-robot added the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Mar 26, 2025
@k8s-ci-robot k8s-ci-robot changed the title fix(ingress): print original annotation validation error Annotations: Log validation error. Mar 26, 2025
@k8s-ci-robot k8s-ci-robot added triage/accepted Indicates an issue or PR is ready to be actively worked on. kind/feature Categorizes issue or PR as related to a new feature. priority/backlog Higher priority than priority/awaiting-more-evidence. and removed needs-triage Indicates an issue or PR lacks a `triage/foo` label and requires one. needs-kind Indicates a PR lacks a `kind/foo` label and requires one. needs-priority labels Mar 26, 2025
@Gacko
Copy link
Member

Gacko commented Mar 29, 2025

@gnarlex Any update here? Can you maybe respond to my questions so we can get this merged? Thank you!

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

@Gacko Gacko Gacko requested changes

@tao12345666333 tao12345666333 Awaiting requested review from tao12345666333

Assignees
No one assigned
Labels
cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. kind/feature Categorizes issue or PR as related to a new feature. needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. priority/backlog Higher priority than priority/awaiting-more-evidence. size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. triage/accepted Indicates an issue or PR is ready to be actively worked on.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@gnarlex @k8s-ci-robot @Gacko