[jira] [Commented] (YARN-5455) LinuxContainerExecutor needs Javadocs

["Varun Vasudev (JIRA)" <ji...@apache.org>]

    [ https://issues.apache.org/jira/browse/YARN-5455?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=15406194#comment-15406194 ] 

Varun Vasudev commented on YARN-5455:
-------------------------------------

Thanks for the patch [~templedf]!
{code}
+ * <ul>
+ *   <li>
+ *     {@code YARN_CONTAINER_RUNTIME_DOCKER_IMAGE} names which image
+ *     will be used to launch the Docker container.
+ *   </li>
+ *   <li>
+ *     {@code YARN_CONTAINER_RUNTIME_DOCKER_IMAGE_FILE} is currently ignored.
+ *   </li>
+ *   <li>
+ *     {@code YARN_CONTAINER_RUNTIME_DOCKER_RUN_OVERRIDE_DISABLE} controls
+ *     whether the Docker container's default command is overridden.  When set
+ *     to {@code true}, the Docker container's command will be
+ *     {@code bash <path_to_launch_script>}. When unset or set to {@code false}
+ *     the Docker container's default command is used.
+ *   </li>
+ *   <li>
+ *     {@code YARN_CONTAINER_RUNTIME_DOCKER_CONTAINER_NETWORK} 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}
+ *     property.
+ *   </li>
+ *   <li>
+ *     {@code YARN_CONTAINER_RUNTIME_DOCKER_RUN_PRIVILEGED_CONTAINER}
+ *     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}
+ *     property must be set to {@code true}, and the application owner must
+ *     appear in the value of the
+ *     {@code yarn.nodemanager.runtime.linux.docker.privileged-containers.acl}
+ *     property. If this environment variable is set to {@code true}, 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_LOCAL_RESOURCE_MOUNTS} adds
+ *     additional volume mounts to 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}, where the
+ *     source is an absolute path that is not a symlink and that points to a
+ *     localized resource.
+ *   </li>
+* </ul>
{code}

Maybe we should move this section into the DockerLinuxContainerRuntime.java and replace the section I highlighted with links to the actual runtime classes(DefaultLinuxContainerRuntime, DelegatingLinuxContainerRuntime, DockerLinuxContainerRuntime)?

The rest of it looks good to me.

> LinuxContainerExecutor needs Javadocs
> -------------------------------------
>
>                 Key: YARN-5455
>                 URL: https://issues.apache.org/jira/browse/YARN-5455
>             Project: Hadoop YARN
>          Issue Type: Improvement
>          Components: nodemanager
>    Affects Versions: 2.8.0
>            Reporter: Daniel Templeton
>            Assignee: Daniel Templeton
>         Attachments: YARN-5455.001.patch, YARN-5455.002.patch
>
>
> 'Nuff said.



--
This message was sent by Atlassian JIRA
(v6.3.4#6332)

---------------------------------------------------------------------
To unsubscribe, e-mail: yarn-issues-unsubscribe@hadoop.apache.org
For additional commands, e-mail: yarn-issues-help@hadoop.apache.org