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

CNV bz1845198 hugepages #23705

Merged

Conversation

aburdenthehand
Copy link
Contributor

Added new assembly to Advanced VM management for configuring VMs to use huge pages. Reusing an OCP concept (conditionalised the final para).

BZ#1845198 - Need documentation around usage of huge-pages

@openshift-ci-robot openshift-ci-robot added the size/M Denotes a PR that changes 30-99 lines, ignoring generated files. label Jul 13, 2020
@openshift-docs-preview-bot

The preview will be available shortly at:


The memory request must be divisible by the page size. For example, you can not request `500Mi` memory with a page size of `1Gi`.

[NOTE]
Copy link
Contributor Author

Choose a reason for hiding this comment

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

@kbidarkar
@stu-gott provided some draft text that hopefully clarifies the issue in BZ#1822875. If this is acceptable then I can merge this and put a link to the doc in the two bugs

@kbidarkar
Copy link

LGTM

Copy link
Member

@ousleyp ousleyp left a comment

Choose a reason for hiding this comment

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

Overall, this is looking good -- just a few typos and nits :)

endif::ocp-hugepages[]

ifdef::virt-hugepages[]
In {VirtProductName}, virtual machines can be configued to consume pre-allocated
Copy link
Member

Choose a reason for hiding this comment

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

s/configued/configured

modules/virt-configuring-huge-pages-for-vms.adoc Outdated Show resolved Hide resolved
modules/virt-configuring-huge-pages-for-vms.adoc Outdated Show resolved Hide resolved
modules/virt-configuring-huge-pages-for-vms.adoc Outdated Show resolved Hide resolved
Comment on lines 15 to 17
The memory layouts of the host and the guest OS are unrelated.
Hugepages requested in the virtual machine manifest apply to QEMU.
Hugepages inside the guest can only be configured based on the amount of available memory of the virtual machine instance.
Copy link
Member

Choose a reason for hiding this comment

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

Nit: I'd prefer if this last sentence were in the active voice.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

It might be my preference talking but I find this easier to understand than the alternative:
"You can only configure huge pages inside the guest based on the amount of available memory of the virtual machine instance."

Comment on lines +22 to +24
.Prerequisites

* Nodes must have pre-allocated huge pages configured.
Copy link
Member

Choose a reason for hiding this comment

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

Do we need to repeat the prereq here, since it's in the assembly itself? (It is a good reminder, so I'm not really mad at it.)

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Yeah, in the built doc the assembly prereq is quite a ways from this procedure because of how large the concept is. Also if this topic was re-used I wanted to make sure the pre-req wasn't lost.

modules/virt-configuring-huge-pages-for-vms.adoc Outdated Show resolved Hide resolved
modules/virt-configuring-huge-pages-for-vms.adoc Outdated Show resolved Hide resolved
modules/virt-configuring-huge-pages-for-vms.adoc Outdated Show resolved Hide resolved
@aburdenthehand aburdenthehand merged commit 653f107 into openshift:master Jul 21, 2020
@aburdenthehand
Copy link
Contributor Author

/cherry-pick enterprise-4.5

@aburdenthehand
Copy link
Contributor Author

/cherry-pick enterprise-4.6

@openshift-cherrypick-robot

@aburdenthehand: new pull request created: #24008

In response to this:

/cherry-pick enterprise-4.5

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.

@openshift-cherrypick-robot

@aburdenthehand: new pull request created: #24009

In response to this:

/cherry-pick enterprise-4.6

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
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.

None yet

6 participants