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

update doc for kubelet option --reserved-cpus #17622

Closed
wants to merge 1 commit into from
Closed

update doc for kubelet option --reserved-cpus #17622

wants to merge 1 commit into from

Conversation

jianzzha
Copy link

This website update is for the new kubelet CLI option: kubernetes/kubernetes#83592

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

Welcome @jianzzha!

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 Nov 17, 2019
@jianzzha
Copy link
Author

/milestone 1.17

@k8s-ci-robot
Copy link
Contributor

@jianzzha: You must be a member of the kubernetes/website-milestone-maintainers GitHub team to set the milestone. If you believe you should be able to issue the /milestone command, please contact your Website milestone maintainers and have them propose you as an additional delegate for this responsibility.

In response to this:

/milestone 1.17

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.

@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by:
To complete the pull request process, please assign makoscafee
You can assign the PR to them by writing /assign @makoscafee in a comment when ready.

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 language/en Issues or PRs related to English language sig/docs Categorizes an issue or PR as relevant to SIG Docs. labels Nov 17, 2019
@netlify
Copy link

netlify bot commented Nov 17, 2019

Deploy preview for kubernetes-io-master-staging ready!

Built with commit ff05a40

https://deploy-preview-17622--kubernetes-io-master-staging.netlify.com

@@ -1024,6 +1024,13 @@ kubelet [flags]
<td></td><td style="line-height: 130%; word-wrap: break-word;">If > 0, limit registry pull QPS to this value. If 0, unlimited. (default 5) (DEPRECATED: This parameter should be set via the config file specified by the Kubelet's --config flag. See https://kubernetes.io/docs/tasks/administer-cluster/kubelet-config-file/ for more information.)</td>
</tr>

<tr>
<td colspan="2">--reserved-cpus string</td>
</tr>
Copy link
Contributor

Choose a reason for hiding this comment

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

Hello @jianzzha . You should make this change in the kubelet cmd line code (k8s/k8s).

Copy link
Author

Choose a reason for hiding this comment

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

@kbhawkey thanks, this file is reverted.

`--system-reserved` options. CPUs reserved by these options are taken, in
`--system-reserved` options. From 1.17, the CPU reservation list can be specified
explictly by kubelet --resevered-cpus option. The explicit CPU list specified by
--resevered-cpus will take precedence over the CPU reservation specified by
Copy link
Contributor

Choose a reason for hiding this comment

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

two typos: resevered -> reserved

defined by `--kube-reserved` and `--system-reserved` options.

This option is specifically designed for Telco/NFV use cases where uncontrolled
interrupts/timers may impact the work load performance. Users may use this option
Copy link
Contributor

Choose a reason for hiding this comment

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

work load -> workload

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.

Here are some comments & suggestions based on the website style guide

`--system-reserved` options. CPUs reserved by these options are taken, in
`--system-reserved` options. From 1.17, the CPU reservation list can be specified
explictly by kubelet --reserved-cpus option. The explicit CPU list specified by
--reserved-cpus will take precedence over the CPU reservation specified by
Copy link
Contributor

Choose a reason for hiding this comment

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

nit

Suggested change
--reserved-cpus will take precedence over the CPU reservation specified by
--reserved-cpus takes precedence over the CPU reservation specified by



`reserved-cpus` is meant to define an explict CPU set for OS system daemons and
kubernetes system daemons. This option is added in 1.17 release. `reserved-cpus`
Copy link
Contributor

Choose a reason for hiding this comment

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

To declare a version where this is supported, could you use a feature-state shortcode instead (eg on line 150)?

Copy link
Author

Choose a reason for hiding this comment

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

added. check if it is what's expected

defined by `--kube-reserved` and `--system-reserved` options.

This option is specifically designed for Telco/NFV use cases where uncontrolled
interrupts/timers may impact the workload performance. Users may use this option
Copy link
Contributor

Choose a reason for hiding this comment

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

nit

Suggested change
interrupts/timers may impact the workload performance. Users may use this option
interrupts/timers may impact the workload performance. You can use this option

workloads, with less impact from uncontrolled interrupts/timers. To move the
system daemon, kubernetes daemons and interrupts/timers to the explict cpuset
defined by this option, other mechanism outside Kubernetes should be used.
For example in Centos, tuned toolset can be used to achieve this.
Copy link
Contributor

Choose a reason for hiding this comment

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

nit

Suggested change
For example in Centos, tuned toolset can be used to achieve this.
For example: in CentOS, you can do this using the tuned toolset.

@@ -259,4 +281,8 @@ for `kube-reserved` and `system-reserved`.
As of Kubernetes version 1.8, the `storage` key name was changed to `ephemeral-storage`
for the alpha release.

As of Kubernetes version 1.17, it has been possible to **optionally** specify
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
As of Kubernetes version 1.17, it has been possible to **optionally** specify
As of Kubernetes version 1.17, you can optionally specify

@sftim
Copy link
Contributor

sftim commented Nov 18, 2019

Did you want this PR to target branch dev-1.17 instead BTW?

@jianzzha
Copy link
Author

Did you want this PR to target branch dev-1.17 instead BTW?
yes. I couldn't add that tag myself

@tengqm
Copy link
Contributor

tengqm commented Nov 19, 2019

As pointed out by @sftim, this PR is about a feature to be landed in 1.17, right?
Please rebase onto dev-1.17 branch if so.
/hold

@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 Nov 19, 2019
@jianzzha
Copy link
Author

As pointed out by @sftim, this PR is about a feature to be landed in 1.17, right?
Please rebase onto dev-1.17 branch if so.
/hold

@tengqm yes. how to do the rebase on 1.17? any instructions?

@tengqm
Copy link
Contributor

tengqm commented Nov 19, 2019

@jianzzha You may want to check this: https://git-scm.com/book/en/v2/Git-Branching-Rebasing

Basically, the commands are:

$ git checkout <your-pr-branch>
$ git rebase dev-1.17
First, rewinding head to replay your work on top of it...
Applying: added staged command
$ git commit --amend --no-edit
$ git push -f

@jianzzha
Copy link
Author

@tengqm @sftim please review #17648 in stead - that PR is base on dev-1.17. I will close this PR. thanks!

@jianzzha jianzzha closed this Nov 19, 2019
@jianzzha
Copy link
Author

@tengqm @sftim please review #17648; it captured all the changes from this PR and it is based off dev-1.17.

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. do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. language/en Issues or PRs related to English language sig/docs Categorizes an issue or PR as relevant to SIG Docs. size/M Denotes a PR that changes 30-99 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants