YARN-8748. Javadoc warnings within the nodemanager package. Contributed by Craig Condit

This commit is contained in:
Shane Kumpf 2018-09-14 10:28:36 -06:00
parent 99237607bf
commit 78902f0250
3 changed files with 22 additions and 11 deletions

View File

@ -53,6 +53,7 @@
import org.apache.hadoop.yarn.server.nodemanager.containermanager.container.Container;
import org.apache.hadoop.yarn.server.nodemanager.containermanager.container.ContainerDiagnosticsUpdateEvent;
import org.apache.hadoop.yarn.server.nodemanager.containermanager.launcher.ContainerLaunch;
import org.apache.hadoop.yarn.server.nodemanager.containermanager.launcher.ContainerLaunch.ShellScriptBuilder;
import org.apache.hadoop.yarn.server.nodemanager.containermanager.runtime.ContainerExecutionException;
import org.apache.hadoop.yarn.server.nodemanager.executor.ContainerPrepareContext;
import org.apache.hadoop.yarn.server.nodemanager.util.NodeManagerHardwareUtils;
@ -88,7 +89,7 @@ public abstract class ContainerExecutor implements Configurable {
/**
* The relative path to which debug information will be written.
*
* @see ContainerLaunch.ShellScriptBuilder#listDebugInformation
* @see ShellScriptBuilder#listDebugInformation
*/
public static final String DIRECTORY_CONTENTS = "directory.info";

View File

@ -241,7 +241,7 @@ public Map<ContainerId, Integer> getBytesSentPerContainer()
* Cleanup operations once container is completed - deletes cgroup and
* removes traffic shaping rule(s).
* @param containerId of the container that was completed.
* @return
* @return null
* @throws ResourceHandlerException
*/
@Override

View File

@ -73,7 +73,8 @@
*
* <ul>
* <li>
* {@value YarnConfiguration#YARN_CONTAINER_SANDBOX} :
* {@value
* org.apache.hadoop.yarn.conf.YarnConfiguration#YARN_CONTAINER_SANDBOX} :
* This yarn-site.xml setting has three options:
* <ul>
* <li>disabled - Default behavior. {@link LinuxContainerRuntime}
@ -86,26 +87,33 @@
* </ul>
* </li>
* <li>
* {@value YarnConfiguration#YARN_CONTAINER_SANDBOX_FILE_PERMISSIONS} :
* {@value
* org.apache.hadoop.yarn.conf.YarnConfiguration#YARN_CONTAINER_SANDBOX_FILE_PERMISSIONS}
* :
* Determines the file permissions for the application directories. The
* permissions come in the form of comma separated values
* (e.g. read,write,execute,delete). Defaults to {@code read} for read-only.
* </li>
* <li>
* {@value YarnConfiguration#YARN_CONTAINER_SANDBOX_POLICY} :
* {@value
* org.apache.hadoop.yarn.conf.YarnConfiguration#YARN_CONTAINER_SANDBOX_POLICY}
* :
* Accepts canonical path to a java policy file on the local filesystem.
* This file will be loaded as the base policy, any additional container
* grants will be appended to this base file. If not specified, the default
* java.policy file provided with hadoop resources will be used.
* </li>
* <li>
* {@value YarnConfiguration#YARN_CONTAINER_SANDBOX_WHITELIST_GROUP} :
* {@value
* org.apache.hadoop.yarn.conf.YarnConfiguration#YARN_CONTAINER_SANDBOX_WHITELIST_GROUP}
* :
* Optional setting to specify a YARN queue which will be exempt from the
* sand-boxing process.
* </li>
* <li>
* {@value
* YarnConfiguration#YARN_CONTAINER_SANDBOX_POLICY_GROUP_PREFIX}$groupName :
* org.apache.hadoop.yarn.conf.YarnConfiguration#YARN_CONTAINER_SANDBOX_POLICY_GROUP_PREFIX}$groupName
* :
* Optional setting to map groups to java policy files. The value is a path
* to the java policy file for $groupName. A user which is a member of
* multiple groups with different policies will receive the superset of all
@ -197,9 +205,10 @@ private void initializePolicyDir() throws ContainerExecutionException {
* <br>
* The Java Sandbox will be circumvented if the user is a member of the
* group specified in:
* {@value YarnConfiguration#YARN_CONTAINER_SANDBOX_WHITELIST_GROUP} and if
* they do not include the JVM flag:
* {@value NMContainerPolicyUtils#SECURITY_FLAG}
* {@value
* org.apache.hadoop.yarn.conf.YarnConfiguration#YARN_CONTAINER_SANDBOX_WHITELIST_GROUP}
* and if they do not include the JVM flag
* <code>-Djava.security.manager</code>.
*
* @param ctx The {@link ContainerRuntimeContext} containing container
* setup properties.
@ -281,7 +290,8 @@ public void relaunchContainer(ContainerRuntimeContext ctx)
/**
* Determine if JVMSandboxLinuxContainerRuntime should be used. This is
* decided based on the value of
* {@value YarnConfiguration#YARN_CONTAINER_SANDBOX}
* {@value
* org.apache.hadoop.yarn.conf.YarnConfiguration#YARN_CONTAINER_SANDBOX}
* @param env the environment variable settings for the operation
* @return true if Sandbox is requested, false otherwise
*/