PrabhuJoseph commented on code in PR #4501: URL: https://github.com/apache/hadoop/pull/4501#discussion_r906995853
########## hadoop-yarn-project/hadoop-yarn/hadoop-yarn-site/src/site/markdown/UsingNuma.md: ########## @@ -0,0 +1,180 @@ +<!--- + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. See accompanying LICENSE file. +--> + +# NUMA + +Non-uniform memory access (NUMA) is a computer memory design used in multiprocessing, +where the memory access time depends on the memory location relative to the processor. +Under NUMA, a processor can access its own local memory faster than non-local memory +(memory local to another processor or memory shared between processors). +Yarn Containers can make benefit of this NUMA design to get better performance by binding to a +specific NUMA node and all subsequent memory allocations will be served by the same node, +reducing remote memory accesses. + +# Enabling NUMA + +### Prerequisites + +- As of now, NUMA awareness works only with `LinuxContainerExecutor` (LCE) +- To use the feature of NUMA awareness in the cluster,It must be enabled with + LinuxContainerExecutor (LCE) +- Steps to enable SecureContainer (LCE) for cluster is documented [here](SecureContainer.md) + +## Configurations + +**1) Enable/Disable the NUMA awareness** + +This property enables the NUMA awareness feature in the Node Manager +for the containers. By default, the value of this property is false which means it is disabled. +If this property is `true` then only the below configurations will be applicable otherwise they +will be ignored. + +In `yarn-site.xml` add + +``` + <property> + <name>yarn.nodemanager.numa-awareness.enabled</name> + <value>true</value> + </property> +``` + +**2) NUMA topology** + +This property decides whether to read the NUMA topology from the system or from the +configurations. If this property value is true then the topology will be read from the system using +`numactl --hardware` command in UNIX systems and similar way in windows. +If this property is false then the topology will be read using the below configurations. +Default value of this configuration is false which means NodeManager will read the NUMA topology +from the below configurations. + +In `yarn-site.xml` add + +``` + <property> + <name>yarn.nodemanager.numa-awareness.read-topology</name> + <value>false</value> + </property> +``` + +**3) Numa command** + +This property is passed when `yarn.nodemanager.numa-awareness.read-topology` is set to true. +It is recommended to verify the installation of `numactl` command in the Linux OS of every node. + +Use `/usr/bin/numactl --hardware` to verify. + +In `yarn-site.xml` add + +``` + <property> + <name>yarn.nodemanager.numa-awareness.numactl.cmd</name> + <value>/usr/bin/numactl</value> + </property> +``` + +**4) NUMA nodes id’s** + +This property is used to provide the NUMA node ids as comma separated values.It will be read only +when the `yarn.nodemanager.numa-awareness.read-topology` is false. + +In ```yarn-site.xml``` add + +``` + <property> + <name>yarn.nodemanager.numa-awareness.node-ids</name> + <value>0,1</value> + </property> +``` + +**5) NUMA Node memory** + +This property will be used to read the memory(in MB) configured for each NUMA node specified in +`yarn.nodemanager.numa-awareness.node-ids` by substituting the node id in the place of +`<NODE_ID>`.It will be read only when the `yarn.nodemanager.numa-awareness.read-topology` +is false. + +In ```yarn-site.xml``` add + +``` + <property> + <name>yarn.nodemanager.numa-awareness.<NODE_ID>.memory</name> + <value>8192</value> + </property> +``` + +**6) NUMA Node CPUs** + +This property will be used to read the number of CPUs configured for each node specified in +`yarn.nodemanager.numa-awareness.node-ids` by substituting the node id in the place of +`<NODE_ID>`.It will be read only when the `yarn.nodemanager.numa-awareness.read-topology` is false. + +In ```yarn-site.xml``` add + +``` + <property> + <name>yarn.nodemanager.numa-awareness.<NODE_ID>.cpus</name> + <value>8192</value> Review Comment: 8192 does not look a right example value for cpus. -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected] --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
