[HDFS-13884] Improve the description of the setting dfs.image.compress

• Type: Improvement
• Status: Resolved
• Priority: Minor
• Resolution: Fixed
• Affects Version/s: 3.1.1
• Fix Version/s: 3.2.0
• Component/s: documentation
• Target Version/s: 3.2.0
• Hadoop Flags: Reviewed
• Assignee: Ryan Wu
• Reporter: Yiqun Lin
• Created: 30/Aug/18 09:40
• Updated: 10/Sep/18 06:23
• Resolved: 10/Sep/18 06:00

Description

In HDFS-1435, we introduced a new option to store fsimage compressed. And this can avoid that It consumes a lot of network bandwidth when SBN do uploads a new fsimage to ANN. When lots of network bandwidth was consumed, it will affect ANN to deal with normal RPC requests or sync edit logs.

This is a very useful setting when our fsimage file is very large. However current description of this setting is too simple, we can document this more.

<property>
  <name>dfs.image.compress</name>
  <value>false</value>
  <description>Should the dfs image be compressed?
  </description>
</property>