Document URL: https://docs.openshift.com/container-platform/4.1/scalability_and_performance/what-huge-pages-do-and-how-they-are-consumed-by-apps.html#configuring-huge-pages_huge-pages Section Number and Name: Configuring huge pages Describe the issue: In step 2, it is stated to edit the default tuned configuration to create hugepage profile. However modifying default tuned configuration does not have any affect and hugepages are not set on the nodes. Further checking with Jiri Mencak, I see we are not suppose to modify default tuned config and instead create a new tuned config to configure hugepages. Suggestions for improvement: We need to modify the docs to create new tuned config similar to below to configure hugepages. $ cat hugepages.yaml apiVersion: tuned.openshift.io/v1 kind: Tuned metadata: name: hugepages spec: profile: - data: | [main] summary=Configuration of hugepages include=openshift-node [vm] transparent_hugepages=never [sysctl] vm.nr_hugepages=1024 name: node-hugepages recommend: - match: - label: hugepages priority: 30 profile: node-hugepages status: {} Additional information:
While the documentation doesn't explicitly state the default profile should be edited, I agree it should be more specific that customizations should be done using custom tuned profiles even though this functionality is a Technology Preview in 4.1. The default tuned CR (tuned/default) should never be used to perform custom node tuning as it is meant to provide default OCP cluster tuning and will get overridden on operator upgrades in the future. The current documentation also lacks the name of the huge-pages profile in the data section, which might have caused the problem the profile was not applied when editing the default CR was attempted. Also, please use the following config instead as the config provided above misses a namespace and has an extra status field: apiVersion: tuned.openshift.io/v1 kind: Tuned metadata: name: hugepages namespace: openshift-cluster-node-tuning-operator spec: profile: - data: | [main] summary=Configuration for hugepages include=openshift-node [vm] transparent_hugepages=never [sysctl] vm.nr_hugepages=1024 name: node-hugepages recommend: - match: - label: hugepages priority: 30 profile: node-hugepages
PTAL for QE review: https://github.com/openshift/openshift-docs/pull/16051
Updated PR per feedback: https://github.com/openshift/openshift-docs/pull/16051
Merged https://github.com/openshift/openshift-docs/pull/16051.
Updated docs published: https://docs.openshift.com/container-platform/4.1/scalability_and_performance/what-huge-pages-do-and-how-they-are-consumed-by-apps.html#configuring-huge-pages_huge-pages https://access.redhat.com/documentation/en-us/openshift_container_platform/4.1/html/scalability_and_performance/what-huge-pages-do-and-how-they-are-consumed#configuring-huge-pages_huge-pages