Details

    • Type: Sub-task Sub-task
    • Status: Closed
    • Priority: Major Major
    • Resolution: Fixed
    • Affects Version/s: None
    • Fix Version/s: 2.3.0
    • Component/s: documentation
    • Labels:
      None
    • Hadoop Flags:
      Reviewed
    1. HDFS-5347.001.patch
      10 kB
      Brandon Li
    2. HDFS-5347.002.patch
      10 kB
      Brandon Li
    3. HDFS-5347.003.patch
      10 kB
      Brandon Li
    4. HDFS-5347.004.trunk.patch
      11 kB
      Brandon Li
    5. HdfsNfsGateway.html
      22 kB
      Brandon Li
    6. HdfsNfsGateway.new.html
      22 kB
      Brandon Li

      Issue Links

        Activity

        Hide
        Brandon Li added a comment -

        Uploaded the first draft along with the converted html file.

        Show
        Brandon Li added a comment - Uploaded the first draft along with the converted html file.
        Hide
        Brandon Li added a comment -

        Uploaded a new patch, which has more explanation for the mount options.

        Show
        Brandon Li added a comment - Uploaded a new patch, which has more explanation for the mount options.
        Hide
        Hadoop QA added a comment -

        +1 overall. Here are the results of testing the latest attachment
        http://issues.apache.org/jira/secure/attachment/12608838/HDFS-5347.001.patch
        against trunk revision .

        +1 @author. The patch does not contain any @author tags.

        +0 tests included. The patch appears to be a documentation patch that doesn't require tests.

        +1 javac. The applied patch does not increase the total number of javac compiler warnings.

        +1 javadoc. The javadoc tool did not generate any warning messages.

        +1 eclipse:eclipse. The patch built with eclipse:eclipse.

        +1 findbugs. The patch does not introduce any new Findbugs (version 1.3.9) warnings.

        +1 release audit. The applied patch does not increase the total number of release audit warnings.

        +1 core tests. The patch passed unit tests in hadoop-hdfs-project/hadoop-hdfs.

        +1 contrib tests. The patch passed contrib unit tests.

        Test results: https://builds.apache.org/job/PreCommit-HDFS-Build/5219//testReport/
        Console output: https://builds.apache.org/job/PreCommit-HDFS-Build/5219//console

        This message is automatically generated.

        Show
        Hadoop QA added a comment - +1 overall . Here are the results of testing the latest attachment http://issues.apache.org/jira/secure/attachment/12608838/HDFS-5347.001.patch against trunk revision . +1 @author . The patch does not contain any @author tags. +0 tests included . The patch appears to be a documentation patch that doesn't require tests. +1 javac . The applied patch does not increase the total number of javac compiler warnings. +1 javadoc . The javadoc tool did not generate any warning messages. +1 eclipse:eclipse . The patch built with eclipse:eclipse. +1 findbugs . The patch does not introduce any new Findbugs (version 1.3.9) warnings. +1 release audit . The applied patch does not increase the total number of release audit warnings. +1 core tests . The patch passed unit tests in hadoop-hdfs-project/hadoop-hdfs. +1 contrib tests . The patch passed contrib unit tests. Test results: https://builds.apache.org/job/PreCommit-HDFS-Build/5219//testReport/ Console output: https://builds.apache.org/job/PreCommit-HDFS-Build/5219//console This message is automatically generated.
        Hide
        Hadoop QA added a comment -

        +1 overall. Here are the results of testing the latest attachment
        http://issues.apache.org/jira/secure/attachment/12608838/HDFS-5347.001.patch
        against trunk revision .

        +1 @author. The patch does not contain any @author tags.

        +0 tests included. The patch appears to be a documentation patch that doesn't require tests.

        +1 javac. The applied patch does not increase the total number of javac compiler warnings.

        +1 javadoc. The javadoc tool did not generate any warning messages.

        +1 eclipse:eclipse. The patch built with eclipse:eclipse.

        +1 findbugs. The patch does not introduce any new Findbugs (version 1.3.9) warnings.

        +1 release audit. The applied patch does not increase the total number of release audit warnings.

        +1 core tests. The patch passed unit tests in hadoop-hdfs-project/hadoop-hdfs.

        +1 contrib tests. The patch passed contrib unit tests.

        Test results: https://builds.apache.org/job/PreCommit-HDFS-Build/5220//testReport/
        Console output: https://builds.apache.org/job/PreCommit-HDFS-Build/5220//console

        This message is automatically generated.

        Show
        Hadoop QA added a comment - +1 overall . Here are the results of testing the latest attachment http://issues.apache.org/jira/secure/attachment/12608838/HDFS-5347.001.patch against trunk revision . +1 @author . The patch does not contain any @author tags. +0 tests included . The patch appears to be a documentation patch that doesn't require tests. +1 javac . The applied patch does not increase the total number of javac compiler warnings. +1 javadoc . The javadoc tool did not generate any warning messages. +1 eclipse:eclipse . The patch built with eclipse:eclipse. +1 findbugs . The patch does not introduce any new Findbugs (version 1.3.9) warnings. +1 release audit . The applied patch does not increase the total number of release audit warnings. +1 core tests . The patch passed unit tests in hadoop-hdfs-project/hadoop-hdfs. +1 contrib tests . The patch passed contrib unit tests. Test results: https://builds.apache.org/job/PreCommit-HDFS-Build/5220//testReport/ Console output: https://builds.apache.org/job/PreCommit-HDFS-Build/5220//console This message is automatically generated.
        Hide
        Hadoop QA added a comment -

        +1 overall. Here are the results of testing the latest attachment
        http://issues.apache.org/jira/secure/attachment/12608856/HDFS-5347.002.patch
        against trunk revision .

        +1 @author. The patch does not contain any @author tags.

        +0 tests included. The patch appears to be a documentation patch that doesn't require tests.

        +1 javac. The applied patch does not increase the total number of javac compiler warnings.

        +1 javadoc. The javadoc tool did not generate any warning messages.

        +1 eclipse:eclipse. The patch built with eclipse:eclipse.

        +1 findbugs. The patch does not introduce any new Findbugs (version 1.3.9) warnings.

        +1 release audit. The applied patch does not increase the total number of release audit warnings.

        +1 core tests. The patch passed unit tests in hadoop-hdfs-project/hadoop-hdfs.

        +1 contrib tests. The patch passed contrib unit tests.

        Test results: https://builds.apache.org/job/PreCommit-HDFS-Build/5221//testReport/
        Console output: https://builds.apache.org/job/PreCommit-HDFS-Build/5221//console

        This message is automatically generated.

        Show
        Hadoop QA added a comment - +1 overall . Here are the results of testing the latest attachment http://issues.apache.org/jira/secure/attachment/12608856/HDFS-5347.002.patch against trunk revision . +1 @author . The patch does not contain any @author tags. +0 tests included . The patch appears to be a documentation patch that doesn't require tests. +1 javac . The applied patch does not increase the total number of javac compiler warnings. +1 javadoc . The javadoc tool did not generate any warning messages. +1 eclipse:eclipse . The patch built with eclipse:eclipse. +1 findbugs . The patch does not introduce any new Findbugs (version 1.3.9) warnings. +1 release audit . The applied patch does not increase the total number of release audit warnings. +1 core tests . The patch passed unit tests in hadoop-hdfs-project/hadoop-hdfs. +1 contrib tests . The patch passed contrib unit tests. Test results: https://builds.apache.org/job/PreCommit-HDFS-Build/5221//testReport/ Console output: https://builds.apache.org/job/PreCommit-HDFS-Build/5221//console This message is automatically generated.
        Hide
        Jing Zhao added a comment -

        The document looks great. Some minors and nits:

        1. "uses" should be "users" in the following
          +  * By default, the export can be mounted by any client. To better control the access,
          +    uses can update the following property. The value string contains machine name and
          
        2. "specifies rw or ro " can be "uses rw or ro to specify read-write or read-only". Also there should be a space after "networks."
          +    characters. Machine name format can be single host, wildcards, and IPv4 networks.The
          +    access privilege specifies rw or ro access of the machines to exports.If the access
          
        3. "especially ONCRPC" --> "especially for ONCRPC"?
          +   to add the following. Note, debug trace, especially ONCRPC, can be very verbose.
          
        4. "trace level" is not consistent with "DEBUG" in the example?
          +    To change trace level:
          +
          +----------------------------------------------- 
          +    log4j.logger.org.apache.hadoop.hdfs.nfs=DEBUG
          +----------------------------------------------- 
          
        5. admin and hdfs here can be "admin" and "hdfs" to make it more clear?
          +  For example, if the NFS client has current user as admin, when the user accesses
          +  the mounted directory, NFS gateway will access HDFS as user admin. To access HDFS
          +  as hdfs user, you must first switch the current user to hdfs on the client system
          
        6. The following line can be divided into two sentences?
          +  NFS gateway converts UID to user name and HDFS uses username for checking permissions.
          
        Show
        Jing Zhao added a comment - The document looks great. Some minors and nits: "uses" should be "users" in the following + * By default , the export can be mounted by any client. To better control the access, + uses can update the following property. The value string contains machine name and "specifies rw or ro " can be "uses rw or ro to specify read-write or read-only". Also there should be a space after "networks." + characters. Machine name format can be single host, wildcards, and IPv4 networks.The + access privilege specifies rw or ro access of the machines to exports.If the access "especially ONCRPC" --> "especially for ONCRPC"? + to add the following. Note, debug trace, especially ONCRPC, can be very verbose. "trace level" is not consistent with "DEBUG" in the example? + To change trace level: + +----------------------------------------------- + log4j.logger.org.apache.hadoop.hdfs.nfs=DEBUG +----------------------------------------------- admin and hdfs here can be "admin" and "hdfs" to make it more clear? + For example, if the NFS client has current user as admin, when the user accesses + the mounted directory, NFS gateway will access HDFS as user admin. To access HDFS + as hdfs user, you must first switch the current user to hdfs on the client system The following line can be divided into two sentences? + NFS gateway converts UID to user name and HDFS uses username for checking permissions.
        Hide
        Brandon Li added a comment -

        Thank you, Jing. I've uploaded a new patch to address the comments.

        Show
        Brandon Li added a comment - Thank you, Jing. I've uploaded a new patch to address the comments.
        Hide
        Hadoop QA added a comment -

        +1 overall. Here are the results of testing the latest attachment
        http://issues.apache.org/jira/secure/attachment/12609234/HDFS-5347.003.patch
        against trunk revision .

        +1 @author. The patch does not contain any @author tags.

        +0 tests included. The patch appears to be a documentation patch that doesn't require tests.

        +1 javac. The applied patch does not increase the total number of javac compiler warnings.

        +1 javadoc. The javadoc tool did not generate any warning messages.

        +1 eclipse:eclipse. The patch built with eclipse:eclipse.

        +1 findbugs. The patch does not introduce any new Findbugs (version 1.3.9) warnings.

        +1 release audit. The applied patch does not increase the total number of release audit warnings.

        +1 core tests. The patch passed unit tests in hadoop-hdfs-project/hadoop-hdfs.

        +1 contrib tests. The patch passed contrib unit tests.

        Test results: https://builds.apache.org/job/PreCommit-HDFS-Build/5240//testReport/
        Console output: https://builds.apache.org/job/PreCommit-HDFS-Build/5240//console

        This message is automatically generated.

        Show
        Hadoop QA added a comment - +1 overall . Here are the results of testing the latest attachment http://issues.apache.org/jira/secure/attachment/12609234/HDFS-5347.003.patch against trunk revision . +1 @author . The patch does not contain any @author tags. +0 tests included . The patch appears to be a documentation patch that doesn't require tests. +1 javac . The applied patch does not increase the total number of javac compiler warnings. +1 javadoc . The javadoc tool did not generate any warning messages. +1 eclipse:eclipse . The patch built with eclipse:eclipse. +1 findbugs . The patch does not introduce any new Findbugs (version 1.3.9) warnings. +1 release audit . The applied patch does not increase the total number of release audit warnings. +1 core tests . The patch passed unit tests in hadoop-hdfs-project/hadoop-hdfs. +1 contrib tests . The patch passed contrib unit tests. Test results: https://builds.apache.org/job/PreCommit-HDFS-Build/5240//testReport/ Console output: https://builds.apache.org/job/PreCommit-HDFS-Build/5240//console This message is automatically generated.
        Hide
        Suresh Srinivas added a comment - - edited

        Brandon, thanks for the excellent documentation.

        Minor comments:

        • "This directory is used to temporarily save out-of-order writes before writing to HDFS." mention the current memory limit beyond which we dump the out-of-order data.
        • symlink - we should say it is disabled on 2.2.0 or remove that section completely. The documentation for future releases could cover it when the feature is enabled back. We should create a jira for adding symlink section covering this for 2.3.0.
        Show
        Suresh Srinivas added a comment - - edited Brandon, thanks for the excellent documentation. Minor comments: "This directory is used to temporarily save out-of-order writes before writing to HDFS." mention the current memory limit beyond which we dump the out-of-order data. symlink - we should say it is disabled on 2.2.0 or remove that section completely. The documentation for future releases could cover it when the feature is enabled back. We should create a jira for adding symlink section covering this for 2.3.0.
        Hide
        Suresh Srinivas added a comment -

        +1 with the above comments addressed.

        Show
        Suresh Srinivas added a comment - +1 with the above comments addressed.
        Hide
        Brandon Li added a comment -

        Thank you, Suresh.
        I've updated the patch to address the comments.I will also upload a patch for branch-2.* with no symlink support in the guide.

        Show
        Brandon Li added a comment - Thank you, Suresh. I've updated the patch to address the comments.I will also upload a patch for branch-2.* with no symlink support in the guide.
        Hide
        Brandon Li added a comment -

        Actually we can use the same patch for branch-2.* since the symlink related content has been removed from the guide.

        Show
        Brandon Li added a comment - Actually we can use the same patch for branch-2.* since the symlink related content has been removed from the guide.
        Hide
        Hadoop QA added a comment -

        -1 overall. Here are the results of testing the latest attachment
        http://issues.apache.org/jira/secure/attachment/12609505/HDFS-5347.004.trunk.patch
        against trunk revision .

        +1 @author. The patch does not contain any @author tags.

        +0 tests included. The patch appears to be a documentation patch that doesn't require tests.

        +1 javac. The applied patch does not increase the total number of javac compiler warnings.

        +1 javadoc. The javadoc tool did not generate any warning messages.

        +1 eclipse:eclipse. The patch built with eclipse:eclipse.

        +1 findbugs. The patch does not introduce any new Findbugs (version 1.3.9) warnings.

        +1 release audit. The applied patch does not increase the total number of release audit warnings.

        -1 core tests. The patch failed these unit tests in hadoop-hdfs-project/hadoop-hdfs:

        org.apache.hadoop.hdfs.server.balancer.TestBalancerWithNodeGroup

        +1 contrib tests. The patch passed contrib unit tests.

        Test results: https://builds.apache.org/job/PreCommit-HDFS-Build/5250//testReport/
        Console output: https://builds.apache.org/job/PreCommit-HDFS-Build/5250//console

        This message is automatically generated.

        Show
        Hadoop QA added a comment - -1 overall . Here are the results of testing the latest attachment http://issues.apache.org/jira/secure/attachment/12609505/HDFS-5347.004.trunk.patch against trunk revision . +1 @author . The patch does not contain any @author tags. +0 tests included . The patch appears to be a documentation patch that doesn't require tests. +1 javac . The applied patch does not increase the total number of javac compiler warnings. +1 javadoc . The javadoc tool did not generate any warning messages. +1 eclipse:eclipse . The patch built with eclipse:eclipse. +1 findbugs . The patch does not introduce any new Findbugs (version 1.3.9) warnings. +1 release audit . The applied patch does not increase the total number of release audit warnings. -1 core tests . The patch failed these unit tests in hadoop-hdfs-project/hadoop-hdfs: org.apache.hadoop.hdfs.server.balancer.TestBalancerWithNodeGroup +1 contrib tests . The patch passed contrib unit tests. Test results: https://builds.apache.org/job/PreCommit-HDFS-Build/5250//testReport/ Console output: https://builds.apache.org/job/PreCommit-HDFS-Build/5250//console This message is automatically generated.
        Hide
        Brandon Li added a comment -

        Thank you, Jing and Suresh, for the review!
        I've committed the patch.

        Show
        Brandon Li added a comment - Thank you, Jing and Suresh, for the review! I've committed the patch.
        Hide
        Hudson added a comment -

        SUCCESS: Integrated in Hadoop-trunk-Commit #4638 (See https://builds.apache.org/job/Hadoop-trunk-Commit/4638/)
        HDFS-5347. Add HDFS NFS user guide. Contributed by Brandon Li (brandonli: http://svn.apache.org/viewcvs.cgi/?root=Apache-SVN&view=rev&rev=1534377)

        • /hadoop/common/trunk/hadoop-hdfs-project/hadoop-hdfs/CHANGES.txt
        • /hadoop/common/trunk/hadoop-hdfs-project/hadoop-hdfs/src/site/apt/HdfsNfsGateway.apt.vm
        • /hadoop/common/trunk/hadoop-project/src/site/site.xml
        Show
        Hudson added a comment - SUCCESS: Integrated in Hadoop-trunk-Commit #4638 (See https://builds.apache.org/job/Hadoop-trunk-Commit/4638/ ) HDFS-5347 . Add HDFS NFS user guide. Contributed by Brandon Li (brandonli: http://svn.apache.org/viewcvs.cgi/?root=Apache-SVN&view=rev&rev=1534377 ) /hadoop/common/trunk/hadoop-hdfs-project/hadoop-hdfs/CHANGES.txt /hadoop/common/trunk/hadoop-hdfs-project/hadoop-hdfs/src/site/apt/HdfsNfsGateway.apt.vm /hadoop/common/trunk/hadoop-project/src/site/site.xml
        Hide
        Brandon Li added a comment -

        Upload the generated html file by the latest patch.

        Show
        Brandon Li added a comment - Upload the generated html file by the latest patch.
        Hide
        Hudson added a comment -

        SUCCESS: Integrated in Hadoop-Yarn-trunk #370 (See https://builds.apache.org/job/Hadoop-Yarn-trunk/370/)
        HDFS-5347. Add HDFS NFS user guide. Contributed by Brandon Li (brandonli: http://svn.apache.org/viewcvs.cgi/?root=Apache-SVN&view=rev&rev=1534377)

        • /hadoop/common/trunk/hadoop-hdfs-project/hadoop-hdfs/CHANGES.txt
        • /hadoop/common/trunk/hadoop-hdfs-project/hadoop-hdfs/src/site/apt/HdfsNfsGateway.apt.vm
        • /hadoop/common/trunk/hadoop-project/src/site/site.xml
        Show
        Hudson added a comment - SUCCESS: Integrated in Hadoop-Yarn-trunk #370 (See https://builds.apache.org/job/Hadoop-Yarn-trunk/370/ ) HDFS-5347 . Add HDFS NFS user guide. Contributed by Brandon Li (brandonli: http://svn.apache.org/viewcvs.cgi/?root=Apache-SVN&view=rev&rev=1534377 ) /hadoop/common/trunk/hadoop-hdfs-project/hadoop-hdfs/CHANGES.txt /hadoop/common/trunk/hadoop-hdfs-project/hadoop-hdfs/src/site/apt/HdfsNfsGateway.apt.vm /hadoop/common/trunk/hadoop-project/src/site/site.xml
        Hide
        Hudson added a comment -

        FAILURE: Integrated in Hadoop-Hdfs-trunk #1560 (See https://builds.apache.org/job/Hadoop-Hdfs-trunk/1560/)
        HDFS-5347. Add HDFS NFS user guide. Contributed by Brandon Li (brandonli: http://svn.apache.org/viewcvs.cgi/?root=Apache-SVN&view=rev&rev=1534377)

        • /hadoop/common/trunk/hadoop-hdfs-project/hadoop-hdfs/CHANGES.txt
        • /hadoop/common/trunk/hadoop-hdfs-project/hadoop-hdfs/src/site/apt/HdfsNfsGateway.apt.vm
        • /hadoop/common/trunk/hadoop-project/src/site/site.xml
        Show
        Hudson added a comment - FAILURE: Integrated in Hadoop-Hdfs-trunk #1560 (See https://builds.apache.org/job/Hadoop-Hdfs-trunk/1560/ ) HDFS-5347 . Add HDFS NFS user guide. Contributed by Brandon Li (brandonli: http://svn.apache.org/viewcvs.cgi/?root=Apache-SVN&view=rev&rev=1534377 ) /hadoop/common/trunk/hadoop-hdfs-project/hadoop-hdfs/CHANGES.txt /hadoop/common/trunk/hadoop-hdfs-project/hadoop-hdfs/src/site/apt/HdfsNfsGateway.apt.vm /hadoop/common/trunk/hadoop-project/src/site/site.xml
        Hide
        Hudson added a comment -

        FAILURE: Integrated in Hadoop-Mapreduce-trunk #1586 (See https://builds.apache.org/job/Hadoop-Mapreduce-trunk/1586/)
        HDFS-5347. Add HDFS NFS user guide. Contributed by Brandon Li (brandonli: http://svn.apache.org/viewcvs.cgi/?root=Apache-SVN&view=rev&rev=1534377)

        • /hadoop/common/trunk/hadoop-hdfs-project/hadoop-hdfs/CHANGES.txt
        • /hadoop/common/trunk/hadoop-hdfs-project/hadoop-hdfs/src/site/apt/HdfsNfsGateway.apt.vm
        • /hadoop/common/trunk/hadoop-project/src/site/site.xml
        Show
        Hudson added a comment - FAILURE: Integrated in Hadoop-Mapreduce-trunk #1586 (See https://builds.apache.org/job/Hadoop-Mapreduce-trunk/1586/ ) HDFS-5347 . Add HDFS NFS user guide. Contributed by Brandon Li (brandonli: http://svn.apache.org/viewcvs.cgi/?root=Apache-SVN&view=rev&rev=1534377 ) /hadoop/common/trunk/hadoop-hdfs-project/hadoop-hdfs/CHANGES.txt /hadoop/common/trunk/hadoop-hdfs-project/hadoop-hdfs/src/site/apt/HdfsNfsGateway.apt.vm /hadoop/common/trunk/hadoop-project/src/site/site.xml

          People

          • Assignee:
            Brandon Li
            Reporter:
            Brandon Li
          • Votes:
            0 Vote for this issue
            Watchers:
            10 Start watching this issue

            Dates

            • Created:
              Updated:
              Resolved:

              Development