httpfs-default.html 7.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198
  1. <html>
  2. <body>
  3. <h2>Configuration Properties</h2>
  4. <table border="1">
  5. <tr>
  6. <th>name</th><th>value</th><th>description</th>
  7. </tr>
  8. <tr>
  9. <td><a name="httpfs.http.port">httpfs.http.port</a></td><td>14000</td><td>
  10. The HTTP port for HttpFS REST API.
  11. </td>
  12. </tr>
  13. <tr>
  14. <td><a name="httpfs.http.hostname">httpfs.http.hostname</a></td><td>0.0.0.0</td><td>
  15. The bind host for HttpFS REST API.
  16. </td>
  17. </tr>
  18. <tr>
  19. <td><a name="httpfs.http.administrators">httpfs.http.administrators</a></td><td></td><td>ACL for the admins, this configuration is used to control
  20. who can access the default servlets for HttpFS server. The value
  21. should be a comma separated list of users and groups. The user list
  22. comes first and is separated by a space followed by the group list,
  23. e.g. "user1,user2 group1,group2". Both users and groups are optional,
  24. so "user1", " group1", "", "user1 group1", "user1,user2 group1,group2"
  25. are all valid (note the leading space in " group1"). '*' grants access
  26. to all users and groups, e.g. '*', '* ' and ' *' are all valid.
  27. </td>
  28. </tr>
  29. <tr>
  30. <td><a name="httpfs.ssl.enabled">httpfs.ssl.enabled</a></td><td>false</td><td>
  31. Whether SSL is enabled. Default is false, i.e. disabled.
  32. </td>
  33. </tr>
  34. <tr>
  35. <td><a name="hadoop.http.idle_timeout.ms">hadoop.http.idle_timeout.ms</a></td><td>60000</td><td>
  36. Httpfs Server connection timeout in milliseconds.
  37. </td>
  38. </tr>
  39. <tr>
  40. <td><a name="hadoop.http.max.threads">hadoop.http.max.threads</a></td><td>1000</td><td>
  41. The maxmimum number of threads.
  42. </td>
  43. </tr>
  44. <tr>
  45. <td><a name="hadoop.http.max.request.header.size">hadoop.http.max.request.header.size</a></td><td>65536</td><td>
  46. The maxmimum HTTP request header size.
  47. </td>
  48. </tr>
  49. <tr>
  50. <td><a name="hadoop.http.max.response.header.size">hadoop.http.max.response.header.size</a></td><td>65536</td><td>
  51. The maxmimum HTTP response header size.
  52. </td>
  53. </tr>
  54. <tr>
  55. <td><a name="hadoop.http.temp.dir">hadoop.http.temp.dir</a></td><td>${hadoop.tmp.dir}/httpfs</td><td>
  56. HttpFS temp directory.
  57. </td>
  58. </tr>
  59. <tr>
  60. <td><a name="httpfs.buffer.size">httpfs.buffer.size</a></td><td>4096</td><td>
  61. The buffer size used by a read/write request when streaming data from/to
  62. HDFS.
  63. </td>
  64. </tr>
  65. <tr>
  66. <td><a name="httpfs.services">httpfs.services</a></td><td>
  67. org.apache.hadoop.lib.service.instrumentation.InstrumentationService,
  68. org.apache.hadoop.lib.service.scheduler.SchedulerService,
  69. org.apache.hadoop.lib.service.security.GroupsService,
  70. org.apache.hadoop.lib.service.hadoop.FileSystemAccessService
  71. </td><td>
  72. Services used by the httpfs server.
  73. </td>
  74. </tr>
  75. <tr>
  76. <td><a name="kerberos.realm">kerberos.realm</a></td><td>LOCALHOST</td><td>
  77. Kerberos realm, used only if Kerberos authentication is used between
  78. the clients and httpfs or between HttpFS and HDFS.
  79. This property is only used to resolve other properties within this
  80. configuration file.
  81. </td>
  82. </tr>
  83. <tr>
  84. <td><a name="httpfs.hostname">httpfs.hostname</a></td><td>${httpfs.http.hostname}</td><td>
  85. Property used to synthetize the HTTP Kerberos principal used by httpfs.
  86. This property is only used to resolve other properties within this
  87. configuration file.
  88. </td>
  89. </tr>
  90. <tr>
  91. <td><a name="hadoop.http.authentication.signature.secret.file">hadoop.http.authentication.signature.secret.file</a></td><td>${httpfs.config.dir}/httpfs-signature.secret</td><td>
  92. File containing the secret to sign HttpFS hadoop-auth cookies.
  93. This file should be readable only by the system user running HttpFS service.
  94. If multiple HttpFS servers are used in a load-balancer/round-robin fashion,
  95. they should share the secret file.
  96. If the secret file specified here does not exist or it is empty, a random
  97. secret is generated at startup time.
  98. httpfs.authentication.signature.secret.file is deprecated. Instead use
  99. hadoop.http.authentication.signature.secret.file.
  100. </td>
  101. </tr>
  102. <tr>
  103. <td><a name="hadoop.http.authentication.type">hadoop.http.authentication.type</a></td><td>simple</td><td>
  104. Defines the authentication mechanism used by httpfs for its HTTP clients.
  105. Valid values are 'simple' or 'kerberos'.
  106. If using 'simple' HTTP clients must specify the username with the
  107. 'user.name' query string parameter.
  108. If using 'kerberos' HTTP clients must use HTTP SPNEGO or delegation tokens.
  109. httpfs.authentication.type is deprecated. Instead use
  110. hadoop.http.authentication.type.
  111. </td>
  112. </tr>
  113. <tr>
  114. <td><a name="hadoop.http.authentication.kerberos.principal">hadoop.http.authentication.kerberos.principal</a></td><td>HTTP/${httpfs.hostname}@${kerberos.realm}</td><td>
  115. The HTTP Kerberos principal used by HttpFS in the HTTP endpoint.
  116. The HTTP Kerberos principal MUST start with 'HTTP/' per Kerberos
  117. HTTP SPNEGO specification.
  118. httpfs.authentication.kerberos.principal is deprecated. Instead use
  119. hadoop.http.authentication.kerberos.principal.
  120. </td>
  121. </tr>
  122. <tr>
  123. <td><a name="hadoop.http.authentication.kerberos.keytab">hadoop.http.authentication.kerberos.keytab</a></td><td>${user.home}/httpfs.keytab</td><td>
  124. The Kerberos keytab file with the credentials for the
  125. HTTP Kerberos principal used by httpfs in the HTTP endpoint.
  126. httpfs.authentication.kerberos.keytab is deprecated. Instead use
  127. hadoop.http.authentication.kerberos.keytab.
  128. </td>
  129. </tr>
  130. <tr>
  131. <td><a name="httpfs.delegation.token.manager.update.interval">httpfs.delegation.token.manager.update.interval</a></td><td>86400</td><td>
  132. HttpFS delegation token update interval, default 1 day, in seconds.
  133. </td>
  134. </tr>
  135. <tr>
  136. <td><a name="httpfs.delegation.token.manager.max.lifetime">httpfs.delegation.token.manager.max.lifetime</a></td><td>604800</td><td>
  137. HttpFS delegation token maximum lifetime, default 7 days, in seconds
  138. </td>
  139. </tr>
  140. <tr>
  141. <td><a name="httpfs.delegation.token.manager.renewal.interval">httpfs.delegation.token.manager.renewal.interval</a></td><td>86400</td><td>
  142. HttpFS delegation token update interval, default 1 day, in seconds.
  143. </td>
  144. </tr>
  145. <tr>
  146. <td><a name="httpfs.hadoop.authentication.type">httpfs.hadoop.authentication.type</a></td><td>simple</td><td>
  147. Defines the authentication mechanism used by httpfs to connect to
  148. the HDFS Namenode.
  149. Valid values are 'simple' and 'kerberos'.
  150. </td>
  151. </tr>
  152. <tr>
  153. <td><a name="httpfs.hadoop.authentication.kerberos.keytab">httpfs.hadoop.authentication.kerberos.keytab</a></td><td>${user.home}/httpfs.keytab</td><td>
  154. The Kerberos keytab file with the credentials for the
  155. Kerberos principal used by httpfs to connect to the HDFS Namenode.
  156. </td>
  157. </tr>
  158. <tr>
  159. <td><a name="httpfs.hadoop.authentication.kerberos.principal">httpfs.hadoop.authentication.kerberos.principal</a></td><td>${user.name}/${httpfs.hostname}@${kerberos.realm}</td><td>
  160. The Kerberos principal used by httpfs to connect to the HDFS Namenode.
  161. </td>
  162. </tr>
  163. <tr>
  164. <td><a name="httpfs.hadoop.filesystem.cache.purge.frequency">httpfs.hadoop.filesystem.cache.purge.frequency</a></td><td>60</td><td>
  165. Frequency, in seconds, for the idle filesystem purging daemon runs.
  166. </td>
  167. </tr>
  168. <tr>
  169. <td><a name="httpfs.hadoop.filesystem.cache.purge.timeout">httpfs.hadoop.filesystem.cache.purge.timeout</a></td><td>60</td><td>
  170. Timeout, in seconds, for an idle filesystem to be purged.
  171. </td>
  172. </tr>
  173. <tr>
  174. <td><a name="httpfs.access.mode">httpfs.access.mode</a></td><td>read-write</td><td>
  175. Sets the access mode for HTTPFS. If access is not allowed the FORBIDDED (403) is returned.
  176. Valid access modes are:
  177. read-write Full Access allowed
  178. write-only PUT POST and DELETE full Access. GET only allows GETFILESTATUS and LISTSTATUS
  179. read-only GET Full Access PUT POST and DELETE are FORBIDDEN
  180. </td>
  181. </tr>
  182. </table>
  183. </body>
  184. </html>