hdfs-rbf-default.xml 33 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960
  1. <?xml version="1.0"?>
  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 hdfs-rbf-site.xml and change them -->
  19. <!-- there. If hdfs-rbf-site.xml does not already exist, create it. -->
  20. <configuration>
  21. <property>
  22. <name>dfs.federation.router.default.nameserviceId</name>
  23. <value></value>
  24. <description>
  25. Nameservice identifier of the default subcluster to monitor.
  26. </description>
  27. </property>
  28. <property>
  29. <name>dfs.federation.router.default.nameservice.enable</name>
  30. <value>true</value>
  31. <description>
  32. The default subcluster is enabled to read and write files.
  33. </description>
  34. </property>
  35. <property>
  36. <name>dfs.federation.router.rpc.enable</name>
  37. <value>true</value>
  38. <description>
  39. If true, the RPC service to handle client requests in the router is
  40. enabled.
  41. </description>
  42. </property>
  43. <property>
  44. <name>dfs.federation.router.rpc-address</name>
  45. <value>0.0.0.0:8888</value>
  46. <description>
  47. RPC address that handles all clients requests.
  48. The value of this property will take the form of router-host1:rpc-port.
  49. </description>
  50. </property>
  51. <property>
  52. <name>dfs.federation.router.rpc-bind-host</name>
  53. <value></value>
  54. <description>
  55. The actual address the RPC server will bind to. If this optional address is
  56. set, it overrides only the hostname portion of
  57. dfs.federation.router.rpc-address. This is useful for making the name node
  58. listen on all interfaces by setting it to 0.0.0.0.
  59. </description>
  60. </property>
  61. <property>
  62. <name>dfs.federation.router.handler.count</name>
  63. <value>10</value>
  64. <description>
  65. The number of server threads for the router to handle RPC requests from
  66. clients.
  67. </description>
  68. </property>
  69. <property>
  70. <name>dfs.federation.router.handler.queue.size</name>
  71. <value>100</value>
  72. <description>
  73. The size of the queue for the number of handlers to handle RPC client requests.
  74. </description>
  75. </property>
  76. <property>
  77. <name>dfs.federation.router.reader.count</name>
  78. <value>1</value>
  79. <description>
  80. The number of readers for the router to handle RPC client requests.
  81. </description>
  82. </property>
  83. <property>
  84. <name>dfs.federation.router.reader.queue.size</name>
  85. <value>100</value>
  86. <description>
  87. The size of the queue for the number of readers for the router to handle RPC client requests.
  88. </description>
  89. </property>
  90. <property>
  91. <name>dfs.federation.router.connection.creator.queue-size</name>
  92. <value>100</value>
  93. <description>
  94. Size of async connection creator queue.
  95. </description>
  96. </property>
  97. <property>
  98. <name>dfs.federation.router.connection.pool-size</name>
  99. <value>1</value>
  100. <description>
  101. Size of the pool of connections from the router to namenodes.
  102. </description>
  103. </property>
  104. <property>
  105. <name>dfs.federation.router.connection.min-active-ratio</name>
  106. <value>0.5f</value>
  107. <description>
  108. Minimum active ratio of connections from the router to namenodes.
  109. </description>
  110. </property>
  111. <property>
  112. <name>dfs.federation.router.connection.clean.ms</name>
  113. <value>10000</value>
  114. <description>
  115. Time interval, in milliseconds, to check if the connection pool should
  116. remove unused connections.
  117. </description>
  118. </property>
  119. <property>
  120. <name>dfs.federation.router.enable.multiple.socket</name>
  121. <value>false</value>
  122. <description>
  123. If enable multiple downstream socket or not. If true, ConnectionPool
  124. will use a new socket when creating a new connection for the same user,
  125. and RouterRPCClient will get a better throughput. It's best used with
  126. dfs.federation.router.max.concurrency.per.connection together to get
  127. a better throughput with fewer sockets. Such as enable
  128. dfs.federation.router.enable.multiple.socket and
  129. set dfs.federation.router.max.concurrency.per.connection = 20.
  130. </description>
  131. </property>
  132. <property>
  133. <name>dfs.federation.router.max.concurrency.per.connection</name>
  134. <value>1</value>
  135. <description>
  136. The maximum number of requests that a connection can handle concurrently.
  137. When the number of requests being processed by a socket is less than this value,
  138. new request will be processed by this socket. When enable
  139. dfs.federation.router.enable.multiple.socket, it's best
  140. set this value greater than 1, such as 20, to avoid frequent
  141. creation and idle sockets in the case of a NS with jitter requests.
  142. </description>
  143. </property>
  144. <property>
  145. <name>dfs.federation.router.connection.pool.clean.ms</name>
  146. <value>60000</value>
  147. <description>
  148. Time interval, in milliseconds, to check if the connection manager should
  149. remove unused connection pools.
  150. </description>
  151. </property>
  152. <property>
  153. <name>dfs.federation.router.metrics.enable</name>
  154. <value>true</value>
  155. <description>
  156. If the metrics in the router are enabled.
  157. </description>
  158. </property>
  159. <property>
  160. <name>dfs.federation.router.dn-report.time-out</name>
  161. <value>1000</value>
  162. <description>
  163. Time out, in milliseconds for getDatanodeReport.
  164. </description>
  165. </property>
  166. <property>
  167. <name>dfs.federation.router.dn-report.cache-expire</name>
  168. <value>10s</value>
  169. <description>
  170. Expiration time in seconds for datanodereport.
  171. </description>
  172. </property>
  173. <property>
  174. <name>dfs.federation.router.enable.get.dn.usage</name>
  175. <value>true</value>
  176. <description>
  177. If true, the getNodeUsage method in RBFMetrics will return an up-to-date
  178. result collecting from downstream nameservices. But it will take a long
  179. time and take up thread resources. If false, it will return a mock result with all 0.
  180. </description>
  181. </property>
  182. <property>
  183. <name>dfs.federation.router.metrics.class</name>
  184. <value>org.apache.hadoop.hdfs.server.federation.metrics.FederationRPCPerformanceMonitor</value>
  185. <description>
  186. Class to monitor the RPC system in the router. It must implement the
  187. RouterRpcMonitor interface.
  188. </description>
  189. </property>
  190. <property>
  191. <name>dfs.federation.router.admin.enable</name>
  192. <value>true</value>
  193. <description>
  194. If true, the RPC admin service to handle client requests in the router is
  195. enabled.
  196. </description>
  197. </property>
  198. <property>
  199. <name>dfs.federation.router.admin-address</name>
  200. <value>0.0.0.0:8111</value>
  201. <description>
  202. RPC address that handles the admin requests.
  203. The value of this property will take the form of router-host1:rpc-port.
  204. </description>
  205. </property>
  206. <property>
  207. <name>dfs.federation.router.admin-bind-host</name>
  208. <value></value>
  209. <description>
  210. The actual address the RPC admin server will bind to. If this optional
  211. address is set, it overrides only the hostname portion of
  212. dfs.federation.router.admin-address. This is useful for making the name
  213. node listen on all interfaces by setting it to 0.0.0.0.
  214. </description>
  215. </property>
  216. <property>
  217. <name>dfs.federation.router.admin.handler.count</name>
  218. <value>1</value>
  219. <description>
  220. The number of server threads for the router to handle RPC requests from
  221. admin.
  222. </description>
  223. </property>
  224. <property>
  225. <name>dfs.federation.router.admin.mount.check.enable</name>
  226. <value>false</value>
  227. <description>
  228. If true, add/update mount table will include a destination check to make
  229. sure the file exists in downstream namenodes, and changes to mount table
  230. will fail if the file doesn't exist in any of the destination namenode.
  231. </description>
  232. </property>
  233. <property>
  234. <name>dfs.federation.router.http-address</name>
  235. <value>0.0.0.0:50071</value>
  236. <description>
  237. HTTP address that handles the web requests to the Router.
  238. The value of this property will take the form of router-host1:http-port.
  239. </description>
  240. </property>
  241. <property>
  242. <name>dfs.federation.router.http-bind-host</name>
  243. <value></value>
  244. <description>
  245. The actual address the HTTP server will bind to. If this optional
  246. address is set, it overrides only the hostname portion of
  247. dfs.federation.router.http-address. This is useful for making the name
  248. node listen on all interfaces by setting it to 0.0.0.0.
  249. </description>
  250. </property>
  251. <property>
  252. <name>dfs.federation.router.https-address</name>
  253. <value>0.0.0.0:50072</value>
  254. <description>
  255. HTTPS address that handles the web requests to the Router.
  256. The value of this property will take the form of router-host1:https-port.
  257. </description>
  258. </property>
  259. <property>
  260. <name>dfs.federation.router.https-bind-host</name>
  261. <value></value>
  262. <description>
  263. The actual address the HTTPS server will bind to. If this optional
  264. address is set, it overrides only the hostname portion of
  265. dfs.federation.router.https-address. This is useful for making the name
  266. node listen on all interfaces by setting it to 0.0.0.0.
  267. </description>
  268. </property>
  269. <property>
  270. <name>dfs.federation.router.http.enable</name>
  271. <value>true</value>
  272. <description>
  273. If the HTTP service to handle client requests in the router is enabled.
  274. </description>
  275. </property>
  276. <property>
  277. <name>dfs.federation.router.fs-limits.max-component-length</name>
  278. <value>0</value>
  279. <description>
  280. Defines the maximum number of bytes in UTF-8 encoding in each
  281. component of a path at Router side. A value of 0 will disable the check.
  282. Support multiple size unit suffix(case insensitive). It is act as
  283. configuration dfs.namenode.fs-limits.max-component-length at NameNode
  284. side.
  285. </description>
  286. </property>
  287. <property>
  288. <name>dfs.federation.router.file.resolver.client.class</name>
  289. <value>org.apache.hadoop.hdfs.server.federation.resolver.MountTableResolver</value>
  290. <description>
  291. Class to resolve files to subclusters. To enable multiple subclusters for a mount point,
  292. set to org.apache.hadoop.hdfs.server.federation.resolver.MultipleDestinationMountTableResolver.
  293. </description>
  294. </property>
  295. <property>
  296. <name>dfs.federation.router.namenode.resolver.client.class</name>
  297. <value>org.apache.hadoop.hdfs.server.federation.resolver.MembershipNamenodeResolver</value>
  298. <description>
  299. Class to resolve the namenode for a subcluster.
  300. </description>
  301. </property>
  302. <property>
  303. <name>dfs.federation.router.store.enable</name>
  304. <value>true</value>
  305. <description>
  306. If true, the Router connects to the State Store.
  307. </description>
  308. </property>
  309. <property>
  310. <name>dfs.federation.router.store.serializer</name>
  311. <value>org.apache.hadoop.hdfs.server.federation.store.driver.impl.StateStoreSerializerPBImpl</value>
  312. <description>
  313. Class to serialize State Store records.
  314. </description>
  315. </property>
  316. <property>
  317. <name>dfs.federation.router.store.driver.class</name>
  318. <value>org.apache.hadoop.hdfs.server.federation.store.driver.impl.StateStoreZooKeeperImpl</value>
  319. <description>
  320. Class to implement the State Store. There are three implementation classes currently
  321. being supported:
  322. org.apache.hadoop.hdfs.server.federation.store.driver.impl.StateStoreFileImpl,
  323. org.apache.hadoop.hdfs.server.federation.store.driver.impl.StateStoreFileSystemImpl,
  324. org.apache.hadoop.hdfs.server.federation.store.driver.impl.StateStoreMySQLImpl and
  325. org.apache.hadoop.hdfs.server.federation.store.driver.impl.StateStoreZooKeeperImpl.
  326. These implementation classes use the local file, filesystem and ZooKeeper as a backend respectively.
  327. By default it uses the ZooKeeper as the default State Store.
  328. </description>
  329. </property>
  330. <property>
  331. <name>dfs.federation.router.store.connection.test</name>
  332. <value>60000</value>
  333. <description>
  334. How often to check for the connection to the State Store in milliseconds.
  335. </description>
  336. </property>
  337. <property>
  338. <name>dfs.federation.router.store.driver.zk.parent-path</name>
  339. <value>/hdfs-federation</value>
  340. <description>
  341. The parent path of zookeeper for StateStoreZooKeeperImpl.
  342. </description>
  343. </property>
  344. <property>
  345. <name>dfs.federation.router.store.driver.zk.async.max.threads</name>
  346. <value>-1</value>
  347. <description>
  348. Max threads number of StateStoreZooKeeperImpl in async mode.
  349. The only class currently being supported:
  350. org.apache.hadoop.hdfs.server.federation.store.driver.impl.StateStoreZooKeeperImpl.
  351. Default value is -1, which means StateStoreZooKeeperImpl is working in sync mode.
  352. Use positive integer value to enable async mode.
  353. </description>
  354. </property>
  355. <property>
  356. <name>dfs.federation.router.cache.ttl</name>
  357. <value>1m</value>
  358. <description>
  359. How often to refresh the State Store caches in milliseconds. This setting
  360. supports multiple time unit suffixes as described in
  361. dfs.heartbeat.interval. If no suffix is specified then milliseconds is
  362. assumed.
  363. </description>
  364. </property>
  365. <property>
  366. <name>dfs.federation.router.store.membership.expiration</name>
  367. <value>300000</value>
  368. <description>
  369. Expiration time in milliseconds for a membership record.
  370. </description>
  371. </property>
  372. <property>
  373. <name>dfs.federation.router.store.membership.expiration.deletion</name>
  374. <value>-1</value>
  375. <description>
  376. Deletion time in milliseconds for a membership record. If an expired
  377. membership record exists beyond this time, it will be deleted. If this
  378. value is negative, the deletion is disabled.
  379. </description>
  380. </property>
  381. <property>
  382. <name>dfs.federation.router.heartbeat.enable</name>
  383. <value>true</value>
  384. <description>
  385. If true, the Router heartbeats into the State Store.
  386. </description>
  387. </property>
  388. <property>
  389. <name>dfs.federation.router.heartbeat.interval</name>
  390. <value>5000</value>
  391. <description>
  392. How often the Router should heartbeat into the State Store in milliseconds.
  393. </description>
  394. </property>
  395. <property>
  396. <name>dfs.federation.router.health.monitor.timeout</name>
  397. <value>30s</value>
  398. <description>
  399. Time out for Router to obtain HAServiceStatus from NameNode.
  400. </description>
  401. </property>
  402. <property>
  403. <name>dfs.federation.router.heartbeat-state.interval</name>
  404. <value>5s</value>
  405. <description>
  406. How often the Router should heartbeat its state into the State Store in
  407. milliseconds. This setting supports multiple time unit suffixes as
  408. described in dfs.federation.router.quota-cache.update.interval.
  409. </description>
  410. </property>
  411. <property>
  412. <name>dfs.federation.router.namenode.heartbeat.enable</name>
  413. <value></value>
  414. <description>
  415. If true, get namenode heartbeats and send into the State Store.
  416. If not explicitly specified takes the same value as for
  417. dfs.federation.router.heartbeat.enable.
  418. </description>
  419. </property>
  420. <property>
  421. <name>dfs.federation.router.namenode.heartbeat.jmx.interval</name>
  422. <value>0</value>
  423. <description>
  424. How often the Router should request JMX reports from the Namenode in miliseconds.
  425. If this value is 0, it will request JMX reports every time a Namenode report is requested.
  426. If this value is negative, it will disable JMX reports from the Namenode.
  427. </description>
  428. </property>
  429. <property>
  430. <name>dfs.federation.router.store.router.expiration</name>
  431. <value>5m</value>
  432. <description>
  433. Expiration time in milliseconds for a router state record. This setting
  434. supports multiple time unit suffixes as described in
  435. dfs.federation.router.quota-cache.update.interval.
  436. </description>
  437. </property>
  438. <property>
  439. <name>dfs.federation.router.store.router.expiration.deletion</name>
  440. <value>-1</value>
  441. <description>
  442. Deletion time in milliseconds for a router state record. If an expired
  443. router state record exists beyond this time, it will be deleted. If this
  444. value is negative, the deletion is disabled.
  445. </description>
  446. </property>
  447. <property>
  448. <name>dfs.federation.router.safemode.enable</name>
  449. <value>true</value>
  450. <description>
  451. </description>
  452. </property>
  453. <property>
  454. <name>dfs.federation.router.safemode.extension</name>
  455. <value>30s</value>
  456. <description>
  457. Time after startup that the Router is in safe mode. This setting
  458. supports multiple time unit suffixes as described in
  459. dfs.heartbeat.interval. If no suffix is specified then milliseconds is
  460. assumed.
  461. </description>
  462. </property>
  463. <property>
  464. <name>dfs.federation.router.safemode.expiration</name>
  465. <value>3m</value>
  466. <description>
  467. Time without being able to reach the State Store to enter safe mode. This
  468. setting supports multiple time unit suffixes as described in
  469. dfs.heartbeat.interval. If no suffix is specified then milliseconds is
  470. assumed.
  471. </description>
  472. </property>
  473. <property>
  474. <name>dfs.federation.router.safemode.checkperiod</name>
  475. <value>5s</value>
  476. <description>
  477. How often the Router should check safe mode. This
  478. setting supports multiple time unit suffixes as described in
  479. dfs.heartbeat.interval. If no suffix is specified then milliseconds is
  480. assumed.
  481. </description>
  482. </property>
  483. <property>
  484. <name>dfs.federation.router.monitor.namenode</name>
  485. <value></value>
  486. <description>
  487. The identifier of the namenodes to monitor and heartbeat.
  488. </description>
  489. </property>
  490. <property>
  491. <name>dfs.federation.router.monitor.namenode.nameservice.resolution-enabled</name>
  492. <value>false</value>
  493. <description>
  494. Determines if the given monitored namenode address is a domain name which needs to
  495. be resolved.
  496. This is used by router to resolve namenodes.
  497. </description>
  498. </property>
  499. <property>
  500. <name>dfs.federation.router.monitor.namenode.nameservice.resolver.impl</name>
  501. <value></value>
  502. <description>
  503. Nameservice resolver implementation used by router.
  504. Effective with
  505. dfs.federation.router.monitor.namenode.nameservices.resolution-enabled on.
  506. </description>
  507. </property>
  508. <property>
  509. <name>dfs.federation.router.monitor.localnamenode.enable</name>
  510. <value>true</value>
  511. <description>
  512. If true, the Router should monitor the namenode in the local machine.
  513. </description>
  514. </property>
  515. <property>
  516. <name>dfs.federation.router.mount-table.max-cache-size</name>
  517. <value>10000</value>
  518. <description>
  519. Maximum number of mount table cache entries to have.
  520. By default, remove cache entries if we have more than 10k.
  521. </description>
  522. </property>
  523. <property>
  524. <name>dfs.federation.router.mount-table.cache.enable</name>
  525. <value>true</value>
  526. <description>
  527. Set to true to enable mount table cache (Path to Remote Location cache).
  528. Disabling the cache is recommended when a large amount of unique paths are queried.
  529. </description>
  530. </property>
  531. <property>
  532. <name>dfs.federation.router.quota.enable</name>
  533. <value>false</value>
  534. <description>
  535. Set to true to enable quota system in Router. When it's enabled, setting
  536. or clearing sub-cluster's quota directly is not recommended since Router
  537. Admin server will override sub-cluster's quota with global quota.
  538. </description>
  539. </property>
  540. <property>
  541. <name>dfs.federation.router.quota-cache.update.interval</name>
  542. <value>60s</value>
  543. <description>
  544. Interval time for updating quota usage cache in Router.
  545. This property is used only if the value of
  546. dfs.federation.router.quota.enable is true.
  547. This setting supports multiple time unit suffixes as described
  548. in dfs.heartbeat.interval. If no suffix is specified then milliseconds
  549. is assumed.
  550. </description>
  551. </property>
  552. <property>
  553. <name>dfs.federation.router.client.thread-size</name>
  554. <value>32</value>
  555. <description>
  556. Max threads size for the RouterClient to execute concurrent
  557. requests.
  558. </description>
  559. </property>
  560. <property>
  561. <name>dfs.federation.router.client.retry.max.attempts</name>
  562. <value>3</value>
  563. <description>
  564. Max retry attempts for the RouterClient talking to the Router.
  565. </description>
  566. </property>
  567. <property>
  568. <name>dfs.federation.router.client.reject.overload</name>
  569. <value>false</value>
  570. <description>
  571. Set to true to reject client requests when we run out of RPC client
  572. threads.
  573. </description>
  574. </property>
  575. <property>
  576. <name>dfs.federation.router.client.allow-partial-listing</name>
  577. <value>true</value>
  578. <description>
  579. If the Router can return a partial list of files in a multi-destination mount point when one of the subclusters is unavailable.
  580. True may return a partial list of files if a subcluster is down.
  581. False will fail the request if one is unavailable.
  582. </description>
  583. </property>
  584. <property>
  585. <name>dfs.federation.router.client.mount-status.time-out</name>
  586. <value>1s</value>
  587. <description>
  588. Set a timeout for the Router when listing folders containing mount
  589. points. In this process, the Router checks the mount table and then it
  590. checks permissions in the subcluster. After the time out, we return the
  591. default values.
  592. </description>
  593. </property>
  594. <property>
  595. <name>dfs.federation.router.connect.max.retries.on.timeouts</name>
  596. <value>0</value>
  597. <description>
  598. Maximum number of retries for the IPC Client when connecting to the
  599. subclusters. By default, it doesn't let the IPC retry and the Router
  600. handles it.
  601. </description>
  602. </property>
  603. <property>
  604. <name>dfs.federation.router.connect.timeout</name>
  605. <value>2s</value>
  606. <description>
  607. Time out for the IPC client connecting to the subclusters. This should be
  608. short as the Router has knowledge of the state of the Routers.
  609. </description>
  610. </property>
  611. <property>
  612. <name>dfs.federation.router.keytab.file</name>
  613. <value></value>
  614. <description>
  615. The keytab file used by router to login as its
  616. service principal. The principal name is configured with
  617. dfs.federation.router.kerberos.principal.
  618. </description>
  619. </property>
  620. <property>
  621. <name>dfs.federation.router.kerberos.principal</name>
  622. <value></value>
  623. <description>
  624. The Router service principal. This is typically set to
  625. router/_HOST@REALM.TLD. Each Router will substitute _HOST with its
  626. own fully qualified hostname at startup. The _HOST placeholder
  627. allows using the same configuration setting on both Router
  628. in an HA setup.
  629. </description>
  630. </property>
  631. <property>
  632. <name>dfs.federation.router.kerberos.principal.hostname</name>
  633. <value></value>
  634. <description>
  635. Optional. The hostname for the Router containing this
  636. configuration file. Will be different for each machine.
  637. Defaults to current hostname.
  638. </description>
  639. </property>
  640. <property>
  641. <name>dfs.federation.router.kerberos.internal.spnego.principal</name>
  642. <value>${dfs.web.authentication.kerberos.principal}</value>
  643. <description>
  644. The server principal used by the Router for web UI SPNEGO
  645. authentication when Kerberos security is enabled. This is
  646. typically set to HTTP/_HOST@REALM.TLD The SPNEGO server principal
  647. begins with the prefix HTTP/ by convention.
  648. If the value is '*', the web server will attempt to login with
  649. every principal specified in the keytab file
  650. dfs.web.authentication.kerberos.keytab.
  651. </description>
  652. </property>
  653. <property>
  654. <name>dfs.federation.router.mount-table.cache.update</name>
  655. <value>false</value>
  656. <description>Set true to enable MountTableRefreshService. This service
  657. updates mount table cache immediately after adding, modifying or
  658. deleting the mount table entries. If this service is not enabled
  659. mount table cache are refreshed periodically by
  660. StateStoreCacheUpdateService
  661. </description>
  662. </property>
  663. <property>
  664. <name>dfs.federation.router.mount-table.cache.update.timeout</name>
  665. <value>1m</value>
  666. <description>This property defines how long to wait for all the
  667. admin servers to finish their mount table cache update. This setting
  668. supports multiple time unit suffixes as described in
  669. dfs.federation.router.safemode.extension.
  670. </description>
  671. </property>
  672. <property>
  673. <name>dfs.federation.router.mount-table.cache.update.client.max.time
  674. </name>
  675. <value>5m</value>
  676. <description>Remote router mount table cache is updated through
  677. RouterClient(RPC call). To improve performance, RouterClient
  678. connections are cached but it should not be kept in cache forever.
  679. This property defines the max time a connection can be cached. This
  680. setting supports multiple time unit suffixes as described in
  681. dfs.federation.router.safemode.extension.
  682. </description>
  683. </property>
  684. <property>
  685. <name>dfs.federation.router.secret.manager.class</name>
  686. <value>org.apache.hadoop.hdfs.server.federation.router.security.token.ZKDelegationTokenSecretManagerImpl</value>
  687. <description>
  688. Class to implement state store to delegation tokens.
  689. Default implementation uses zookeeper as the backend to store delegation tokens.
  690. </description>
  691. </property>
  692. <property>
  693. <name>dfs.federation.router.top.num.token.realowners</name>
  694. <value>10</value>
  695. <description>
  696. The number of top real owners by tokens count to report in the JMX metrics.
  697. Real owners are the effective users whose cretential are used to generate
  698. the tokens.
  699. </description>
  700. </property>
  701. <property>
  702. <name>dfs.federation.router.fairness.policy.controller.class</name>
  703. <value>org.apache.hadoop.hdfs.server.federation.fairness.NoRouterRpcFairnessPolicyController</value>
  704. <description>
  705. No fairness policy handler by default, for fairness
  706. StaticFairnessPolicyController should be configured.
  707. </description>
  708. </property>
  709. <property>
  710. <name>dfs.federation.router.fairness.handler.count.EXAMPLENAMESERVICE</name>
  711. <value></value>
  712. <description>
  713. Dedicated handler count for nameservice EXAMPLENAMESERVICE. The handler
  714. (configed by dfs.federation.router.handler.count)resource is controlled
  715. internally by Semaphore permits. Two requirements have to be satisfied.
  716. 1) all downstream nameservices need this config otherwise no permit will
  717. be given thus not proxy will happen. 2) if a special *concurrent*
  718. nameservice is specified, the sum of all configured values is smaller or
  719. equal to the total number of router handlers; if the special *concurrent*
  720. is not specified, the sum of all configured values must be strictly
  721. smaller than the router handlers thus the left will be allocated to the
  722. concurrent calls.
  723. </description>
  724. </property>
  725. <property>
  726. <name>dfs.federation.router.fairness.acquire.timeout</name>
  727. <value>1s</value>
  728. <description>
  729. The maximum time to wait for a permit.
  730. </description>
  731. </property>
  732. <property>
  733. <name>dfs.federation.router.fairness.handler.proportion.EXAMPLENAMESERVICE</name>
  734. <value>0.1</value>
  735. <description>
  736. Dedicated handler proportion for nameservice EXAMPLENAMESERVICE.
  737. The range of this value is [0, 1], and the data type is float.
  738. If this value is configured as x, and the total number of handlers
  739. (configed by dfs.federation.router.handler.count) of the router is y,
  740. then the maximum number of handlers for the EXAMPLENAMESERVICE is z=(int) x*y;
  741. If z is 0, z is reset to 1, ensuring the ns has at least one handler.
  742. </description>
  743. </property>
  744. <property>
  745. <name>dfs.federation.router.federation.rename.bandwidth</name>
  746. <value>10</value>
  747. <description>
  748. Specify bandwidth per map in MB.
  749. </description>
  750. </property>
  751. <property>
  752. <name>dfs.federation.router.federation.rename.map</name>
  753. <value>10</value>
  754. <description>
  755. Max number of concurrent maps to use for copy.
  756. </description>
  757. </property>
  758. <property>
  759. <name>dfs.federation.router.federation.rename.delay</name>
  760. <value>1000</value>
  761. <description>
  762. Specify the delayed duration(millie seconds) when the job needs to retry.
  763. </description>
  764. </property>
  765. <property>
  766. <name>dfs.federation.router.federation.rename.diff</name>
  767. <value>0</value>
  768. <description>
  769. Specify the threshold of the diff entries that used in incremental copy
  770. stage.
  771. </description>
  772. </property>
  773. <property>
  774. <name>dfs.federation.router.federation.rename.option</name>
  775. <value>NONE</value>
  776. <description>
  777. Specify the action when rename across namespaces. The option can be NONE
  778. and DISTCP.
  779. </description>
  780. </property>
  781. <property>
  782. <name>dfs.federation.router.federation.rename.force.close.open.file</name>
  783. <value>true</value>
  784. <description>
  785. Force close all open files when there is no diff in the DIFF_DISTCP stage.
  786. </description>
  787. </property>
  788. <property>
  789. <name>dfs.federation.router.federation.rename.trash</name>
  790. <value>trash</value>
  791. <description>
  792. This options has 3 values: trash (move the source path to trash), delete
  793. (delete the source path directly) and skip (skip both trash and deletion).
  794. </description>
  795. </property>
  796. <property>
  797. <name>dfs.federation.router.observer.read.default</name>
  798. <value>false</value>
  799. <description>
  800. Whether observer reads are enabled. This is a default for all nameservices.
  801. The default can be inverted for individual namespace by adding them to
  802. dfs.federation.router.observer.read.overrides.
  803. </description>
  804. </property>
  805. <property>
  806. <name>dfs.federation.router.observer.read.overrides</name>
  807. <value/>
  808. <description>
  809. Commas separated list of namespaces for which to invert the default configuration,
  810. dfs.federation.router.observer.read.default, for whether to enable observer reads.
  811. </description>
  812. </property>
  813. <property>
  814. <name>dfs.federation.router.observer.federated.state.propagation.maxsize</name>
  815. <value>5</value>
  816. <description>
  817. The maximum size of the federated state to send in the RPC header. Sending the federated
  818. state removes the need to msync on every read call, but at the expense of having a larger
  819. header. The cost tradeoff between the larger header and always msync'ing depends on the number
  820. of namespaces in use and the latency of the msync requests.
  821. </description>
  822. </property>
  823. <property>
  824. <name>dfs.federation.router.observer.state.id.refresh.period</name>
  825. <value>15s</value>
  826. <description>
  827. Period to refresh namespace stateID using active namenode. This ensures the
  828. namespace stateID is refresh even when an observer is trailing behind.
  829. If this is below 0, the auto-refresh is disabled.
  830. </description>
  831. </property>
  832. <property>
  833. <name>dfs.federation.router.store.driver.file.async.threads</name>
  834. <value>0</value>
  835. <description>
  836. Max threads used by StateStoreFileImpl to access state store files concurrently.
  837. The only class currently being supported:
  838. org.apache.hadoop.hdfs.server.federation.store.driver.impl.StateStoreFileImpl.
  839. Default value is 0, which means StateStoreFileImpl would work in sync mode, meaning it
  840. would access one file at a time.
  841. Use positive integer value to enable concurrent files access.
  842. </description>
  843. </property>
  844. <property>
  845. <name>dfs.federation.router.store.driver.fs.async.threads</name>
  846. <value>0</value>
  847. <description>
  848. Max threads used by StateStoreFileSystemImpl to access state store files from the given
  849. filesystem concurrently.
  850. The only class currently being supported:
  851. org.apache.hadoop.hdfs.server.federation.store.driver.impl.StateStoreFileSystemImpl.
  852. Default value is 0, which means StateStoreFileSystemImpl would work in sync mode, meaning it
  853. would access one file from the filesystem at a time.
  854. Use positive integer value to enable concurrent files access from the given filesystem.
  855. </description>
  856. </property>
  857. </configuration>