Uploaded image for project: 'Hadoop Common'
  1. Hadoop Common
  2. HADOOP-12786

"hadoop key" command usage is not documented

    Details

    • Hadoop Flags:
      Reviewed

      Description

      I found "hadoop key" command usage is not documented when reviewing HDFS-9784.
      In addition, we should document that uppercase is not allowed for key name.

      1. HADOOP-12786.01.patch
        3 kB
        Xiao Chen
      2. HADOOP-12786.02.patch
        3 kB
        Xiao Chen
      3. CommandsManual.html
        39 kB
        Xiao Chen

        Issue Links

          Activity

          Hide
          vinodkv Vinod Kumar Vavilapalli added a comment -

          Closing the JIRA as part of 2.7.3 release.

          Show
          vinodkv Vinod Kumar Vavilapalli added a comment - Closing the JIRA as part of 2.7.3 release.
          Hide
          xiaochen Xiao Chen added a comment -

          Thank you Akira Ajisaka for the review and commit!

          Show
          xiaochen Xiao Chen added a comment - Thank you Akira Ajisaka for the review and commit!
          Hide
          hudson Hudson added a comment -

          FAILURE: Integrated in Hadoop-trunk-Commit #9303 (See https://builds.apache.org/job/Hadoop-trunk-Commit/9303/)
          HADOOP-12786. "hadoop key" command usage is not documented. Contributed (aajisaka: rev 1c48e50ce71fd0e38740d69ce1e03119dca97a38)

          • hadoop-common-project/hadoop-common/CHANGES.txt
          • hadoop-common-project/hadoop-common/src/main/java/org/apache/hadoop/crypto/key/KeyShell.java
          • hadoop-common-project/hadoop-common/src/site/markdown/CommandsManual.md
          Show
          hudson Hudson added a comment - FAILURE: Integrated in Hadoop-trunk-Commit #9303 (See https://builds.apache.org/job/Hadoop-trunk-Commit/9303/ ) HADOOP-12786 . "hadoop key" command usage is not documented. Contributed (aajisaka: rev 1c48e50ce71fd0e38740d69ce1e03119dca97a38) hadoop-common-project/hadoop-common/CHANGES.txt hadoop-common-project/hadoop-common/src/main/java/org/apache/hadoop/crypto/key/KeyShell.java hadoop-common-project/hadoop-common/src/site/markdown/CommandsManual.md
          Hide
          ajisakaa Akira Ajisaka added a comment -

          Committed this to branch-2.7 and above. Thanks Xiao Chen for the contribution!

          Show
          ajisakaa Akira Ajisaka added a comment - Committed this to branch-2.7 and above. Thanks Xiao Chen for the contribution!
          Hide
          ajisakaa Akira Ajisaka added a comment -

          +1, checking this in.

          Show
          ajisakaa Akira Ajisaka added a comment - +1, checking this in.
          Hide
          hadoopqa Hadoop QA added a comment -
          -1 overall



          Vote Subsystem Runtime Comment
          0 reexec 0m 12s Docker mode activated.
          +1 @author 0m 0s The patch does not contain any @author tags.
          -1 test4tests 0m 0s The patch doesn't appear to include any new or modified tests. Please justify why no new tests are needed for this patch. Also please list what manual steps were performed to verify this patch.
          +1 mvninstall 7m 53s trunk passed
          +1 compile 7m 39s trunk passed with JDK v1.8.0_66
          +1 compile 8m 5s trunk passed with JDK v1.7.0_91
          +1 checkstyle 0m 25s trunk passed
          +1 mvnsite 1m 14s trunk passed
          +1 mvneclipse 0m 15s trunk passed
          +1 findbugs 1m 49s trunk passed
          +1 javadoc 1m 2s trunk passed with JDK v1.8.0_66
          +1 javadoc 1m 13s trunk passed with JDK v1.7.0_91
          +1 mvninstall 0m 45s the patch passed
          +1 compile 7m 37s the patch passed with JDK v1.8.0_66
          +1 javac 7m 37s the patch passed
          +1 compile 7m 56s the patch passed with JDK v1.7.0_91
          +1 javac 7m 56s the patch passed
          +1 checkstyle 0m 25s the patch passed
          +1 mvnsite 1m 13s the patch passed
          +1 mvneclipse 0m 16s the patch passed
          +1 whitespace 0m 0s Patch has no whitespace issues.
          +1 findbugs 2m 4s the patch passed
          +1 javadoc 0m 57s the patch passed with JDK v1.8.0_66
          +1 javadoc 1m 12s the patch passed with JDK v1.7.0_91
          +1 unit 9m 3s hadoop-common in the patch passed with JDK v1.8.0_66.
          +1 unit 8m 12s hadoop-common in the patch passed with JDK v1.7.0_91.
          +1 asflicense 0m 23s Patch does not generate ASF License warnings.
          71m 3s



          Subsystem Report/Notes
          Docker Image:yetus/hadoop:0ca8df7
          JIRA Patch URL https://issues.apache.org/jira/secure/attachment/12787815/HADOOP-12786.02.patch
          JIRA Issue HADOOP-12786
          Optional Tests asflicense compile javac javadoc mvninstall mvnsite unit findbugs checkstyle
          uname Linux b9e4d68acbec 3.13.0-36-lowlatency #63-Ubuntu SMP PREEMPT Wed Sep 3 21:56:12 UTC 2014 x86_64 x86_64 x86_64 GNU/Linux
          Build tool maven
          Personality /testptch/hadoop/patchprocess/precommit/personality/provided.sh
          git revision trunk / ec12ce8
          Default Java 1.7.0_91
          Multi-JDK versions /usr/lib/jvm/java-8-oracle:1.8.0_66 /usr/lib/jvm/java-7-openjdk-amd64:1.7.0_91
          findbugs v3.0.0
          JDK v1.7.0_91 Test Results https://builds.apache.org/job/PreCommit-HADOOP-Build/8623/testReport/
          modules C: hadoop-common-project/hadoop-common U: hadoop-common-project/hadoop-common
          Console output https://builds.apache.org/job/PreCommit-HADOOP-Build/8623/console
          Powered by Apache Yetus 0.2.0-SNAPSHOT http://yetus.apache.org

          This message was automatically generated.

          Show
          hadoopqa Hadoop QA added a comment - -1 overall Vote Subsystem Runtime Comment 0 reexec 0m 12s Docker mode activated. +1 @author 0m 0s The patch does not contain any @author tags. -1 test4tests 0m 0s The patch doesn't appear to include any new or modified tests. Please justify why no new tests are needed for this patch. Also please list what manual steps were performed to verify this patch. +1 mvninstall 7m 53s trunk passed +1 compile 7m 39s trunk passed with JDK v1.8.0_66 +1 compile 8m 5s trunk passed with JDK v1.7.0_91 +1 checkstyle 0m 25s trunk passed +1 mvnsite 1m 14s trunk passed +1 mvneclipse 0m 15s trunk passed +1 findbugs 1m 49s trunk passed +1 javadoc 1m 2s trunk passed with JDK v1.8.0_66 +1 javadoc 1m 13s trunk passed with JDK v1.7.0_91 +1 mvninstall 0m 45s the patch passed +1 compile 7m 37s the patch passed with JDK v1.8.0_66 +1 javac 7m 37s the patch passed +1 compile 7m 56s the patch passed with JDK v1.7.0_91 +1 javac 7m 56s the patch passed +1 checkstyle 0m 25s the patch passed +1 mvnsite 1m 13s the patch passed +1 mvneclipse 0m 16s the patch passed +1 whitespace 0m 0s Patch has no whitespace issues. +1 findbugs 2m 4s the patch passed +1 javadoc 0m 57s the patch passed with JDK v1.8.0_66 +1 javadoc 1m 12s the patch passed with JDK v1.7.0_91 +1 unit 9m 3s hadoop-common in the patch passed with JDK v1.8.0_66. +1 unit 8m 12s hadoop-common in the patch passed with JDK v1.7.0_91. +1 asflicense 0m 23s Patch does not generate ASF License warnings. 71m 3s Subsystem Report/Notes Docker Image:yetus/hadoop:0ca8df7 JIRA Patch URL https://issues.apache.org/jira/secure/attachment/12787815/HADOOP-12786.02.patch JIRA Issue HADOOP-12786 Optional Tests asflicense compile javac javadoc mvninstall mvnsite unit findbugs checkstyle uname Linux b9e4d68acbec 3.13.0-36-lowlatency #63-Ubuntu SMP PREEMPT Wed Sep 3 21:56:12 UTC 2014 x86_64 x86_64 x86_64 GNU/Linux Build tool maven Personality /testptch/hadoop/patchprocess/precommit/personality/provided.sh git revision trunk / ec12ce8 Default Java 1.7.0_91 Multi-JDK versions /usr/lib/jvm/java-8-oracle:1.8.0_66 /usr/lib/jvm/java-7-openjdk-amd64:1.7.0_91 findbugs v3.0.0 JDK v1.7.0_91 Test Results https://builds.apache.org/job/PreCommit-HADOOP-Build/8623/testReport/ modules C: hadoop-common-project/hadoop-common U: hadoop-common-project/hadoop-common Console output https://builds.apache.org/job/PreCommit-HADOOP-Build/8623/console Powered by Apache Yetus 0.2.0-SNAPSHOT http://yetus.apache.org This message was automatically generated.
          Hide
          hadoopqa Hadoop QA added a comment -
          -1 overall



          Vote Subsystem Runtime Comment
          0 reexec 0m 12s Docker mode activated.
          +1 @author 0m 0s The patch does not contain any @author tags.
          -1 test4tests 0m 0s The patch doesn't appear to include any new or modified tests. Please justify why no new tests are needed for this patch. Also please list what manual steps were performed to verify this patch.
          +1 mvninstall 7m 8s trunk passed
          +1 compile 7m 10s trunk passed with JDK v1.8.0_66
          +1 compile 8m 11s trunk passed with JDK v1.7.0_91
          +1 checkstyle 0m 25s trunk passed
          +1 mvnsite 1m 16s trunk passed
          +1 mvneclipse 0m 15s trunk passed
          +1 findbugs 1m 48s trunk passed
          +1 javadoc 1m 4s trunk passed with JDK v1.8.0_66
          +1 javadoc 1m 11s trunk passed with JDK v1.7.0_91
          +1 mvninstall 0m 46s the patch passed
          +1 compile 7m 37s the patch passed with JDK v1.8.0_66
          +1 javac 7m 37s the patch passed
          +1 compile 8m 7s the patch passed with JDK v1.7.0_91
          +1 javac 8m 7s the patch passed
          +1 checkstyle 0m 24s the patch passed
          +1 mvnsite 1m 14s the patch passed
          +1 mvneclipse 0m 15s the patch passed
          +1 whitespace 0m 0s Patch has no whitespace issues.
          +1 findbugs 2m 6s the patch passed
          +1 javadoc 1m 2s the patch passed with JDK v1.8.0_66
          +1 javadoc 1m 12s the patch passed with JDK v1.7.0_91
          +1 unit 8m 59s hadoop-common in the patch passed with JDK v1.8.0_66.
          +1 unit 9m 3s hadoop-common in the patch passed with JDK v1.7.0_91.
          +1 asflicense 0m 22s Patch does not generate ASF License warnings.
          70m 56s



          Subsystem Report/Notes
          Docker Image:yetus/hadoop:0ca8df7
          JIRA Patch URL https://issues.apache.org/jira/secure/attachment/12787815/HADOOP-12786.02.patch
          JIRA Issue HADOOP-12786
          Optional Tests asflicense compile javac javadoc mvninstall mvnsite unit findbugs checkstyle
          uname Linux 5e14097de490 3.13.0-36-lowlatency #63-Ubuntu SMP PREEMPT Wed Sep 3 21:56:12 UTC 2014 x86_64 x86_64 x86_64 GNU/Linux
          Build tool maven
          Personality /testptch/hadoop/patchprocess/precommit/personality/provided.sh
          git revision trunk / ec12ce8
          Default Java 1.7.0_91
          Multi-JDK versions /usr/lib/jvm/java-8-oracle:1.8.0_66 /usr/lib/jvm/java-7-openjdk-amd64:1.7.0_91
          findbugs v3.0.0
          JDK v1.7.0_91 Test Results https://builds.apache.org/job/PreCommit-HADOOP-Build/8622/testReport/
          modules C: hadoop-common-project/hadoop-common U: hadoop-common-project/hadoop-common
          Console output https://builds.apache.org/job/PreCommit-HADOOP-Build/8622/console
          Powered by Apache Yetus 0.2.0-SNAPSHOT http://yetus.apache.org

          This message was automatically generated.

          Show
          hadoopqa Hadoop QA added a comment - -1 overall Vote Subsystem Runtime Comment 0 reexec 0m 12s Docker mode activated. +1 @author 0m 0s The patch does not contain any @author tags. -1 test4tests 0m 0s The patch doesn't appear to include any new or modified tests. Please justify why no new tests are needed for this patch. Also please list what manual steps were performed to verify this patch. +1 mvninstall 7m 8s trunk passed +1 compile 7m 10s trunk passed with JDK v1.8.0_66 +1 compile 8m 11s trunk passed with JDK v1.7.0_91 +1 checkstyle 0m 25s trunk passed +1 mvnsite 1m 16s trunk passed +1 mvneclipse 0m 15s trunk passed +1 findbugs 1m 48s trunk passed +1 javadoc 1m 4s trunk passed with JDK v1.8.0_66 +1 javadoc 1m 11s trunk passed with JDK v1.7.0_91 +1 mvninstall 0m 46s the patch passed +1 compile 7m 37s the patch passed with JDK v1.8.0_66 +1 javac 7m 37s the patch passed +1 compile 8m 7s the patch passed with JDK v1.7.0_91 +1 javac 8m 7s the patch passed +1 checkstyle 0m 24s the patch passed +1 mvnsite 1m 14s the patch passed +1 mvneclipse 0m 15s the patch passed +1 whitespace 0m 0s Patch has no whitespace issues. +1 findbugs 2m 6s the patch passed +1 javadoc 1m 2s the patch passed with JDK v1.8.0_66 +1 javadoc 1m 12s the patch passed with JDK v1.7.0_91 +1 unit 8m 59s hadoop-common in the patch passed with JDK v1.8.0_66. +1 unit 9m 3s hadoop-common in the patch passed with JDK v1.7.0_91. +1 asflicense 0m 22s Patch does not generate ASF License warnings. 70m 56s Subsystem Report/Notes Docker Image:yetus/hadoop:0ca8df7 JIRA Patch URL https://issues.apache.org/jira/secure/attachment/12787815/HADOOP-12786.02.patch JIRA Issue HADOOP-12786 Optional Tests asflicense compile javac javadoc mvninstall mvnsite unit findbugs checkstyle uname Linux 5e14097de490 3.13.0-36-lowlatency #63-Ubuntu SMP PREEMPT Wed Sep 3 21:56:12 UTC 2014 x86_64 x86_64 x86_64 GNU/Linux Build tool maven Personality /testptch/hadoop/patchprocess/precommit/personality/provided.sh git revision trunk / ec12ce8 Default Java 1.7.0_91 Multi-JDK versions /usr/lib/jvm/java-8-oracle:1.8.0_66 /usr/lib/jvm/java-7-openjdk-amd64:1.7.0_91 findbugs v3.0.0 JDK v1.7.0_91 Test Results https://builds.apache.org/job/PreCommit-HADOOP-Build/8622/testReport/ modules C: hadoop-common-project/hadoop-common U: hadoop-common-project/hadoop-common Console output https://builds.apache.org/job/PreCommit-HADOOP-Build/8622/console Powered by Apache Yetus 0.2.0-SNAPSHOT http://yetus.apache.org This message was automatically generated.
          Hide
          xiaochen Xiao Chen added a comment -

          Thanks Akira Ajisaka for reviewing!
          Sorry I missed that, patch 2 fixes it. Also updated the description of the subcommands to not say 'The xxx subcommand' to be consistent with other commands.

          Show
          xiaochen Xiao Chen added a comment - Thanks Akira Ajisaka for reviewing! Sorry I missed that, patch 2 fixes it. Also updated the description of the subcommands to not say 'The xxx subcommand' to be consistent with other commands.
          Hide
          ajisakaa Akira Ajisaka added a comment -

          Thanks Xiao Chen for creating the patch. Mostly looks good to me.
          One nit: There are some incorrect brackets matching.

          roll keyname [-provider provider] [-help]]
          
          delete *keyname* [-provider *provider*] [-f] [-help]]
          
          [list [-provider *provider*] [-metadata] [-help]]
          

          Would you fix them?

          Show
          ajisakaa Akira Ajisaka added a comment - Thanks Xiao Chen for creating the patch. Mostly looks good to me. One nit: There are some incorrect brackets matching. roll keyname [-provider provider] [-help]] delete *keyname* [-provider *provider*] [-f] [-help]] [list [-provider *provider*] [-metadata] [-help]] Would you fix them?
          Hide
          hadoopqa Hadoop QA added a comment -
          -1 overall



          Vote Subsystem Runtime Comment
          0 reexec 0m 15s Docker mode activated.
          +1 @author 0m 0s The patch does not contain any @author tags.
          -1 test4tests 0m 0s The patch doesn't appear to include any new or modified tests. Please justify why no new tests are needed for this patch. Also please list what manual steps were performed to verify this patch.
          +1 mvninstall 6m 41s trunk passed
          +1 compile 5m 52s trunk passed with JDK v1.8.0_72
          +1 compile 6m 43s trunk passed with JDK v1.7.0_95
          +1 checkstyle 0m 20s trunk passed
          +1 mvnsite 1m 4s trunk passed
          +1 mvneclipse 0m 13s trunk passed
          +1 findbugs 1m 32s trunk passed
          +1 javadoc 0m 58s trunk passed with JDK v1.8.0_72
          +1 javadoc 1m 2s trunk passed with JDK v1.7.0_95
          +1 mvninstall 0m 41s the patch passed
          +1 compile 5m 48s the patch passed with JDK v1.8.0_72
          +1 javac 5m 48s the patch passed
          +1 compile 6m 41s the patch passed with JDK v1.7.0_95
          +1 javac 6m 41s the patch passed
          +1 checkstyle 0m 21s the patch passed
          +1 mvnsite 1m 1s the patch passed
          +1 mvneclipse 0m 14s the patch passed
          +1 whitespace 0m 0s Patch has no whitespace issues.
          +1 findbugs 1m 47s the patch passed
          +1 javadoc 0m 53s the patch passed with JDK v1.8.0_72
          +1 javadoc 1m 3s the patch passed with JDK v1.7.0_95
          +1 unit 7m 15s hadoop-common in the patch passed with JDK v1.8.0_72.
          +1 unit 7m 37s hadoop-common in the patch passed with JDK v1.7.0_95.
          +1 asflicense 0m 23s Patch does not generate ASF License warnings.
          59m 34s



          Subsystem Report/Notes
          Docker Image:yetus/hadoop:0ca8df7
          JIRA Patch URL https://issues.apache.org/jira/secure/attachment/12787769/HADOOP-12786.01.patch
          JIRA Issue HADOOP-12786
          Optional Tests asflicense compile javac javadoc mvninstall mvnsite unit findbugs checkstyle
          uname Linux 523830c267f9 3.13.0-36-lowlatency #63-Ubuntu SMP PREEMPT Wed Sep 3 21:56:12 UTC 2014 x86_64 x86_64 x86_64 GNU/Linux
          Build tool maven
          Personality /testptch/hadoop/patchprocess/precommit/personality/provided.sh
          git revision trunk / 91a96ea
          Default Java 1.7.0_95
          Multi-JDK versions /usr/lib/jvm/java-8-oracle:1.8.0_72 /usr/lib/jvm/java-7-openjdk-amd64:1.7.0_95
          findbugs v3.0.0
          JDK v1.7.0_95 Test Results https://builds.apache.org/job/PreCommit-HADOOP-Build/8616/testReport/
          modules C: hadoop-common-project/hadoop-common U: hadoop-common-project/hadoop-common
          Console output https://builds.apache.org/job/PreCommit-HADOOP-Build/8616/console
          Powered by Apache Yetus 0.2.0-SNAPSHOT http://yetus.apache.org

          This message was automatically generated.

          Show
          hadoopqa Hadoop QA added a comment - -1 overall Vote Subsystem Runtime Comment 0 reexec 0m 15s Docker mode activated. +1 @author 0m 0s The patch does not contain any @author tags. -1 test4tests 0m 0s The patch doesn't appear to include any new or modified tests. Please justify why no new tests are needed for this patch. Also please list what manual steps were performed to verify this patch. +1 mvninstall 6m 41s trunk passed +1 compile 5m 52s trunk passed with JDK v1.8.0_72 +1 compile 6m 43s trunk passed with JDK v1.7.0_95 +1 checkstyle 0m 20s trunk passed +1 mvnsite 1m 4s trunk passed +1 mvneclipse 0m 13s trunk passed +1 findbugs 1m 32s trunk passed +1 javadoc 0m 58s trunk passed with JDK v1.8.0_72 +1 javadoc 1m 2s trunk passed with JDK v1.7.0_95 +1 mvninstall 0m 41s the patch passed +1 compile 5m 48s the patch passed with JDK v1.8.0_72 +1 javac 5m 48s the patch passed +1 compile 6m 41s the patch passed with JDK v1.7.0_95 +1 javac 6m 41s the patch passed +1 checkstyle 0m 21s the patch passed +1 mvnsite 1m 1s the patch passed +1 mvneclipse 0m 14s the patch passed +1 whitespace 0m 0s Patch has no whitespace issues. +1 findbugs 1m 47s the patch passed +1 javadoc 0m 53s the patch passed with JDK v1.8.0_72 +1 javadoc 1m 3s the patch passed with JDK v1.7.0_95 +1 unit 7m 15s hadoop-common in the patch passed with JDK v1.8.0_72. +1 unit 7m 37s hadoop-common in the patch passed with JDK v1.7.0_95. +1 asflicense 0m 23s Patch does not generate ASF License warnings. 59m 34s Subsystem Report/Notes Docker Image:yetus/hadoop:0ca8df7 JIRA Patch URL https://issues.apache.org/jira/secure/attachment/12787769/HADOOP-12786.01.patch JIRA Issue HADOOP-12786 Optional Tests asflicense compile javac javadoc mvninstall mvnsite unit findbugs checkstyle uname Linux 523830c267f9 3.13.0-36-lowlatency #63-Ubuntu SMP PREEMPT Wed Sep 3 21:56:12 UTC 2014 x86_64 x86_64 x86_64 GNU/Linux Build tool maven Personality /testptch/hadoop/patchprocess/precommit/personality/provided.sh git revision trunk / 91a96ea Default Java 1.7.0_95 Multi-JDK versions /usr/lib/jvm/java-8-oracle:1.8.0_72 /usr/lib/jvm/java-7-openjdk-amd64:1.7.0_95 findbugs v3.0.0 JDK v1.7.0_95 Test Results https://builds.apache.org/job/PreCommit-HADOOP-Build/8616/testReport/ modules C: hadoop-common-project/hadoop-common U: hadoop-common-project/hadoop-common Console output https://builds.apache.org/job/PreCommit-HADOOP-Build/8616/console Powered by Apache Yetus 0.2.0-SNAPSHOT http://yetus.apache.org This message was automatically generated.
          Hide
          xiaochen Xiao Chen added a comment -

          Attached patch 1 to add documentation. The usage part is copied from the command usage directly (found a typo there, corrected), adapting to the markdown format. Also attached a generated html for easier reviewing.

          The reason that HDFS-9784 saw the exception is due to a KeyProvider's precondition check.

          Please see if the document makes sense. Thank you!

          Show
          xiaochen Xiao Chen added a comment - Attached patch 1 to add documentation. The usage part is copied from the command usage directly (found a typo there, corrected), adapting to the markdown format. Also attached a generated html for easier reviewing. The reason that HDFS-9784 saw the exception is due to a KeyProvider's precondition check . Please see if the document makes sense. Thank you!
          Hide
          xiaochen Xiao Chen added a comment -

          Thanks Akira Ajisaka for filing this. I'd like to work on this one, and gain more knowledge.

          Show
          xiaochen Xiao Chen added a comment - Thanks Akira Ajisaka for filing this. I'd like to work on this one, and gain more knowledge.

            People

            • Assignee:
              xiaochen Xiao Chen
              Reporter:
              ajisakaa Akira Ajisaka
            • Votes:
              0 Vote for this issue
              Watchers:
              7 Start watching this issue

              Dates

              • Created:
                Updated:
                Resolved:

                Development