| <!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:21 GMT 2021 --> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <title>DockerLinuxContainerRuntime (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="DockerLinuxContainerRuntime (Apache Hadoop YARN NodeManager 3.3.1 API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":9,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":9}; |
| var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance 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/DockerLinuxContainerRuntime.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/containermanager/linux/runtime/DelegatingLinuxContainerRuntime.html" title="class in org.apache.hadoop.yarn.server.nodemanager.containermanager.linux.runtime"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../../../../../org/apache/hadoop/yarn/server/nodemanager/containermanager/linux/runtime/JavaSandboxLinuxContainerRuntime.html" title="class in org.apache.hadoop.yarn.server.nodemanager.containermanager.linux.runtime"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../../../../index.html?org/apache/hadoop/yarn/server/nodemanager/containermanager/linux/runtime/DockerLinuxContainerRuntime.html" target="_top">Frames</a></li> |
| <li><a href="DockerLinuxContainerRuntime.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../../../../../../allclasses-noframe.html">All 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: </li> |
| <li>Nested | </li> |
| <li><a href="#field.summary">Field</a> | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li><a href="#field.detail">Field</a> | </li> |
| <li><a href="#constructor.detail">Constr</a> | </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.containermanager.linux.runtime</div> |
| <h2 title="Class DockerLinuxContainerRuntime" class="title">Class DockerLinuxContainerRuntime</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><a href="../../../../../../../../../org/apache/hadoop/yarn/server/nodemanager/containermanager/linux/runtime/OCIContainerRuntime.html" title="class in org.apache.hadoop.yarn.server.nodemanager.containermanager.linux.runtime">org.apache.hadoop.yarn.server.nodemanager.containermanager.linux.runtime.OCIContainerRuntime</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.hadoop.yarn.server.nodemanager.containermanager.linux.runtime.DockerLinuxContainerRuntime</li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><a href="../../../../../../../../../org/apache/hadoop/yarn/server/nodemanager/containermanager/linux/runtime/LinuxContainerRuntime.html" title="interface in org.apache.hadoop.yarn.server.nodemanager.containermanager.linux.runtime">LinuxContainerRuntime</a>, <a href="../../../../../../../../../org/apache/hadoop/yarn/server/nodemanager/containermanager/runtime/ContainerRuntime.html" title="interface in org.apache.hadoop.yarn.server.nodemanager.containermanager.runtime">ContainerRuntime</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>@InterfaceAudience.Private |
| @InterfaceStability.Unstable |
| public class <span class="typeNameLabel">DockerLinuxContainerRuntime</span> |
| extends <a href="../../../../../../../../../org/apache/hadoop/yarn/server/nodemanager/containermanager/linux/runtime/OCIContainerRuntime.html" title="class in org.apache.hadoop.yarn.server.nodemanager.containermanager.linux.runtime">OCIContainerRuntime</a></pre> |
| <div class="block"><p>This class is an extension of <a href="../../../../../../../../../org/apache/hadoop/yarn/server/nodemanager/containermanager/linux/runtime/OCIContainerRuntime.html" title="class in org.apache.hadoop.yarn.server.nodemanager.containermanager.linux.runtime"><code>OCIContainerRuntime</code></a> that uses the |
| native <code>container-executor</code> binary via a |
| <a href="../../../../../../../../../org/apache/hadoop/yarn/server/nodemanager/containermanager/linux/privileged/PrivilegedOperationExecutor.html" title="class in org.apache.hadoop.yarn.server.nodemanager.containermanager.linux.privileged"><code>PrivilegedOperationExecutor</code></a> instance to launch processes inside |
| Docker containers.</p> |
| |
| <p>The following environment variables are used to configure the Docker |
| engine:</p> |
| |
| <ul> |
| <li> |
| <code>YARN_CONTAINER_RUNTIME_TYPE</code> ultimately determines whether a |
| Docker container will be used. If the value is <code>docker</code>, a Docker |
| container will be used. Otherwise a regular process tree container will |
| be used. This environment variable is checked by the |
| <a href="../../../../../../../../../org/apache/hadoop/yarn/server/nodemanager/containermanager/linux/runtime/DockerLinuxContainerRuntime.html#isDockerContainerRequested-org.apache.hadoop.conf.Configuration-java.util.Map-"><code>isDockerContainerRequested(org.apache.hadoop.conf.Configuration, java.util.Map<java.lang.String, java.lang.String>)</code></a> method, which is called by the |
| <a href="../../../../../../../../../org/apache/hadoop/yarn/server/nodemanager/containermanager/linux/runtime/DelegatingLinuxContainerRuntime.html" title="class in org.apache.hadoop.yarn.server.nodemanager.containermanager.linux.runtime"><code>DelegatingLinuxContainerRuntime</code></a>. |
| </li> |
| <li> |
| <code>YARN_CONTAINER_RUNTIME_DOCKER_IMAGE</code> names which image |
| will be used to launch the Docker container. |
| </li> |
| <li> |
| <code>YARN_CONTAINER_RUNTIME_DOCKER_RUN_OVERRIDE_DISABLE</code> controls |
| whether the Docker container's default command is overridden. When set |
| to <code>true</code>, the Docker container's command will be |
| <code>bash <path_to_launch_script></code>. When unset or set to <code>false</code> |
| the Docker container's default command is used. |
| </li> |
| <li> |
| <code>YARN_CONTAINER_RUNTIME_DOCKER_CONTAINER_NETWORK</code> sets the |
| network type to be used by the Docker container. It must be a valid |
| value as determined by the |
| <code>yarn.nodemanager.runtime.linux.docker.allowed-container-networks</code> |
| property. |
| </li> |
| <li> |
| <code>YARN_CONTAINER_RUNTIME_DOCKER_PORTS_MAPPING</code> allows users to |
| specify ports mapping for the bridge network Docker container. The value |
| of the environment variable should be a comma-separated list of ports |
| mapping. It's the same to "-p" option for the Docker run command. If the |
| value is empty, "-P" will be added. |
| </li> |
| <li> |
| <code>YARN_CONTAINER_RUNTIME_DOCKER_CONTAINER_PID_NAMESPACE</code> |
| controls which PID namespace will be used by the Docker container. By |
| default, each Docker container has its own PID namespace. To share the |
| namespace of the host, the |
| <code>yarn.nodemanager.runtime.linux.docker.host-pid-namespace.allowed</code> |
| property must be set to <code>true</code>. If the host PID namespace is |
| allowed and this environment variable is set to <code>host</code>, the |
| Docker container will share the host's PID namespace. No other value is |
| allowed. |
| </li> |
| <li> |
| <code>YARN_CONTAINER_RUNTIME_DOCKER_CONTAINER_HOSTNAME</code> sets the |
| hostname to be used by the Docker container. If not specified, a |
| hostname will be derived from the container ID and set as default |
| hostname for networks other than 'host'. |
| </li> |
| <li> |
| <code>YARN_CONTAINER_RUNTIME_DOCKER_RUN_PRIVILEGED_CONTAINER</code> |
| controls whether the Docker container is a privileged container. In order |
| to use privileged containers, the |
| <code>yarn.nodemanager.runtime.linux.docker.privileged-containers.allowed</code> |
| property must be set to <code>true</code>, and the application owner must |
| appear in the value of the |
| <code>yarn.nodemanager.runtime.linux.docker.privileged-containers.acl</code> |
| property. If this environment variable is set to <code>true</code>, a |
| privileged Docker container will be used if allowed. No other value is |
| allowed, so the environment variable should be left unset rather than |
| setting it to false. |
| </li> |
| <li> |
| <code>YARN_CONTAINER_RUNTIME_DOCKER_MOUNTS</code> allows users to specify |
| additional volume mounts for the Docker container. The value of the |
| environment variable should be a comma-separated list of mounts. |
| All such mounts must be given as <code>source:dest[:mode]</code> and the mode |
| must be "ro" (read-only) or "rw" (read-write) to specify the type of |
| access being requested. If neither is specified, read-write will be |
| assumed. The mode may include a bind propagation option. In that case, |
| the mode should either be of the form [option], rw+[option], or |
| ro+[option]. Valid bind propagation options are shared, rshared, slave, |
| rslave, private, and rprivate. The requested mounts will be validated by |
| container-executor based on the values set in container-executor.cfg for |
| <code>docker.allowed.ro-mounts</code> and <code>docker.allowed.rw-mounts</code>. |
| </li> |
| <li> |
| <code>YARN_CONTAINER_RUNTIME_DOCKER_TMPFS_MOUNTS</code> allows users to |
| specify additional tmpfs mounts for the Docker container. The value of |
| the environment variable should be a comma-separated list of mounts. |
| </li> |
| <li> |
| <code>YARN_CONTAINER_RUNTIME_DOCKER_DELAYED_REMOVAL</code> allows a user |
| to request delayed deletion of the Docker containers on a per |
| container basis. If true, Docker containers will not be removed until |
| the duration defined by <code>yarn.nodemanager.delete.debug-delay-sec</code> |
| has elapsed. Administrators can disable this feature through the |
| yarn-site property |
| <code>yarn.nodemanager.runtime.linux.docker.delayed-removal.allowed</code>. |
| This feature is disabled by default. When this feature is disabled or set |
| to false, the container will be removed as soon as it exits. |
| </li> |
| <li> |
| <code>YARN_CONTAINER_RUNTIME_YARN_SYSFS_ENABLE</code> allows export yarn |
| service json to docker container. This feature is disabled by default. |
| When this feature is set, app.json will be available in |
| /hadoop/yarn/sysfs/app.json. |
| </li> |
| </ul></div> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="field.summary"> |
| <!-- --> |
| </a> |
| <h3>Field Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation"> |
| <caption><span>Fields</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Field and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../../org/apache/hadoop/yarn/server/nodemanager/containermanager/linux/runtime/DockerLinuxContainerRuntime.html#DOCKER_IMAGE_PATTERN">DOCKER_IMAGE_PATTERN</a></span></code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../../org/apache/hadoop/yarn/server/nodemanager/containermanager/linux/runtime/DockerLinuxContainerRuntime.html#ENV_DOCKER_CONTAINER_DELAYED_REMOVAL">ENV_DOCKER_CONTAINER_DELAYED_REMOVAL</a></span></code> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../../org/apache/hadoop/yarn/server/nodemanager/containermanager/linux/runtime/DockerLinuxContainerRuntime.html#ENV_DOCKER_CONTAINER_DOCKER_RUNTIME">ENV_DOCKER_CONTAINER_DOCKER_RUNTIME</a></span></code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../../org/apache/hadoop/yarn/server/nodemanager/containermanager/linux/runtime/DockerLinuxContainerRuntime.html#ENV_DOCKER_CONTAINER_DOCKER_SERVICE_MODE">ENV_DOCKER_CONTAINER_DOCKER_SERVICE_MODE</a></span></code> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../../org/apache/hadoop/yarn/server/nodemanager/containermanager/linux/runtime/DockerLinuxContainerRuntime.html#ENV_DOCKER_CONTAINER_HOSTNAME">ENV_DOCKER_CONTAINER_HOSTNAME</a></span></code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../../org/apache/hadoop/yarn/server/nodemanager/containermanager/linux/runtime/DockerLinuxContainerRuntime.html#ENV_DOCKER_CONTAINER_IMAGE">ENV_DOCKER_CONTAINER_IMAGE</a></span></code> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../../org/apache/hadoop/yarn/server/nodemanager/containermanager/linux/runtime/DockerLinuxContainerRuntime.html#ENV_DOCKER_CONTAINER_MOUNTS">ENV_DOCKER_CONTAINER_MOUNTS</a></span></code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../../org/apache/hadoop/yarn/server/nodemanager/containermanager/linux/runtime/DockerLinuxContainerRuntime.html#ENV_DOCKER_CONTAINER_NETWORK">ENV_DOCKER_CONTAINER_NETWORK</a></span></code> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../../org/apache/hadoop/yarn/server/nodemanager/containermanager/linux/runtime/DockerLinuxContainerRuntime.html#ENV_DOCKER_CONTAINER_PORTS_MAPPING">ENV_DOCKER_CONTAINER_PORTS_MAPPING</a></span></code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../../org/apache/hadoop/yarn/server/nodemanager/containermanager/linux/runtime/DockerLinuxContainerRuntime.html#ENV_DOCKER_CONTAINER_TMPFS_MOUNTS">ENV_DOCKER_CONTAINER_TMPFS_MOUNTS</a></span></code> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../../org/apache/hadoop/yarn/server/nodemanager/containermanager/linux/runtime/DockerLinuxContainerRuntime.html#ENV_DOCKER_CONTAINER_YARN_SYSFS">ENV_DOCKER_CONTAINER_YARN_SYSFS</a></span></code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../../org/apache/hadoop/yarn/server/nodemanager/containermanager/linux/runtime/DockerLinuxContainerRuntime.html#ENV_OCI_CONTAINER_PID_NAMESPACE">ENV_OCI_CONTAINER_PID_NAMESPACE</a></span></code> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../../org/apache/hadoop/yarn/server/nodemanager/containermanager/linux/runtime/DockerLinuxContainerRuntime.html#ENV_OCI_CONTAINER_RUN_PRIVILEGED_CONTAINER">ENV_OCI_CONTAINER_RUN_PRIVILEGED_CONTAINER</a></span></code> </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="fields.inherited.from.class.org.apache.hadoop.yarn.server.nodemanager.containermanager.linux.runtime.OCIContainerRuntime"> |
| <!-- --> |
| </a> |
| <h3>Fields inherited from class org.apache.hadoop.yarn.server.nodemanager.containermanager.linux.runtime.<a href="../../../../../../../../../org/apache/hadoop/yarn/server/nodemanager/containermanager/linux/runtime/OCIContainerRuntime.html" title="class in org.apache.hadoop.yarn.server.nodemanager.containermanager.linux.runtime">OCIContainerRuntime</a></h3> |
| <code><a href="../../../../../../../../../org/apache/hadoop/yarn/server/nodemanager/containermanager/linux/runtime/OCIContainerRuntime.html#CONTAINER_PID_NAMESPACE_SUFFIX">CONTAINER_PID_NAMESPACE_SUFFIX</a>, <a href="../../../../../../../../../org/apache/hadoop/yarn/server/nodemanager/containermanager/linux/runtime/OCIContainerRuntime.html#RUN_PRIVILEGED_CONTAINER_SUFFIX">RUN_PRIVILEGED_CONTAINER_SUFFIX</a>, <a href="../../../../../../../../../org/apache/hadoop/yarn/server/nodemanager/containermanager/linux/runtime/OCIContainerRuntime.html#RUNTIME_PREFIX">RUNTIME_PREFIX</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ======== 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"> </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/containermanager/linux/runtime/DockerLinuxContainerRuntime.html#DockerLinuxContainerRuntime-org.apache.hadoop.yarn.server.nodemanager.containermanager.linux.privileged.PrivilegedOperationExecutor-">DockerLinuxContainerRuntime</a></span>(<a href="../../../../../../../../../org/apache/hadoop/yarn/server/nodemanager/containermanager/linux/privileged/PrivilegedOperationExecutor.html" title="class in org.apache.hadoop.yarn.server.nodemanager.containermanager.linux.privileged">PrivilegedOperationExecutor</a> privilegedOperationExecutor)</code> |
| <div class="block">Create an instance using the given <a href="../../../../../../../../../org/apache/hadoop/yarn/server/nodemanager/containermanager/linux/privileged/PrivilegedOperationExecutor.html" title="class in org.apache.hadoop.yarn.server.nodemanager.containermanager.linux.privileged"><code>PrivilegedOperationExecutor</code></a> |
| instance for performing operations.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../../../../../../../org/apache/hadoop/yarn/server/nodemanager/containermanager/linux/runtime/DockerLinuxContainerRuntime.html#DockerLinuxContainerRuntime-org.apache.hadoop.yarn.server.nodemanager.containermanager.linux.privileged.PrivilegedOperationExecutor-org.apache.hadoop.yarn.server.nodemanager.containermanager.linux.resources.CGroupsHandler-">DockerLinuxContainerRuntime</a></span>(<a href="../../../../../../../../../org/apache/hadoop/yarn/server/nodemanager/containermanager/linux/privileged/PrivilegedOperationExecutor.html" title="class in org.apache.hadoop.yarn.server.nodemanager.containermanager.linux.privileged">PrivilegedOperationExecutor</a> privilegedOperationExecutor, |
| <a href="../../../../../../../../../org/apache/hadoop/yarn/server/nodemanager/containermanager/linux/resources/CGroupsHandler.html" title="interface in org.apache.hadoop.yarn.server.nodemanager.containermanager.linux.resources">CGroupsHandler</a> cGroupsHandler)</code> |
| <div class="block">Create an instance using the given <a href="../../../../../../../../../org/apache/hadoop/yarn/server/nodemanager/containermanager/linux/privileged/PrivilegedOperationExecutor.html" title="class in org.apache.hadoop.yarn.server.nodemanager.containermanager.linux.privileged"><code>PrivilegedOperationExecutor</code></a> |
| instance for performing operations and the given <a href="../../../../../../../../../org/apache/hadoop/yarn/server/nodemanager/containermanager/linux/resources/CGroupsHandler.html" title="interface in org.apache.hadoop.yarn.server.nodemanager.containermanager.linux.resources"><code>CGroupsHandler</code></a> |
| instance.</div> |
| </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"> </span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </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>protected void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../../org/apache/hadoop/yarn/server/nodemanager/containermanager/linux/runtime/DockerLinuxContainerRuntime.html#addCGroupParentIfRequired-java.lang.String-java.lang.String-org.apache.hadoop.yarn.server.nodemanager.containermanager.linux.runtime.docker.DockerRunCommand-">addCGroupParentIfRequired</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> resourcesOptions, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> containerIdStr, |
| <a href="../../../../../../../../../org/apache/hadoop/yarn/server/nodemanager/containermanager/linux/runtime/docker/DockerRunCommand.html" title="class in org.apache.hadoop.yarn.server.nodemanager.containermanager.linux.runtime.docker">DockerRunCommand</a> runCommand)</code> |
| <div class="block">If CGROUPS in enabled and not set to none, then set the CGROUP parent for |
| the command instance.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>org.apache.hadoop.hdfs.protocol.datatransfer.IOStreamPair</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../../org/apache/hadoop/yarn/server/nodemanager/containermanager/linux/runtime/DockerLinuxContainerRuntime.html#execContainer-org.apache.hadoop.yarn.server.nodemanager.executor.ContainerExecContext-">execContainer</a></span>(<a href="../../../../../../../../../org/apache/hadoop/yarn/server/nodemanager/executor/ContainerExecContext.html" title="class in org.apache.hadoop.yarn.server.nodemanager.executor">ContainerExecContext</a> ctx)</code> |
| <div class="block">Perform docker exec command into running container.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../../org/apache/hadoop/yarn/server/nodemanager/containermanager/linux/runtime/DockerLinuxContainerRuntime.html#getCapabilities--">getCapabilities</a></span>()</code> </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../../org/apache/hadoop/yarn/server/nodemanager/containermanager/linux/runtime/DockerLinuxContainerRuntime.html#getExposedPorts-org.apache.hadoop.yarn.server.nodemanager.containermanager.container.Container-">getExposedPorts</a></span>(<a href="../../../../../../../../../org/apache/hadoop/yarn/server/nodemanager/containermanager/container/Container.html" title="interface in org.apache.hadoop.yarn.server.nodemanager.containermanager.container">Container</a> container)</code> |
| <div class="block">Return the exposed ports of the container.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[]</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../../org/apache/hadoop/yarn/server/nodemanager/containermanager/linux/runtime/DockerLinuxContainerRuntime.html#getIpAndHost-org.apache.hadoop.yarn.server.nodemanager.containermanager.container.Container-">getIpAndHost</a></span>(<a href="../../../../../../../../../org/apache/hadoop/yarn/server/nodemanager/containermanager/container/Container.html" title="interface in org.apache.hadoop.yarn.server.nodemanager.containermanager.container">Container</a> container)</code> |
| <div class="block">Return the host and ip of the container.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../../org/apache/hadoop/yarn/server/nodemanager/containermanager/linux/runtime/DockerLinuxContainerRuntime.html#initialize-org.apache.hadoop.conf.Configuration-org.apache.hadoop.yarn.server.nodemanager.Context-">initialize</a></span>(org.apache.hadoop.conf.Configuration conf, |
| <a href="../../../../../../../../../org/apache/hadoop/yarn/server/nodemanager/Context.html" title="interface in org.apache.hadoop.yarn.server.nodemanager">Context</a> nmContext)</code> |
| <div class="block">Initialize the runtime.</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code>static boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../../org/apache/hadoop/yarn/server/nodemanager/containermanager/linux/runtime/DockerLinuxContainerRuntime.html#isDockerContainerRequested-org.apache.hadoop.conf.Configuration-java.util.Map-">isDockerContainerRequested</a></span>(org.apache.hadoop.conf.Configuration daemonConf, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>> env)</code> |
| <div class="block">Return whether the given environment variables indicate that the operation |
| is requesting a Docker container.</div> |
| </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../../org/apache/hadoop/yarn/server/nodemanager/containermanager/linux/runtime/DockerLinuxContainerRuntime.html#isRuntimeRequested-java.util.Map-">isRuntimeRequested</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>> env)</code> |
| <div class="block">Return whether the given environment variables indicate that the operation |
| is requesting this runtime.</div> |
| </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../../org/apache/hadoop/yarn/server/nodemanager/containermanager/linux/runtime/DockerLinuxContainerRuntime.html#launchContainer-org.apache.hadoop.yarn.server.nodemanager.containermanager.runtime.ContainerRuntimeContext-">launchContainer</a></span>(<a href="../../../../../../../../../org/apache/hadoop/yarn/server/nodemanager/containermanager/runtime/ContainerRuntimeContext.html" title="class in org.apache.hadoop.yarn.server.nodemanager.containermanager.runtime">ContainerRuntimeContext</a> ctx)</code> |
| <div class="block">Launch a container.</div> |
| </td> |
| </tr> |
| <tr id="i9" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../../org/apache/hadoop/yarn/server/nodemanager/containermanager/linux/runtime/DockerLinuxContainerRuntime.html#pullImageFromRemote-java.lang.String-java.lang.String-">pullImageFromRemote</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> containerIdStr, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> imageName)</code> </td> |
| </tr> |
| <tr id="i10" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../../org/apache/hadoop/yarn/server/nodemanager/containermanager/linux/runtime/DockerLinuxContainerRuntime.html#reapContainer-org.apache.hadoop.yarn.server.nodemanager.containermanager.runtime.ContainerRuntimeContext-">reapContainer</a></span>(<a href="../../../../../../../../../org/apache/hadoop/yarn/server/nodemanager/containermanager/runtime/ContainerRuntimeContext.html" title="class in org.apache.hadoop.yarn.server.nodemanager.containermanager.runtime">ContainerRuntimeContext</a> ctx)</code> |
| <div class="block">Reap the docker container.</div> |
| </td> |
| </tr> |
| <tr id="i11" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../../org/apache/hadoop/yarn/server/nodemanager/containermanager/linux/runtime/DockerLinuxContainerRuntime.html#relaunchContainer-org.apache.hadoop.yarn.server.nodemanager.containermanager.runtime.ContainerRuntimeContext-">relaunchContainer</a></span>(<a href="../../../../../../../../../org/apache/hadoop/yarn/server/nodemanager/containermanager/runtime/ContainerRuntimeContext.html" title="class in org.apache.hadoop.yarn.server.nodemanager.containermanager.runtime">ContainerRuntimeContext</a> ctx)</code> |
| <div class="block">Relaunch a container.</div> |
| </td> |
| </tr> |
| <tr id="i12" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../../org/apache/hadoop/yarn/server/nodemanager/containermanager/linux/runtime/DockerLinuxContainerRuntime.html#signalContainer-org.apache.hadoop.yarn.server.nodemanager.containermanager.runtime.ContainerRuntimeContext-">signalContainer</a></span>(<a href="../../../../../../../../../org/apache/hadoop/yarn/server/nodemanager/containermanager/runtime/ContainerRuntimeContext.html" title="class in org.apache.hadoop.yarn.server.nodemanager.containermanager.runtime">ContainerRuntimeContext</a> ctx)</code> |
| <div class="block">Signal the docker container.</div> |
| </td> |
| </tr> |
| <tr id="i13" class="rowColor"> |
| <td class="colFirst"><code>static void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../../org/apache/hadoop/yarn/server/nodemanager/containermanager/linux/runtime/DockerLinuxContainerRuntime.html#validateImageName-java.lang.String-">validateImageName</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> imageName)</code> </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.org.apache.hadoop.yarn.server.nodemanager.containermanager.linux.runtime.OCIContainerRuntime"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class org.apache.hadoop.yarn.server.nodemanager.containermanager.linux.runtime.<a href="../../../../../../../../../org/apache/hadoop/yarn/server/nodemanager/containermanager/linux/runtime/OCIContainerRuntime.html" title="class in org.apache.hadoop.yarn.server.nodemanager.containermanager.linux.runtime">OCIContainerRuntime</a></h3> |
| <code><a href="../../../../../../../../../org/apache/hadoop/yarn/server/nodemanager/containermanager/linux/runtime/OCIContainerRuntime.html#allowHostPidNamespace-org.apache.hadoop.yarn.server.nodemanager.containermanager.container.Container-">allowHostPidNamespace</a>, <a href="../../../../../../../../../org/apache/hadoop/yarn/server/nodemanager/containermanager/linux/runtime/OCIContainerRuntime.html#allowPrivilegedContainerExecution-org.apache.hadoop.yarn.server.nodemanager.containermanager.container.Container-">allowPrivilegedContainerExecution</a>, <a href="../../../../../../../../../org/apache/hadoop/yarn/server/nodemanager/containermanager/linux/runtime/OCIContainerRuntime.html#formatOciEnvKey-java.lang.String-java.lang.String-">formatOciEnvKey</a>, <a href="../../../../../../../../../org/apache/hadoop/yarn/server/nodemanager/containermanager/linux/runtime/OCIContainerRuntime.html#getCsiClients--">getCsiClients</a>, <a href="../../../../../../../../../org/apache/hadoop/yarn/server/nodemanager/containermanager/linux/runtime/OCIContainerRuntime.html#getGroupIdInfo-java.lang.String-">getGroupIdInfo</a>, <a href="../../../../../../../../../org/apache/hadoop/yarn/server/nodemanager/containermanager/linux/runtime/OCIContainerRuntime.html#getUserIdInfo-java.lang.String-">getUserIdInfo</a>, <a href="../../../../../../../../../org/apache/hadoop/yarn/server/nodemanager/containermanager/linux/runtime/OCIContainerRuntime.html#initiateCsiClients-org.apache.hadoop.conf.Configuration-">initiateCsiClients</a>, <a href="../../../../../../../../../org/apache/hadoop/yarn/server/nodemanager/containermanager/linux/runtime/OCIContainerRuntime.html#isContainerRequestedAsPrivileged-org.apache.hadoop.yarn.server.nodemanager.containermanager.container.Container-">isContainerRequestedAsPrivileged</a>, <a href="../../../../../../../../../org/apache/hadoop/yarn/server/nodemanager/containermanager/linux/runtime/OCIContainerRuntime.html#isOCICompliantContainerRequested-org.apache.hadoop.conf.Configuration-java.util.Map-">isOCICompliantContainerRequested</a>, <a href="../../../../../../../../../org/apache/hadoop/yarn/server/nodemanager/containermanager/linux/runtime/OCIContainerRuntime.html#mountReadOnlyPath-java.lang.String-java.util.Map-">mountReadOnlyPath</a>, <a href="../../../../../../../../../org/apache/hadoop/yarn/server/nodemanager/containermanager/linux/runtime/OCIContainerRuntime.html#prepareContainer-org.apache.hadoop.yarn.server.nodemanager.containermanager.runtime.ContainerRuntimeContext-">prepareContainer</a>, <a href="../../../../../../../../../org/apache/hadoop/yarn/server/nodemanager/containermanager/linux/runtime/OCIContainerRuntime.html#validateContainerNetworkType-java.lang.String-">validateContainerNetworkType</a>, <a href="../../../../../../../../../org/apache/hadoop/yarn/server/nodemanager/containermanager/linux/runtime/OCIContainerRuntime.html#validateContainerRuntimeType-java.lang.String-">validateContainerRuntimeType</a>, <a href="../../../../../../../../../org/apache/hadoop/yarn/server/nodemanager/containermanager/linux/runtime/OCIContainerRuntime.html#validateHostname-java.lang.String-">validateHostname</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class 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> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.org.apache.hadoop.yarn.server.nodemanager.containermanager.linux.runtime.LinuxContainerRuntime"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from interface org.apache.hadoop.yarn.server.nodemanager.containermanager.linux.runtime.<a href="../../../../../../../../../org/apache/hadoop/yarn/server/nodemanager/containermanager/linux/runtime/LinuxContainerRuntime.html" title="interface in org.apache.hadoop.yarn.server.nodemanager.containermanager.linux.runtime">LinuxContainerRuntime</a></h3> |
| <code><a href="../../../../../../../../../org/apache/hadoop/yarn/server/nodemanager/containermanager/linux/runtime/LinuxContainerRuntime.html#getLocalResources-org.apache.hadoop.yarn.server.nodemanager.containermanager.container.Container-">getLocalResources</a>, <a href="../../../../../../../../../org/apache/hadoop/yarn/server/nodemanager/containermanager/linux/runtime/LinuxContainerRuntime.html#start--">start</a>, <a href="../../../../../../../../../org/apache/hadoop/yarn/server/nodemanager/containermanager/linux/runtime/LinuxContainerRuntime.html#stop--">stop</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ FIELD DETAIL =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="field.detail"> |
| <!-- --> |
| </a> |
| <h3>Field Detail</h3> |
| <a name="DOCKER_IMAGE_PATTERN"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>DOCKER_IMAGE_PATTERN</h4> |
| <pre>public static final <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> DOCKER_IMAGE_PATTERN</pre> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../../../../../constant-values.html#org.apache.hadoop.yarn.server.nodemanager.containermanager.linux.runtime.DockerLinuxContainerRuntime.DOCKER_IMAGE_PATTERN">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="ENV_DOCKER_CONTAINER_IMAGE"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>ENV_DOCKER_CONTAINER_IMAGE</h4> |
| <pre>@InterfaceAudience.Private |
| public static final <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> ENV_DOCKER_CONTAINER_IMAGE</pre> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../../../../../constant-values.html#org.apache.hadoop.yarn.server.nodemanager.containermanager.linux.runtime.DockerLinuxContainerRuntime.ENV_DOCKER_CONTAINER_IMAGE">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="ENV_DOCKER_CONTAINER_NETWORK"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>ENV_DOCKER_CONTAINER_NETWORK</h4> |
| <pre>@InterfaceAudience.Private |
| public static final <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> ENV_DOCKER_CONTAINER_NETWORK</pre> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../../../../../constant-values.html#org.apache.hadoop.yarn.server.nodemanager.containermanager.linux.runtime.DockerLinuxContainerRuntime.ENV_DOCKER_CONTAINER_NETWORK">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="ENV_DOCKER_CONTAINER_HOSTNAME"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>ENV_DOCKER_CONTAINER_HOSTNAME</h4> |
| <pre>@InterfaceAudience.Private |
| public static final <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> ENV_DOCKER_CONTAINER_HOSTNAME</pre> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../../../../../constant-values.html#org.apache.hadoop.yarn.server.nodemanager.containermanager.linux.runtime.DockerLinuxContainerRuntime.ENV_DOCKER_CONTAINER_HOSTNAME">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="ENV_DOCKER_CONTAINER_MOUNTS"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>ENV_DOCKER_CONTAINER_MOUNTS</h4> |
| <pre>@InterfaceAudience.Private |
| public static final <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> ENV_DOCKER_CONTAINER_MOUNTS</pre> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../../../../../constant-values.html#org.apache.hadoop.yarn.server.nodemanager.containermanager.linux.runtime.DockerLinuxContainerRuntime.ENV_DOCKER_CONTAINER_MOUNTS">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="ENV_DOCKER_CONTAINER_TMPFS_MOUNTS"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>ENV_DOCKER_CONTAINER_TMPFS_MOUNTS</h4> |
| <pre>@InterfaceAudience.Private |
| public static final <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> ENV_DOCKER_CONTAINER_TMPFS_MOUNTS</pre> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../../../../../constant-values.html#org.apache.hadoop.yarn.server.nodemanager.containermanager.linux.runtime.DockerLinuxContainerRuntime.ENV_DOCKER_CONTAINER_TMPFS_MOUNTS">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="ENV_DOCKER_CONTAINER_DELAYED_REMOVAL"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>ENV_DOCKER_CONTAINER_DELAYED_REMOVAL</h4> |
| <pre>@InterfaceAudience.Private |
| public static final <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> ENV_DOCKER_CONTAINER_DELAYED_REMOVAL</pre> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../../../../../constant-values.html#org.apache.hadoop.yarn.server.nodemanager.containermanager.linux.runtime.DockerLinuxContainerRuntime.ENV_DOCKER_CONTAINER_DELAYED_REMOVAL">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="ENV_DOCKER_CONTAINER_PORTS_MAPPING"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>ENV_DOCKER_CONTAINER_PORTS_MAPPING</h4> |
| <pre>@InterfaceAudience.Private |
| public static final <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> ENV_DOCKER_CONTAINER_PORTS_MAPPING</pre> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../../../../../constant-values.html#org.apache.hadoop.yarn.server.nodemanager.containermanager.linux.runtime.DockerLinuxContainerRuntime.ENV_DOCKER_CONTAINER_PORTS_MAPPING">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="ENV_DOCKER_CONTAINER_YARN_SYSFS"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>ENV_DOCKER_CONTAINER_YARN_SYSFS</h4> |
| <pre>@InterfaceAudience.Private |
| public static final <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> ENV_DOCKER_CONTAINER_YARN_SYSFS</pre> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../../../../../constant-values.html#org.apache.hadoop.yarn.server.nodemanager.containermanager.linux.runtime.DockerLinuxContainerRuntime.ENV_DOCKER_CONTAINER_YARN_SYSFS">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="ENV_DOCKER_CONTAINER_DOCKER_RUNTIME"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>ENV_DOCKER_CONTAINER_DOCKER_RUNTIME</h4> |
| <pre>@InterfaceAudience.Private |
| public static final <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> ENV_DOCKER_CONTAINER_DOCKER_RUNTIME</pre> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../../../../../constant-values.html#org.apache.hadoop.yarn.server.nodemanager.containermanager.linux.runtime.DockerLinuxContainerRuntime.ENV_DOCKER_CONTAINER_DOCKER_RUNTIME">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="ENV_DOCKER_CONTAINER_DOCKER_SERVICE_MODE"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>ENV_DOCKER_CONTAINER_DOCKER_SERVICE_MODE</h4> |
| <pre>@InterfaceAudience.Private |
| public static final <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> ENV_DOCKER_CONTAINER_DOCKER_SERVICE_MODE</pre> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../../../../../constant-values.html#org.apache.hadoop.yarn.server.nodemanager.containermanager.linux.runtime.DockerLinuxContainerRuntime.ENV_DOCKER_CONTAINER_DOCKER_SERVICE_MODE">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="ENV_OCI_CONTAINER_PID_NAMESPACE"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>ENV_OCI_CONTAINER_PID_NAMESPACE</h4> |
| <pre>@InterfaceAudience.Private |
| public static final <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> ENV_OCI_CONTAINER_PID_NAMESPACE</pre> |
| </li> |
| </ul> |
| <a name="ENV_OCI_CONTAINER_RUN_PRIVILEGED_CONTAINER"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>ENV_OCI_CONTAINER_RUN_PRIVILEGED_CONTAINER</h4> |
| <pre>@InterfaceAudience.Private |
| public static final <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> ENV_OCI_CONTAINER_RUN_PRIVILEGED_CONTAINER</pre> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a name="DockerLinuxContainerRuntime-org.apache.hadoop.yarn.server.nodemanager.containermanager.linux.privileged.PrivilegedOperationExecutor-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>DockerLinuxContainerRuntime</h4> |
| <pre>public DockerLinuxContainerRuntime(<a href="../../../../../../../../../org/apache/hadoop/yarn/server/nodemanager/containermanager/linux/privileged/PrivilegedOperationExecutor.html" title="class in org.apache.hadoop.yarn.server.nodemanager.containermanager.linux.privileged">PrivilegedOperationExecutor</a> privilegedOperationExecutor)</pre> |
| <div class="block">Create an instance using the given <a href="../../../../../../../../../org/apache/hadoop/yarn/server/nodemanager/containermanager/linux/privileged/PrivilegedOperationExecutor.html" title="class in org.apache.hadoop.yarn.server.nodemanager.containermanager.linux.privileged"><code>PrivilegedOperationExecutor</code></a> |
| instance for performing operations.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>privilegedOperationExecutor</code> - the <a href="../../../../../../../../../org/apache/hadoop/yarn/server/nodemanager/containermanager/linux/privileged/PrivilegedOperationExecutor.html" title="class in org.apache.hadoop.yarn.server.nodemanager.containermanager.linux.privileged"><code>PrivilegedOperationExecutor</code></a> |
| instance</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="DockerLinuxContainerRuntime-org.apache.hadoop.yarn.server.nodemanager.containermanager.linux.privileged.PrivilegedOperationExecutor-org.apache.hadoop.yarn.server.nodemanager.containermanager.linux.resources.CGroupsHandler-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>DockerLinuxContainerRuntime</h4> |
| <pre>public DockerLinuxContainerRuntime(<a href="../../../../../../../../../org/apache/hadoop/yarn/server/nodemanager/containermanager/linux/privileged/PrivilegedOperationExecutor.html" title="class in org.apache.hadoop.yarn.server.nodemanager.containermanager.linux.privileged">PrivilegedOperationExecutor</a> privilegedOperationExecutor, |
| <a href="../../../../../../../../../org/apache/hadoop/yarn/server/nodemanager/containermanager/linux/resources/CGroupsHandler.html" title="interface in org.apache.hadoop.yarn.server.nodemanager.containermanager.linux.resources">CGroupsHandler</a> cGroupsHandler)</pre> |
| <div class="block">Create an instance using the given <a href="../../../../../../../../../org/apache/hadoop/yarn/server/nodemanager/containermanager/linux/privileged/PrivilegedOperationExecutor.html" title="class in org.apache.hadoop.yarn.server.nodemanager.containermanager.linux.privileged"><code>PrivilegedOperationExecutor</code></a> |
| instance for performing operations and the given <a href="../../../../../../../../../org/apache/hadoop/yarn/server/nodemanager/containermanager/linux/resources/CGroupsHandler.html" title="interface in org.apache.hadoop.yarn.server.nodemanager.containermanager.linux.resources"><code>CGroupsHandler</code></a> |
| instance. This constructor is intended for use in testing.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>privilegedOperationExecutor</code> - the <a href="../../../../../../../../../org/apache/hadoop/yarn/server/nodemanager/containermanager/linux/privileged/PrivilegedOperationExecutor.html" title="class in org.apache.hadoop.yarn.server.nodemanager.containermanager.linux.privileged"><code>PrivilegedOperationExecutor</code></a> |
| instance</dd> |
| <dd><code>cGroupsHandler</code> - the <a href="../../../../../../../../../org/apache/hadoop/yarn/server/nodemanager/containermanager/linux/resources/CGroupsHandler.html" title="interface in org.apache.hadoop.yarn.server.nodemanager.containermanager.linux.resources"><code>CGroupsHandler</code></a> instance</dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="isDockerContainerRequested-org.apache.hadoop.conf.Configuration-java.util.Map-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isDockerContainerRequested</h4> |
| <pre>public static boolean isDockerContainerRequested(org.apache.hadoop.conf.Configuration daemonConf, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>> env)</pre> |
| <div class="block">Return whether the given environment variables indicate that the operation |
| is requesting a Docker container. If the environment contains a key |
| called <code>YARN_CONTAINER_RUNTIME_TYPE</code> whose value is <code>docker</code>, |
| this method will return true. Otherwise it will return false.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>daemonConf</code> - the NodeManager daemon configuration</dd> |
| <dd><code>env</code> - the environment variable settings for the operation</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>whether a Docker container is requested</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="initialize-org.apache.hadoop.conf.Configuration-org.apache.hadoop.yarn.server.nodemanager.Context-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>initialize</h4> |
| <pre>public void initialize(org.apache.hadoop.conf.Configuration conf, |
| <a href="../../../../../../../../../org/apache/hadoop/yarn/server/nodemanager/Context.html" title="interface in org.apache.hadoop.yarn.server.nodemanager">Context</a> nmContext) |
| throws <a href="../../../../../../../../../org/apache/hadoop/yarn/server/nodemanager/containermanager/runtime/ContainerExecutionException.html" title="class in org.apache.hadoop.yarn.server.nodemanager.containermanager.runtime">ContainerExecutionException</a></pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../../../../../org/apache/hadoop/yarn/server/nodemanager/containermanager/linux/runtime/LinuxContainerRuntime.html#initialize-org.apache.hadoop.conf.Configuration-org.apache.hadoop.yarn.server.nodemanager.Context-">LinuxContainerRuntime</a></code></span></div> |
| <div class="block">Initialize the runtime.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../../../../../org/apache/hadoop/yarn/server/nodemanager/containermanager/linux/runtime/LinuxContainerRuntime.html#initialize-org.apache.hadoop.conf.Configuration-org.apache.hadoop.yarn.server.nodemanager.Context-">initialize</a></code> in interface <code><a href="../../../../../../../../../org/apache/hadoop/yarn/server/nodemanager/containermanager/linux/runtime/LinuxContainerRuntime.html" title="interface in org.apache.hadoop.yarn.server.nodemanager.containermanager.linux.runtime">LinuxContainerRuntime</a></code></dd> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="../../../../../../../../../org/apache/hadoop/yarn/server/nodemanager/containermanager/linux/runtime/OCIContainerRuntime.html#initialize-org.apache.hadoop.conf.Configuration-org.apache.hadoop.yarn.server.nodemanager.Context-">initialize</a></code> in class <code><a href="../../../../../../../../../org/apache/hadoop/yarn/server/nodemanager/containermanager/linux/runtime/OCIContainerRuntime.html" title="class in org.apache.hadoop.yarn.server.nodemanager.containermanager.linux.runtime">OCIContainerRuntime</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>conf</code> - the <code>Configuration</code> to use</dd> |
| <dd><code>nmContext</code> - NMContext</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../../../../../../../org/apache/hadoop/yarn/server/nodemanager/containermanager/runtime/ContainerExecutionException.html" title="class in org.apache.hadoop.yarn.server.nodemanager.containermanager.runtime">ContainerExecutionException</a></code> - if an error occurs while initializing |
| the runtime</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="isRuntimeRequested-java.util.Map-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isRuntimeRequested</h4> |
| <pre>public boolean isRuntimeRequested(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>> env)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../../../../../org/apache/hadoop/yarn/server/nodemanager/containermanager/linux/runtime/LinuxContainerRuntime.html#isRuntimeRequested-java.util.Map-">LinuxContainerRuntime</a></code></span></div> |
| <div class="block">Return whether the given environment variables indicate that the operation |
| is requesting this runtime.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>env</code> - the environment variable settings for the operation</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>whether this runtime is requested</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getCapabilities--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getCapabilities</h4> |
| <pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>> getCapabilities()</pre> |
| </li> |
| </ul> |
| <a name="addCGroupParentIfRequired-java.lang.String-java.lang.String-org.apache.hadoop.yarn.server.nodemanager.containermanager.linux.runtime.docker.DockerRunCommand-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addCGroupParentIfRequired</h4> |
| <pre>protected void addCGroupParentIfRequired(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> resourcesOptions, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> containerIdStr, |
| <a href="../../../../../../../../../org/apache/hadoop/yarn/server/nodemanager/containermanager/linux/runtime/docker/DockerRunCommand.html" title="class in org.apache.hadoop.yarn.server.nodemanager.containermanager.linux.runtime.docker">DockerRunCommand</a> runCommand)</pre> |
| <div class="block">If CGROUPS in enabled and not set to none, then set the CGROUP parent for |
| the command instance.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>resourcesOptions</code> - the resource options to check for "cgroups=none"</dd> |
| <dd><code>containerIdStr</code> - the container ID</dd> |
| <dd><code>runCommand</code> - the command to set with the CGROUP parent</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="launchContainer-org.apache.hadoop.yarn.server.nodemanager.containermanager.runtime.ContainerRuntimeContext-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>launchContainer</h4> |
| <pre>public void launchContainer(<a href="../../../../../../../../../org/apache/hadoop/yarn/server/nodemanager/containermanager/runtime/ContainerRuntimeContext.html" title="class in org.apache.hadoop.yarn.server.nodemanager.containermanager.runtime">ContainerRuntimeContext</a> ctx) |
| throws <a href="../../../../../../../../../org/apache/hadoop/yarn/server/nodemanager/containermanager/runtime/ContainerExecutionException.html" title="class in org.apache.hadoop.yarn.server.nodemanager.containermanager.runtime">ContainerExecutionException</a></pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../../../../../org/apache/hadoop/yarn/server/nodemanager/containermanager/runtime/ContainerRuntime.html#launchContainer-org.apache.hadoop.yarn.server.nodemanager.containermanager.runtime.ContainerRuntimeContext-">ContainerRuntime</a></code></span></div> |
| <div class="block">Launch a container.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>ctx</code> - the <a href="../../../../../../../../../org/apache/hadoop/yarn/server/nodemanager/containermanager/runtime/ContainerRuntimeContext.html" title="class in org.apache.hadoop.yarn.server.nodemanager.containermanager.runtime"><code>ContainerRuntimeContext</code></a></dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../../../../../../../org/apache/hadoop/yarn/server/nodemanager/containermanager/runtime/ContainerExecutionException.html" title="class in org.apache.hadoop.yarn.server.nodemanager.containermanager.runtime">ContainerExecutionException</a></code> - if an error occurs while launching |
| the container</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="relaunchContainer-org.apache.hadoop.yarn.server.nodemanager.containermanager.runtime.ContainerRuntimeContext-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>relaunchContainer</h4> |
| <pre>public void relaunchContainer(<a href="../../../../../../../../../org/apache/hadoop/yarn/server/nodemanager/containermanager/runtime/ContainerRuntimeContext.html" title="class in org.apache.hadoop.yarn.server.nodemanager.containermanager.runtime">ContainerRuntimeContext</a> ctx) |
| throws <a href="../../../../../../../../../org/apache/hadoop/yarn/server/nodemanager/containermanager/runtime/ContainerExecutionException.html" title="class in org.apache.hadoop.yarn.server.nodemanager.containermanager.runtime">ContainerExecutionException</a></pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../../../../../org/apache/hadoop/yarn/server/nodemanager/containermanager/runtime/ContainerRuntime.html#relaunchContainer-org.apache.hadoop.yarn.server.nodemanager.containermanager.runtime.ContainerRuntimeContext-">ContainerRuntime</a></code></span></div> |
| <div class="block">Relaunch a container.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>ctx</code> - the <a href="../../../../../../../../../org/apache/hadoop/yarn/server/nodemanager/containermanager/runtime/ContainerRuntimeContext.html" title="class in org.apache.hadoop.yarn.server.nodemanager.containermanager.runtime"><code>ContainerRuntimeContext</code></a></dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../../../../../../../org/apache/hadoop/yarn/server/nodemanager/containermanager/runtime/ContainerExecutionException.html" title="class in org.apache.hadoop.yarn.server.nodemanager.containermanager.runtime">ContainerExecutionException</a></code> - if an error occurs while relaunching |
| the container</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="signalContainer-org.apache.hadoop.yarn.server.nodemanager.containermanager.runtime.ContainerRuntimeContext-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>signalContainer</h4> |
| <pre>public void signalContainer(<a href="../../../../../../../../../org/apache/hadoop/yarn/server/nodemanager/containermanager/runtime/ContainerRuntimeContext.html" title="class in org.apache.hadoop.yarn.server.nodemanager.containermanager.runtime">ContainerRuntimeContext</a> ctx) |
| throws <a href="../../../../../../../../../org/apache/hadoop/yarn/server/nodemanager/containermanager/runtime/ContainerExecutionException.html" title="class in org.apache.hadoop.yarn.server.nodemanager.containermanager.runtime">ContainerExecutionException</a></pre> |
| <div class="block">Signal the docker container. |
| |
| Signals are used to check the liveliness of the container as well as to |
| stop/kill the container. The following outlines the docker container |
| signal handling. |
| |
| <ol> |
| <li>If the null signal is sent, run kill -0 on the pid. This is used |
| to check if the container is still alive, which is necessary for |
| reacquiring containers on NM restart.</li> |
| <li>If SIGTERM, SIGKILL is sent, attempt to stop and remove the docker |
| container.</li> |
| <li>If the docker container exists and is running, execute docker |
| stop.</li> |
| <li>If any other signal is sent, signal the container using docker |
| kill.</li> |
| </ol></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>ctx</code> - the <a href="../../../../../../../../../org/apache/hadoop/yarn/server/nodemanager/containermanager/runtime/ContainerRuntimeContext.html" title="class in org.apache.hadoop.yarn.server.nodemanager.containermanager.runtime"><code>ContainerRuntimeContext</code></a>.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../../../../../../../org/apache/hadoop/yarn/server/nodemanager/containermanager/runtime/ContainerExecutionException.html" title="class in org.apache.hadoop.yarn.server.nodemanager.containermanager.runtime">ContainerExecutionException</a></code> - if the signaling fails.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="reapContainer-org.apache.hadoop.yarn.server.nodemanager.containermanager.runtime.ContainerRuntimeContext-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>reapContainer</h4> |
| <pre>public void reapContainer(<a href="../../../../../../../../../org/apache/hadoop/yarn/server/nodemanager/containermanager/runtime/ContainerRuntimeContext.html" title="class in org.apache.hadoop.yarn.server.nodemanager.containermanager.runtime">ContainerRuntimeContext</a> ctx) |
| throws <a href="../../../../../../../../../org/apache/hadoop/yarn/server/nodemanager/containermanager/runtime/ContainerExecutionException.html" title="class in org.apache.hadoop.yarn.server.nodemanager.containermanager.runtime">ContainerExecutionException</a></pre> |
| <div class="block">Reap the docker container.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>ctx</code> - the <a href="../../../../../../../../../org/apache/hadoop/yarn/server/nodemanager/containermanager/runtime/ContainerRuntimeContext.html" title="class in org.apache.hadoop.yarn.server.nodemanager.containermanager.runtime"><code>ContainerRuntimeContext</code></a>.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../../../../../../../org/apache/hadoop/yarn/server/nodemanager/containermanager/runtime/ContainerExecutionException.html" title="class in org.apache.hadoop.yarn.server.nodemanager.containermanager.runtime">ContainerExecutionException</a></code> - if the removal fails.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="execContainer-org.apache.hadoop.yarn.server.nodemanager.executor.ContainerExecContext-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>execContainer</h4> |
| <pre>public org.apache.hadoop.hdfs.protocol.datatransfer.IOStreamPair execContainer(<a href="../../../../../../../../../org/apache/hadoop/yarn/server/nodemanager/executor/ContainerExecContext.html" title="class in org.apache.hadoop.yarn.server.nodemanager.executor">ContainerExecContext</a> ctx) |
| throws <a href="../../../../../../../../../org/apache/hadoop/yarn/server/nodemanager/containermanager/runtime/ContainerExecutionException.html" title="class in org.apache.hadoop.yarn.server.nodemanager.containermanager.runtime">ContainerExecutionException</a></pre> |
| <div class="block">Perform docker exec command into running container.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>ctx</code> - container exec context</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>IOStreams of docker exec</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../../../../../../../org/apache/hadoop/yarn/server/nodemanager/containermanager/runtime/ContainerExecutionException.html" title="class in org.apache.hadoop.yarn.server.nodemanager.containermanager.runtime">ContainerExecutionException</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getIpAndHost-org.apache.hadoop.yarn.server.nodemanager.containermanager.container.Container-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getIpAndHost</h4> |
| <pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[] getIpAndHost(<a href="../../../../../../../../../org/apache/hadoop/yarn/server/nodemanager/containermanager/container/Container.html" title="interface in org.apache.hadoop.yarn.server.nodemanager.containermanager.container">Container</a> container)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../../../../../org/apache/hadoop/yarn/server/nodemanager/containermanager/runtime/ContainerRuntime.html#getIpAndHost-org.apache.hadoop.yarn.server.nodemanager.containermanager.container.Container-">ContainerRuntime</a></code></span></div> |
| <div class="block">Return the host and ip of the container.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>container</code> - the <a href="../../../../../../../../../org/apache/hadoop/yarn/server/nodemanager/containermanager/container/Container.html" title="interface in org.apache.hadoop.yarn.server.nodemanager.containermanager.container"><code>Container</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getExposedPorts-org.apache.hadoop.yarn.server.nodemanager.containermanager.container.Container-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getExposedPorts</h4> |
| <pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> getExposedPorts(<a href="../../../../../../../../../org/apache/hadoop/yarn/server/nodemanager/containermanager/container/Container.html" title="interface in org.apache.hadoop.yarn.server.nodemanager.containermanager.container">Container</a> container)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../../../../../org/apache/hadoop/yarn/server/nodemanager/containermanager/runtime/ContainerRuntime.html#getExposedPorts-org.apache.hadoop.yarn.server.nodemanager.containermanager.container.Container-">ContainerRuntime</a></code></span></div> |
| <div class="block">Return the exposed ports of the container.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>container</code> - the <a href="../../../../../../../../../org/apache/hadoop/yarn/server/nodemanager/containermanager/container/Container.html" title="interface in org.apache.hadoop.yarn.server.nodemanager.containermanager.container"><code>Container</code></a></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>List of exposed ports</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="validateImageName-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>validateImageName</h4> |
| <pre>public static void validateImageName(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> imageName) |
| throws <a href="../../../../../../../../../org/apache/hadoop/yarn/server/nodemanager/containermanager/runtime/ContainerExecutionException.html" title="class in org.apache.hadoop.yarn.server.nodemanager.containermanager.runtime">ContainerExecutionException</a></pre> |
| <dl> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../../../../../../../org/apache/hadoop/yarn/server/nodemanager/containermanager/runtime/ContainerExecutionException.html" title="class in org.apache.hadoop.yarn.server.nodemanager.containermanager.runtime">ContainerExecutionException</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="pullImageFromRemote-java.lang.String-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>pullImageFromRemote</h4> |
| <pre>public void pullImageFromRemote(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> containerIdStr, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> imageName) |
| throws <a href="../../../../../../../../../org/apache/hadoop/yarn/server/nodemanager/containermanager/runtime/ContainerExecutionException.html" title="class in org.apache.hadoop.yarn.server.nodemanager.containermanager.runtime">ContainerExecutionException</a></pre> |
| <dl> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../../../../../../../org/apache/hadoop/yarn/server/nodemanager/containermanager/runtime/ContainerExecutionException.html" title="class in org.apache.hadoop.yarn.server.nodemanager.containermanager.runtime">ContainerExecutionException</a></code></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/DockerLinuxContainerRuntime.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/containermanager/linux/runtime/DelegatingLinuxContainerRuntime.html" title="class in org.apache.hadoop.yarn.server.nodemanager.containermanager.linux.runtime"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../../../../../org/apache/hadoop/yarn/server/nodemanager/containermanager/linux/runtime/JavaSandboxLinuxContainerRuntime.html" title="class in org.apache.hadoop.yarn.server.nodemanager.containermanager.linux.runtime"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../../../../index.html?org/apache/hadoop/yarn/server/nodemanager/containermanager/linux/runtime/DockerLinuxContainerRuntime.html" target="_top">Frames</a></li> |
| <li><a href="DockerLinuxContainerRuntime.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../../../../../../allclasses-noframe.html">All 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: </li> |
| <li>Nested | </li> |
| <li><a href="#field.summary">Field</a> | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li><a href="#field.detail">Field</a> | </li> |
| <li><a href="#constructor.detail">Constr</a> | </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 © 2008–2021 <a href="https://www.apache.org">Apache Software Foundation</a>. All rights reserved.</small></p> |
| </body> |
| </html> |
