HDFS-12511. Ozone: Add tags to config. Contributed by Ajay Kumar.

This commit is contained in:
Anu Engineer 2017-09-28 17:29:55 -07:00 committed by Owen O'Malley
parent 7151a9b604
commit aaec2689f4
2 changed files with 132 additions and 0 deletions

View File

@ -26,6 +26,7 @@
<property> <property>
<name>ozone.enabled</name> <name>ozone.enabled</name>
<value>false</value> <value>false</value>
<tag>OZONE,REQUIRED</tag>
<description> <description>
Status of the Ozone Object Storage service is enabled. Status of the Ozone Object Storage service is enabled.
Set to true to enable Ozone. Set to true to enable Ozone.
@ -36,6 +37,7 @@
<property> <property>
<name>ozone.handler.type</name> <name>ozone.handler.type</name>
<value>distributed</value> <value>distributed</value>
<tag>OZONE,REST</tag>
<description> <description>
The second key dfs.storage.handler.type tells ozone which storage The second key dfs.storage.handler.type tells ozone which storage
handler to use. The possible values are: handler to use. The possible values are:
@ -47,6 +49,7 @@
<property> <property>
<name>ozone.localstorage.root</name> <name>ozone.localstorage.root</name>
<value>/tmp/ozone</value> <value>/tmp/ozone</value>
<tag>OZONE,REST</tag>
<description> <description>
</description> </description>
</property> </property>
@ -54,6 +57,7 @@
<property> <property>
<name>ozone.trace.enabled</name> <name>ozone.trace.enabled</name>
<value>false</value> <value>false</value>
<tag>OZONE,DEBUG</tag>
<description> <description>
</description> </description>
</property> </property>
@ -61,6 +65,7 @@
<property> <property>
<name>ozone.metadata.dirs</name> <name>ozone.metadata.dirs</name>
<value></value> <value></value>
<tag>OZONE,KSM,SCM,CONTAINER,REQUIRED,STORAGE</tag>
<description> <description>
Ozone metadata dir path. Ozone metadata dir path.
</description> </description>
@ -69,6 +74,7 @@
<property> <property>
<name>ozone.key.cache.size</name> <name>ozone.key.cache.size</name>
<value>1024</value> <value>1024</value>
<tag>PERFORMANCE,CONTAINER,STORAGE</tag>
<description> <description>
</description> </description>
</property> </property>
@ -76,6 +82,7 @@
<property> <property>
<name>ozone.administrators</name> <name>ozone.administrators</name>
<value></value> <value></value>
<tag>OZONE,SECURITY</tag>
<description> <description>
Ozone administrator users delimited by comma. Ozone administrator users delimited by comma.
If not set, only the user who launches an ozone service will be the If not set, only the user who launches an ozone service will be the
@ -88,6 +95,7 @@
<property> <property>
<name>ozone.client.protocol</name> <name>ozone.client.protocol</name>
<value>org.apache.hadoop.ozone.client.rpc.RpcClient</value> <value>org.apache.hadoop.ozone.client.rpc.RpcClient</value>
<tag>OZONE</tag>
<description> <description>
Protocol class to be used by client to connect to ozone cluster. Protocol class to be used by client to connect to ozone cluster.
The build-in implementation includes: The build-in implementation includes:
@ -99,6 +107,7 @@
<property> <property>
<name>ozone.client.socket.timeout.ms</name> <name>ozone.client.socket.timeout.ms</name>
<value>5000</value> <value>5000</value>
<tag>OZONE</tag>
<description> <description>
Socket timeout for Ozone client in milliseconds. Socket timeout for Ozone client in milliseconds.
</description> </description>
@ -107,6 +116,7 @@
<property> <property>
<name>ozone.client.connection.timeout.ms</name> <name>ozone.client.connection.timeout.ms</name>
<value>5000</value> <value>5000</value>
<tag>OZONE,PERFORMANCE,CLIENT</tag>
<description> <description>
Connection timeout for Ozone client in milliseconds. Connection timeout for Ozone client in milliseconds.
</description> </description>
@ -115,6 +125,7 @@
<property> <property>
<name>ozone.scm.client.address</name> <name>ozone.scm.client.address</name>
<value></value> <value></value>
<tag>OZONE</tag>
<description> <description>
The address of the Ozone SCM client service. This is a required The address of the Ozone SCM client service. This is a required
setting. setting.
@ -127,6 +138,7 @@
<property> <property>
<name>ozone.scm.client.port</name> <name>ozone.scm.client.port</name>
<value>9860</value> <value>9860</value>
<tag>OZONE</tag>
<description> <description>
The port number of the Ozone SCM client service. The port number of the Ozone SCM client service.
</description> </description>
@ -135,6 +147,7 @@
<property> <property>
<name>ozone.scm.datanode.address</name> <name>ozone.scm.datanode.address</name>
<value></value> <value></value>
<tag>OZONE</tag>
<description> <description>
The address of the Ozone SCM service used for internal communication The address of the Ozone SCM service used for internal communication
between the DataNodes and the SCM. between the DataNodes and the SCM.
@ -151,6 +164,7 @@
<property> <property>
<name>ozone.scm.datanode.bind.host</name> <name>ozone.scm.datanode.bind.host</name>
<value></value> <value></value>
<tag>OZONE</tag>
<description> <description>
The hostname or IP address used by the SCM service endpoint to bind. The hostname or IP address used by the SCM service endpoint to bind.
</description> </description>
@ -159,6 +173,7 @@
<property> <property>
<name>ozone.scm.datanode.port</name> <name>ozone.scm.datanode.port</name>
<value>9861</value> <value>9861</value>
<tag>OZONE</tag>
<description> <description>
The port number of the Ozone SCM service. The port number of the Ozone SCM service.
</description> </description>
@ -167,6 +182,7 @@
<property> <property>
<name>ozone.scm.client.bind.host</name> <name>ozone.scm.client.bind.host</name>
<value>0.0.0.0</value> <value>0.0.0.0</value>
<tag>OZONE</tag>
<description> <description>
The hostname or IP address used by the SCM client endpoint to bind. The hostname or IP address used by the SCM client endpoint to bind.
This setting is used by the SCM only and never used by clients. This setting is used by the SCM only and never used by clients.
@ -181,6 +197,7 @@
<property> <property>
<name>ozone.scm.block.client.address</name> <name>ozone.scm.block.client.address</name>
<value></value> <value></value>
<tag>OZONE</tag>
<description> <description>
The address of the Ozone SCM block client service. If not defined The address of the Ozone SCM block client service. If not defined
value of ozone.scm.client.address is used. value of ozone.scm.client.address is used.
@ -190,6 +207,7 @@
<property> <property>
<name>ozone.scm.block.client.bind.host</name> <name>ozone.scm.block.client.bind.host</name>
<value>0.0.0.0</value> <value>0.0.0.0</value>
<tag>OZONE</tag>
<description> <description>
The hostname or IP address used by the SCM block client The hostname or IP address used by the SCM block client
endpoint to bind. endpoint to bind.
@ -199,6 +217,7 @@
<property> <property>
<name>ozone.scm.block.client.port</name> <name>ozone.scm.block.client.port</name>
<value>9863</value> <value>9863</value>
<tag>OZONE</tag>
<description> <description>
The port number of the Ozone SCM block client service. The port number of the Ozone SCM block client service.
</description> </description>
@ -207,6 +226,7 @@
<property> <property>
<name>ozone.scm.handler.count.key</name> <name>ozone.scm.handler.count.key</name>
<value>10</value> <value>10</value>
<tag>OZONE</tag>
<description> <description>
The number of RPC handler threads for each SCM service endpoint. The number of RPC handler threads for each SCM service endpoint.
@ -217,6 +237,7 @@
<property> <property>
<name>ozone.scm.chunk.size</name> <name>ozone.scm.chunk.size</name>
<value>1048576</value> <value>1048576</value>
<tag>OZONE</tag>
<description> <description>
The chunk size for read/write chunk operations in bytes. The chunk size for read/write chunk operations in bytes.
@ -229,6 +250,7 @@
<property> <property>
<name>ozone.scm.heartbeat.interval.seconds</name> <name>ozone.scm.heartbeat.interval.seconds</name>
<value>30</value> <value>30</value>
<tag>OZONE</tag>
<description> <description>
The heartbeat interval from a datanode to SCM in seconds. The heartbeat interval from a datanode to SCM in seconds.
</description> </description>
@ -237,6 +259,7 @@
<property> <property>
<name>ozone.scm.stale.node.interval.ms</name> <name>ozone.scm.stale.node.interval.ms</name>
<value>90000</value> <value>90000</value>
<tag>OZONE</tag>
<description> <description>
The interval in milliseconds for stale node flagging. The interval in milliseconds for stale node flagging.
</description> </description>
@ -245,6 +268,7 @@
<property> <property>
<name>ozone.scm.dead.node.interval.ms</name> <name>ozone.scm.dead.node.interval.ms</name>
<value>600000</value> <value>600000</value>
<tag>OZONE</tag>
<description> <description>
The interval in milliseconds for dead node flagging. The interval in milliseconds for dead node flagging.
</description> </description>
@ -253,6 +277,7 @@
<property> <property>
<name>ozone.scm.max.hb.count.to.process</name> <name>ozone.scm.max.hb.count.to.process</name>
<value>5000</value> <value>5000</value>
<tag>OZONE</tag>
<description> <description>
The maximum number of heartbeat to process per loop of the process The maximum number of heartbeat to process per loop of the process
thread. thread.
@ -262,6 +287,7 @@
<property> <property>
<name>ozone.scm.heartbeat.thread.interval.ms</name> <name>ozone.scm.heartbeat.thread.interval.ms</name>
<value>3000</value> <value>3000</value>
<tag>OZONE</tag>
<description> <description>
The interval in milliseconds that the heartbeat processor thread runs. The interval in milliseconds that the heartbeat processor thread runs.
</description> </description>
@ -270,6 +296,7 @@
<property> <property>
<name>ozone.scm.heartbeat.rpc-timeout</name> <name>ozone.scm.heartbeat.rpc-timeout</name>
<value>1000</value> <value>1000</value>
<tag>OZONE</tag>
<description> <description>
Timeout value for the RPC from Datanode to SCM in milliseconds. Timeout value for the RPC from Datanode to SCM in milliseconds.
</description> </description>
@ -278,6 +305,7 @@
<property> <property>
<name>ozone.scm.block.deletion.max.retry</name> <name>ozone.scm.block.deletion.max.retry</name>
<value>4096</value> <value>4096</value>
<tag>OZONE</tag>
<description> <description>
SCM wraps up a number of blocks in a deletion transaction and send that SCM wraps up a number of blocks in a deletion transaction and send that
to datanode for physically deletion periodically. This property to datanode for physically deletion periodically. This property
@ -291,6 +319,7 @@
<property> <property>
<name>ozone.scm.heartbeat.log.warn.interval.count</name> <name>ozone.scm.heartbeat.log.warn.interval.count</name>
<value>10</value> <value>10</value>
<tag>OZONE</tag>
<description> <description>
Defines how frequently we will log the missing of heartbeat to SCM. Defines how frequently we will log the missing of heartbeat to SCM.
For example in the default case, we will write a warning message for each 10 For example in the default case, we will write a warning message for each 10
@ -301,6 +330,7 @@
<property> <property>
<name>ozone.scm.names</name> <name>ozone.scm.names</name>
<value></value> <value></value>
<tag>OZONE</tag>
<description> <description>
The value of this property is a set of DNS | DNS:PORT | IP Address | IP:PORT. The value of this property is a set of DNS | DNS:PORT | IP Address | IP:PORT.
Written as a comma separated string. e.g. scm1, scm2:8020, 7.7.7.7:7777. Written as a comma separated string. e.g. scm1, scm2:8020, 7.7.7.7:7777.
@ -312,6 +342,7 @@
<property> <property>
<name>ozone.scm.datanode.id</name> <name>ozone.scm.datanode.id</name>
<value></value> <value></value>
<tag>OZONE</tag>
<description> <description>
The path that datanodes will created to store the datanode ID. The path that datanodes will created to store the datanode ID.
If this value is not set, datanodes will fail to come up. If this value is not set, datanodes will fail to come up.
@ -321,6 +352,7 @@
<property> <property>
<name>ozone.scm.db.cache.size.mb</name> <name>ozone.scm.db.cache.size.mb</name>
<value>128</value> <value>128</value>
<tag>OZONE</tag>
<description> <description>
The cache size for SCM level db store in MB. The cache size for SCM level db store in MB.
</description> </description>
@ -329,6 +361,7 @@
<property> <property>
<name>ozone.scm.container.size.gb</name> <name>ozone.scm.container.size.gb</name>
<value>5</value> <value>5</value>
<tag>OZONE</tag>
<description> <description>
Storage container size in GB for block allocations. Storage container size in GB for block allocations.
</description> </description>
@ -337,6 +370,7 @@
<property> <property>
<name>ozone.scm.container.placement.impl</name> <name>ozone.scm.container.placement.impl</name>
<value>org.apache.hadoop.ozone.scm.container.placement.algorithms.SCMContainerPlacementRandom</value> <value>org.apache.hadoop.ozone.scm.container.placement.algorithms.SCMContainerPlacementRandom</value>
<tag>OZONE</tag>
<description> <description>
Placement policy class for containers. Placement policy class for containers.
Defaults to SCMContainerPlacementRandom.class Defaults to SCMContainerPlacementRandom.class
@ -346,6 +380,7 @@
<property> <property>
<name>ozone.scm.container.provision_batch_size</name> <name>ozone.scm.container.provision_batch_size</name>
<value>1</value> <value>1</value>
<tag>OZONE</tag>
<description> <description>
Pre-provision specified number of containers to creare for Pre-provision specified number of containers to creare for
block creation. block creation.
@ -355,6 +390,7 @@
<property> <property>
<name>ozone.scm.max.container.report.threads</name> <name>ozone.scm.max.container.report.threads</name>
<value>100</value> <value>100</value>
<tag>OZONE</tag>
<description> <description>
Maximum number of threads to process container reports in scm. Maximum number of threads to process container reports in scm.
Each container report from a datanode is processed by scm in Each container report from a datanode is processed by scm in
@ -366,6 +402,7 @@
<property> <property>
<name>ozone.scm.container.reports.wait.timeout.seconds</name> <name>ozone.scm.container.reports.wait.timeout.seconds</name>
<value>300</value> <value>300</value>
<tag>OZONE</tag>
<description> <description>
Maximum time to wait in seconds for processing all container Maximum time to wait in seconds for processing all container
reports from a node pool. It determines the timeout for a reports from a node pool. It determines the timeout for a
@ -376,6 +413,7 @@
<property> <property>
<name>ozone.scm.container.report.processing.interval.seconds</name> <name>ozone.scm.container.report.processing.interval.seconds</name>
<value>60</value> <value>60</value>
<tag>OZONE</tag>
<description> <description>
Time interval in seconds for scm to process container reports Time interval in seconds for scm to process container reports
for a node pool. Scm handles node pool reports in a cyclic clock for a node pool. Scm handles node pool reports in a cyclic clock
@ -386,6 +424,7 @@
<property> <property>
<name>ozone.block.deleting.service.interval.ms</name> <name>ozone.block.deleting.service.interval.ms</name>
<value>60000</value> <value>60000</value>
<tag>OZONE,PERFORMANCE,SCM</tag>
<description> <description>
Time interval in milliseconds of the block deleting service. Time interval in milliseconds of the block deleting service.
The block deleting service runs on each datanode to scan staled The block deleting service runs on each datanode to scan staled
@ -396,6 +435,7 @@
<property> <property>
<name>ozone.block.deleting.service.timeout</name> <name>ozone.block.deleting.service.timeout</name>
<value>300000ms</value> <value>300000ms</value>
<tag>OZONE,PERFORMANCE,SCM</tag>
<description> <description>
Timeout value of block deletion service. If this is set greater than 0, Timeout value of block deletion service. If this is set greater than 0,
the service will stop waiting for the block deleting completion after this the service will stop waiting for the block deleting completion after this
@ -409,6 +449,7 @@
<property> <property>
<name>ozone.block.deleting.limit.per.task</name> <name>ozone.block.deleting.limit.per.task</name>
<value>1000</value> <value>1000</value>
<tag>OZONE,PERFORMANCE,SCM</tag>
<description> <description>
Maximum number of blocks to be deleted by block deleting service Maximum number of blocks to be deleted by block deleting service
per time interval. This property is used to throttle the actual number per time interval. This property is used to throttle the actual number
@ -419,6 +460,7 @@
<property> <property>
<name>ozone.block.deleting.container.limit.per.interval</name> <name>ozone.block.deleting.container.limit.per.interval</name>
<value>10</value> <value>10</value>
<tag>OZONE,PERFORMANCE,SCM</tag>
<description> <description>
Maximum number of containers to be scanned by block deleting service Maximum number of containers to be scanned by block deleting service
per time interval. The block deleting service spawns a thread to handle per time interval. The block deleting service spawns a thread to handle
@ -430,6 +472,7 @@
<property> <property>
<name>ozone.scm.container.deletion-choosing.policy</name> <name>ozone.scm.container.deletion-choosing.policy</name>
<value>org.apache.hadoop.ozone.container.common.impl.TopNOrderedContainerDeletionChoosingPolicy</value> <value>org.apache.hadoop.ozone.container.common.impl.TopNOrderedContainerDeletionChoosingPolicy</value>
<tag>OZONE</tag>
<description> <description>
The policy used for choosing desire containers for block deletion. The policy used for choosing desire containers for block deletion.
Datanode selects a number of containers to process block deletion Datanode selects a number of containers to process block deletion
@ -450,6 +493,7 @@
<property> <property>
<name>ozone.key.deleting.limit.per.task</name> <name>ozone.key.deleting.limit.per.task</name>
<value>1000</value> <value>1000</value>
<tag>PERFORMANCE,KSM</tag>
<description> <description>
Maximum number of keys to be scanned by key deleting service per Maximum number of keys to be scanned by key deleting service per
time interval in KSM. Those keys are sent to delete metadata and time interval in KSM. Those keys are sent to delete metadata and
@ -461,6 +505,7 @@
<property> <property>
<name>dfs.container.ipc</name> <name>dfs.container.ipc</name>
<value>9859</value> <value>9859</value>
<tag>OZONE</tag>
<description> <description>
The ipc port number of container. The ipc port number of container.
</description> </description>
@ -469,6 +514,7 @@
<property> <property>
<name>dfs.container.ipc.random.port</name> <name>dfs.container.ipc.random.port</name>
<value>false</value> <value>false</value>
<tag>OZONE,CONTAINER,PIPELINE,STANDALONE</tag>
<description> <description>
Whether allocates a random free port for ozone container. Whether allocates a random free port for ozone container.
</description> </description>
@ -477,6 +523,7 @@
<property> <property>
<name>scm.container.client.idle.threshold</name> <name>scm.container.client.idle.threshold</name>
<value>10000</value> <value>10000</value>
<tag>OZONE</tag>
<description> <description>
</description> </description>
</property> </property>
@ -484,6 +531,7 @@
<property> <property>
<name>scm.container.client.max.size</name> <name>scm.container.client.max.size</name>
<value>256</value> <value>256</value>
<tag>OZONE</tag>
<description> <description>
</description> </description>
</property> </property>
@ -491,6 +539,7 @@
<property> <property>
<name>dfs.container.ratis.enabled</name> <name>dfs.container.ratis.enabled</name>
<value>false</value> <value>false</value>
<tag>OZONE</tag>
<description> <description>
</description> </description>
</property> </property>
@ -498,6 +547,7 @@
<property> <property>
<name>dfs.container.ratis.rpc.type</name> <name>dfs.container.ratis.rpc.type</name>
<value>GRPC</value> <value>GRPC</value>
<tag>OZONE</tag>
<description> <description>
</description> </description>
</property> </property>
@ -505,6 +555,7 @@
<property> <property>
<name>dfs.container.ratis.server.id</name> <name>dfs.container.ratis.server.id</name>
<value></value> <value></value>
<tag>OZONE</tag>
<description> <description>
The unique ID to identify a Ratis server. The unique ID to identify a Ratis server.
</description> </description>
@ -513,6 +564,7 @@
<property> <property>
<name>dfs.container.ratis.datanode.storage.dir</name> <name>dfs.container.ratis.datanode.storage.dir</name>
<value></value> <value></value>
<tag>OZONE,CONTAINER,STORAGE</tag>
<description> <description>
</description> </description>
</property> </property>
@ -522,6 +574,7 @@
<property> <property>
<name>ozone.ksm.handler.count.key</name> <name>ozone.ksm.handler.count.key</name>
<value>200</value> <value>200</value>
<tag>PERFORMANCE,KSM</tag>
<description> <description>
The number of RPC handler threads for each KSM service endpoint. The number of RPC handler threads for each KSM service endpoint.
</description> </description>
@ -530,6 +583,7 @@
<property> <property>
<name>ozone.ksm.address</name> <name>ozone.ksm.address</name>
<value></value> <value></value>
<tag>KSM,REQUIRED</tag>
<description> <description>
The address of the Ozone KSM service. The address of the Ozone KSM service.
</description> </description>
@ -538,6 +592,7 @@
<property> <property>
<name>ozone.ksm.leveldb.cache.size.mb</name> <name>ozone.ksm.leveldb.cache.size.mb</name>
<value>128</value> <value>128</value>
<tag>PERFORMANCE,KSM</tag>
<description> <description>
The size of KSM LevelDB cache in MB that used for caching files. The size of KSM LevelDB cache in MB that used for caching files.
</description> </description>
@ -546,6 +601,7 @@
<property> <property>
<name>ozone.ksm.user.max.volume</name> <name>ozone.ksm.user.max.volume</name>
<value>1024</value> <value>1024</value>
<tag>KSM,MANAGEMENT</tag>
<description> <description>
The maximum number of volumes that each user can create. The maximum number of volumes that each user can create.
</description> </description>
@ -554,6 +610,7 @@
<property> <property>
<name>ozone.ksm.user.rights</name> <name>ozone.ksm.user.rights</name>
<value>READ_WRITE</value> <value>READ_WRITE</value>
<tag>SECURITY,KSM</tag>
<description> <description>
Default user permissions in Ozone KSM. Default user permissions in Ozone KSM.
</description> </description>
@ -562,6 +619,7 @@
<property> <property>
<name>ozone.ksm.group.rights</name> <name>ozone.ksm.group.rights</name>
<value>READ_WRITE</value> <value>READ_WRITE</value>
<tag>SECURITY,KSM</tag>
<description> <description>
Default group permissions in Ozone KSM. Default group permissions in Ozone KSM.
</description> </description>
@ -571,6 +629,7 @@
<property> <property>
<name>ozone.scm.http.enabled</name> <name>ozone.scm.http.enabled</name>
<value>true</value> <value>true</value>
<tag>OZONE</tag>
<description> <description>
Property to enable or disable SCM web ui. Property to enable or disable SCM web ui.
</description> </description>
@ -579,6 +638,7 @@
<property> <property>
<name>ozone.scm.http-address</name> <name>ozone.scm.http-address</name>
<value>0.0.0.0:9876</value> <value>0.0.0.0:9876</value>
<tag>OZONE</tag>
<description> <description>
The address and the base port where the SCM web ui will listen on. The address and the base port where the SCM web ui will listen on.
@ -589,6 +649,7 @@
<property> <property>
<name>ozone.scm.http-bind-host</name> <name>ozone.scm.http-bind-host</name>
<value>0.0.0.0</value> <value>0.0.0.0</value>
<tag>OZONE</tag>
<description> <description>
The actual address the SCM web server will bind to. If this optional The actual address the SCM web server will bind to. If this optional
address is set, it overrides only the hostname portion of address is set, it overrides only the hostname portion of
@ -599,6 +660,7 @@
<property> <property>
<name>ozone.scm.https-address</name> <name>ozone.scm.https-address</name>
<value>0.0.0.0:9877</value> <value>0.0.0.0:9877</value>
<tag>OZONE</tag>
<description> <description>
The address and the base port where the SCM web ui will listen on The address and the base port where the SCM web ui will listen on
using HTTPS. using HTTPS.
@ -610,6 +672,7 @@
<property> <property>
<name>ozone.scm.https-bind-host</name> <name>ozone.scm.https-bind-host</name>
<value>0.0.0.0</value> <value>0.0.0.0</value>
<tag>OZONE</tag>
<description> <description>
The actual address the SCM web server will bind to using HTTPS. If this The actual address the SCM web server will bind to using HTTPS. If this
optional address is set, it overrides only the hostname portion of optional address is set, it overrides only the hostname portion of
@ -620,6 +683,7 @@
<property> <property>
<name>ozone.ksm.http.enabled</name> <name>ozone.ksm.http.enabled</name>
<value>true</value> <value>true</value>
<tag>KSM,MANAGEMENT</tag>
<description> <description>
Property to enable or disable KSM web ui. Property to enable or disable KSM web ui.
</description> </description>
@ -628,6 +692,7 @@
<property> <property>
<name>ozone.ksm.http-address</name> <name>ozone.ksm.http-address</name>
<value>0.0.0.0:9874</value> <value>0.0.0.0:9874</value>
<tag>KSM,MANAGEMENT</tag>
<description> <description>
The address and the base port where the KSM web ui will listen on. The address and the base port where the KSM web ui will listen on.
@ -638,6 +703,7 @@
<property> <property>
<name>ozone.ksm.http-bind-host</name> <name>ozone.ksm.http-bind-host</name>
<value>0.0.0.0</value> <value>0.0.0.0</value>
<tag>KSM,MANAGEMENT</tag>
<description> <description>
The actual address the KSM web server will bind to. If this optional The actual address the KSM web server will bind to. If this optional
address is set, it overrides only the hostname portion of address is set, it overrides only the hostname portion of
@ -648,6 +714,7 @@
<property> <property>
<name>ozone.ksm.https-address</name> <name>ozone.ksm.https-address</name>
<value>0.0.0.0:9875</value> <value>0.0.0.0:9875</value>
<tag>KSM,MANAGEMENT,SECURITY</tag>
<description> <description>
The address and the base port where the KSM web ui will listen on The address and the base port where the KSM web ui will listen on
using HTTPS. using HTTPS.
@ -659,6 +726,7 @@
<property> <property>
<name>ozone.ksm.https-bind-host</name> <name>ozone.ksm.https-bind-host</name>
<value>0.0.0.0</value> <value>0.0.0.0</value>
<tag>KSM,MANAGEMENT,SECURITY</tag>
<description> <description>
The actual address the KSM web server will bind to using HTTPS. If this The actual address the KSM web server will bind to using HTTPS. If this
optional address is set, it overrides only the hostname portion of optional address is set, it overrides only the hostname portion of
@ -669,6 +737,7 @@
<property> <property>
<name>ozone.web.authentication.kerberos.principal</name> <name>ozone.web.authentication.kerberos.principal</name>
<value></value> <value></value>
<tag>OZONE,SECURITY</tag>
<description> <description>
The server principal used by the SCM and KSM for web UI SPNEGO The server principal used by the SCM and KSM for web UI SPNEGO
authentication when Kerberos security is enabled. This is authentication when Kerberos security is enabled. This is
@ -683,6 +752,7 @@
<property> <property>
<name>ozone.scm.keytab.file</name> <name>ozone.scm.keytab.file</name>
<value></value> <value></value>
<tag>OZONE</tag>
<description> <description>
The keytab file for Kerberos authentication in SCM. The keytab file for Kerberos authentication in SCM.
</description> </description>
@ -691,6 +761,7 @@
<property> <property>
<name>ozone.ksm.keytab.file</name> <name>ozone.ksm.keytab.file</name>
<value></value> <value></value>
<tag>SECURITY,KSM</tag>
<description> <description>
The keytab file for Kerberos authentication in KSM. The keytab file for Kerberos authentication in KSM.
</description> </description>
@ -699,6 +770,7 @@
<property> <property>
<name>ozone.metastore.impl</name> <name>ozone.metastore.impl</name>
<value>RocksDB</value> <value>RocksDB</value>
<tag>OZONE,KSM,SCM,CONTAINER,STORAGE</tag>
<description> <description>
Ozone metadata store implementation. Ozone metadata are well distributed Ozone metadata store implementation. Ozone metadata are well distributed
to multiple services such as ksm, scm. They are stored in some local to multiple services such as ksm, scm. They are stored in some local
@ -710,6 +782,7 @@
<property> <property>
<name>dfs.cblock.servicerpc-address</name> <name>dfs.cblock.servicerpc-address</name>
<value></value> <value></value>
<tag>OZONE</tag>
<description> <description>
The address that cblock will be bind to, should be a host:port format, The address that cblock will be bind to, should be a host:port format,
this setting is required for cblock server to start. this setting is required for cblock server to start.
@ -721,6 +794,7 @@
<property> <property>
<name>dfs.cblock.service.rpc-bind-host</name> <name>dfs.cblock.service.rpc-bind-host</name>
<value>0.0.0.0</value> <value>0.0.0.0</value>
<tag>OZONE</tag>
<description> <description>
The actual address the cblock service rpc server will bind to. If this The actual address the cblock service rpc server will bind to. If this
optional address is set, it overrides only the hostname portion of optional address is set, it overrides only the hostname portion of
@ -731,6 +805,7 @@
<property> <property>
<name>dfs.cblock.jscsi-address</name> <name>dfs.cblock.jscsi-address</name>
<value></value> <value></value>
<tag>OZONE</tag>
<description> <description>
The address that cblock will be bind to, should be a host:port format, The address that cblock will be bind to, should be a host:port format,
this setting is required for cblock server to start. this setting is required for cblock server to start.
@ -741,6 +816,7 @@
<property> <property>
<name>dfs.cblock.jscsi.rpc-bind-host</name> <name>dfs.cblock.jscsi.rpc-bind-host</name>
<value>0.0.0.0</value> <value>0.0.0.0</value>
<tag>OZONE</tag>
<description> <description>
The actual address the cblock jscsi rpc server will bind to. If this The actual address the cblock jscsi rpc server will bind to. If this
optional address is set, it overrides only the hostname portion of optional address is set, it overrides only the hostname portion of
@ -751,6 +827,7 @@
<property> <property>
<name>dfs.cblock.jscsi.port</name> <name>dfs.cblock.jscsi.port</name>
<value>9811</value> <value>9811</value>
<tag>OZONE</tag>
<description> <description>
The port on CBlockManager node for jSCSI to talk to. The port on CBlockManager node for jSCSI to talk to.
</description> </description>
@ -759,6 +836,7 @@
<property> <property>
<name>dfs.storage.service.handler.count</name> <name>dfs.storage.service.handler.count</name>
<value>10</value> <value>10</value>
<tag>OZONE</tag>
<description> <description>
Default number of handlers for CBlock service rpc. Default number of handlers for CBlock service rpc.
</description> </description>
@ -767,6 +845,7 @@
<property> <property>
<name>dfs.cblock.service.leveldb.path</name> <name>dfs.cblock.service.leveldb.path</name>
<value>/tmp/cblock_levelDB.dat</value> <value>/tmp/cblock_levelDB.dat</value>
<tag>OZONE</tag>
<description> <description>
Default path for the cblock meta data disk store. Default path for the cblock meta data disk store.
</description> </description>
@ -775,6 +854,7 @@
<property> <property>
<name>dfs.cblock.disk.cache.path</name> <name>dfs.cblock.disk.cache.path</name>
<value>/tmp/cblockCacheDB</value> <value>/tmp/cblockCacheDB</value>
<tag>OZONE</tag>
<description> <description>
Default path for the cblock local cache. Default path for the cblock local cache.
</description> </description>
@ -783,6 +863,7 @@
<property> <property>
<name>dfs.cblock.trace.io</name> <name>dfs.cblock.trace.io</name>
<value>false</value> <value>false</value>
<tag>OZONE</tag>
<description> <description>
Default flag for enabling trace io. Default flag for enabling trace io.
</description> </description>
@ -791,6 +872,7 @@
<property> <property>
<name>dfs.cblock.short.circuit.io</name> <name>dfs.cblock.short.circuit.io</name>
<value>false</value> <value>false</value>
<tag>OZONE</tag>
<description> <description>
Default flag to enable cblock local cache. Default flag to enable cblock local cache.
</description> </description>
@ -799,6 +881,7 @@
<property> <property>
<name>dfs.cblock.cache.cache.size.in.kb</name> <name>dfs.cblock.cache.cache.size.in.kb</name>
<value>256</value> <value>256</value>
<tag>OZONE</tag>
<description> <description>
Default cblock cache queue size, in number of kb. Default cblock cache queue size, in number of kb.
</description> </description>
@ -807,6 +890,7 @@
<property> <property>
<name>dfs.cblock.cache.core.min.pool.size</name> <name>dfs.cblock.cache.core.min.pool.size</name>
<value>16</value> <value>16</value>
<tag>OZONE</tag>
<description> <description>
Minimum number of thread pool thread that cBlock cache will use for background I/O. Minimum number of thread pool thread that cBlock cache will use for background I/O.
</description> </description>
@ -815,6 +899,7 @@
<property> <property>
<name>dfs.cblock.cache.max.pool.size</name> <name>dfs.cblock.cache.max.pool.size</name>
<value>256</value> <value>256</value>
<tag>OZONE</tag>
<description> <description>
Maximum number of thread pool thread that cBlcok cache will use for background I/O. Maximum number of thread pool thread that cBlcok cache will use for background I/O.
</description> </description>
@ -823,6 +908,7 @@
<property> <property>
<name>dfs.cblock.cache.keep.alive.seconds</name> <name>dfs.cblock.cache.keep.alive.seconds</name>
<value>60</value> <value>60</value>
<tag>OZONE</tag>
<description> <description>
Number of seconds to keep the Thread alive when it is idle. Number of seconds to keep the Thread alive when it is idle.
</description> </description>
@ -831,6 +917,7 @@
<property> <property>
<name>dfs.cblock.cache.thread.priority</name> <name>dfs.cblock.cache.thread.priority</name>
<value>5</value> <value>5</value>
<tag>OZONE</tag>
<description> <description>
Priority of cache flusher thread, affecting the relative Priority of cache flusher thread, affecting the relative
performance of write and read.upported values are 1, 5, 10. performance of write and read.upported values are 1, 5, 10.
@ -841,6 +928,7 @@
<property> <property>
<name>dfs.cblock.cache.block.buffer.size</name> <name>dfs.cblock.cache.block.buffer.size</name>
<value>512</value> <value>512</value>
<tag>OZONE</tag>
<description> <description>
Block Buffer size in terms of blockID entries, in number of blockIDs. Block Buffer size in terms of blockID entries, in number of blockIDs.
</description> </description>
@ -849,6 +937,7 @@
<property> <property>
<name>dfs.cblock.block.buffer.flush.interval.seconds</name> <name>dfs.cblock.block.buffer.flush.interval.seconds</name>
<value>60</value> <value>60</value>
<tag>OZONE</tag>
<description> <description>
The interval to flush cblock buffer in seconds. The interval to flush cblock buffer in seconds.
</description> </description>
@ -857,6 +946,7 @@
<property> <property>
<name>dfs.cblock.jscsi.server.address</name> <name>dfs.cblock.jscsi.server.address</name>
<value>0.0.0.0</value> <value>0.0.0.0</value>
<tag>OZONE</tag>
<description> <description>
The address that jscsi server will be running, should have one The address that jscsi server will be running, should have one
local jscsi server for each client that tries to mount cblock. local jscsi server for each client that tries to mount cblock.
@ -866,6 +956,7 @@
<property> <property>
<name>dfs.cblock.jscsi.cblock.server.address</name> <name>dfs.cblock.jscsi.cblock.server.address</name>
<value>127.0.0.1</value> <value>127.0.0.1</value>
<tag>OZONE</tag>
<description> <description>
The address local jscsi server will use to talk to cblock manager. The address local jscsi server will use to talk to cblock manager.
</description> </description>
@ -874,6 +965,7 @@
<property> <property>
<name>dfs.cblock.container.size</name> <name>dfs.cblock.container.size</name>
<value>5</value> <value>5</value>
<tag>OZONE</tag>
<description> <description>
The size of ozone container in number of GBs. Note that this is The size of ozone container in number of GBs. Note that this is
not setting container size for ozone, but rather, this is setting not setting container size for ozone, but rather, this is setting
@ -884,6 +976,7 @@
<property> <property>
<name>dfs.cblock.cache.leveldb.cache.size.mb</name> <name>dfs.cblock.cache.leveldb.cache.size.mb</name>
<value>256</value> <value>256</value>
<tag>OZONE</tag>
<description> <description>
The size of LevelDB cache file which uses an off-heap cache in LevelDB. The size of LevelDB cache file which uses an off-heap cache in LevelDB.
</description> </description>
@ -892,6 +985,7 @@
<property> <property>
<name>dfs.cblock.cache.max.retry</name> <name>dfs.cblock.cache.max.retry</name>
<value>65536</value> <value>65536</value>
<tag>OZONE</tag>
<description> <description>
The maximum number of retries when writing a block to container. The maximum number of retries when writing a block to container.
</description> </description>
@ -900,6 +994,7 @@
<property> <property>
<name>dfs.cblock.manager.pool.size</name> <name>dfs.cblock.manager.pool.size</name>
<value>16</value> <value>16</value>
<tag>OZONE</tag>
<description> <description>
Number of threads that cblock manager will use for container operations. Number of threads that cblock manager will use for container operations.
</description> </description>
@ -908,6 +1003,7 @@
<property> <property>
<name>dfs.cblock.rpc.timeout.seconds</name> <name>dfs.cblock.rpc.timeout.seconds</name>
<value>300</value> <value>300</value>
<tag>OZONE</tag>
<description> <description>
RPC timeout in seconds used for cblock CLI operations. RPC timeout in seconds used for cblock CLI operations.
</description> </description>
@ -916,6 +1012,7 @@
<property> <property>
<name>dfs.cblock.scm.ipaddress</name> <name>dfs.cblock.scm.ipaddress</name>
<value>127.0.0.1</value> <value>127.0.0.1</value>
<tag>OZONE</tag>
<description> <description>
IP address used by cblock to connect to SCM. IP address used by cblock to connect to SCM.
</description> </description>
@ -924,6 +1021,7 @@
<property> <property>
<name>dfs.cblock.scm.port</name> <name>dfs.cblock.scm.port</name>
<value>9860</value> <value>9860</value>
<tag>OZONE</tag>
<description> <description>
Port used by cblock to connect to SCM. Port used by cblock to connect to SCM.
</description> </description>
@ -932,6 +1030,7 @@
<property> <property>
<name>ozone.scm.block.size</name> <name>ozone.scm.block.size</name>
<value>268435456</value> <value>268435456</value>
<tag>OZONE</tag>
<description> <description>
The default size of a scm block in bytes. The default size of a scm block in bytes.
</description> </description>
@ -940,6 +1039,7 @@
<property> <property>
<name>dfs.container.ratis.ipc</name> <name>dfs.container.ratis.ipc</name>
<value>9858</value> <value>9858</value>
<tag>OZONE,CONTAINER,PIPELINE,RATIS</tag>
<description> <description>
The ipc port number of container. The ipc port number of container.
</description> </description>
@ -948,6 +1048,7 @@
<property> <property>
<name>dfs.container.ratis.ipc.random.port</name> <name>dfs.container.ratis.ipc.random.port</name>
<value>false</value> <value>false</value>
<tag>OZONE,CONTAINER,PIPELINE,RATIS</tag>
<description> <description>
Whether allocates a random free port for ozone ratis port for container. Whether allocates a random free port for ozone ratis port for container.
</description> </description>

View File

@ -18,9 +18,13 @@
package org.apache.hadoop.ozone; package org.apache.hadoop.ozone;
import org.apache.hadoop.cblock.CBlockConfigKeys; import org.apache.hadoop.cblock.CBlockConfigKeys;
import org.apache.hadoop.conf.Configuration;
import org.apache.hadoop.conf.OzonePropertyTag;
import org.apache.hadoop.conf.TestConfigurationFieldsBase; import org.apache.hadoop.conf.TestConfigurationFieldsBase;
import org.apache.hadoop.ozone.ksm.KSMConfigKeys; import org.apache.hadoop.ozone.ksm.KSMConfigKeys;
import org.apache.hadoop.scm.ScmConfigKeys; import org.apache.hadoop.scm.ScmConfigKeys;
import org.junit.Test;
import static org.junit.Assert.assertEquals;
/** /**
* Tests if configuration constants documented in ozone-defaults.xml. * Tests if configuration constants documented in ozone-defaults.xml.
@ -37,4 +41,31 @@ public void initializeMemberVariables() {
errorIfMissingXmlProps = true; errorIfMissingXmlProps = true;
} }
@Test
public void testOzoneTags() {
Configuration config = new OzoneConfiguration();
config.reloadConfiguration();
// To load default resources
config.get("ozone.enabled");
assertEquals(87,
config.getAllPropertiesByTag(OzonePropertyTag.OZONE).size());
assertEquals(15, config.getAllPropertiesByTag(OzonePropertyTag.KSM)
.size());
assertEquals(6, config.getAllPropertiesByTag(OzonePropertyTag.SCM)
.size());
assertEquals(6, config.getAllPropertiesByTag(OzonePropertyTag.MANAGEMENT)
.size());
assertEquals(7, config.getAllPropertiesByTag(OzonePropertyTag.SECURITY)
.size());
assertEquals(9, config.getAllPropertiesByTag(OzonePropertyTag.PERFORMANCE)
.size());
assertEquals(1, config.getAllPropertiesByTag(OzonePropertyTag.DEBUG)
.size());
assertEquals(3, config.getAllPropertiesByTag(OzonePropertyTag.REQUIRED)
.size());
assertEquals(2, config.getAllPropertiesByTag(OzonePropertyTag.RATIS)
.size());
}
} }