Skip to content

Add section for APF best practices #42114

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
Merged
merged 1 commit into from
Sep 4, 2023
Merged

Add section for APF best practices #42114

merged 1 commit into from
Sep 4, 2023

Conversation

natherz97
Copy link
Contributor

This PR adds a section for APF best practices. The intent of this section is to educate cluster administrators how they can avoid APF-induced request latency or dropped requests. It covers how administrators can either modify their workload or tune APF configurations to avoid these issues.

@k8s-ci-robot k8s-ci-robot added the cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. label Jul 20, 2023
@k8s-ci-robot
Copy link
Contributor

Welcome @natherz97!

It looks like this is your first PR to kubernetes/website 🎉. 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/website 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 the size/M Denotes a PR that changes 30-99 lines, ignoring generated files. label Jul 20, 2023
@k8s-ci-robot k8s-ci-robot added language/en Issues or PRs related to English language sig/docs Categorizes an issue or PR as relevant to SIG Docs. labels Jul 20, 2023
@andrewsykim
Copy link
Member

/cc

@k8s-ci-robot k8s-ci-robot requested a review from andrewsykim July 20, 2023 17:42
@shyamjvs
Copy link
Member

/assign @andrewsykim @wojtek-t

sftim
sftim reviewed Jul 20, 2023
View reviewed changes
Copy link
Contributor

@sftim sftim left a comment

Choose a reason for hiding this comment

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

Thanks

I recommend reviewing our style guide, including:

That will help you write text that matches the rest of the site, or at least matches how we'd like the rest of the site to read.

I also added some inline feedback.

@sftim
Copy link
Contributor

sftim commented Jul 20, 2023

/sig api-machinery

@k8s-ci-robot k8s-ci-robot added the sig/api-machinery Categorizes an issue or PR as relevant to SIG API Machinery. label Jul 20, 2023
@netlify
Copy link

netlify bot commented Jul 26, 2023 •
edited
Loading

✅ Pull request preview available for checking

Built without sensitive environment variables

Name Link
🔨 Latest commit fbd11ee
🔍 Latest deploy log https://app.netlify.com/sites/kubernetes-io-main-staging/deploys/64e7e52ef2094f00097f1ca3
😎 Deploy Preview https://deploy-preview-42114--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.

@sftim sftim mentioned this pull request Aug 8, 2023
Closed
@k8s-ci-robot k8s-ci-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 Aug 14, 2023
@marseel
Copy link
Member

marseel commented Aug 16, 2023

/lgtm
Thanks, looks great from my point of view.

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Aug 16, 2023
@k8s-ci-robot
Copy link
Contributor

LGTM label has been added.

Git tree hash: 849d9ee2ebb11fe3a2cdd807154d6608e32b64a8

@MikeSpreitzer
Copy link
Member

/cc @MikeSpreitzer

wojtek-t
wojtek-t reviewed Aug 24, 2023
View reviewed changes
Copy link
Member

@wojtek-t wojtek-t left a comment

Choose a reason for hiding this comment

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

Just some minor comments from me - other than that it LGTM.

@k8s-ci-robot k8s-ci-robot removed the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Aug 24, 2023
andrewsykim
andrewsykim reviewed Aug 25, 2023
View reviewed changes
content/en/docs/concepts/cluster-administration/flow-control.md
@@ -782,6 +782,106 @@ APF adds the following two headers to each HTTP response message.
- `X-Kubernetes-PF-PriorityLevel-UID` holds the UID of the
PriorityLevelConfiguration object associated with that FlowSchema.

## Good practices for using API Priority and Fairness
Copy link
Member

Choose a reason for hiding this comment

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

Not blocking, but personally I think it would be more valuable to have "best practices" content in a separate page. This page already has a lot of information about the general concept which may be a very different audience from folks who are managing and optimizing their workloads.

Copy link
Member

Choose a reason for hiding this comment

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

+1 overall, but I would block this PR on it

Copy link
Contributor

Choose a reason for hiding this comment

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

Did you mean “wouldn't” @wojtek-t ?

Copy link
Member

Choose a reason for hiding this comment

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

oops - sorry. Yes, I meant "wouldn't" ...

@wojtek-t
Copy link
Member

/lgtm

/assign @MikeSpreitzer
I just realized that Mike wasn't even cc-ed here.

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Aug 25, 2023
@k8s-ci-robot
Copy link
Contributor

LGTM label has been added.

Git tree hash: 1cc19b7854fa5f4377a00b2f070cdac788604beb

sftim
sftim reviewed Sep 4, 2023
View reviewed changes
Copy link
Contributor

@sftim sftim left a comment

Choose a reason for hiding this comment

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

Given https://github.com/kubernetes/website/pull/42114/files#r1314718145

/approve

Fixups, if any prove needed, are of course welcome.

@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: sftim

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

@k8s-ci-robot k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Sep 4, 2023
@k8s-ci-robot k8s-ci-robot merged commit 64b2336 into kubernetes:main Sep 4, 2023
@natherz97 natherz97 mentioned this pull request Apr 4, 2025
Closed
11 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@aritraghosh aritraghosh aritraghosh left review comments

@andrewsykim andrewsykim andrewsykim left review comments

@sftim sftim sftim left review comments

@windsonsea windsonsea windsonsea left review comments

@nate-double-u nate-double-u Awaiting requested review from nate-double-u

@tengqm tengqm Awaiting requested review from tengqm

@MikeSpreitzer MikeSpreitzer Awaiting requested review from MikeSpreitzer

@marseel marseel Awaiting requested review from marseel

@wojtek-t wojtek-t Awaiting requested review from wojtek-t

Assignees

@marseel marseel

@wojtek-t wojtek-t

@andrewsykim andrewsykim

@MikeSpreitzer MikeSpreitzer

Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. language/en Issues or PRs related to English language lgtm "Looks good to me", indicates that a PR is ready to be merged. 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/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.
10 participants
@natherz97 @k8s-ci-robot @andrewsykim @shyamjvs @sftim @marseel @MikeSpreitzer @wojtek-t @aritraghosh @windsonsea