[HDFS-9784] Example usage is not correct in Transparent Encryption document

• Type: Bug
• Status: Closed
• Priority: Major
• Resolution: Fixed
• Affects Version/s: 2.7.2, 3.0.0-alpha1
• Fix Version/s: 2.8.0, 2.7.3, 3.0.0-alpha1
• Component/s: documentation
• Hadoop Flags: Reviewed
• Assignee: Takashi Ohnishi
• Reporter: Takashi Ohnishi
• Created: 07/Feb/16 13:30
• Updated: 30/Aug/16 01:19
• Resolved: 09/Feb/16 18:35

Description

It says

# As the normal user, create a new encryption key
hadoop key create myKey

But, this actually fails with the below error.

$ hadoop key create myKey
java.lang.IllegalArgumentException: Uppercase key names are unsupported: myKey
    at sun.reflect.NativeConstructorAccessorImpl.newInstance0(Native Method)
    at sun.reflect.NativeConstructorAccessorImpl.newInstance(NativeConstructorAccessorImpl.java:62)
    at sun.reflect.DelegatingConstructorAccessorImpl.newInstance(DelegatingConstructorAccessorImpl.java:45)
    at java.lang.reflect.Constructor.newInstance(Constructor.java:422)
    at org.apache.hadoop.util.HttpExceptionUtils.validateResponse(HttpExceptionUtils.java:157)
    at org.apache.hadoop.crypto.key.kms.KMSClientProvider.call(KMSClientProvider.java:546)
    at org.apache.hadoop.crypto.key.kms.KMSClientProvider.call(KMSClientProvider.java:504)
    at org.apache.hadoop.crypto.key.kms.KMSClientProvider.createKeyInternal(KMSClientProvider.java:677)
    at org.apache.hadoop.crypto.key.kms.KMSClientProvider.createKey(KMSClientProvider.java:685)
    at org.apache.hadoop.crypto.key.KeyShell$CreateCommand.execute(KeyShell.java:483)
    at org.apache.hadoop.crypto.key.KeyShell.run(KeyShell.java:79)
    at org.apache.hadoop.util.ToolRunner.run(ToolRunner.java:70)
    at org.apache.hadoop.crypto.key.KeyShell.main(KeyShell.java:515)

Though I'm not sure why it is so, I think the document should be fixed to use only lowercase in key names.

Issue Links

• is related to: HADOOP-12786 "hadoop key" command usage is not documented