ozone-default.xml 73 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138
  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <?xml-stylesheet type="text/xsl" href="configuration.xsl"?>
  3. <!--
  4. Licensed to the Apache Software Foundation (ASF) under one or more
  5. contributor license agreements. See the NOTICE file distributed with
  6. this work for additional information regarding copyright ownership.
  7. The ASF licenses this file to You under the Apache License, Version 2.0
  8. (the "License"); you may not use this file except in compliance with
  9. the License. You may obtain a copy of the License at
  10. http://www.apache.org/licenses/LICENSE-2.0
  11. Unless required by applicable law or agreed to in writing, software
  12. distributed under the License is distributed on an "AS IS" BASIS,
  13. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14. See the License for the specific language governing permissions and
  15. limitations under the License.
  16. -->
  17. <!-- Do not modify this file directly. Instead, copy entries that you -->
  18. <!-- wish to modify from this file into ozone-site.xml and change them -->
  19. <!-- there. If ozone-site.xml does not already exist, create it. -->
  20. <!--Tags supported are OZONE, CBLOCK, MANAGEMENT, SECURITY, PERFORMANCE, -->
  21. <!--DEBUG, CLIENT, SERVER, OM, SCM, CRITICAL, RATIS, CONTAINER, REQUIRED, -->
  22. <!--REST, STORAGE, PIPELINE, STANDALONE -->
  23. <configuration>
  24. <!--Container Settings used by Datanode-->
  25. <property>
  26. <name>ozone.container.cache.size</name>
  27. <value>1024</value>
  28. <tag>PERFORMANCE, CONTAINER, STORAGE</tag>
  29. <description>The open container is cached on the data node side. We maintain
  30. an LRU
  31. cache for caching the recently used containers. This setting controls the
  32. size of that cache.
  33. </description>
  34. </property>
  35. <property>
  36. <name>dfs.container.ipc</name>
  37. <value>9859</value>
  38. <tag>OZONE, CONTAINER, MANAGEMENT</tag>
  39. <description>The ipc port number of container.</description>
  40. </property>
  41. <property>
  42. <name>dfs.container.ipc.random.port</name>
  43. <value>false</value>
  44. <tag>OZONE, DEBUG, CONTAINER</tag>
  45. <description>Allocates a random free port for ozone container. This is used
  46. only while
  47. running unit tests.
  48. </description>
  49. </property>
  50. <property>
  51. <name>dfs.container.chunk.write.sync</name>
  52. <value>true</value>
  53. <tag>OZONE, CONTAINER, MANAGEMENT</tag>
  54. <description>Determines whether the chunk writes in the container happen as
  55. sync I/0 or buffered I/O operation.
  56. </description>
  57. </property>
  58. <property>
  59. <name>dfs.container.ratis.statemachinedata.sync.timeout</name>
  60. <value>10s</value>
  61. <tag>OZONE, DEBUG, CONTAINER, RATIS</tag>
  62. <description>Timeout for StateMachine data writes by Ratis.
  63. </description>
  64. </property>
  65. <property>
  66. <name>dfs.container.ratis.statemachinedata.sync.retries</name>
  67. <value>-1</value>
  68. <tag>OZONE, DEBUG, CONTAINER, RATIS</tag>
  69. <description>Number of times the WriteStateMachineData op will be tried
  70. before failing, if this value is -1, then this retries indefinitely.
  71. </description>
  72. </property>
  73. <property>
  74. <name>dfs.container.ratis.log.queue.num-elements</name>
  75. <value>1024</value>
  76. <tag>OZONE, DEBUG, CONTAINER, RATIS</tag>
  77. <description>Limit for the number of operations in Ratis Log Worker.
  78. </description>
  79. </property>
  80. <property>
  81. <name>dfs.container.ratis.log.queue.byte-limit</name>
  82. <value>4GB</value>
  83. <tag>OZONE, DEBUG, CONTAINER, RATIS</tag>
  84. <description>Byte limit for Ratis Log Worker queue.
  85. </description>
  86. </property>
  87. <property>
  88. <name>dfs.container.ratis.log.appender.queue.num-elements</name>
  89. <value>1</value>
  90. <tag>OZONE, DEBUG, CONTAINER, RATIS</tag>
  91. <description>Limit for number of append entries in ratis leader's
  92. log appender queue.
  93. </description>
  94. </property>
  95. <property>
  96. <name>dfs.container.ratis.log.appender.queue.byte-limit</name>
  97. <value>32MB</value>
  98. <tag>OZONE, DEBUG, CONTAINER, RATIS</tag>
  99. <description>Byte limit for ratis leader's log appender queue.
  100. </description>
  101. </property>
  102. <property>
  103. <name>dfs.container.ratis.datanode.storage.dir</name>
  104. <value/>
  105. <tag>OZONE, CONTAINER, STORAGE, MANAGEMENT, RATIS</tag>
  106. <description>This directory is used for storing Ratis metadata like logs. If
  107. this is
  108. not set then default metadata dirs is used. A warning will be logged if
  109. this not set. Ideally, this should be mapped to a fast disk like an SSD.
  110. </description>
  111. </property>
  112. <property>
  113. <name>hdds.datanode.dir</name>
  114. <value/>
  115. <tag>OZONE, CONTAINER, STORAGE, MANAGEMENT</tag>
  116. <description>Determines where on the local filesystem HDDS data will be
  117. stored. Defaults to dfs.datanode.data.dir if not specified.
  118. The directories should be tagged with corresponding storage types
  119. ([SSD]/[DISK]/[ARCHIVE]/[RAM_DISK]) for storage policies. The default
  120. storage type will be DISK if the directory does not have a storage type
  121. tagged explicitly.
  122. </description>
  123. </property>
  124. <property>
  125. <name>hdds.datanode.volume.choosing.policy</name>
  126. <value/>
  127. <tag>OZONE, CONTAINER, STORAGE, MANAGEMENT</tag>
  128. <description>
  129. The class name of the policy for choosing volumes in the list of
  130. directories. Defaults to
  131. org.apache.hadoop.ozone.container.common.volume.RoundRobinVolumeChoosingPolicy.
  132. This volume choosing policy selects volumes in a round-robin order.
  133. </description>
  134. </property>
  135. <property>
  136. <name>dfs.container.ratis.enabled</name>
  137. <value>false</value>
  138. <tag>OZONE, MANAGEMENT, PIPELINE, RATIS</tag>
  139. <description>Ozone supports different kinds of replication pipelines. Ratis
  140. is one of
  141. the replication pipeline supported by ozone.
  142. </description>
  143. </property>
  144. <property>
  145. <name>dfs.container.ratis.ipc</name>
  146. <value>9858</value>
  147. <tag>OZONE, CONTAINER, PIPELINE, RATIS, MANAGEMENT</tag>
  148. <description>The ipc port number of container.</description>
  149. </property>
  150. <property>
  151. <name>dfs.container.ratis.ipc.random.port</name>
  152. <value>false</value>
  153. <tag>OZONE,DEBUG</tag>
  154. <description>Allocates a random free port for ozone ratis port for the
  155. container. This
  156. is used only while running unit tests.
  157. </description>
  158. </property>
  159. <property>
  160. <name>dfs.container.ratis.rpc.type</name>
  161. <value>GRPC</value>
  162. <tag>OZONE, RATIS, MANAGEMENT</tag>
  163. <description>Ratis supports different kinds of transports like netty, GRPC,
  164. Hadoop RPC
  165. etc. This picks one of those for this cluster.
  166. </description>
  167. </property>
  168. <property>
  169. <name>dfs.ratis.snapshot.threshold</name>
  170. <value>10000</value>
  171. <tag>OZONE, RATIS</tag>
  172. <description>Number of transactions after which a ratis snapshot should be
  173. taken.
  174. </description>
  175. </property>
  176. <property>
  177. <name>dfs.container.ratis.num.write.chunk.threads</name>
  178. <value>60</value>
  179. <tag>OZONE, RATIS, PERFORMANCE</tag>
  180. <description>Maximum number of threads in the thread pool that Ratis
  181. will use for writing chunks (60 by default).
  182. </description>
  183. </property>
  184. <property>
  185. <name>dfs.container.ratis.replication.level</name>
  186. <value>MAJORITY</value>
  187. <tag>OZONE, RATIS</tag>
  188. <description>Replication level to be used by datanode for submitting a
  189. container command to ratis. Available replication levels are ALL and
  190. MAJORTIY, MAJORITY is used as the default replication level.
  191. </description>
  192. </property>
  193. <property>
  194. <name>dfs.container.ratis.num.container.op.executors</name>
  195. <value>10</value>
  196. <tag>OZONE, RATIS, PERFORMANCE</tag>
  197. <description>Number of executors that will be used by Ratis to execute
  198. container ops.(10 by default).
  199. </description>
  200. </property>
  201. <property>
  202. <name>dfs.container.ratis.segment.size</name>
  203. <value>16KB</value>
  204. <tag>OZONE, RATIS, PERFORMANCE</tag>
  205. <description>The size of the raft segment used by Apache Ratis on datanodes.
  206. (16 KB by default)
  207. </description>
  208. </property>
  209. <property>
  210. <name>dfs.container.ratis.segment.preallocated.size</name>
  211. <value>16KB</value>
  212. <tag>OZONE, RATIS, PERFORMANCE</tag>
  213. <description>The size of the buffer which is preallocated for raft segment
  214. used by Apache Ratis on datanodes.(16 KB by default)
  215. </description>
  216. </property>
  217. <property>
  218. <name>dfs.container.ratis.statemachine.cache.expiry.interval</name>
  219. <value>10s</value>
  220. <tag>OZONE, RATIS, PERFORMANCE</tag>
  221. <description>The interval till which the stateMachine data in ratis
  222. will be cached inside the ContainerStateMachine.
  223. </description>
  224. </property>
  225. <property>
  226. <name>dfs.ratis.client.request.timeout.duration</name>
  227. <value>3s</value>
  228. <tag>OZONE, RATIS, MANAGEMENT</tag>
  229. <description>The timeout duration for ratis client request.</description>
  230. </property>
  231. <property>
  232. <name>dfs.ratis.client.request.max.retries</name>
  233. <value>180</value>
  234. <tag>OZONE, RATIS, MANAGEMENT</tag>
  235. <description>Number of retries for ratis client request.</description>
  236. </property>
  237. <property>
  238. <name>dfs.ratis.client.request.retry.interval</name>
  239. <value>100ms</value>
  240. <tag>OZONE, RATIS, MANAGEMENT</tag>
  241. <description>Interval between successive retries for a ratis client request.
  242. </description>
  243. </property>
  244. <property>
  245. <name>dfs.ratis.server.retry-cache.timeout.duration</name>
  246. <value>600000ms</value>
  247. <tag>OZONE, RATIS, MANAGEMENT</tag>
  248. <description>Retry Cache entry timeout for ratis server.</description>
  249. </property>
  250. <property>
  251. <name>dfs.ratis.server.request.timeout.duration</name>
  252. <value>3s</value>
  253. <tag>OZONE, RATIS, MANAGEMENT</tag>
  254. <description>The timeout duration for ratis server request.</description>
  255. </property>
  256. <property>
  257. <name>dfs.ratis.leader.election.minimum.timeout.duration</name>
  258. <value>1s</value>
  259. <tag>OZONE, RATIS, MANAGEMENT</tag>
  260. <description>The minimum timeout duration for ratis leader election.
  261. Default is 1s.
  262. </description>
  263. </property>
  264. <property>
  265. <name>dfs.ratis.server.failure.duration</name>
  266. <value>120s</value>
  267. <tag>OZONE, RATIS, MANAGEMENT</tag>
  268. <description>The timeout duration for ratis server failure detection,
  269. once the threshold has reached, the ratis state machine will be informed
  270. about the failure in the ratis ring
  271. </description>
  272. </property>
  273. <property>
  274. <name>hdds.node.report.interval</name>
  275. <value>60000ms</value>
  276. <tag>OZONE, CONTAINER, MANAGEMENT</tag>
  277. <description>Time interval of the datanode to send node report. Each
  278. datanode periodically send node report to SCM. Unit could be
  279. defined with postfix (ns,ms,s,m,h,d)</description>
  280. </property>
  281. <property>
  282. <name>hdds.container.report.interval</name>
  283. <value>60000ms</value>
  284. <tag>OZONE, CONTAINER, MANAGEMENT</tag>
  285. <description>Time interval of the datanode to send container report. Each
  286. datanode periodically send container report to SCM. Unit could be
  287. defined with postfix (ns,ms,s,m,h,d)</description>
  288. </property>
  289. <property>
  290. <name>hdds.command.status.report.interval</name>
  291. <value>60000ms</value>
  292. <tag>OZONE, CONTAINER, MANAGEMENT</tag>
  293. <description>Time interval of the datanode to send status of command
  294. execution. Each datanode periodically the execution status of commands
  295. received from SCM to SCM. Unit could be defined with postfix
  296. (ns,ms,s,m,h,d)</description>
  297. </property>
  298. <property>
  299. <name>hdds.pipeline.report.interval</name>
  300. <value>60000ms</value>
  301. <tag>OZONE, PIPELINE, MANAGEMENT</tag>
  302. <description>Time interval of the datanode to send pipeline report. Each
  303. datanode periodically send pipeline report to SCM. Unit could be
  304. defined with postfix (ns,ms,s,m,h,d)</description>
  305. </property>
  306. <property>
  307. <name>hdds.prometheus.endpoint.enabled</name>
  308. <value>false</value>
  309. <tag>OZONE, MANAGEMENT</tag>
  310. <description>Enable prometheus compatible metric page on the HTTP
  311. servers.
  312. </description>
  313. </property>
  314. <property>
  315. <name>hdds.profiler.endpoint.enabled</name>
  316. <value>false</value>
  317. <tag>OZONE, MANAGEMENT</tag>
  318. <description>Enable /prof java profiler servlet page on HTTP server.
  319. </description>
  320. </property>
  321. <!--Ozone Settings-->
  322. <property>
  323. <name>ozone.administrators</name>
  324. <value/>
  325. <tag>OZONE, SECURITY</tag>
  326. <description>Ozone administrator users delimited by the comma.
  327. If not set, only the user who launches an ozone service will be the admin
  328. user. This property must be set if ozone services are started by different
  329. users. Otherwise, the RPC layer will reject calls from other servers which
  330. are started by users not in the list.
  331. </description>
  332. </property>
  333. <property>
  334. <name>ozone.block.deleting.container.limit.per.interval</name>
  335. <value>10</value>
  336. <tag>OZONE, PERFORMANCE, SCM</tag>
  337. <description>A maximum number of containers to be scanned by block deleting
  338. service per
  339. time interval. The block deleting service spawns a thread to handle block
  340. deletions in a container. This property is used to throttle the number of
  341. threads spawned for block deletions.
  342. </description>
  343. </property>
  344. <property>
  345. <name>ozone.block.deleting.limit.per.task</name>
  346. <value>1000</value>
  347. <tag>OZONE, PERFORMANCE, SCM</tag>
  348. <description>A maximum number of blocks to be deleted by block deleting
  349. service per
  350. time interval. This property is used to throttle the actual number of
  351. block deletions on a data node per container.
  352. </description>
  353. </property>
  354. <property>
  355. <name>ozone.block.deleting.service.interval</name>
  356. <value>1m</value>
  357. <tag>OZONE, PERFORMANCE, SCM</tag>
  358. <description>Time interval of the block deleting service.
  359. The block deleting service runs on each datanode periodically and
  360. deletes blocks queued for deletion. Unit could be defined with
  361. postfix (ns,ms,s,m,h,d)
  362. </description>
  363. </property>
  364. <property>
  365. <name>ozone.block.deleting.service.timeout</name>
  366. <value>300000ms</value>
  367. <tag>OZONE, PERFORMANCE, SCM</tag>
  368. <description>A timeout value of block deletion service. If this is set
  369. greater than 0,
  370. the service will stop waiting for the block deleting completion after this
  371. time. If timeout happens to a large proportion of block deletion, this
  372. needs to be increased with ozone.block.deleting.limit.per.task. This
  373. setting supports multiple time unit suffixes as described in
  374. dfs.heartbeat.interval. If no suffix is specified, then milliseconds is
  375. assumed.
  376. </description>
  377. </property>
  378. <property>
  379. <name>ozone.client.connection.timeout</name>
  380. <value>5000ms</value>
  381. <tag>OZONE, PERFORMANCE, CLIENT</tag>
  382. <description>Connection timeout for Ozone client in milliseconds.
  383. </description>
  384. </property>
  385. <property>
  386. <name>ozone.client.stream.buffer.flush.size</name>
  387. <value>64MB</value>
  388. <tag>OZONE, CLIENT</tag>
  389. <description>Size which determines at what buffer position , a partial
  390. flush will be initiated during write. It should be ideally a multiple
  391. of chunkSize.
  392. </description>
  393. </property>
  394. <property>
  395. <name>ozone.client.stream.buffer.max.size</name>
  396. <value>128MB</value>
  397. <tag>OZONE, CLIENT</tag>
  398. <description>Size which determines at what buffer position,
  399. write call be blocked till acknowledgement of the first partial flush
  400. happens by all servers.
  401. </description>
  402. </property>
  403. <property>
  404. <name>ozone.client.watch.request.timeout</name>
  405. <value>30s</value>
  406. <tag>OZONE, CLIENT</tag>
  407. <description>Timeout for the watch API in Ratis client to acknowledge
  408. a particular request getting replayed to all servers.
  409. </description>
  410. </property>
  411. <property>
  412. <name>ozone.client.protocol</name>
  413. <value>org.apache.hadoop.ozone.client.rpc.RpcClient</value>
  414. <tag>OZONE, CLIENT, MANAGEMENT</tag>
  415. <description>Protocol class to be used by the client to connect to ozone
  416. cluster.
  417. The build-in implementation includes:
  418. org.apache.hadoop.ozone.client.rpc.RpcClient for RPC
  419. org.apache.hadoop.ozone.client.rest.RestClient for REST
  420. The default is the RpClient. Please do not change this unless you have a
  421. very good understanding of what you are doing.
  422. </description>
  423. </property>
  424. <property>
  425. <name>ozone.client.socket.timeout</name>
  426. <value>5000ms</value>
  427. <tag>OZONE, CLIENT</tag>
  428. <description>Socket timeout for Ozone client. Unit could be defined with
  429. postfix (ns,ms,s,m,h,d)</description>
  430. </property>
  431. <property>
  432. <name>ozone.enabled</name>
  433. <value>false</value>
  434. <tag>OZONE, REQUIRED</tag>
  435. <description>
  436. Status of the Ozone Object Storage service is enabled.
  437. Set to true to enable Ozone.
  438. Set to false to disable Ozone.
  439. Unless this value is set to true, Ozone services will not be started in
  440. the cluster.
  441. Please note: By default ozone is disabled on a hadoop cluster.
  442. </description>
  443. </property>
  444. <property>
  445. <name>ozone.key.deleting.limit.per.task</name>
  446. <value>1000</value>
  447. <tag>OM, PERFORMANCE</tag>
  448. <description>
  449. A maximum number of keys to be scanned by key deleting service
  450. per time interval in OM. Those keys are sent to delete metadata and
  451. generate transactions in SCM for next async deletion between SCM
  452. and DataNode.
  453. </description>
  454. </property>
  455. <property>
  456. <name>ozone.om.service.ids</name>
  457. <value></value>
  458. <tag>OM, HA</tag>
  459. <description>
  460. Comma-separated list of OM service Ids.
  461. If not set, the default value of "om-service-value" is assigned as the
  462. OM service ID.
  463. </description>
  464. </property>
  465. <property>
  466. <name>ozone.om.nodes.EXAMPLEOMSERVICEID</name>
  467. <value></value>
  468. <tag>OM, HA</tag>
  469. <description>
  470. Comma-separated list of OM node Ids for a given OM service ID (eg.
  471. EXAMPLEOMSERVICEID). The OM service ID should be the value (one of the
  472. values if there are multiple) set for the parameter ozone.om.service.ids.
  473. Unique identifiers for each OM Node, delimited by commas. This will be
  474. used by OzoneManagers in HA setup to determine all the OzoneManagers
  475. belonging to the same OMservice in the cluster. For example, if you
  476. used “omService1” as the OM service ID previously, and you wanted to
  477. use “om1”, “om2” and "om3" as the individual IDs of the OzoneManagers,
  478. you would configure a property ozone.om.nodes.omService1, and its value
  479. "om1,om2,om3".
  480. </description>
  481. </property>
  482. <property>
  483. <name>ozone.om.node.id</name>
  484. <value></value>
  485. <tag>OM, HA</tag>
  486. <description>
  487. The ID of this OM node. If the OM node ID is not configured it
  488. is determined automatically by matching the local node's address
  489. with the configured address.
  490. If node ID is not deterministic from the configuration, then it is set
  491. to the OmId from the OM version file.
  492. </description>
  493. </property>
  494. <property>
  495. <name>ozone.om.address</name>
  496. <value/>
  497. <tag>OM, REQUIRED</tag>
  498. <description>
  499. The address of the Ozone OM service. This allows clients to discover
  500. the address of the OM.
  501. </description>
  502. </property>
  503. <property>
  504. <name>ozone.om.group.rights</name>
  505. <value>READ_WRITE</value>
  506. <tag>OM, SECURITY</tag>
  507. <description>
  508. Default group permissions in Ozone OM.
  509. </description>
  510. </property>
  511. <property>
  512. <name>ozone.om.handler.count.key</name>
  513. <value>20</value>
  514. <tag>OM, PERFORMANCE</tag>
  515. <description>
  516. The number of RPC handler threads for OM service endpoints.
  517. </description>
  518. </property>
  519. <property>
  520. <name>ozone.om.http-address</name>
  521. <value>0.0.0.0:9874</value>
  522. <tag>OM, MANAGEMENT</tag>
  523. <description>
  524. The address and the base port where the OM web UI will listen on.
  525. If the port is 0, then the server will start on a free port. However, it
  526. is best to specify a well-known port, so it is easy to connect and see
  527. the OM management UI.
  528. </description>
  529. </property>
  530. <property>
  531. <name>ozone.om.http-bind-host</name>
  532. <value>0.0.0.0</value>
  533. <tag>OM, MANAGEMENT</tag>
  534. <description>
  535. The actual address the OM web server will bind to. If this optional
  536. the address is set, it overrides only the hostname portion of
  537. ozone.om.http-address.
  538. </description>
  539. </property>
  540. <property>
  541. <name>ozone.om.http.enabled</name>
  542. <value>true</value>
  543. <tag>OM, MANAGEMENT</tag>
  544. <description>
  545. Property to enable or disable OM web user interface.
  546. </description>
  547. </property>
  548. <property>
  549. <name>ozone.om.https-address</name>
  550. <value>0.0.0.0:9875</value>
  551. <tag>OM, MANAGEMENT, SECURITY</tag>
  552. <description>
  553. The address and the base port where the OM web UI will listen
  554. on using HTTPS.
  555. If the port is 0 then the server will start on a free port.
  556. </description>
  557. </property>
  558. <property>
  559. <name>ozone.om.https-bind-host</name>
  560. <value>0.0.0.0</value>
  561. <tag>OM, MANAGEMENT, SECURITY</tag>
  562. <description>
  563. The actual address the OM web server will bind to using HTTPS.
  564. If this optional address is set, it overrides only the hostname portion of
  565. ozone.om.http-address.
  566. </description>
  567. </property>
  568. <property>
  569. <name>ozone.om.keytab.file</name>
  570. <value/>
  571. <tag>OM, SECURITY</tag>
  572. <description>
  573. The keytab file for Kerberos authentication in OM.
  574. </description>
  575. </property>
  576. <property>
  577. <name>ozone.om.db.cache.size.mb</name>
  578. <value>128</value>
  579. <tag>OM, PERFORMANCE</tag>
  580. <description>
  581. The size of OM DB cache in MB that used for caching files.
  582. This value is set to an abnormally low value in the default configuration.
  583. That is to make unit testing easy. Generally, this value should be set to
  584. something like 16GB or more, if you intend to use Ozone at scale.
  585. A large value for this key allows a proportionally larger amount of OM
  586. metadata to be cached in memory. This makes OM operations faster.
  587. </description>
  588. </property>
  589. <property>
  590. <name>ozone.om.user.max.volume</name>
  591. <value>1024</value>
  592. <tag>OM, MANAGEMENT</tag>
  593. <description>
  594. The maximum number of volumes a user can have on a cluster.Increasing or
  595. decreasing this number has no real impact on ozone cluster. This is
  596. defined only for operational purposes. Only an administrator can create a
  597. volume, once a volume is created there are no restrictions on the number
  598. of buckets or keys inside each bucket a user can create.
  599. </description>
  600. </property>
  601. <property>
  602. <name>ozone.om.user.rights</name>
  603. <value>READ_WRITE</value>
  604. <tag>OM, SECURITY</tag>
  605. <description>
  606. Default user permissions used in OM.
  607. </description>
  608. </property>
  609. <property>
  610. <name>ozone.om.db.dirs</name>
  611. <value/>
  612. <tag>OZONE, OM, STORAGE, PERFORMANCE</tag>
  613. <description>
  614. Directory where the OzoneManager stores its metadata. This should
  615. be specified as a single directory. If the directory does not
  616. exist then the OM will attempt to create it.
  617. If undefined, then the OM will log a warning and fallback to
  618. ozone.metadata.dirs.
  619. </description>
  620. </property>
  621. <property>
  622. <name>ozone.metadata.dirs</name>
  623. <value/>
  624. <tag>OZONE, OM, SCM, CONTAINER, STORAGE</tag>
  625. <description>
  626. This setting is the fallback location for SCM, OM and DataNodes
  627. to store their metadata. This setting may be used in test/PoC clusters
  628. to simplify configuration.
  629. For production clusters or any time you care about performance, it is
  630. recommended that ozone.om.db.dirs, ozone.scm.db.dirs and
  631. dfs.container.ratis.datanode.storage.dir be configured separately.
  632. </description>
  633. </property>
  634. <property>
  635. <name>ozone.metastore.impl</name>
  636. <value>RocksDB</value>
  637. <tag>OZONE, OM, SCM, CONTAINER, STORAGE</tag>
  638. <description>
  639. Ozone metadata store implementation. Ozone metadata are well
  640. distributed to multiple services such as ozoneManager, scm. They are stored in
  641. some local key-value databases. This property determines which database
  642. library to use. Supported value is either LevelDB or RocksDB.
  643. </description>
  644. </property>
  645. <property>
  646. <name>ozone.metastore.rocksdb.statistics</name>
  647. <value>OFF</value>
  648. <tag>OZONE, OM, SCM, STORAGE, PERFORMANCE</tag>
  649. <description>
  650. The statistics level of the rocksdb store. If you use any value from
  651. org.rocksdb.StatsLevel (eg. ALL or EXCEPT_DETAILED_TIMERS), the rocksdb
  652. statistics will be exposed over JMX bean with the choosed setting. Set
  653. it to OFF to not initialize rocksdb statistics at all. Please note that
  654. collection of statistics could have 5-10% performance penalty.
  655. Check the rocksdb documentation for more details.
  656. </description>
  657. </property>
  658. <property>
  659. <name>ozone.scm.db.dirs</name>
  660. <value/>
  661. <tag>OZONE, SCM, STORAGE, PERFORMANCE</tag>
  662. <description>
  663. Directory where the StorageContainerManager stores its metadata.
  664. This should be specified as a single directory. If the directory
  665. does not exist then the SCM will attempt to create it.
  666. If undefined, then the SCM will log a warning and fallback to
  667. ozone.metadata.dirs.
  668. </description>
  669. </property>
  670. <property>
  671. <name>ozone.scm.block.client.address</name>
  672. <value/>
  673. <tag>OZONE, SCM</tag>
  674. <description>The address of the Ozone SCM block client service. If not
  675. defined value of ozone.scm.client.address is used.
  676. </description>
  677. </property>
  678. <property>
  679. <name>ozone.scm.block.client.bind.host</name>
  680. <value>0.0.0.0</value>
  681. <tag>OZONE, SCM</tag>
  682. <description>
  683. The hostname or IP address used by the SCM block client
  684. endpoint to bind.
  685. </description>
  686. </property>
  687. <property>
  688. <name>ozone.scm.block.client.port</name>
  689. <value>9863</value>
  690. <tag>OZONE, SCM</tag>
  691. <description>
  692. The port number of the Ozone SCM block client service.
  693. </description>
  694. </property>
  695. <property>
  696. <name>ozone.scm.block.deletion.max.retry</name>
  697. <value>4096</value>
  698. <tag>OZONE, SCM</tag>
  699. <description>
  700. SCM wraps up many blocks in a deletion transaction and sends that to data
  701. node for physical deletion periodically. This property determines how many
  702. times SCM is going to retry sending a deletion operation to the data node.
  703. </description>
  704. </property>
  705. <property>
  706. <name>ozone.scm.block.size</name>
  707. <value>256MB</value>
  708. <tag>OZONE, SCM</tag>
  709. <description>
  710. The default size of a scm block. This is maps to the default
  711. Ozone block size.
  712. </description>
  713. </property>
  714. <property>
  715. <name>ozone.scm.chunk.size</name>
  716. <value>16MB</value>
  717. <tag>OZONE, SCM, CONTAINER, PERFORMANCE</tag>
  718. <description>
  719. The chunk size for reading/writing chunk operations in bytes.
  720. The chunk size defaults to 8MB. If the value configured is more than the
  721. maximum size (16MB), it will be reset to the maximum size. This maps to
  722. the network packet sizes and file write operations in the client to
  723. datanode protocol.
  724. </description>
  725. </property>
  726. <property>
  727. <name>ozone.scm.client.address</name>
  728. <value/>
  729. <tag>OZONE, SCM, REQUIRED</tag>
  730. <description>
  731. The address of the Ozone SCM client service. This is a required setting.
  732. It is a string in the host:port format. The port number is optional
  733. and defaults to 9860.
  734. </description>
  735. </property>
  736. <property>
  737. <name>ozone.scm.client.bind.host</name>
  738. <value>0.0.0.0</value>
  739. <tag>OZONE, SCM, MANAGEMENT</tag>
  740. <description>The hostname or IP address used by the SCM client endpoint to
  741. bind.
  742. This setting is used by the SCM only and never used by clients.
  743. The setting can be useful in multi-homed setups to restrict the
  744. availability of the SCM client service to a specific interface.
  745. The default is appropriate for most clusters.
  746. </description>
  747. </property>
  748. <property>
  749. <name>ozone.scm.client.port</name>
  750. <value>9860</value>
  751. <tag>OZONE, SCM, MANAGEMENT</tag>
  752. <description>The port number of the Ozone SCM client service.</description>
  753. </property>
  754. <property>
  755. <name>ozone.scm.keyvalue.container.deletion-choosing.policy</name>
  756. <value>
  757. org.apache.hadoop.ozone.container.common.impl.TopNOrderedContainerDeletionChoosingPolicy
  758. </value>
  759. <tag>OZONE, MANAGEMENT</tag>
  760. <description>
  761. The policy used for choosing desired keyvalue containers for block deletion.
  762. Datanode selects some containers to process block deletion
  763. in a certain interval defined by ozone.block.deleting.service.interval.
  764. The number of containers to process in each interval is defined
  765. by ozone.block.deleting.container.limit.per.interval. This property is
  766. used to configure the policy applied while selecting containers.
  767. There are two policies supporting now:
  768. RandomContainerDeletionChoosingPolicy and
  769. TopNOrderedContainerDeletionChoosingPolicy.
  770. org.apache.hadoop.ozone.container.common.impl.RandomContainerDeletionChoosingPolicy
  771. implements a simply random policy that to return a random list of
  772. containers.
  773. org.apache.hadoop.ozone.container.common.impl.TopNOrderedContainerDeletionChoosingPolicy
  774. implements a policy that choosing top count number of containers in a
  775. pending-deletion-blocks's num
  776. based descending order.
  777. </description>
  778. </property>
  779. <property>
  780. <name>ozone.scm.container.placement.impl</name>
  781. <value>
  782. org.apache.hadoop.hdds.scm.container.placement.algorithms.SCMContainerPlacementRandom
  783. </value>
  784. <tag>OZONE, MANAGEMENT</tag>
  785. <description>Placement policy class for containers.
  786. Defaults to SCMContainerPlacementRandom.class
  787. </description>
  788. </property>
  789. <property>
  790. <name>ozone.scm.pipeline.owner.container.count</name>
  791. <value>3</value>
  792. <tag>OZONE, SCM, PIPELINE</tag>
  793. <description>Number of containers per owner in a pipeline.
  794. </description>
  795. </property>
  796. <property>
  797. <name>ozone.scm.container.size</name>
  798. <value>5GB</value>
  799. <tag>OZONE, PERFORMANCE, MANAGEMENT</tag>
  800. <description>
  801. Default container size used by Ozone.
  802. There are two considerations while picking this number. The speed at which
  803. a container can be replicated, determined by the network speed and the
  804. metadata that each container generates. So selecting a large number
  805. creates less SCM metadata, but recovery time will be more. 5GB is a number
  806. that maps to quick replication times in gigabit networks, but still
  807. balances the amount of metadata.
  808. </description>
  809. </property>
  810. <property>
  811. <name>ozone.scm.datanode.address</name>
  812. <value/>
  813. <tag>OZONE, MANAGEMENT</tag>
  814. <description>
  815. The address of the Ozone SCM service used for internal
  816. communication between the DataNodes and the SCM.
  817. It is a string in the host:port format. The port number is optional
  818. and defaults to 9861.
  819. This setting is optional. If unspecified then the hostname portion
  820. is picked from the ozone.scm.client.address setting and the
  821. default service port of 9861 is chosen.
  822. </description>
  823. </property>
  824. <property>
  825. <name>ozone.scm.datanode.bind.host</name>
  826. <value/>
  827. <tag>OZONE, MANAGEMENT</tag>
  828. <description>
  829. The hostname or IP address used by the SCM service endpoint to
  830. bind.
  831. </description>
  832. </property>
  833. <property>
  834. <name>ozone.scm.datanode.id</name>
  835. <value/>
  836. <tag>OZONE, MANAGEMENT</tag>
  837. <description>The path that datanodes will use to store the datanode ID.
  838. If this value is not set, then datanode ID is created under the
  839. metadata directory.
  840. </description>
  841. </property>
  842. <property>
  843. <name>ozone.scm.datanode.port</name>
  844. <value>9861</value>
  845. <tag>OZONE, MANAGEMENT</tag>
  846. <description>
  847. The port number of the Ozone SCM service.
  848. </description>
  849. </property>
  850. <property>
  851. <name>ozone.scm.db.cache.size.mb</name>
  852. <value>128</value>
  853. <tag>OZONE, PERFORMANCE</tag>
  854. <description>SCM keeps track of the Containers in the cluster. This DB holds
  855. the container metadata. This value is set to a small value to make the
  856. unit
  857. testing runs smooth. In production, we recommend a value of 16GB or
  858. higher. This allows SCM to avoid disk I/O's while looking up the container
  859. location.
  860. </description>
  861. </property>
  862. <property>
  863. <name>ozone.scm.dead.node.interval</name>
  864. <value>10m</value>
  865. <tag>OZONE, MANAGEMENT</tag>
  866. <description>
  867. The interval between heartbeats before a node is tagged as dead.
  868. </description>
  869. </property>
  870. <property>
  871. <name>ozone.scm.handler.count.key</name>
  872. <value>10</value>
  873. <tag>OZONE, MANAGEMENT, PERFORMANCE</tag>
  874. <description>
  875. The number of RPC handler threads for each SCM service
  876. endpoint.
  877. The default is appropriate for small clusters (tens of nodes).
  878. Set a value that is appropriate for the cluster size. Generally, HDFS
  879. recommends RPC handler count is set to 20 * log2(Cluster Size) with an
  880. upper limit of 200. However, SCM will not have the same amount of
  881. traffic as Namenode, so a value much smaller than that will work well too.
  882. </description>
  883. </property>
  884. <property>
  885. <name>hdds.heartbeat.interval</name>
  886. <value>30s</value>
  887. <tag>OZONE, MANAGEMENT</tag>
  888. <description>
  889. The heartbeat interval from a data node to SCM. Yes,
  890. it is not three but 30, since most data nodes will heart beating via Ratis
  891. heartbeats. If a client is not able to talk to a data node, it will notify
  892. OM/SCM eventually. So a 30 second HB seems to work. This assumes that
  893. replication strategy used is Ratis if not, this value should be set to
  894. something smaller like 3 seconds.
  895. ozone.scm.pipeline.close.timeout should also be adjusted accordingly,
  896. if the default value for this config is not used.
  897. </description>
  898. </property>
  899. <property>
  900. <name>ozone.scm.heartbeat.log.warn.interval.count</name>
  901. <value>10</value>
  902. <tag>OZONE, MANAGEMENT</tag>
  903. <description>
  904. Defines how frequently we will log the missing of a heartbeat to SCM.
  905. For example in the default case, we will write a warning message for each
  906. ten consecutive heartbeats that we miss to SCM. This helps in reducing
  907. clutter in a data node log, but trade off is that logs will have less of
  908. this statement.
  909. </description>
  910. </property>
  911. <property>
  912. <name>ozone.scm.heartbeat.rpc-timeout</name>
  913. <value>1s</value>
  914. <tag>OZONE, MANAGEMENT</tag>
  915. <description>
  916. Timeout value for the RPC from Datanode to SCM.
  917. </description>
  918. </property>
  919. <property>
  920. <name>ozone.scm.heartbeat.thread.interval</name>
  921. <value>3s</value>
  922. <tag>OZONE, MANAGEMENT</tag>
  923. <description>
  924. When a heartbeat from the data node arrives on SCM, It is queued for
  925. processing with the time stamp of when the heartbeat arrived. There is a
  926. heartbeat processing thread inside SCM that runs at a specified interval.
  927. This value controls how frequently this thread is run.
  928. There are some assumptions build into SCM such as this value should allow
  929. the heartbeat processing thread to run at least three times more
  930. frequently than heartbeats and at least five times more than stale node
  931. detection time. If you specify a wrong value, SCM will gracefully refuse
  932. to run. For more info look at the node manager tests in SCM.
  933. In short, you don't need to change this.
  934. </description>
  935. </property>
  936. <property>
  937. <name>ozone.scm.http-address</name>
  938. <value>0.0.0.0:9876</value>
  939. <tag>OZONE, MANAGEMENT</tag>
  940. <description>
  941. The address and the base port where the SCM web ui will listen on.
  942. If the port is 0 then the server will start on a free port.
  943. </description>
  944. </property>
  945. <property>
  946. <name>ozone.scm.http-bind-host</name>
  947. <value>0.0.0.0</value>
  948. <tag>OZONE, MANAGEMENT</tag>
  949. <description>
  950. The actual address the SCM web server will bind to. If this
  951. optional address is set, it overrides only the hostname portion of
  952. ozone.scm.http-address.
  953. </description>
  954. </property>
  955. <property>
  956. <name>ozone.scm.http.enabled</name>
  957. <value>true</value>
  958. <tag>OZONE, MANAGEMENT</tag>
  959. <description>
  960. Property to enable or disable SCM web ui.
  961. </description>
  962. </property>
  963. <property>
  964. <name>ozone.scm.https-address</name>
  965. <value>0.0.0.0:9877</value>
  966. <tag>OZONE, MANAGEMENT</tag>
  967. <description>
  968. The address and the base port where the SCM web UI will listen
  969. on using HTTPS.
  970. If the port is 0 then the server will start on a free port.
  971. </description>
  972. </property>
  973. <property>
  974. <name>ozone.scm.https-bind-host</name>
  975. <value>0.0.0.0</value>
  976. <tag>OZONE, MANAGEMENT</tag>
  977. <description>
  978. The actual address the SCM web server will bind to using HTTPS.
  979. If this optional address is set, it overrides only the hostname portion of
  980. ozone.scm.http-address.
  981. </description>
  982. </property>
  983. <property>
  984. <name>ozone.scm.names</name>
  985. <value/>
  986. <tag>OZONE, REQUIRED</tag>
  987. <description>
  988. The value of this property is a set of DNS | DNS:PORT | IP
  989. Address | IP:PORT. Written as a comma separated string. e.g. scm1,
  990. scm2:8020, 7.7.7.7:7777.
  991. This property allows datanodes to discover where SCM is, so that
  992. datanodes can send heartbeat to SCM.
  993. </description>
  994. </property>
  995. <property>
  996. <name>ozone.scm.stale.node.interval</name>
  997. <value>90s</value>
  998. <tag>OZONE, MANAGEMENT</tag>
  999. <description>
  1000. The interval for stale node flagging. Please
  1001. see ozone.scm.heartbeat.thread.interval before changing this value.
  1002. </description>
  1003. </property>
  1004. <property>
  1005. <name>ozone.trace.enabled</name>
  1006. <value>false</value>
  1007. <tag>OZONE, DEBUG</tag>
  1008. <description>
  1009. Setting this flag to true dumps the HTTP request/ response in
  1010. the logs. Very useful when debugging REST protocol.
  1011. </description>
  1012. </property>
  1013. <!--Client Settings-->
  1014. <property>
  1015. <name>scm.container.client.idle.threshold</name>
  1016. <value>10s</value>
  1017. <tag>OZONE, PERFORMANCE</tag>
  1018. <description>
  1019. In the standalone pipelines, the SCM clients use netty to
  1020. communicate with the container. It also uses connection pooling to
  1021. reduce client side overheads. This allows a connection to stay idle for
  1022. a while before the connection is closed.
  1023. </description>
  1024. </property>
  1025. <property>
  1026. <name>scm.container.client.max.size</name>
  1027. <value>256</value>
  1028. <tag>OZONE, PERFORMANCE</tag>
  1029. <description>
  1030. Controls the maximum number of connections that we cached via
  1031. clientconnection pooling. If the number of connection
  1032. exceed this count then the oldest idle connection is evicted.
  1033. </description>
  1034. </property>
  1035. <property>
  1036. <name>scm.container.client.max.outstanding.requests</name>
  1037. <value>100</value>
  1038. <tag>OZONE, PERFORMANCE</tag>
  1039. <description>
  1040. Controls the maximum number of outstanding async requests that can be
  1041. handled by the Standalone as well as Ratis client.
  1042. </description>
  1043. </property>
  1044. <property>
  1045. <name>ozone.scm.container.creation.lease.timeout</name>
  1046. <value>60s</value>
  1047. <tag>OZONE, SCM</tag>
  1048. <description>
  1049. Container creation timeout in milliseconds to be used by SCM. When
  1050. BEGIN_CREATE event happens the container is moved from ALLOCATED to
  1051. CREATING state, SCM will now wait for the configured amount of time
  1052. to get COMPLETE_CREATE event if it doesn't receive it will move the
  1053. container to DELETING.
  1054. </description>
  1055. </property>
  1056. <property>
  1057. <name>ozone.key.preallocation.max.blocks</name>
  1058. <value>64</value>
  1059. <tag>OZONE, OM, PERFORMANCE</tag>
  1060. <description>
  1061. While allocating blocks from OM, this configuration limits the maximum
  1062. number of blocks being allocated. This configuration ensures that the
  1063. allocated block response do not exceed rpc payload limit. If client needs
  1064. more space for the write, separate block allocation requests will be made.
  1065. </description>
  1066. </property>
  1067. <property>
  1068. <name>ozone.client.list.cache</name>
  1069. <value>1000</value>
  1070. <tag>OZONE, PERFORMANCE</tag>
  1071. <description>
  1072. Configuration property to configure the cache size of client list calls.
  1073. </description>
  1074. </property>
  1075. <property>
  1076. <name>ozone.replication</name>
  1077. <value>3</value>
  1078. <tag>OZONE, CLIENT</tag>
  1079. <description>
  1080. Default replication value. The actual number of replications can be
  1081. specified when writing the key. The default is used if replication
  1082. is not specified. Supported values: 1 and 3.
  1083. </description>
  1084. </property>
  1085. <property>
  1086. <name>ozone.replication.type</name>
  1087. <value>RATIS</value>
  1088. <tag>OZONE, CLIENT</tag>
  1089. <description>
  1090. Default replication type to be used while writing key into ozone. The
  1091. value can be specified when writing the key, default is used when
  1092. nothing is specified. Supported values: RATIS, STAND_ALONE and CHAINED.
  1093. </description>
  1094. </property>
  1095. <property>
  1096. <name>hdds.container.close.threshold</name>
  1097. <value>0.9f</value>
  1098. <tag>OZONE, DATANODE</tag>
  1099. <description>
  1100. This determines the threshold to be used for closing a container.
  1101. When the container used percentage reaches this threshold,
  1102. the container will be closed. Value should be a positive, non-zero
  1103. percentage in float notation (X.Yf), with 1.0f meaning 100%.
  1104. </description>
  1105. </property>
  1106. <property>
  1107. <name>ozone.rest.client.http.connection.max</name>
  1108. <value>100</value>
  1109. <tag>OZONE, CLIENT</tag>
  1110. <description>
  1111. This defines the overall connection limit for the connection pool used in
  1112. RestClient.
  1113. </description>
  1114. </property>
  1115. <property>
  1116. <name>ozone.rest.client.http.connection.per-route.max</name>
  1117. <value>20</value>
  1118. <tag>OZONE, CLIENT</tag>
  1119. <description>
  1120. This defines the connection limit per one HTTP route/host. Total max
  1121. connection is limited by ozone.rest.client.http.connection.max property.
  1122. </description>
  1123. </property>
  1124. <property>
  1125. <name>ozone.open.key.cleanup.service.interval.seconds</name>
  1126. <value>86400</value>
  1127. <tag>OZONE, OM, PERFORMANCE</tag>
  1128. <description>
  1129. A background job periodically checks open key entries and delete the expired ones. This entry controls the
  1130. interval of this cleanup check.
  1131. </description>
  1132. </property>
  1133. <property>
  1134. <name>ozone.open.key.expire.threshold</name>
  1135. <value>86400</value>
  1136. <tag>OZONE, OM, PERFORMANCE</tag>
  1137. <description>
  1138. Controls how long an open key operation is considered active. Specifically, if a key
  1139. has been open longer than the value of this config entry, that open key is considered as
  1140. expired (e.g. due to client crash). Default to 24 hours.
  1141. </description>
  1142. </property>
  1143. <property>
  1144. <name>hadoop.tags.custom</name>
  1145. <value>OZONE,MANAGEMENT,SECURITY,PERFORMANCE,DEBUG,CLIENT,SERVER,OM,SCM,CRITICAL,RATIS,CONTAINER,REQUIRED,REST,STORAGE,PIPELINE,STANDALONE,S3GATEWAY</value>
  1146. </property>
  1147. <property>
  1148. <name>ozone.tags.system</name>
  1149. <value>OZONE,MANAGEMENT,SECURITY,PERFORMANCE,DEBUG,CLIENT,SERVER,OM,SCM,
  1150. CRITICAL,RATIS,CONTAINER,REQUIRED,REST,STORAGE,PIPELINE,STANDALONE,S3GATEWAY,TOKEN,TLS</value>
  1151. </property>
  1152. <property>
  1153. <name>hdds.rest.rest-csrf.enabled</name>
  1154. <value>false</value>
  1155. <description>
  1156. If true, then enables Object Store REST server protection against
  1157. cross-site request forgery (CSRF).
  1158. </description>
  1159. </property>
  1160. <property>
  1161. <name>hdds.rest.http-address</name>
  1162. <value>0.0.0.0:9880</value>
  1163. <description>The http address of Object Store REST server inside the
  1164. datanode.</description>
  1165. </property>
  1166. <property>
  1167. <name>hdds.rest.netty.high.watermark</name>
  1168. <value>65535</value>
  1169. <description>
  1170. High watermark configuration to Netty for Object Store REST server.
  1171. </description>
  1172. </property>
  1173. <property>
  1174. <name>hdds.rest.netty.low.watermark</name>
  1175. <value>32768</value>
  1176. <description>
  1177. Low watermark configuration to Netty for Object Store REST server.
  1178. </description>
  1179. </property>
  1180. <property>
  1181. <name>hdds.datanode.plugins</name>
  1182. <value>org.apache.hadoop.ozone.web.OzoneHddsDatanodeService</value>
  1183. <description>
  1184. Comma-separated list of HDDS datanode plug-ins to be activated when
  1185. HDDS service starts as part of datanode.
  1186. </description>
  1187. </property>
  1188. <property>
  1189. <name>hdds.datanode.storage.utilization.warning.threshold</name>
  1190. <value>0.75</value>
  1191. <tag>OZONE, SCM, MANAGEMENT</tag>
  1192. <description>
  1193. If a datanode overall storage utilization exceeds more than this
  1194. value, a warning will be logged while processing the nodeReport in SCM.
  1195. </description>
  1196. </property>
  1197. <property>
  1198. <name>hdds.datanode.storage.utilization.critical.threshold</name>
  1199. <value>0.95</value>
  1200. <tag>OZONE, SCM, MANAGEMENT</tag>
  1201. <description>
  1202. If a datanode overall storage utilization exceeds more than this
  1203. value, the datanode will be marked out of space.
  1204. </description>
  1205. </property>
  1206. <property>
  1207. <name>hdds.command.status.report.interval</name>
  1208. <value>30s</value>
  1209. <tag>OZONE, DATANODE, MANAGEMENT</tag>
  1210. <description>Time interval of the datanode to send status of commands
  1211. executed since last report. Unit could be defined with
  1212. postfix (ns,ms,s,m,h,d)</description>
  1213. </property>
  1214. <property>
  1215. <name>ozone.scm.pipeline.destroy.timeout</name>
  1216. <value>300s</value>
  1217. <tag>OZONE, SCM, PIPELINE</tag>
  1218. <description>
  1219. Once a pipeline is closed, SCM should wait for the above configured time
  1220. before destroying a pipeline.
  1221. </description>
  1222. </property>
  1223. <property>
  1224. <name>ozone.scm.pipeline.creation.interval</name>
  1225. <value>120s</value>
  1226. <tag>OZONE, SCM, PIPELINE</tag>
  1227. <description>
  1228. SCM schedules a fixed interval job using the configured interval to
  1229. create pipelines.
  1230. </description>
  1231. </property>
  1232. <property>
  1233. <name>hdds.scm.chillmode.threshold.pct</name>
  1234. <value>0.99</value>
  1235. <tag>HDDS,SCM,OPERATION</tag>
  1236. <description> % of containers which should have at least one
  1237. reported replica before SCM comes out of chill mode.
  1238. </description>
  1239. </property>
  1240. <property>
  1241. <name>hdds.scm.chillmode.enabled</name>
  1242. <value>true</value>
  1243. <tag>HDDS,SCM,OPERATION</tag>
  1244. <description>Boolean value to enable or disable SCM chill mode.
  1245. </description>
  1246. </property>
  1247. <property>
  1248. <name>hdds.scm.chillmode.min.datanode</name>
  1249. <value>1</value>
  1250. <tag>HDDS,SCM,OPERATION</tag>
  1251. <description>Minimum DataNodes which should be registered to get SCM out of
  1252. chill mode.
  1253. </description>
  1254. </property>
  1255. <property>
  1256. <name>hdds.scm.chillmode.pipeline-availability.check</name>
  1257. <value>false</value>
  1258. <tag>HDDS,SCM,OPERATION</tag>
  1259. <description>
  1260. Boolean value to enable pipeline availability check during SCM chill mode.
  1261. </description>
  1262. </property>
  1263. <property>
  1264. <name>hdds.scm.chillmode.healthy.pipelie.pct</name>
  1265. <value>0.10</value>
  1266. <tag>HDDS,SCM,OPERATION</tag>
  1267. <description>
  1268. Percentage of healthy pipelines, where all 3 datanodes are reported in the
  1269. pipeline.
  1270. </description>
  1271. </property>
  1272. <property>
  1273. <name>hdds.scm.chillmode.atleast.one.node.reported.pipeline.pct</name>
  1274. <value>0.90</value>
  1275. <tag>HDDS,SCM,OPERATION</tag>
  1276. <description>
  1277. Percentage of pipelines, where at least one datanode is reported in the
  1278. pipeline.
  1279. </description>
  1280. </property>
  1281. <property>
  1282. <name>hdds.container.action.max.limit</name>
  1283. <value>20</value>
  1284. <tag>DATANODE</tag>
  1285. <description>
  1286. Maximum number of Container Actions sent by the datanode to SCM in a
  1287. single heartbeat.
  1288. </description>
  1289. </property>
  1290. <property>
  1291. <name>hdds.pipeline.action.max.limit</name>
  1292. <value>20</value>
  1293. <tag>DATANODE</tag>
  1294. <description>
  1295. Maximum number of Pipeline Actions sent by the datanode to SCM in a
  1296. single heartbeat.
  1297. </description>
  1298. </property>
  1299. <property>
  1300. <name>hdds.scm.watcher.timeout</name>
  1301. <value>10m</value>
  1302. <tag>OZONE, SCM, MANAGEMENT</tag>
  1303. <description>
  1304. Timeout for the watchers of the HDDS SCM CommandWatchers. After this
  1305. duration the Copy/Delete container commands will be sent again to the
  1306. datanode unless the datanode confirms the completion.
  1307. </description>
  1308. </property>
  1309. <property>
  1310. <name>hdds.db.profile</name>
  1311. <value>DISK</value>
  1312. <tag>OZONE, OM, PERFORMANCE</tag>
  1313. <description>This property allows user to pick a configuration
  1314. that tunes the RocksDB settings for the hardware it is running
  1315. on. Right now, we have SSD and DISK as profile options.</description>
  1316. </property>
  1317. <property>
  1318. <name>hdds.datanode.replication.work.dir</name>
  1319. <tag>DATANODE</tag>
  1320. <description>Temporary which is used during the container replication
  1321. betweeen datanodes. Should have enough space to store multiple container
  1322. (in compressed format), but doesn't require fast io access such as SSD.
  1323. </description>
  1324. </property>
  1325. <property>
  1326. <name>hdds.lock.max.concurrency</name>
  1327. <value>100</value>
  1328. <tag>HDDS</tag>
  1329. <description>Locks in HDDS/Ozone uses object pool to maintain active locks
  1330. in the system, this property defines the max limit for the locks that
  1331. will be maintained in the pool.
  1332. </description>
  1333. </property>
  1334. <property>
  1335. <name>ozone.s3g.authentication.kerberos.principal</name>
  1336. <value/>
  1337. <tag>OZONE, S3GATEWAY</tag>
  1338. <description>The server principal used by Ozone S3Gateway server. This is
  1339. typically set to
  1340. HTTP/_HOST@REALM.TLD The SPNEGO server principal begins with the prefix
  1341. HTTP/ by convention.</description>
  1342. </property>
  1343. <property>
  1344. <name>ozone.s3g.domain.name</name>
  1345. <value/>
  1346. <tag>OZONE, S3GATEWAY</tag>
  1347. <description>List of Ozone S3Gateway domain names. If multiple
  1348. domain names to be provided, they should be a "," seperated.
  1349. This parameter is only required when virtual host style pattern is
  1350. followed.</description>
  1351. </property>
  1352. <property>
  1353. <name>ozone.s3g.http-address</name>
  1354. <value>0.0.0.0:9878</value>
  1355. <tag>OZONE, S3GATEWAY</tag>
  1356. <description>The address and the base port where the Ozone S3Gateway
  1357. Server will
  1358. listen on.</description>
  1359. </property>
  1360. <property>
  1361. <name>ozone.s3g.http-bind-host</name>
  1362. <value>0.0.0.0</value>
  1363. <tag>OZONE, S3GATEWAY</tag>
  1364. <description>The actual address the HTTP server will bind to. If this optional address
  1365. is set, it overrides only the hostname portion of ozone.s3g.http-address.
  1366. This is useful for making the Ozone S3Gateway HTTP server listen on all
  1367. interfaces by setting it to 0.0.0.0.</description>
  1368. </property>
  1369. <property>
  1370. <name>ozone.s3g.http.enabled</name>
  1371. <value>true</value>
  1372. <tag>OZONE, S3GATEWAY</tag>
  1373. <description>The boolean which enables the Ozone S3Gateway server
  1374. .</description>
  1375. </property>
  1376. <property>
  1377. <name>ozone.s3g.https-address</name>
  1378. <value/>
  1379. <tag>OZONE, S3GATEWAY</tag>
  1380. <description>Ozone S3Gateway serverHTTPS server address and port
  1381. .</description>
  1382. </property>
  1383. <property>
  1384. <name>ozone.s3g.https-bind-host</name>
  1385. <value/>
  1386. <tag>OZONE, S3GATEWAY</tag>
  1387. <description>The actual address the HTTPS server will bind to. If this optional address
  1388. is set, it overrides only the hostname portion of ozone.s3g.https-address.
  1389. This is useful for making the Ozone S3Gateway HTTPS server listen on all
  1390. interfaces by setting it to 0.0.0.0.</description>
  1391. </property>
  1392. <property>
  1393. <name>ozone.s3g.keytab.file</name>
  1394. <value/>
  1395. <tag>OZONE, S3GATEWAY</tag>
  1396. <description>The keytab file used by the S3Gateway server to login as its
  1397. service principal. </description>
  1398. </property>
  1399. <property>
  1400. <name>ozone.om.save.metrics.interval</name>
  1401. <value>5m</value>
  1402. <tag>OZONE, OM</tag>
  1403. <description>Time interval used to store the omMetrics in to a
  1404. file. Background thread perodically stores the OM metrics in to a
  1405. file. Unit could be defined with postfix (ns,ms,s,m,h,d)
  1406. </description>
  1407. </property>
  1408. <property>
  1409. <name>ozone.security.enabled</name>
  1410. <value>false</value>
  1411. <tag> OZONE, SECURITY</tag>
  1412. <description>True if security is enabled for ozone. When this property is
  1413. true, hadoop.security.authentication should be Kerberos.
  1414. </description>
  1415. </property>
  1416. <property>
  1417. <name>ozone.client.checksum.type</name>
  1418. <value>CRC32</value>
  1419. <tag>OZONE, CLIENT, MANAGEMENT</tag>
  1420. <description>The checksum type [NONE/ CRC32/ CRC32C/ SHA256/ MD5] determines
  1421. which algorithm would be used to compute checksum for chunk data.
  1422. Default checksum type is SHA256.
  1423. </description>
  1424. </property>
  1425. <property>
  1426. <name>ozone.client.bytes.per.checksum</name>
  1427. <value>1MB</value>
  1428. <tag>OZONE, CLIENT, MANAGEMENT</tag>
  1429. <description>Checksum will be computed for every bytes per checksum number
  1430. of bytes and stored sequentially. The minimum value for this config is
  1431. 256KB.
  1432. </description>
  1433. </property>
  1434. <property>
  1435. <name>ozone.client.verify.checksum</name>
  1436. <value>true</value>
  1437. <tag>OZONE, CLIENT, MANAGEMENT</tag>
  1438. <description>
  1439. Ozone client to verify checksum of the checksum blocksize data.
  1440. </description>
  1441. </property>
  1442. <property>
  1443. <name>ozone.om.ratis.enable</name>
  1444. <value>false</value>
  1445. <tag>OZONE, OM, RATIS, MANAGEMENT</tag>
  1446. <description>Property to enable or disable Ratis server on OM.
  1447. Please note - this is a temporary property to disable OM Ratis server.
  1448. </description>
  1449. </property>
  1450. <property>
  1451. <name>ozone.om.ratis.port</name>
  1452. <value>9872</value>
  1453. <tag>OZONE, OM, RATIS</tag>
  1454. <description>
  1455. The port number of the OzoneManager's Ratis server.
  1456. </description>
  1457. </property>
  1458. <property>
  1459. <name>ozone.om.ratis.rpc.type</name>
  1460. <value>GRPC</value>
  1461. <tag>OZONE, OM, RATIS, MANAGEMENT</tag>
  1462. <description>Ratis supports different kinds of transports like netty, GRPC,
  1463. Hadoop RPC etc. This picks one of those for this cluster.
  1464. </description>
  1465. </property>
  1466. <property>
  1467. <name>ozone.om.ratis.storage.dir</name>
  1468. <value/>
  1469. <tag>OZONE, OM, STORAGE, MANAGEMENT, RATIS</tag>
  1470. <description>This directory is used for storing OM's Ratis metadata like
  1471. logs. If this is not set then default metadata dirs is used. A warning
  1472. will be logged if this not set. Ideally, this should be mapped to a
  1473. fast disk like an SSD.
  1474. </description>
  1475. </property>
  1476. <property>
  1477. <name>ozone.om.ratis.segment.size</name>
  1478. <value>16KB</value>
  1479. <tag>OZONE, OM, RATIS, PERFORMANCE</tag>
  1480. <description>The size of the raft segment used by Apache Ratis on OM.
  1481. (16 KB by default)
  1482. </description>
  1483. </property>
  1484. <property>
  1485. <name>ozone.om.ratis.segment.preallocated.size</name>
  1486. <value>16KB</value>
  1487. <tag>OZONE, OM, RATIS, PERFORMANCE</tag>
  1488. <description>The size of the buffer which is preallocated for raft segment
  1489. used by Apache Ratis on OM.(16 KB by default)
  1490. </description>
  1491. </property>
  1492. <property>
  1493. <name>ozone.om.ratis.log.appender.queue.num-elements</name>
  1494. <value>1024</value>
  1495. <tag>OZONE, DEBUG, CONTAINER, RATIS</tag>
  1496. <description>Number of operation pending with Raft's Log Worker.
  1497. </description>
  1498. </property>
  1499. <property>
  1500. <name>ozone.om.ratis.log.appender.queue.byte-limit</name>
  1501. <value>32MB</value>
  1502. <tag>OZONE, DEBUG, CONTAINER, RATIS</tag>
  1503. <description>Byte limit for Raft's Log Worker queue.
  1504. </description>
  1505. </property>
  1506. <property>
  1507. <name>ozone.om.ratis.server.request.timeout</name>
  1508. <value>3s</value>
  1509. <tag>OZONE, OM, RATIS, MANAGEMENT</tag>
  1510. <description>The timeout duration for OM's ratis server request .</description>
  1511. </property>
  1512. <property>
  1513. <name>ozone.om.ratis.server.retry.cache.timeout</name>
  1514. <value>600000ms</value>
  1515. <tag>OZONE, OM, RATIS, MANAGEMENT</tag>
  1516. <description>Retry Cache entry timeout for OM's ratis server.</description>
  1517. </property>
  1518. <property>
  1519. <name>ozone.om.ratis.minimum.timeout</name>
  1520. <value>1s</value>
  1521. <tag>OZONE, OM, RATIS, MANAGEMENT</tag>
  1522. <description>The minimum timeout duration for OM's Ratis server rpc.
  1523. </description>
  1524. </property>
  1525. <property>
  1526. <name>ozone.om.ratis.client.request.timeout.duration</name>
  1527. <value>3s</value>
  1528. <tag>OZONE, OM, RATIS, MANAGEMENT</tag>
  1529. <description>The timeout duration for OM Ratis client request.
  1530. </description>
  1531. </property>
  1532. <property>
  1533. <name>ozone.om.ratis.client.request.max.retries</name>
  1534. <value>180</value>
  1535. <tag>OZONE, OM, RATIS, MANAGEMENT</tag>
  1536. <description>Number of retries for OM client request.</description>
  1537. </property>
  1538. <property>
  1539. <name>ozone.om.ratis.client.request.retry.interval</name>
  1540. <value>100ms</value>
  1541. <tag>OZONE, OM, RATIS, MANAGEMENT</tag>
  1542. <description>Interval between successive retries for a OM client request.
  1543. </description>
  1544. </property>
  1545. <property>
  1546. <name>ozone.om.leader.election.minimum.timeout.duration</name>
  1547. <value>1s</value>
  1548. <tag>OZONE, OM, RATIS, MANAGEMENT</tag>
  1549. <description>The minimum timeout duration for OM ratis leader election.
  1550. Default is 1s.
  1551. </description>
  1552. </property>
  1553. <property>
  1554. <name>ozone.om.ratis.server.failure.timeout.duration</name>
  1555. <value>120s</value>
  1556. <tag>OZONE, OM, RATIS, MANAGEMENT</tag>
  1557. <description>The timeout duration for ratis server failure detection,
  1558. once the threshold has reached, the ratis state machine will be informed
  1559. about the failure in the ratis ring.
  1560. </description>
  1561. </property>
  1562. <property>
  1563. <name>ozone.acl.authorizer.class</name>
  1564. <value>org.apache.hadoop.ozone.security.acl.OzoneAccessAuthorizer</value>
  1565. <tag>OZONE, SECURITY, ACL</tag>
  1566. <description>Acl authorizer for Ozone.
  1567. </description>
  1568. </property>
  1569. <property>
  1570. <name>ozone.acl.enabled</name>
  1571. <value>false</value>
  1572. <tag>OZONE, SECURITY, ACL</tag>
  1573. <description>Key to enable/disable ozone acls.</description>
  1574. </property>
  1575. <property>
  1576. <name>hdds.scm.kerberos.keytab.file</name>
  1577. <value></value>
  1578. <tag> OZONE, SECURITY</tag>
  1579. <description> The keytab file used by each SCM daemon to login as its
  1580. service principal. The principal name is configured with
  1581. hdds.scm.kerberos.principal.
  1582. </description>
  1583. </property>
  1584. <property>
  1585. <name>hdds.scm.kerberos.principal</name>
  1586. <value></value>
  1587. <tag> OZONE, SECURITY</tag>
  1588. <description>The SCM service principal. Ex scm/_HOST@REALM.COM</description>
  1589. </property>
  1590. <property>
  1591. <name>ozone.om.kerberos.keytab.file</name>
  1592. <value></value>
  1593. <tag> OZONE, SECURITY</tag>
  1594. <description> The keytab file used by OzoneManager daemon to login as its
  1595. service principal. The principal name is configured with
  1596. ozone.om.kerberos.principal.
  1597. </description>
  1598. </property>
  1599. <property>
  1600. <name>ozone.om.kerberos.principal</name>
  1601. <value></value>
  1602. <tag> OZONE, SECURITY</tag>
  1603. <description>The OzoneManager service principal. Ex om/_HOST@REALM.COM</description>
  1604. </property>
  1605. <property>
  1606. <name>hdds.scm.http.kerberos.principal</name>
  1607. <value>HTTP/_HOST@EXAMPLE.COM</value>
  1608. </property>
  1609. <property>
  1610. <name>hdds.scm.http.kerberos.keytab</name>
  1611. <value>/etc/security/keytabs/HTTP.keytab</value>
  1612. </property>
  1613. <property>
  1614. <name>ozone.om.http.kerberos.principal</name>
  1615. <value>HTTP/_HOST@EXAMPLE.COM</value>
  1616. <description>
  1617. OzoneManager http server kerberos principal.
  1618. </description>
  1619. </property>
  1620. <property>
  1621. <name>ozone.om.http.kerberos.keytab.file</name>
  1622. <value>/etc/security/keytabs/HTTP.keytab</value>
  1623. <description>
  1624. OzoneManager http server kerberos keytab.
  1625. </description>
  1626. </property>
  1627. <property>
  1628. <name>hdds.key.len</name>
  1629. <value>2048</value>
  1630. <tag>SCM, HDDS, X509, SECURITY</tag>
  1631. <description>
  1632. SCM CA key length. This is an algorithm-specific metric, such as modulus length, specified in number of bits.
  1633. </description>
  1634. </property>
  1635. <property>
  1636. <name>hdds.key.dir.name</name>
  1637. <value>keys</value>
  1638. <tag>SCM, HDDS, X509, SECURITY</tag>
  1639. <description>
  1640. Directory to store public/private key for SCM CA. This is relative to ozone/hdds meteadata dir.
  1641. </description>
  1642. </property>
  1643. <property>
  1644. <name>hdds.block.token.expiry.time</name>
  1645. <value>1d</value>
  1646. <tag>OZONE, HDDS, SECURITY, TOKEN</tag>
  1647. <description>
  1648. Default value for expiry time of block token. This
  1649. setting supports multiple time unit suffixes as described in
  1650. dfs.heartbeat.interval. If no suffix is specified, then milliseconds is
  1651. assumed.
  1652. </description>
  1653. </property>
  1654. <property>
  1655. <name>hdds.block.token.enabled</name>
  1656. <value>false</value>
  1657. <tag>OZONE, HDDS, SECURITY, TOKEN</tag>
  1658. <description>True if block tokens are enabled, else false.</description>
  1659. </property>
  1660. <property>
  1661. <name>hdds.x509.file.name</name>
  1662. <value>certificate.crt</value>
  1663. <tag>OZONE, HDDS, SECURITY</tag>
  1664. <description>Certificate file name.</description>
  1665. </property>
  1666. <property>
  1667. <name>hdds.grpc.tls.provider</name>
  1668. <value>OPENSSL</value>
  1669. <tag>OZONE, HDDS, SECURITY, TLS</tag>
  1670. <description>HDDS GRPC server TLS provider.</description>
  1671. </property>
  1672. <property>
  1673. <name>hdds.client.cert.chain.file.name</name>
  1674. <value>client.crt</value>
  1675. <tag>OZONE, HDDS, SECURITY</tag>
  1676. <description>Client certificate file name. It is an optional
  1677. field only required when mutual TLS (hdds.grpc.mutual.tls.required)
  1678. is set to true .</description>
  1679. </property>
  1680. <property>
  1681. <name>hdds.grpc.mutual.tls.required</name>
  1682. <value>false</value>
  1683. <tag>OZONE, HDDS, SECURITY, TLS</tag>
  1684. <description>If mutual tls check is enabled for GRPC.
  1685. Considered only if hdds.grpc.tls.enabled is set to true.</description>
  1686. </property>
  1687. <property>
  1688. <name>hdds.grpc.tls.enabled</name>
  1689. <value>false</value>
  1690. <tag>OZONE, HDDS, SECURITY, TLS</tag>
  1691. <description>If HDDS GRPC server TLS is enabled.</description>
  1692. </property>
  1693. <property>
  1694. <name>hdds.server.cert.chain.file.name</name>
  1695. <value>server.crt</value>
  1696. <tag>OZONE, HDDS, SECURITY</tag>
  1697. <description>Hdds server certificate file name.</description>
  1698. </property>
  1699. <property>
  1700. <name>hdds.trust.cert.collection.file.name</name>
  1701. <value>ca.crt</value>
  1702. <tag>OZONE, HDDS, SECURITY</tag>
  1703. <description>HDDS Certificate Authority trust store file name.</description>
  1704. </property>
  1705. <property>
  1706. <name>hdds.x509.default.duration</name>
  1707. <value>P365D</value>
  1708. <tag>OZONE, HDDS, SECURITY</tag>
  1709. <description>Default duration for which x509 certificates issued by SCM are
  1710. valid. The formats accepted are based on the ISO-8601 duration format
  1711. PnDTnHnMn.nS</description>
  1712. </property>
  1713. <property>
  1714. <name>hdds.x509.dir.name</name>
  1715. <value>certs</value>
  1716. <tag>OZONE, HDDS, SECURITY</tag>
  1717. <description>X509 certificate directory name.</description>
  1718. </property>
  1719. <property>
  1720. <name>hdds.x509.max.duration</name>
  1721. <value>P1865D</value>
  1722. <tag>OZONE, HDDS, SECURITY</tag>
  1723. <description>Max time for which certificate issued by SCM CA are valid.
  1724. . The formats accepted are based on the ISO-8601 duration format
  1725. PnDTnHnMn.nS</description>
  1726. </property>
  1727. <property>
  1728. <name>hdds.x509.signature.algorithm</name>
  1729. <value>SHA256withRSA</value>
  1730. <tag>OZONE, HDDS, SECURITY</tag>
  1731. <description>X509 signature certificate.</description>
  1732. </property>
  1733. <property>
  1734. <name>ozone.scm.security.handler.count.key</name>
  1735. <value>2</value>
  1736. <tag>OZONE, HDDS, SECURITY</tag>
  1737. <description>Threads configured for SCMSecurityProtocolServer.</description>
  1738. </property>
  1739. <property>
  1740. <name>ozone.scm.security.service.address</name>
  1741. <value/>
  1742. <tag>OZONE, HDDS, SECURITY</tag>
  1743. <description>Address of SCMSecurityProtocolServer.</description>
  1744. </property>
  1745. <property>
  1746. <name>ozone.scm.security.service.bind.host</name>
  1747. <value>0.0.0.0</value>
  1748. <tag>OZONE, HDDS, SECURITY</tag>
  1749. <description>SCM security server host.</description>
  1750. </property>
  1751. <property>
  1752. <name>ozone.scm.security.service.port</name>
  1753. <value>9961</value>
  1754. <tag>OZONE, HDDS, SECURITY</tag>
  1755. <description>SCM security server port.</description>
  1756. </property>
  1757. <property>
  1758. <name>hdds.metadata.dir</name>
  1759. <value/>
  1760. <tag>X509, SECURITY</tag>
  1761. <description>
  1762. Absolute path to HDDS metadata dir.
  1763. </description>
  1764. </property>
  1765. <property>
  1766. <name>hdds.priv.key.file.name</name>
  1767. <value>private.pem</value>
  1768. <tag>X509, SECURITY</tag>
  1769. <description>
  1770. Name of file which stores private key generated for SCM CA.
  1771. </description>
  1772. </property>
  1773. <property>
  1774. <name>hdds.public.key.file.name</name>
  1775. <value>public.pem</value>
  1776. <tag>X509, SECURITY</tag>
  1777. <description>
  1778. Name of file which stores public key generated for SCM CA.
  1779. </description>
  1780. </property>
  1781. <property>
  1782. <name>ozone.manager.delegation.remover.scan.interval</name>
  1783. <value>3600000</value>
  1784. <description>
  1785. Time interval after which ozone secret manger scans for expired
  1786. delegation token.
  1787. </description>
  1788. </property>
  1789. <property>
  1790. <name>ozone.manager.delegation.token.renew-interval</name>
  1791. <value>1d</value>
  1792. <description>
  1793. Default time interval after which ozone delegation token will
  1794. require renewal before any further use.
  1795. </description>
  1796. </property>
  1797. <property>
  1798. <name>ozone.manager.delegation.token.max-lifetime</name>
  1799. <value>7d</value>
  1800. <description>
  1801. Default max time interval after which ozone delegation token will
  1802. not be renewed.
  1803. </description>
  1804. </property>
  1805. <property>
  1806. <name>ozone.fs.isolated-classloader</name>
  1807. <value></value>
  1808. <tag>OZONE, OZONEFS</tag>
  1809. <description>
  1810. Enable it for older hadoops to separate the classloading of all the
  1811. Ozone classes. With 'true' value, ozonefs can be used with older
  1812. hadoop versions as the hadoop3/ozone related classes are loaded by
  1813. an isolated classloader.
  1814. Default depends from the used jar. true for ozone-filesystem-lib-legacy
  1815. jar and false for the ozone-filesystem-lib.jar
  1816. </description>
  1817. </property>
  1818. <property>
  1819. <name>ozone.manager.db.checkpoint.transfer.bandwidthPerSec</name>
  1820. <value>0</value>
  1821. <tag>OZONE</tag>
  1822. <description>
  1823. Maximum bandwidth used for Ozone Manager DB checkpoint download through
  1824. the servlet.
  1825. </description>
  1826. </property>
  1827. <property>
  1828. <name>ozone.freon.http-address</name>
  1829. <value>0.0.0.0:9884</value>
  1830. <tag>OZONE, MANAGEMENT</tag>
  1831. <description>
  1832. The address and the base port where the FREON web ui will listen on.
  1833. If the port is 0 then the server will start on a free port.
  1834. </description>
  1835. </property>
  1836. <property>
  1837. <name>ozone.freon.http-bind-host</name>
  1838. <value>0.0.0.0</value>
  1839. <tag>OZONE, MANAGEMENT</tag>
  1840. <description>
  1841. The actual address the Freon web server will bind to. If this
  1842. optional address is set, it overrides only the hostname portion of
  1843. ozone.freon.http-address.
  1844. </description>
  1845. </property>
  1846. <property>
  1847. <name>ozone.freon.http.enabled</name>
  1848. <value>true</value>
  1849. <tag>OZONE, MANAGEMENT</tag>
  1850. <description>
  1851. Property to enable or disable FREON web ui.
  1852. </description>
  1853. </property>
  1854. <property>
  1855. <name>ozone.freon.https-address</name>
  1856. <value>0.0.0.0:9885</value>
  1857. <tag>OZONE, MANAGEMENT</tag>
  1858. <description>
  1859. The address and the base port where the Freon web server will listen
  1860. on using HTTPS.
  1861. If the port is 0 then the server will start on a free port.
  1862. </description>
  1863. </property>
  1864. <property>
  1865. <name>ozone.freon.https-bind-host</name>
  1866. <value>0.0.0.0</value>
  1867. <tag>OZONE, MANAGEMENT</tag>
  1868. <description>
  1869. The actual address the Freon web server will bind to using HTTPS.
  1870. If this optional address is set, it overrides only the hostname portion of
  1871. ozone.freon.http-address.
  1872. </description>
  1873. </property>
  1874. <property>
  1875. <name>ozone.freon.http.kerberos.principal</name>
  1876. <value>HTTP/_HOST@EXAMPLE.COM</value>
  1877. <tag>SECURITY</tag>
  1878. <description>
  1879. Security principal used by freon.
  1880. </description>
  1881. </property>
  1882. <property>
  1883. <name>ozone.freon.http.kerberos.keytab</name>
  1884. <value>/etc/security/keytabs/HTTP.keytab</value>
  1885. <tag>SECURITY</tag>
  1886. <description>
  1887. Keytab used by Freon.
  1888. </description>
  1889. </property>
  1890. <property>
  1891. <name>hdds.security.client.datanode.container.protocol.acl</name>
  1892. <value>*</value>
  1893. <tag>SECURITY</tag>
  1894. <description>
  1895. Comma separated list of users and groups allowed to access
  1896. client datanode container protocol.
  1897. </description>
  1898. </property>
  1899. <property>
  1900. <name>hdds.security.client.scm.block.protocol.acl</name>
  1901. <value>*</value>
  1902. <tag>SECURITY</tag>
  1903. <description>
  1904. Comma separated list of users and groups allowed to access
  1905. client scm block protocol.
  1906. </description>
  1907. </property>
  1908. <property>
  1909. <name>hdds.security.client.scm.certificate.protocol.acl</name>
  1910. <value>*</value>
  1911. <tag>SECURITY</tag>
  1912. <description>
  1913. Comma separated list of users and groups allowed to access
  1914. client scm certificate protocol.
  1915. </description>
  1916. </property>
  1917. <property>
  1918. <name>hdds.security.client.scm.container.protocol.acl</name>
  1919. <value>*</value>
  1920. <tag>SECURITY</tag>
  1921. <description>
  1922. Comma separated list of users and groups allowed to access
  1923. client scm container protocol.
  1924. </description>
  1925. </property>
  1926. <property>
  1927. <name>ozone.om.security.client.protocol.acl</name>
  1928. <value>*</value>
  1929. <tag>SECURITY</tag>
  1930. <description>
  1931. Comma separated list of users and groups allowed to access
  1932. client ozone manager protocol.
  1933. </description>
  1934. </property>
  1935. <property>
  1936. <name>hdds.datanode.http.kerberos.principal</name>
  1937. <value>HTTP/_HOST@EXAMPLE.COM</value>
  1938. <tag>HDDS, SECURITY, MANAGEMENT</tag>
  1939. <description>
  1940. The kerberos principal for the datanode http server.
  1941. </description>
  1942. </property>
  1943. <property>
  1944. <name>hdds.datanode.http.kerberos.keytab</name>
  1945. <value>/etc/security/keytabs/HTTP.keytab</value>
  1946. <tag>HDDS, SECURITY, MANAGEMENT</tag>
  1947. <description>
  1948. The kerberos keytab file for datanode http server
  1949. </description>
  1950. </property>
  1951. <property>
  1952. <name>hdds.datanode.http-address</name>
  1953. <value>0.0.0.0:9882</value>
  1954. <tag>HDDS, MANAGEMENT</tag>
  1955. <description>
  1956. The address and the base port where the Datanode web ui will listen on.
  1957. If the port is 0 then the server will start on a free port.
  1958. </description>
  1959. </property>
  1960. <property>
  1961. <name>hdds.datanode.http-bind-host</name>
  1962. <value>0.0.0.0</value>
  1963. <tag>HDDS, MANAGEMENT</tag>
  1964. <description>
  1965. The actual address the Datanode web server will bind to. If this
  1966. optional address is set, it overrides only the hostname portion of
  1967. hdds.datanode.http-address.
  1968. </description>
  1969. </property>
  1970. <property>
  1971. <name>hdds.datanode.http.enabled</name>
  1972. <value>true</value>
  1973. <tag>HDDS, MANAGEMENT</tag>
  1974. <description>
  1975. Property to enable or disable Datanode web ui.
  1976. </description>
  1977. </property>
  1978. <property>
  1979. <name>hdds.datanode.https-address</name>
  1980. <value>0.0.0.0:9883</value>
  1981. <tag>HDDS, MANAGEMENT, SECURITY</tag>
  1982. <description>
  1983. The address and the base port where the Datanode web UI will listen
  1984. on using HTTPS.
  1985. If the port is 0 then the server will start on a free port.
  1986. </description>
  1987. </property>
  1988. <property>
  1989. <name>hdds.datanode.https-bind-host</name>
  1990. <value>0.0.0.0</value>
  1991. <tag>HDDS, MANAGEMENT, SECURITY</tag>
  1992. <description>
  1993. The actual address the Datanode web server will bind to using HTTPS.
  1994. If this optional address is set, it overrides only the hostname portion of
  1995. hdds.datanode.http-address.
  1996. </description>
  1997. </property>
  1998. <property>
  1999. <name>ozone.client.retry.max.attempts</name>
  2000. <value>10</value>
  2001. <description>
  2002. Max retry attempts for Ozone RpcClient talking to OzoneManagers.
  2003. </description>
  2004. </property>
  2005. <property>
  2006. <name>ozone.client.failover.max.attempts</name>
  2007. <value>15</value>
  2008. <description>
  2009. Expert only. The number of client failover attempts that should be
  2010. made before the failover is considered failed.
  2011. </description>
  2012. </property>
  2013. <property>
  2014. <name>ozone.client.failover.sleep.base.millis</name>
  2015. <value>500</value>
  2016. <description>
  2017. Expert only. The time to wait, in milliseconds, between failover
  2018. attempts increases exponentially as a function of the number of
  2019. attempts made so far, with a random factor of +/- 50%. This option
  2020. specifies the base value used in the failover calculation. The
  2021. first failover will retry immediately. The 2nd failover attempt
  2022. will delay at least ozone.client.failover.sleep.base.millis
  2023. milliseconds. And so on.
  2024. </description>
  2025. </property>
  2026. <property>
  2027. <name>ozone.client.failover.sleep.max.millis</name>
  2028. <value>15000</value>
  2029. <description>
  2030. Expert only. The time to wait, in milliseconds, between failover
  2031. attempts increases exponentially as a function of the number of
  2032. attempts made so far, with a random factor of +/- 50%. This option
  2033. specifies the maximum value to wait between failovers.
  2034. Specifically, the time between two failover attempts will not
  2035. exceed +/- 50% of ozone.client.failover.sleep.max.millis
  2036. milliseconds.
  2037. </description>
  2038. </property>
  2039. </configuration>