Google Git
Sign in
apache / hadoop-site / 952d547359cafef280f0a0324055741b2ed55be1 / . / content / docs / r3.3.1 / hadoop-yarn / hadoop-yarn-server / hadoop-yarn-server-nodemanager / apidocs / org / apache / hadoop / yarn / server / nodemanager / util / NodeManagerHardwareUtils.html
blob: 0ee654e19e2e59585cc7058dec2e9ec9c7fdedba [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_292) on Tue Jun 15 06:11:23 GMT 2021 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>NodeManagerHardwareUtils (Apache Hadoop YARN NodeManager 3.3.1 API)</title>
<meta name="date" content="2021-06-15">
<link rel="stylesheet" type="text/css" href="../../../../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../../../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="NodeManagerHardwareUtils (Apache Hadoop YARN NodeManager 3.3.1 API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":9,"i1":9,"i2":9,"i3":9,"i4":9,"i5":9,"i6":9,"i7":9,"i8":9,"i9":9};
var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/NodeManagerHardwareUtils.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../../../org/apache/hadoop/yarn/server/nodemanager/util/NodeManagerBuilderUtils.html" title="class in org.apache.hadoop.yarn.server.nodemanager.util"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../../../org/apache/hadoop/yarn/server/nodemanager/util/ProcessIdFileReader.html" title="class in org.apache.hadoop.yarn.server.nodemanager.util"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../../index.html?org/apache/hadoop/yarn/server/nodemanager/util/NodeManagerHardwareUtils.html" target="_top">Frames</a></li>
<li><a href="NodeManagerHardwareUtils.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">org.apache.hadoop.yarn.server.nodemanager.util</div>
<h2 title="Class NodeManagerHardwareUtils" class="title">Class NodeManagerHardwareUtils</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li>
<li>
<ul class="inheritance">
<li>org.apache.hadoop.yarn.server.nodemanager.util.NodeManagerHardwareUtils</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>@InterfaceAudience.Private
@InterfaceStability.Unstable
public class <span class="typeNameLabel">NodeManagerHardwareUtils</span>
extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></pre>
<div class="block">Helper class to determine hardware related characteristics such as the
number of processors and the amount of memory on the node.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/hadoop/yarn/server/nodemanager/util/NodeManagerHardwareUtils.html#NodeManagerHardwareUtils--">NodeManagerHardwareUtils</a></span>()</code>&nbsp;</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>static long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/hadoop/yarn/server/nodemanager/util/NodeManagerHardwareUtils.html#getContainerMemoryMB-org.apache.hadoop.conf.Configuration-">getContainerMemoryMB</a></span>(org.apache.hadoop.conf.Configuration&nbsp;conf)</code>
<div class="block">Function to return how much memory we should set aside for YARN containers.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>static long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/hadoop/yarn/server/nodemanager/util/NodeManagerHardwareUtils.html#getContainerMemoryMB-org.apache.hadoop.yarn.util.ResourceCalculatorPlugin-org.apache.hadoop.conf.Configuration-">getContainerMemoryMB</a></span>(org.apache.hadoop.yarn.util.ResourceCalculatorPlugin&nbsp;plugin,
org.apache.hadoop.conf.Configuration&nbsp;conf)</code>
<div class="block">Function to return how much memory we should set aside for YARN containers.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>static float</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/hadoop/yarn/server/nodemanager/util/NodeManagerHardwareUtils.html#getContainersCPUs-org.apache.hadoop.conf.Configuration-">getContainersCPUs</a></span>(org.apache.hadoop.conf.Configuration&nbsp;conf)</code>
<div class="block">Returns the fraction of CPUs that should be used for YARN containers.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>static float</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/hadoop/yarn/server/nodemanager/util/NodeManagerHardwareUtils.html#getContainersCPUs-org.apache.hadoop.yarn.util.ResourceCalculatorPlugin-org.apache.hadoop.conf.Configuration-">getContainersCPUs</a></span>(org.apache.hadoop.yarn.util.ResourceCalculatorPlugin&nbsp;plugin,
org.apache.hadoop.conf.Configuration&nbsp;conf)</code>
<div class="block">Returns the fraction of CPUs that should be used for YARN containers.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/hadoop/yarn/server/nodemanager/util/NodeManagerHardwareUtils.html#getNodeCpuPercentage-org.apache.hadoop.conf.Configuration-">getNodeCpuPercentage</a></span>(org.apache.hadoop.conf.Configuration&nbsp;conf)</code>
<div class="block">Gets the percentage of physical CPU that is configured for YARN containers.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/hadoop/yarn/server/nodemanager/util/NodeManagerHardwareUtils.html#getNodeCPUs-org.apache.hadoop.conf.Configuration-">getNodeCPUs</a></span>(org.apache.hadoop.conf.Configuration&nbsp;conf)</code>
<div class="block">Returns the number of CPUs on the node.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/hadoop/yarn/server/nodemanager/util/NodeManagerHardwareUtils.html#getNodeCPUs-org.apache.hadoop.yarn.util.ResourceCalculatorPlugin-org.apache.hadoop.conf.Configuration-">getNodeCPUs</a></span>(org.apache.hadoop.yarn.util.ResourceCalculatorPlugin&nbsp;plugin,
org.apache.hadoop.conf.Configuration&nbsp;conf)</code>
<div class="block">Returns the number of CPUs on the node.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>static org.apache.hadoop.yarn.api.records.Resource</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/hadoop/yarn/server/nodemanager/util/NodeManagerHardwareUtils.html#getNodeResources-org.apache.hadoop.conf.Configuration-">getNodeResources</a></span>(org.apache.hadoop.conf.Configuration&nbsp;configuration)</code>
<div class="block">Get the resources for the node.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/hadoop/yarn/server/nodemanager/util/NodeManagerHardwareUtils.html#getVCores-org.apache.hadoop.conf.Configuration-">getVCores</a></span>(org.apache.hadoop.conf.Configuration&nbsp;conf)</code>
<div class="block">Function to return the number of vcores on the system that can be used for
YARN containers.</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/hadoop/yarn/server/nodemanager/util/NodeManagerHardwareUtils.html#getVCores-org.apache.hadoop.yarn.util.ResourceCalculatorPlugin-org.apache.hadoop.conf.Configuration-">getVCores</a></span>(org.apache.hadoop.yarn.util.ResourceCalculatorPlugin&nbsp;plugin,
org.apache.hadoop.conf.Configuration&nbsp;conf)</code>
<div class="block">Function to return the number of vcores on the system that can be used for
YARN containers.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="NodeManagerHardwareUtils--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>NodeManagerHardwareUtils</h4>
<pre>public&nbsp;NodeManagerHardwareUtils()</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="getNodeCPUs-org.apache.hadoop.conf.Configuration-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getNodeCPUs</h4>
<pre>public static&nbsp;int&nbsp;getNodeCPUs(org.apache.hadoop.conf.Configuration&nbsp;conf)</pre>
<div class="block">Returns the number of CPUs on the node. This value depends on the
configuration setting which decides whether to count logical processors
(such as hyperthreads) as cores or not.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>conf</code> - - Configuration object</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Number of CPUs</dd>
</dl>
</li>
</ul>
<a name="getNodeCPUs-org.apache.hadoop.yarn.util.ResourceCalculatorPlugin-org.apache.hadoop.conf.Configuration-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getNodeCPUs</h4>
<pre>public static&nbsp;int&nbsp;getNodeCPUs(org.apache.hadoop.yarn.util.ResourceCalculatorPlugin&nbsp;plugin,
org.apache.hadoop.conf.Configuration&nbsp;conf)</pre>
<div class="block">Returns the number of CPUs on the node. This value depends on the
configuration setting which decides whether to count logical processors
(such as hyperthreads) as cores or not.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>plugin</code> - - ResourceCalculatorPlugin object to determine hardware specs</dd>
<dd><code>conf</code> - - Configuration object</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Number of CPU cores on the node.</dd>
</dl>
</li>
</ul>
<a name="getContainersCPUs-org.apache.hadoop.conf.Configuration-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getContainersCPUs</h4>
<pre>public static&nbsp;float&nbsp;getContainersCPUs(org.apache.hadoop.conf.Configuration&nbsp;conf)</pre>
<div class="block">Returns the fraction of CPUs that should be used for YARN containers.
The number is derived based on various configuration params such as
YarnConfiguration.NM_RESOURCE_PERCENTAGE_PHYSICAL_CPU_LIMIT</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>conf</code> - - Configuration object</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Fraction of CPUs to be used for YARN containers</dd>
</dl>
</li>
</ul>
<a name="getContainersCPUs-org.apache.hadoop.yarn.util.ResourceCalculatorPlugin-org.apache.hadoop.conf.Configuration-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getContainersCPUs</h4>
<pre>public static&nbsp;float&nbsp;getContainersCPUs(org.apache.hadoop.yarn.util.ResourceCalculatorPlugin&nbsp;plugin,
org.apache.hadoop.conf.Configuration&nbsp;conf)</pre>
<div class="block">Returns the fraction of CPUs that should be used for YARN containers.
The number is derived based on various configuration params such as
YarnConfiguration.NM_RESOURCE_PERCENTAGE_PHYSICAL_CPU_LIMIT</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>plugin</code> - - ResourceCalculatorPlugin object to determine hardware specs</dd>
<dd><code>conf</code> - - Configuration object</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Fraction of CPUs to be used for YARN containers</dd>
</dl>
</li>
</ul>
<a name="getNodeCpuPercentage-org.apache.hadoop.conf.Configuration-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getNodeCpuPercentage</h4>
<pre>public static&nbsp;int&nbsp;getNodeCpuPercentage(org.apache.hadoop.conf.Configuration&nbsp;conf)</pre>
<div class="block">Gets the percentage of physical CPU that is configured for YARN containers.
This is percent &gt; 0 and &lt;= 100 based on
<code>YarnConfiguration.NM_RESOURCE_PERCENTAGE_PHYSICAL_CPU_LIMIT</code></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>conf</code> - Configuration object</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>percent &gt; 0 and &lt;= 100</dd>
</dl>
</li>
</ul>
<a name="getVCores-org.apache.hadoop.conf.Configuration-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getVCores</h4>
<pre>public static&nbsp;int&nbsp;getVCores(org.apache.hadoop.conf.Configuration&nbsp;conf)</pre>
<div class="block">Function to return the number of vcores on the system that can be used for
YARN containers. If a number is specified in the configuration file, then
that number is returned. If nothing is specified - 1. If the OS is an
"unknown" OS(one for which we don't have ResourceCalculatorPlugin
implemented), return the default NodeManager cores. 2. If the config
variable yarn.nodemanager.cpu.use_logical_processors is set to true, it
returns the logical processor count(count hyperthreads as cores), else it
returns the physical cores count.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>conf</code> - - the configuration for the NodeManager</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the number of cores to be used for YARN containers</dd>
</dl>
</li>
</ul>
<a name="getVCores-org.apache.hadoop.yarn.util.ResourceCalculatorPlugin-org.apache.hadoop.conf.Configuration-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getVCores</h4>
<pre>public static&nbsp;int&nbsp;getVCores(org.apache.hadoop.yarn.util.ResourceCalculatorPlugin&nbsp;plugin,
org.apache.hadoop.conf.Configuration&nbsp;conf)</pre>
<div class="block">Function to return the number of vcores on the system that can be used for
YARN containers. If a number is specified in the configuration file, then
that number is returned. If nothing is specified - 1. If the OS is an
"unknown" OS(one for which we don't have ResourceCalculatorPlugin
implemented), return the default NodeManager cores. 2. If the config
variable yarn.nodemanager.cpu.use_logical_processors is set to true, it
returns the logical processor count(count hyperthreads as cores), else it
returns the physical cores count.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>plugin</code> - - ResourceCalculatorPlugin object to determine hardware specs</dd>
<dd><code>conf</code> - - the configuration for the NodeManager</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the number of cores to be used for YARN containers</dd>
</dl>
</li>
</ul>
<a name="getContainerMemoryMB-org.apache.hadoop.conf.Configuration-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getContainerMemoryMB</h4>
<pre>public static&nbsp;long&nbsp;getContainerMemoryMB(org.apache.hadoop.conf.Configuration&nbsp;conf)</pre>
<div class="block">Function to return how much memory we should set aside for YARN containers.
If a number is specified in the configuration file, then that number is
returned. If nothing is specified - 1. If the OS is an "unknown" OS(one for
which we don't have ResourceCalculatorPlugin implemented), return the
default NodeManager physical memory. 2. If the OS has a
ResourceCalculatorPlugin implemented, the calculation is 0.8 * (RAM - 2 *
JVM-memory) i.e. use 80% of the memory after accounting for memory used by
the DataNode and the NodeManager. If the number is less than 1GB, log a
warning message.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>conf</code> - - the configuration for the NodeManager</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the amount of memory that will be used for YARN containers in MB.</dd>
</dl>
</li>
</ul>
<a name="getContainerMemoryMB-org.apache.hadoop.yarn.util.ResourceCalculatorPlugin-org.apache.hadoop.conf.Configuration-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getContainerMemoryMB</h4>
<pre>public static&nbsp;long&nbsp;getContainerMemoryMB(org.apache.hadoop.yarn.util.ResourceCalculatorPlugin&nbsp;plugin,
org.apache.hadoop.conf.Configuration&nbsp;conf)</pre>
<div class="block">Function to return how much memory we should set aside for YARN containers.
If a number is specified in the configuration file, then that number is
returned. If nothing is specified - 1. If the OS is an "unknown" OS(one for
which we don't have ResourceCalculatorPlugin implemented), return the
default NodeManager physical memory. 2. If the OS has a
ResourceCalculatorPlugin implemented, the calculation is 0.8 * (RAM - 2 *
JVM-memory) i.e. use 80% of the memory after accounting for memory used by
the DataNode and the NodeManager. If the number is less than 1GB, log a
warning message.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>plugin</code> - - ResourceCalculatorPlugin object to determine hardware specs</dd>
<dd><code>conf</code> - - the configuration for the NodeManager</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the amount of memory that will be used for YARN containers in MB.</dd>
</dl>
</li>
</ul>
<a name="getNodeResources-org.apache.hadoop.conf.Configuration-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getNodeResources</h4>
<pre>public static&nbsp;org.apache.hadoop.yarn.api.records.Resource&nbsp;getNodeResources(org.apache.hadoop.conf.Configuration&nbsp;configuration)</pre>
<div class="block">Get the resources for the node.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>configuration</code> - configuration file</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the resources for the node</dd>
</dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/NodeManagerHardwareUtils.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../../../org/apache/hadoop/yarn/server/nodemanager/util/NodeManagerBuilderUtils.html" title="class in org.apache.hadoop.yarn.server.nodemanager.util"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../../../org/apache/hadoop/yarn/server/nodemanager/util/ProcessIdFileReader.html" title="class in org.apache.hadoop.yarn.server.nodemanager.util"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../../index.html?org/apache/hadoop/yarn/server/nodemanager/util/NodeManagerHardwareUtils.html" target="_top">Frames</a></li>
<li><a href="NodeManagerHardwareUtils.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright &#169; 2008&#x2013;2021 <a href="https://www.apache.org">Apache Software Foundation</a>. All rights reserved.</small></p>
</body>
</html>