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

Added documentation to support Topology Manager feature in Kubelet. #15716

Merged
merged 3 commits into from
Sep 9, 2019
Merged

Added documentation to support Topology Manager feature in Kubelet. #15716

merged 3 commits into from
Sep 9, 2019

Conversation

lmdaly
Copy link
Contributor

@lmdaly lmdaly commented Aug 7, 2019

  • Added new document outlining feature
  • Updated feature-gates.md to include feature gate for feature
  • Update kubelet.md to include kubelet flags for feature

@k8s-ci-robot k8s-ci-robot added the cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. label Aug 7, 2019
@k8sio-netlify-preview-bot
Copy link
Collaborator

k8sio-netlify-preview-bot commented Aug 7, 2019 •
edited
Loading

Deploy preview for kubernetes-io-vnext-staging processing.

Building with commit 7d970f3

https://app.netlify.com/sites/kubernetes-io-vnext-staging/deploys/5d764411d163a100089a1a79

@k8s-ci-robot k8s-ci-robot added the size/L Denotes a PR that changes 100-499 lines, ignoring generated files. label Aug 7, 2019
@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 Aug 7, 2019
@lmdaly lmdaly mentioned this pull request Aug 7, 2019
Closed
11 tasks
@zacharysarah
Copy link
Contributor

/milestone 1.16

@k8s-ci-robot k8s-ci-robot added this to the 1.16 milestone Aug 7, 2019
sftim
sftim reviewed Aug 7, 2019
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.

@lmdaly thank you for this PR!

I'm not at all familiar with topology or with device plugins. The documentation overall made sense to me.
Do you think it would be useful for https://kubernetes.io/docs/concepts/scheduling/kube-scheduler/ to link to this new page once it exists? Or any other pages?

I spotted a few lines where the wording isn't in SIG Docs' recommended style, and I've suggested some changes. I hope these are helpful.

content/en/docs/tasks/administer-cluster/topology-manager.md Outdated Show resolved Hide resolved
content/en/docs/tasks/administer-cluster/topology-manager.md Outdated Show resolved Hide resolved
content/en/docs/tasks/administer-cluster/topology-manager.md Outdated Show resolved Hide resolved
content/en/docs/tasks/administer-cluster/topology-manager.md Outdated Show resolved Hide resolved
content/en/docs/tasks/administer-cluster/topology-manager.md Outdated Show resolved Hide resolved
content/en/docs/tasks/administer-cluster/topology-manager.md Outdated Show resolved Hide resolved
content/en/docs/tasks/administer-cluster/topology-manager.md Outdated Show resolved Hide resolved
content/en/docs/tasks/administer-cluster/topology-manager.md Outdated Show resolved Hide resolved
content/en/docs/tasks/administer-cluster/topology-manager.md Outdated Show resolved Hide resolved
content/en/docs/tasks/administer-cluster/topology-manager.md Show resolved Hide resolved
lmdaly
lmdaly commented Aug 8, 2019
View reviewed changes
Copy link
Contributor Author

@lmdaly lmdaly left a comment

Choose a reason for hiding this comment

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

@lmdaly thank you for this PR!

I'm not at all familiar with topology or with device plugins. The documentation overall made sense to me.
Do you think it would be useful for https://kubernetes.io/docs/concepts/scheduling/kube-scheduler/ to link to this new page once it exists? Or any other pages?

I spotted a few lines where the wording isn't in SIG Docs' recommended style, and I've suggested some changes. I hope these are helpful.

Thanks for the review @sftim, very helpful! I have made some changes based on the comments.

Topology Manager is confined to the node and only influences decisions when the pod has been scheduled onto a node. I think it would be good if CPU Manager and Device Plugin docs link to Topology Manager, and potentially the Kubelet doc?

@sftim sftim mentioned this pull request Aug 8, 2019
Merged
@xiangpengzhao
Copy link
Contributor

/cc @nolancon

@k8s-ci-robot
Copy link
Contributor

@xiangpengzhao: GitHub didn't allow me to request PR reviews from the following users: nolancon.

Note that only kubernetes members and repo collaborators can review this PR, and authors cannot review their own PRs.

In response to this:

/cc @nolancon

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.

@sftim
Copy link
Contributor

sftim commented Sep 6, 2019

Hi. I probably won't have time to provide more feedback between now and the v1.16 release.

@simplytunde
Copy link
Contributor

simplytunde commented Sep 6, 2019 •
edited
Loading

@lmdaly @klueska I will need a technical lgtm on this before merging and the deadline for merging is Sep 9.

@lmdaly @sftim
Added documentation to support Topology Manager feature in Kubelet.
f61f1cd 
	* Added new document outlining feature
	* Updated feature-gates.md to include feature gate for feature
	* Update kubelet.md to include kubelet flags for feature
	* Added Topology Manager reference to relevant pages

Co-authored-by: Tim Bannister <[email protected]>
@klueska
Copy link
Contributor

klueska commented Sep 7, 2019

Minor nits, but nothing blocking.

/lgtm

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Sep 7, 2019
@simplytunde
Copy link
Contributor

@lmdaly Once the little format issues are fixed and the generated reference doc is remove. This is lgtm from me.

@k8s-ci-robot k8s-ci-robot removed the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Sep 7, 2019
@lmdaly
Copy link
Contributor Author

lmdaly commented Sep 7, 2019

@simplytunde Updated, removed generated doc + fixed any formatting issues I could see.

@klueska
Copy link
Contributor

klueska commented Sep 7, 2019

/lgtm

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Sep 7, 2019
@simplytunde
Copy link
Contributor

Preview: https://5d7401684e48d2000ce63f08--kubernetes-io-vnext-staging.netlify.com/docs/tasks/administer-cluster/topology-manager/

@k8s-ci-robot k8s-ci-robot removed the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Sep 9, 2019
@lmdaly
Copy link
Contributor Author

lmdaly commented Sep 9, 2019

Preview: https://5d7401684e48d2000ce63f08--kubernetes-io-vnext-staging.netlify.com/docs/tasks/administer-cluster/topology-manager/

@simplytunde that's looking good to me!

@simplytunde
Copy link
Contributor

@lmdaly Overall, it looks good but I will like to address this part.

The Topology Manager currently: - Works on Nodes with the static CPU Manager Policy enabled. See control CPU Management Policies - Works on Pods in the Guaranteed QOS Class QoS class If these conditions are met, Topology Manager will align CPU and device requests.

Add a blank line before - Works on Nodes with the static CPU Manager Policy... if a list is intended here. Also, I noticed the repeated QOS Class

@lmdaly
Copy link
Contributor Author

lmdaly commented Sep 9, 2019 •
edited
Loading

@lmdaly Overall, it looks good but I will like to address this part.

The Topology Manager currently: - Works on Nodes with the static CPU Manager Policy enabled. See control CPU Management Policies - Works on Pods in the Guaranteed QOS Class QoS class If these conditions are met, Topology Manager will align CPU and device requests.

Add a blank line before - Works on Nodes with the static CPU Manager Policy... if a list is intended here. Also, I noticed the repeated QOS Class

@simplytunde Done! Let me know if the list is formatted correctly.

@simplytunde
Copy link
Contributor

Yes, it is!
/lgtm

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Sep 9, 2019
@simplytunde
Copy link
Contributor

/approve

@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: simplytunde

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 9, 2019
@k8s-ci-robot k8s-ci-robot merged commit f83de3f into kubernetes:dev-1.16 Sep 9, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@nolancon nolancon nolancon left review comments

@sftim sftim sftim requested changes

@klueska klueska klueska left review comments

@jimangel jimangel Awaiting requested review from jimangel

@stewart-yu stewart-yu Awaiting requested review from stewart-yu

Assignees

@klueska klueska

@simplytunde simplytunde

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/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
1.16
Development

Successfully merging this pull request may close these issues.
10 participants
@lmdaly @k8sio-netlify-preview-bot @zacharysarah @xiangpengzhao @k8s-ci-robot @VineethReddy02 @sftim @simplytunde @klueska @nolancon