Document apiserver.latency.k8s.io/total audit annotation #47448

Ritikaa96 · 2024-08-12T04:06:12Z

Documented apiserver.latency.k8s.io/total annotation in page https://kubernetes.io/docs/reference/labels-annotations-taints/audit-annotations/
also added values details in authorization.k8s.io/decision annotation.
Partially Fixes: #29479

Signed-off-by: Ritikaa96 <[email protected]>

k8s-ci-robot · 2024-08-12T04:06:31Z

[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 natalisucks 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:

content/en/docs/OWNERS

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

Ritikaa96 · 2024-08-12T04:06:35Z

/sig cli
/kind feature

Ritikaa96 · 2024-08-12T04:07:48Z

Information taken from kep and code file, specifically audit.go

netlify · 2024-08-12T04:13:49Z

✅ Pull request preview available for checking

Built without sensitive environment variables

Name	Link
🔨 Latest commit	`4a53adf`
🔍 Latest deploy log	https://app.netlify.com/sites/kubernetes-io-main-staging/deploys/66c711941826550008f1f5db
😎 Deploy Preview	https://deploy-preview-47448--kubernetes-io-main-staging.netlify.app
📱 Preview on mobile	Toggle 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 · 2024-08-12T05:15:50Z

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

sftim · 2024-08-12T08:51:49Z

/retitle Document apiserver.latency.k8s.io/total audit annotation

aramase · 2024-08-12T16:14:49Z

/triage accepted

/assign nilekhc
(assigned to review the authz changes as part of SIG Auth triage meeting)

aramase · 2024-08-12T16:18:30Z

/sig api-machinery

sftim · 2024-08-20T15:30:21Z

Hello Prow. Is this now OK to merge?

sftim

Thanks; please see feedback.

sftim · 2024-08-20T15:32:36Z

content/en/docs/reference/labels-annotations-taints/audit-annotations.md

+This value shows total latency incurred in components within the apiserver. Please note that the latency is recorded in
+annotation only when the total latency of the given request exceeds 500ms; This is in keeping with the
+traces in rest/handlers for create, delete, update, get, list, and delete collection.


Suggested change

This value shows total latency incurred in components within the apiserver. Please note that the latency is recorded in

annotation only when the total latency of the given request exceeds 500ms; This is in keeping with the

traces in rest/handlers for create, delete, update, get, list, and delete collection.

This annotation records total latency incurred in components within the API server.

The API server only adds this audit annotation for requests where the total latency for handling

and responding to that request exceeds a threshold; in Kubernetes {{< skew currentVersion >}}

that threshold is 500ms (half a second).

This looks clean , thanks for the suggestion.

sftim · 2024-08-20T15:32:51Z

content/en/docs/reference/labels-annotations-taints/audit-annotations.md

 ## authorization.k8s.io/decision

 Example: `authorization.k8s.io/decision: "forbid"`

-This annotation indicates whether or not a request was authorized in Kubernetes audit logs.
+Value must be **forbid** or **allow**. This annotation indicates whether or not a request was authorized in Kubernetes audit logs.


This change does not align with the PR title and description. I think it belongs in a separate commit and possibly a different PR.

Should i add a different PR? In case it is needed i'll add another PR for it.

Two PRs is easiest.

Signed-off-by: Ritikaa96 <[email protected]>

Ritikaa96 · 2024-08-29T09:31:34Z

I have added different pr for improvement on already documented annotation. Is there any other change needed here?

k8s-triage-robot · 2024-11-27T09:41:12Z

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

Ritikaa96 · 2024-11-27T12:33:31Z

/remove-lifecycle stale
I am waiting for the reviews and approval so this is still active.

registering apiserver.latency.k8s.io/total annotation

efaca25

Signed-off-by: Ritikaa96 <[email protected]>

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

k8s-ci-robot requested a review from reylejano August 12, 2024 04:06

k8s-ci-robot added the language/en Issues or PRs related to English language label Aug 12, 2024

k8s-ci-robot requested a review from sftim August 12, 2024 04:06

k8s-ci-robot added sig/cli Categorizes an issue or PR as relevant to SIG CLI. kind/feature Categorizes issue or PR as related to a new feature. labels Aug 12, 2024

Ritikaa96 mentioned this pull request Aug 12, 2024

Document well-known audit annotations #29479

Open

16 tasks

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

k8s-ci-robot changed the title ~~registering apiserver.latency.k8s.io/total annotation~~ Document apiserver.latency.k8s.io/total audit annotation Aug 12, 2024

k8s-ci-robot assigned nilekhc Aug 12, 2024

k8s-ci-robot added the triage/accepted Indicates an issue or PR is ready to be actively worked on. label Aug 12, 2024

k8s-ci-robot added the sig/api-machinery Categorizes an issue or PR as relevant to SIG API Machinery. label Aug 12, 2024

johnnyboystar22 mentioned this pull request Aug 12, 2024

Rad54s kubernetes #47464

Closed

sftim requested changes Aug 20, 2024

View reviewed changes

adding suggested changes

4a53adf

Signed-off-by: Ritikaa96 <[email protected]>

k8s-ci-robot added size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. and removed size/S Denotes a PR that changes 10-29 lines, ignoring generated files. labels Aug 22, 2024

k8s-ci-robot added the lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. label Nov 27, 2024

k8s-ci-robot removed the lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. label Nov 27, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Document apiserver.latency.k8s.io/total audit annotation #47448

Document apiserver.latency.k8s.io/total audit annotation #47448

Ritikaa96 commented Aug 12, 2024

k8s-ci-robot commented Aug 12, 2024

Ritikaa96 commented Aug 12, 2024

Ritikaa96 commented Aug 12, 2024

netlify bot commented Aug 12, 2024 •

edited

Loading

Ritikaa96 commented Aug 12, 2024

sftim commented Aug 12, 2024

aramase commented Aug 12, 2024 •

edited

Loading

aramase commented Aug 12, 2024

sftim commented Aug 20, 2024

sftim left a comment

sftim Aug 20, 2024

Ritikaa96 Aug 22, 2024

sftim Aug 20, 2024

Ritikaa96 Aug 22, 2024

sftim Aug 23, 2024

Ritikaa96 commented Aug 29, 2024

k8s-triage-robot commented Nov 27, 2024

Ritikaa96 commented Nov 27, 2024

-This value shows total latency incurred in components within the apiserver. Please note that the latency is recorded in
-annotation only when the total latency of the given request exceeds 500ms; This is in keeping with the
-traces in rest/handlers for create, delete, update, get, list, and delete collection.
+This annotation records total latency incurred in components within the API server.
+The API server only adds this audit annotation for requests where the total latency for handling
+and responding to that request exceeds a threshold; in Kubernetes {{< skew currentVersion >}}
+that threshold is 500ms (half a second).

Document apiserver.latency.k8s.io/total audit annotation #47448

Are you sure you want to change the base?

Document apiserver.latency.k8s.io/total audit annotation #47448

Conversation

Ritikaa96 commented Aug 12, 2024

k8s-ci-robot commented Aug 12, 2024

Ritikaa96 commented Aug 12, 2024

Ritikaa96 commented Aug 12, 2024

netlify bot commented Aug 12, 2024 • edited Loading

✅ Pull request preview available for checking

Ritikaa96 commented Aug 12, 2024

sftim commented Aug 12, 2024

aramase commented Aug 12, 2024 • edited Loading

aramase commented Aug 12, 2024

sftim commented Aug 20, 2024

sftim left a comment

Choose a reason for hiding this comment

sftim Aug 20, 2024

Choose a reason for hiding this comment

Ritikaa96 Aug 22, 2024

Choose a reason for hiding this comment

sftim Aug 20, 2024

Choose a reason for hiding this comment

Ritikaa96 Aug 22, 2024

Choose a reason for hiding this comment

sftim Aug 23, 2024

Choose a reason for hiding this comment

Ritikaa96 commented Aug 29, 2024

k8s-triage-robot commented Nov 27, 2024

Ritikaa96 commented Nov 27, 2024

netlify bot commented Aug 12, 2024 •

edited

Loading

aramase commented Aug 12, 2024 •

edited

Loading