Google Git
Sign in
apache / incubator-heron / refs/heads/asf-site / . / content / api / java / org / apache / heron / packing / roundrobin / ResourceCompliantRRPacking.html
blob: 26983a4355284146028f43ce04bc7055351fd17d [file] [log] [blame]
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (11.0.18) on Wed Mar 01 02:01:42 GMT 2023 -->
<title>ResourceCompliantRRPacking (Heron Java API)</title>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="dc.created" content="2023-03-01">
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../../../jquery/jquery-ui.min.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../../../jquery-ui.overrides.css" title="Style">
<script type="text/javascript" src="../../../../../script.js"></script>
<script type="text/javascript" src="../../../../../jquery/jszip/dist/jszip.min.js"></script>
<script type="text/javascript" src="../../../../../jquery/jszip-utils/dist/jszip-utils.min.js"></script>
<!--[if IE]>
<script type="text/javascript" src="../../../../../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script>
<![endif]-->
<script type="text/javascript" src="../../../../../jquery/jquery-3.6.0.min.js"></script>
<script type="text/javascript" src="../../../../../jquery/jquery-ui.min.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="ResourceCompliantRRPacking (Heron Java API)";
}
}
catch(err) {
}
//-->
var data = {"i0":10,"i1":10,"i2":10,"i3":10};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
var pathtoroot = "../../../../../";
var useModuleDirectories = true;
loadScripts(document, 'script');</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<header role="banner">
<nav role="navigation">
<div class="fixedNav">
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a id="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../index.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</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" id="allclasses_navbar_top">
<li><a href="../../../../../allclasses.html">All&nbsp;Classes</a></li>
</ul>
<ul class="navListSearch">
<li><label for="search">SEARCH:</label>
<input type="text" id="search" value="search" disabled="disabled">
<input type="reset" id="reset" value="reset" disabled="disabled">
</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>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&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 id="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
</div>
<div class="navPadding">&nbsp;</div>
<script type="text/javascript"><!--
$('.navPadding').css('padding-top', $('.fixedNav').css("height"));
//-->
</script>
</nav>
</header>
<!-- ======== START OF CLASS DATA ======== -->
<main role="main">
<div class="header">
<div class="subTitle"><span class="packageLabelInType">Package</span>&nbsp;<a href="package-summary.html">org.apache.heron.packing.roundrobin</a></div>
<h2 title="Class ResourceCompliantRRPacking" class="title">Class ResourceCompliantRRPacking</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li><a href="../AbstractPacking.html" title="class in org.apache.heron.packing">org.apache.heron.packing.AbstractPacking</a></li>
<li>
<ul class="inheritance">
<li>org.apache.heron.packing.roundrobin.ResourceCompliantRRPacking</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><code>java.lang.AutoCloseable</code>, <code><a href="../../spi/packing/IPacking.html" title="interface in org.apache.heron.spi.packing">IPacking</a></code>, <code><a href="../../spi/packing/IRepacking.html" title="interface in org.apache.heron.spi.packing">IRepacking</a></code></dd>
</dl>
<hr>
<pre>public class <span class="typeNameLabel">ResourceCompliantRRPacking</span>
extends <a href="../AbstractPacking.html" title="class in org.apache.heron.packing">AbstractPacking</a></pre>
<div class="block">ResourceCompliantRoundRobin packing algorithm
<p>
This IPacking implementation generates a PackingPlan using a round robin algorithm.
<p>
Following semantics are guaranteed:
1. Supports heterogeneous containers.
The user provides the number of containers to use as well as
the maximum container size and a padding percentage.
The padding percentage whose values range from [0, 100], determines the per container
resources allocated for system-related processes (e.g., the stream manager).
<p>
2. The user provides the maximum CPU, RAM and Disk that can be used by each container through
the org.apache.heron.api.Config.TOPOLOGY_CONTAINER_CPU_REQUESTED,
org.apache.heron.api.Config.TOPOLOGY_CONTAINER_RAM_REQUESTED,
org.apache.heron.api.Config.TOPOLOGY_CONTAINER_DISK_REQUESTED parameters.
If the parameters are not specified then a default value is used for the maximum container
size.
<p>
3. The user provides a percentage of each container size that will be used for padding
through the org.apache.heron.api.Config.TOPOLOGY_CONTAINER_PADDING_PERCENTAGE
If the parameter is not specified then a default value of 10 is used (10% of the container size)
<p>
4. The RAM required for one instance is calculated as:
value in org.apache.heron.api.Config.TOPOLOGY_COMPONENT_RAMMAP if exists, otherwise,
the default RAM value for one instance.
<p>
5. The CPU required for one instance is calculated as the default CPU value for one instance.
<p>
6. The disk required for one instance is calculated as the default disk value for one instance.
<p>
7. The RAM required for a container is calculated as:
(RAM for instances in container) + (paddingPercentage * RAM for instances in container)
<p>
8. The CPU required for a container is calculated as:
(CPU for instances in container) + (paddingPercentage * CPU for instances in container)
<p>
9. The disk required for a container is calculated as:
(disk for instances in container) + ((paddingPercentage * disk for instances in container)
<p>
10. The pack() return null if PackingPlan fails to pass the safe check, for instance,
the size of RAM for an instance is less than the minimal required value.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- =========== FIELD SUMMARY =========== -->
<section>
<ul class="blockList">
<li class="blockList"><a id="field.summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<ul class="blockList">
<li class="blockList"><a id="fields.inherited.from.class.org.apache.heron.packing.AbstractPacking">
<!-- -->
</a>
<h3>Fields inherited from class&nbsp;org.apache.heron.packing.<a href="../AbstractPacking.html" title="class in org.apache.heron.packing">AbstractPacking</a></h3>
<code><a href="../AbstractPacking.html#componentResourceMap">componentResourceMap</a>, <a href="../AbstractPacking.html#defaultInstanceResources">defaultInstanceResources</a>, <a href="../AbstractPacking.html#maxContainerResources">maxContainerResources</a>, <a href="../AbstractPacking.html#maxNumInstancesPerContainer">maxNumInstancesPerContainer</a>, <a href="../AbstractPacking.html#padding">padding</a>, <a href="../AbstractPacking.html#topology">topology</a></code></li>
</ul>
</li>
</ul>
</section>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<section>
<ul class="blockList">
<li class="blockList"><a id="constructor.summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Constructor</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr class="altColor">
<th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E()">ResourceCompliantRRPacking</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
</table>
</li>
</ul>
</section>
<!-- ========== METHOD SUMMARY =========== -->
<section>
<ul class="blockList">
<li class="blockList"><a id="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance 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="colSecond" scope="col">Method</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#initialize(org.apache.heron.spi.common.Config,org.apache.heron.api.generated.TopologyAPI.Topology)">initialize</a></span>&#8203;(<a href="../../spi/common/Config.html" title="class in org.apache.heron.spi.common">Config</a>&nbsp;config,
<a href="../../api/generated/TopologyAPI.Topology.html" title="class in org.apache.heron.api.generated">TopologyAPI.Topology</a>&nbsp;inputTopology)</code></th>
<td class="colLast">
<div class="block">Initialize the packing algorithm with the static config and the topology</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code><a href="../../spi/packing/PackingPlan.html" title="class in org.apache.heron.spi.packing">PackingPlan</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#pack()">pack</a></span>()</code></th>
<td class="colLast">
<div class="block">Called by scheduler to generate container packing.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code><a href="../../spi/packing/PackingPlan.html" title="class in org.apache.heron.spi.packing">PackingPlan</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#repack(org.apache.heron.spi.packing.PackingPlan,int,java.util.Map)">repack</a></span>&#8203;(<a href="../../spi/packing/PackingPlan.html" title="class in org.apache.heron.spi.packing">PackingPlan</a>&nbsp;currentPackingPlan,
int&nbsp;containers,
java.util.Map&lt;java.lang.String,&#8203;java.lang.Integer&gt;&nbsp;componentChanges)</code></th>
<td class="colLast">
<div class="block">Generates a new packing given an existing packing and component changes
Packing algorithm output generates instance id and container id.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code><a href="../../spi/packing/PackingPlan.html" title="class in org.apache.heron.spi.packing">PackingPlan</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#repack(org.apache.heron.spi.packing.PackingPlan,java.util.Map)">repack</a></span>&#8203;(<a href="../../spi/packing/PackingPlan.html" title="class in org.apache.heron.spi.packing">PackingPlan</a>&nbsp;currentPackingPlan,
java.util.Map&lt;java.lang.String,&#8203;java.lang.Integer&gt;&nbsp;componentChanges)</code></th>
<td class="colLast">
<div class="block">Get a new packing plan given an existing packing plan and component-level changes.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.org.apache.heron.packing.AbstractPacking">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;org.apache.heron.packing.<a href="../AbstractPacking.html" title="class in org.apache.heron.packing">AbstractPacking</a></h3>
<code><a href="../AbstractPacking.html#close()">close</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
</ul>
</li>
</ul>
</section>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<section>
<ul class="blockList">
<li class="blockList"><a id="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a id="&lt;init&gt;()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>ResourceCompliantRRPacking</h4>
<pre>public&nbsp;ResourceCompliantRRPacking()</pre>
</li>
</ul>
</li>
</ul>
</section>
<!-- ============ METHOD DETAIL ========== -->
<section>
<ul class="blockList">
<li class="blockList"><a id="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a id="initialize(org.apache.heron.spi.common.Config,org.apache.heron.api.generated.TopologyAPI.Topology)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>initialize</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;initialize&#8203;(<a href="../../spi/common/Config.html" title="class in org.apache.heron.spi.common">Config</a>&nbsp;config,
<a href="../../api/generated/TopologyAPI.Topology.html" title="class in org.apache.heron.api.generated">TopologyAPI.Topology</a>&nbsp;inputTopology)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../spi/packing/IPacking.html#initialize(org.apache.heron.spi.common.Config,org.apache.heron.api.generated.TopologyAPI.Topology)">IPacking</a></code></span></div>
<div class="block">Initialize the packing algorithm with the static config and the topology</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../spi/packing/IPacking.html#initialize(org.apache.heron.spi.common.Config,org.apache.heron.api.generated.TopologyAPI.Topology)">initialize</a></code>&nbsp;in interface&nbsp;<code><a href="../../spi/packing/IPacking.html" title="interface in org.apache.heron.spi.packing">IPacking</a></code></dd>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../spi/packing/IRepacking.html#initialize(org.apache.heron.spi.common.Config,org.apache.heron.api.generated.TopologyAPI.Topology)">initialize</a></code>&nbsp;in interface&nbsp;<code><a href="../../spi/packing/IRepacking.html" title="interface in org.apache.heron.spi.packing">IRepacking</a></code></dd>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../AbstractPacking.html#initialize(org.apache.heron.spi.common.Config,org.apache.heron.api.generated.TopologyAPI.Topology)">initialize</a></code>&nbsp;in class&nbsp;<code><a href="../AbstractPacking.html" title="class in org.apache.heron.packing">AbstractPacking</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>config</code> - topology config</dd>
<dd><code>inputTopology</code> - topology to repack</dd>
</dl>
</li>
</ul>
<a id="pack()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>pack</h4>
<pre class="methodSignature">public&nbsp;<a href="../../spi/packing/PackingPlan.html" title="class in org.apache.heron.spi.packing">PackingPlan</a>&nbsp;pack()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../spi/packing/IPacking.html#pack()">IPacking</a></code></span></div>
<div class="block">Called by scheduler to generate container packing.
Packing algorithm output generates instance id and container id.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>PackingPlan describing the job to schedule.</dd>
</dl>
</li>
</ul>
<a id="repack(org.apache.heron.spi.packing.PackingPlan,java.util.Map)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>repack</h4>
<pre class="methodSignature">public&nbsp;<a href="../../spi/packing/PackingPlan.html" title="class in org.apache.heron.spi.packing">PackingPlan</a>&nbsp;repack&#8203;(<a href="../../spi/packing/PackingPlan.html" title="class in org.apache.heron.spi.packing">PackingPlan</a>&nbsp;currentPackingPlan,
java.util.Map&lt;java.lang.String,&#8203;java.lang.Integer&gt;&nbsp;componentChanges)</pre>
<div class="block">Get a new packing plan given an existing packing plan and component-level changes.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>currentPackingPlan</code> - Existing packing plan</dd>
<dd><code>componentChanges</code> - Map &lt; componentName, new component parallelism &gt;
that contains the parallelism for each component whose parallelism has changed.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>new packing plan</dd>
</dl>
</li>
</ul>
<a id="repack(org.apache.heron.spi.packing.PackingPlan,int,java.util.Map)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>repack</h4>
<pre class="methodSignature">public&nbsp;<a href="../../spi/packing/PackingPlan.html" title="class in org.apache.heron.spi.packing">PackingPlan</a>&nbsp;repack&#8203;(<a href="../../spi/packing/PackingPlan.html" title="class in org.apache.heron.spi.packing">PackingPlan</a>&nbsp;currentPackingPlan,
int&nbsp;containers,
java.util.Map&lt;java.lang.String,&#8203;java.lang.Integer&gt;&nbsp;componentChanges)
throws <a href="../../spi/packing/PackingException.html" title="class in org.apache.heron.spi.packing">PackingException</a>,
java.lang.UnsupportedOperationException</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../spi/packing/IRepacking.html#repack(org.apache.heron.spi.packing.PackingPlan,int,java.util.Map)">IRepacking</a></code></span></div>
<div class="block">Generates a new packing given an existing packing and component changes
Packing algorithm output generates instance id and container id.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>currentPackingPlan</code> - Existing packing plan</dd>
<dd><code>containers</code> - &lt; the new number of containers for the topology
specified by the user</dd>
<dd><code>componentChanges</code> - Map &lt; componentName, new component parallelism &gt;
that contains the parallelism for each component whose parallelism has changed.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>PackingPlan describing the new packing plan.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../spi/packing/PackingException.html" title="class in org.apache.heron.spi.packing">PackingException</a></code> - if the packing plan can not be generated</dd>
<dd><code>java.lang.UnsupportedOperationException</code></dd>
</dl>
</li>
</ul>
</li>
</ul>
</section>
</li>
</ul>
</div>
</div>
</main>
<!-- ========= END OF CLASS DATA ========= -->
<footer role="contentinfo">
<nav role="navigation">
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a id="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../index.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</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" id="allclasses_navbar_bottom">
<li><a href="../../../../../allclasses.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>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&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 id="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</nav>
</footer>
</body>
</html>