[jira] [Commented] (YARN-2317) Update documentation about how to write YARN applications

["Zhijie Shen (JIRA)" <ji...@apache.org>]

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

Zhijie Shen commented on YARN-2317:
-----------------------------------

[~gtCarrera9], thanks for updating this document, which I think will be really helpful to the new YARN app developers. I read through the updated document, and it looks good to me in general. I've some minor comments so far:

0. Resource Manager -> ResourceManager, Node Manager -> NodeManager, Application Master -> ApplicationMaster

1. application submission context
{code}
+  client can then set up application context, prepare the very first container of
{code}

2. Should ignore "Unix", it is expected to work on windows as well.
{code}
Unix environment settings
{code}

3. YARN cluster
{code}
+  YARN platform, and handles application execution. It performs operations in an
{code}

4. object
{code}
+  <<<AMRMClientAsync>>> objects, with event handling methods specified in a
{code}

5. Don't say event. Users don't need to know the internal, 4 callback methods?
{code}
+  <<<NMClientAsync>>>. Typical container events include start, stop, status
{code}

6. "Use Runnable objects to launch containers." can be removed, because it's not necessary to be on a separate thread.
{code}
+    Use Runnable objects to launch containers. Communicate with node managers
{code}

7. ContainerManagerProtocol
{code}
+      ApplicationMasterProtocol and ContainerManager) are still preserved. The
{code}

8. Is this still valid?
{code}
+  // Set the necessary security tokens as needed
+  //amContainer.setContainerTokens(containerToken);
{code}

9. Perhaps you want to mention unregistration after the AM determines the work is done.

10. In Useful Links section, how about linking to the analog webpages on this web site: YARN Architecture and Capacity Scheduler

11. In Sample Code section, maybe we don't want to talk about the IDE. And maybe call it sample application?

BTW, I looked into the updated webpage directly, instead of doing side-by-side comparison between the old and the new webpages. It would be great if you can comment what are the itemized significant changes in your patch, such that the community can be aware of them.

> Update documentation about how to write YARN applications
> ---------------------------------------------------------
>
>                 Key: YARN-2317
>                 URL: https://issues.apache.org/jira/browse/YARN-2317
>             Project: Hadoop YARN
>          Issue Type: Sub-task
>          Components: documentation
>            Reporter: Li Lu
>            Assignee: Li Lu
>             Fix For: 2.6.0
>
>         Attachments: YARN-2317-071714.patch, YARN-2317-073014-1.patch, YARN-2317-073014.patch
>
>
> Some information in WritingYarnApplications webpage is out-dated. Need some refresh work on this document to reflect the most recent changes in YARN APIs. 



--
This message was sent by Atlassian JIRA
(v6.2#6252)