ozone-default.xml 86 KB

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