Google Git
Sign in
apache / drill-site / 1afc0c0bd77668c5c5c8527776fb56bf6159badb / . / apidocs / org / apache / drill / yarn / appMaster / package-summary.html
blob: fd4608700f482c01b4292060c50c8845857268d7 [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 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>org.apache.drill.yarn.appMaster (Drill : 1.20.3 API)</title>
<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="org.apache.drill.yarn.appMaster (Drill : 1.20.3 API)";
}
}
catch(err) {
}
//-->
</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 class="navBarCell1Rev">Package</li>
<li>Class</li>
<li><a href="package-use.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/drill/metastore/util/package-summary.html">Prev&nbsp;Package</a></li>
<li><a href="../../../../../org/apache/drill/yarn/appMaster/http/package-summary.html">Next&nbsp;Package</a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/drill/yarn/appMaster/package-summary.html" target="_top">Frames</a></li>
<li><a href="package-summary.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>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<div class="header">
<h1 title="Package" class="title">Package&nbsp;org.apache.drill.yarn.appMaster</h1>
<div class="docSummary">
<div class="block">Implements the Drill Application Master for YARN.</div>
</div>
<p>See:&nbsp;<a href="#package.description">Description</a></p>
</div>
<div class="contentContainer">
<ul class="blockList">
<li class="blockList">
<table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Interface Summary table, listing interfaces, and an explanation">
<caption><span>Interface Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Interface</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/drill/yarn/appMaster/AMRegistrar.html" title="interface in org.apache.drill.yarn.appMaster">AMRegistrar</a></td>
<td class="colLast">
<div class="block">Interface to register the AM.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/apache/drill/yarn/appMaster/AMYarnFacade.html" title="interface in org.apache.drill.yarn.appMaster">AMYarnFacade</a></td>
<td class="colLast">
<div class="block">Defines the interface between the Application Master and YARN.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/drill/yarn/appMaster/ClusterController.html" title="interface in org.apache.drill.yarn.appMaster">ClusterController</a></td>
<td class="colLast">
<div class="block">Interface which identifies the cluster controller methods that are save to
call from the <a href="../../../../../org/apache/drill/yarn/appMaster/Dispatcher.html" title="class in org.apache.drill.yarn.appMaster"><code>Dispatcher</code></a>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/apache/drill/yarn/appMaster/ControllerFactory.html" title="interface in org.apache.drill.yarn.appMaster">ControllerFactory</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/drill/yarn/appMaster/ControllerVisitor.html" title="interface in org.apache.drill.yarn.appMaster">ControllerVisitor</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/apache/drill/yarn/appMaster/DispatcherAddOn.html" title="interface in org.apache.drill.yarn.appMaster">DispatcherAddOn</a></td>
<td class="colLast">
<div class="block">Interface for an add-on to the dispatcher that
should be started at start of the run and ended
at the end of the run.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/drill/yarn/appMaster/Pollable.html" title="interface in org.apache.drill.yarn.appMaster">Pollable</a></td>
<td class="colLast">
<div class="block">Interface for objects that are polled on each
controller clock tick in order to perform
time-based tasks.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/apache/drill/yarn/appMaster/PulseRunnable.PulseCallback.html" title="interface in org.apache.drill.yarn.appMaster">PulseRunnable.PulseCallback</a></td>
<td class="colLast">
<div class="block">Interface implemented to receive calls on each clock "tick."</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/drill/yarn/appMaster/RegistryHandler.html" title="interface in org.apache.drill.yarn.appMaster">RegistryHandler</a></td>
<td class="colLast">
<div class="block">Callback from the ZooKeeper registry to announce events
related to Drillbit registration.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/apache/drill/yarn/appMaster/Scheduler.html" title="interface in org.apache.drill.yarn.appMaster">Scheduler</a></td>
<td class="colLast">
<div class="block">The scheduler describes the set of tasks to run.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/drill/yarn/appMaster/Scheduler.TaskManager.html" title="interface in org.apache.drill.yarn.appMaster">Scheduler.TaskManager</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/apache/drill/yarn/appMaster/SchedulerState.html" title="interface in org.apache.drill.yarn.appMaster">SchedulerState</a></td>
<td class="colLast">
<div class="block">The cluster state for tasks managed by a scheduler.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/drill/yarn/appMaster/SchedulerStateActions.html" title="interface in org.apache.drill.yarn.appMaster">SchedulerStateActions</a></td>
<td class="colLast">
<div class="block">Represents the set of commands called by the cluster controller to manage the
state of tasks within a task group.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/apache/drill/yarn/appMaster/TaskLifecycleListener.html" title="interface in org.apache.drill.yarn.appMaster">TaskLifecycleListener</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/drill/yarn/appMaster/TaskVisitor.html" title="interface in org.apache.drill.yarn.appMaster">TaskVisitor</a></td>
<td class="colLast">&nbsp;</td>
</tr>
</tbody>
</table>
</li>
<li class="blockList">
<table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Class Summary table, listing classes, and an explanation">
<caption><span>Class Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Class</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/drill/yarn/appMaster/AbstractDrillbitScheduler.html" title="class in org.apache.drill.yarn.appMaster">AbstractDrillbitScheduler</a></td>
<td class="colLast">
<div class="block">Base class for schedulers (pools) for Drillbits.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/drill/yarn/appMaster/AbstractScheduler.html" title="class in org.apache.drill.yarn.appMaster">AbstractScheduler</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/apache/drill/yarn/appMaster/AbstractTaskManager.html" title="class in org.apache.drill.yarn.appMaster">AbstractTaskManager</a></td>
<td class="colLast">
<div class="block">Task manager that does nothing.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/drill/yarn/appMaster/AMYarnFacade.YarnAppHostReport.html" title="class in org.apache.drill.yarn.appMaster">AMYarnFacade.YarnAppHostReport</a></td>
<td class="colLast">
<div class="block">Provides a collection of web UI links for the YARN Resource Manager and the
Node Manager that is running the Drill-on-YARN AM.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/apache/drill/yarn/appMaster/AMYarnFacadeImpl.html" title="class in org.apache.drill.yarn.appMaster">AMYarnFacadeImpl</a></td>
<td class="colLast">
<div class="block">Wrapper around the asynchronous versions of the YARN AM-RM and AM-NM
interfaces.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/drill/yarn/appMaster/BatchScheduler.html" title="class in org.apache.drill.yarn.appMaster">BatchScheduler</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/apache/drill/yarn/appMaster/ClusterControllerImpl.html" title="class in org.apache.drill.yarn.appMaster">ClusterControllerImpl</a></td>
<td class="colLast">
<div class="block">Controls the Drill cluster by representing the current cluster state with a
desired state, taking corrective action to keep the cluster in the desired
state.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/drill/yarn/appMaster/Dispatcher.html" title="class in org.apache.drill.yarn.appMaster">Dispatcher</a></td>
<td class="colLast">
<div class="block">Dispatches YARN, timer and ZooKeeper events to the cluster controller.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/apache/drill/yarn/appMaster/DrillApplicationMaster.html" title="class in org.apache.drill.yarn.appMaster">DrillApplicationMaster</a></td>
<td class="colLast">
<div class="block">Application Master for Drill.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/drill/yarn/appMaster/DrillbitScheduler.html" title="class in org.apache.drill.yarn.appMaster">DrillbitScheduler</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/apache/drill/yarn/appMaster/DrillControllerFactory.html" title="class in org.apache.drill.yarn.appMaster">DrillControllerFactory</a></td>
<td class="colLast">
<div class="block">Builds a controller for a cluster of Drillbits.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/drill/yarn/appMaster/DrillControllerFactory.ZKRegistryAddOn.html" title="class in org.apache.drill.yarn.appMaster">DrillControllerFactory.ZKRegistryAddOn</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/apache/drill/yarn/appMaster/EventContext.html" title="class in org.apache.drill.yarn.appMaster">EventContext</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/drill/yarn/appMaster/NodeInventory.html" title="class in org.apache.drill.yarn.appMaster">NodeInventory</a></td>
<td class="colLast">
<div class="block">Creates an AM-side inventory of cluster nodes.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/apache/drill/yarn/appMaster/PersistentTaskScheduler.html" title="class in org.apache.drill.yarn.appMaster">PersistentTaskScheduler</a></td>
<td class="colLast">
<div class="block">Abstract base class for schedulers that work with persistent
(long-running) tasks.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/drill/yarn/appMaster/PulseRunnable.html" title="class in org.apache.drill.yarn.appMaster">PulseRunnable</a></td>
<td class="colLast">
<div class="block">Clock driver that calls a callback once each pulse period.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/apache/drill/yarn/appMaster/SchedulerStateImpl.html" title="class in org.apache.drill.yarn.appMaster">SchedulerStateImpl</a></td>
<td class="colLast">
<div class="block">Manages a the set of tasks associated with a scheduler.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/drill/yarn/appMaster/Task.html" title="class in org.apache.drill.yarn.appMaster">Task</a></td>
<td class="colLast">
<div class="block">AM-side state of individual containers.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/apache/drill/yarn/appMaster/TaskSpec.html" title="class in org.apache.drill.yarn.appMaster">TaskSpec</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/drill/yarn/appMaster/TaskState.html" title="class in org.apache.drill.yarn.appMaster">TaskState</a></td>
<td class="colLast">
<div class="block">Represents the behaviors associated with each state in the lifecycle
of a task.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/apache/drill/yarn/appMaster/TaskState.EndingState.html" title="class in org.apache.drill.yarn.appMaster">TaskState.EndingState</a></td>
<td class="colLast">
<div class="block">Task for which a termination request has been sent to the Drill-bit, but
confirmation has not yet been received from the Node Manager.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/drill/yarn/appMaster/TaskState.KillingState.html" title="class in org.apache.drill.yarn.appMaster">TaskState.KillingState</a></td>
<td class="colLast">
<div class="block">Task for which a forced termination request has been sent to the Node
Manager, but a stop message has not yet been received.</div>
</td>
</tr>
</tbody>
</table>
</li>
<li class="blockList">
<table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Enum Summary table, listing enums, and an explanation">
<caption><span>Enum Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Enum</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/drill/yarn/appMaster/ClusterControllerImpl.State.html" title="enum in org.apache.drill.yarn.appMaster">ClusterControllerImpl.State</a></td>
<td class="colLast">
<div class="block">Controller lifecycle state.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/apache/drill/yarn/appMaster/Task.Disposition.html" title="enum in org.apache.drill.yarn.appMaster">Task.Disposition</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/drill/yarn/appMaster/Task.TrackingState.html" title="enum in org.apache.drill.yarn.appMaster">Task.TrackingState</a></td>
<td class="colLast">
<div class="block">Tracking plugin state.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/apache/drill/yarn/appMaster/TaskLifecycleListener.Event.html" title="enum in org.apache.drill.yarn.appMaster">TaskLifecycleListener.Event</a></td>
<td class="colLast">&nbsp;</td>
</tr>
</tbody>
</table>
</li>
<li class="blockList">
<table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Exception Summary table, listing exceptions, and an explanation">
<caption><span>Exception Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Exception</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/drill/yarn/appMaster/AMException.html" title="class in org.apache.drill.yarn.appMaster">AMException</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/apache/drill/yarn/appMaster/AMRegistrar.AMRegistrationException.html" title="class in org.apache.drill.yarn.appMaster">AMRegistrar.AMRegistrationException</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/drill/yarn/appMaster/ControllerFactory.ControllerFactoryException.html" title="class in org.apache.drill.yarn.appMaster">ControllerFactory.ControllerFactoryException</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/apache/drill/yarn/appMaster/YarnFacadeException.html" title="class in org.apache.drill.yarn.appMaster">YarnFacadeException</a></td>
<td class="colLast">
<div class="block">Exceptions thrown from the YARN facade: the wrapper around the YARN AM
interfaces.</div>
</td>
</tr>
</tbody>
</table>
</li>
<li class="blockList">
<table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Error Summary table, listing errors, and an explanation">
<caption><span>Error Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Error</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/drill/yarn/appMaster/AMWrapperException.html" title="class in org.apache.drill.yarn.appMaster">AMWrapperException</a></td>
<td class="colLast">&nbsp;</td>
</tr>
</tbody>
</table>
</li>
</ul>
<a name="package.description">
<!-- -->
</a>
<h2 title="Package org.apache.drill.yarn.appMaster Description">Package org.apache.drill.yarn.appMaster Description</h2>
<div class="block">Implements the Drill Application Master for YARN.
<p>
Note that AM implementation classes use org.apache.commons.logging
to be consistent with the logging used within YARN itself. However,
the AM uses Drill's class path which uses logback logging. To enable
logging, modify
<code>$DRILL_HOME/conf/logback.xml</code> and add a section something
like this:
<pre><code>
&lt;logger name="org.apache.drill.yarn" additivity="false">
&lt;level value="trace" />
&lt;appender-ref ref="STDOUT" />
&lt;/logger>
</code></pre></div>
</div>
<!-- ======= 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 class="navBarCell1Rev">Package</li>
<li>Class</li>
<li><a href="package-use.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/drill/metastore/util/package-summary.html">Prev&nbsp;Package</a></li>
<li><a href="../../../../../org/apache/drill/yarn/appMaster/http/package-summary.html">Next&nbsp;Package</a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/drill/yarn/appMaster/package-summary.html" target="_top">Frames</a></li>
<li><a href="package-summary.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>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright &#169; 1970 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
</body>
</html>