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

documenting validating-webhook and mutating-webhook audit annotation #47449

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

Ritikaa96
Copy link
Contributor

Documenting apiserver.latency.k8s.io/mutating-webhook
apiserver.latency.k8s.io/validating-webhook
in page audit annotation: https://kubernetes.io/docs/reference/labels-annotations-taints/audit-annotations/

Partially fixes : #29479

@k8s-ci-robot k8s-ci-robot added cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. size/S Denotes a PR that changes 10-29 lines, ignoring generated files. labels Aug 12, 2024
@Ritikaa96
Copy link
Contributor Author

/kind feature
/sig docs
/sig cli

@k8s-ci-robot k8s-ci-robot added language/en Issues or PRs related to English language kind/feature Categorizes issue or PR as related to a new feature. sig/docs Categorizes an issue or PR as relevant to SIG Docs. sig/cli Categorizes an issue or PR as relevant to SIG CLI. labels Aug 12, 2024
@Ritikaa96
Copy link
Contributor Author

Reference of content from : webhook.go and audit docs


Example: `apiserver.latency.k8s.io/validating-webhook: "203.698864ms"`

This annotation shows the measure of the latency incurred in validating webhook(s).
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Suggested change
This annotation shows the measure of the latency incurred in validating webhook(s).
This annotation shows the measure of the latency incurred in validating webhook(s). Validating webhooks is done parallel, hence the latency is aggregated using max duration taken.

I want to add this as the last line but don't know if this info is important to add here
Please confirm

Copy link
Contributor

Choose a reason for hiding this comment

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

Good to have this clarification.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I'll add this in the next commit then

Copy link

netlify bot commented Aug 12, 2024

Pull request preview available for checking

Built without sensitive environment variables

Name Link
🔨 Latest commit 7b5607c
🔍 Latest deploy log https://app.netlify.com/sites/kubernetes-io-main-staging/deploys/6749f7834870700008fade9e
😎 Deploy Preview https://deploy-preview-47449--kubernetes-io-main-staging.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@Ritikaa96
Copy link
Contributor Author

oops!! i added in flow to my other work
/remove-sig cli
/sig auth

@k8s-ci-robot k8s-ci-robot added sig/auth Categorizes an issue or PR as relevant to SIG Auth. and removed sig/cli Categorizes an issue or PR as relevant to SIG CLI. labels Aug 12, 2024
@aramase
Copy link
Member

aramase commented Aug 12, 2024

/sig api-machinery
/remove-sig auth

@k8s-ci-robot k8s-ci-robot added sig/api-machinery Categorizes an issue or PR as relevant to SIG API Machinery. and removed sig/auth Categorizes an issue or PR as relevant to SIG Auth. labels Aug 12, 2024
@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by:
Once this PR has been reviewed and has the lgtm label, please assign reylejano for approval. For more information see the Kubernetes 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

@Ritikaa96
Copy link
Contributor Author

Ritikaa96 commented Nov 29, 2024

Hi @tengqm Sorry for delay. i have now added the clarification in the validating-webhook, PTAL.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. kind/feature Categorizes issue or PR as related to a new feature. language/en Issues or PRs related to English language sig/api-machinery Categorizes an issue or PR as relevant to SIG API Machinery. sig/docs Categorizes an issue or PR as relevant to SIG Docs. size/S Denotes a PR that changes 10-29 lines, ignoring generated files.
Projects
Status: !SIG Auth
Status: Needs Triage
Development

Successfully merging this pull request may close these issues.

Document well-known audit annotations
4 participants