manual.txt 28 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836
  1. Hue Installation Guide
  2. ======================
  3. Introduction
  4. ------------
  5. Hue is a graphical user interface to operate and develop applications for
  6. Apache Hadoop. Hue applications are collected into a desktop-style environment
  7. and delivered as a Web application, requiring no additional installation for
  8. individual users.
  9. This guide describes how to install and configure a Hue tarball. For
  10. information about installing Hue packages, see
  11. https://ccp.cloudera.com/display/CDH4DOC/Hue+Installation[Installing Hue].
  12. There is also a companion SDK guide that describes how to develop
  13. new Hue applications:
  14. link:sdk/sdk.html[Hue SDK Documentation]
  15. IMPORTANT: Hue requires the Hadoop contained in
  16. https://ccp.cloudera.com/display/CDH4DOC/CDH4+Quick+Start+Guide[Cloudera's
  17. Distribution including Apache Hadoop (CDH4)]
  18. .Conventions Used in this Guide:
  19. * Commands that must be run with +root+ permission have a +#+ command prompt.
  20. * Commands that do not require +root+ permission have a +$+ command prompt.
  21. Hue Installation Instructions
  22. -----------------------------
  23. The following instructions describe how to install the Hue tarball on a
  24. multi-node cluster. You need to also install CDH and update some
  25. Hadoop configuration files before running Hue.
  26. Install Hue
  27. ~~~~~~~~~~~
  28. Hue consists of a web service that runs on a special node in your cluster.
  29. Choose one node where you want to run Hue. This guide refers to that node as
  30. the _Hue Server_. For optimal performance, this should be one of the nodes
  31. within your cluster, though it can be a remote node as long as there are no
  32. overly restrictive firewalls. For small clusters of less than 10 nodes,
  33. you can use your existing master node as the Hue Server.
  34. You can download the Hue tarball here:
  35. http://github.com/cloudera/hue/downloads/
  36. Hue Dependencies
  37. ^^^^^^^^^^^^^^^^
  38. Hue employs some Python modules which use native code and requires
  39. certain development libraries be installed on your system. To install from the
  40. tarball, you must have the following installed:
  41. .Required Dependencies
  42. [grid="rows"]
  43. ``~
  44. Redhat,Ubuntu
  45. ~~~~~~~~~~
  46. gcc,gcc
  47. g++,g++
  48. libxml2-devel,libxml2-dev
  49. libxslt-devel,libxslt-dev
  50. cyrus-sasl-devel,libsasl2-dev
  51. cyrus-sasl-gssapi,libsasl2-modules-gssapi-mit
  52. mysql-devel,libmysqlclient-dev
  53. python-devel,python-dev
  54. python-setuptools,python-setuptools
  55. python-simplejson,python-simplejson
  56. sqlite-devel,libsqlite3-dev
  57. ant,ant
  58. libsasl2-dev,cyrus-sasl-devel
  59. libsasl2-modules-gssapi-mit,cyrus-sasl-gssapi
  60. libkrb5-dev,krb5-devel
  61. libtidy-0.99-0,libtidy (For unit tests only)
  62. mvn,mvn (From maven2 package or tarball)
  63. openldap-dev / libldap2-dev, openldap-devel
  64. ~~~~~~~~~~
  65. The full list is here: https://github.com/cloudera/hue#development-prerequisites
  66. Build
  67. ^^^^^
  68. Configure `$PREFIX` with the path where you want to install Hue by running:
  69. $ PREFIX=/usr/share make install
  70. $ cd /usr/share/hue
  71. $ sudo chmod 4750 apps/shell/src/shell/build/setuid
  72. $ sudo chown root:$USER apps/shell/src/shell/build/setuid
  73. You can install Hue anywhere on your system, and run Hue as a non-root user.
  74. The Shell application needs root privileges to launch various sub-processes as
  75. the logged in users. `$USER` should be the group of the user running Hue (same as
  76. its username).
  77. It is a good practice to create a new user for Hue and either install Hue in
  78. that user's home directory, or in a directory within `/usr/share`.
  79. Troubleshooting the Hue Tarball Installation
  80. ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  81. .Q: I moved my Hue installation from one directory to another and now Hue no
  82. longer functions correctly.
  83. A: Due to the use of absolute paths by some Python packages, you must run a
  84. series of commands if you move your Hue installation. In the new location, run:
  85. ----
  86. $ rm app.reg
  87. $ rm -r build
  88. $ make apps
  89. ----
  90. .Q: Why does "make install" compile other pieces of software?
  91. A: In order to ensure that Hue is stable on a variety of distributions and
  92. architectures, it installs a Python virtual environment which includes its
  93. dependencies. This ensures that the software can depend on specific versions
  94. of various Python libraries and you don't have to be concerned about missing
  95. software components.
  96. Install Hadoop from CDH
  97. ~~~~~~~~~~~~~~~~~~~~~~~
  98. To use Hue, you must install and run Hadoop from CDH4 or later. If you
  99. are not running this version of CDH or later, upgrade your cluster before
  100. proceeding.
  101. .Dependency on CDH Components
  102. [grid="rows"]
  103. `-------------.----------.----------------------------------.------------------------
  104. Component Required Applications Notes
  105. -------------------------------------------------------------------------------------
  106. HDFS Yes Core, Filebrowser HDFS access through WebHdfs or HttpFS
  107. MR1 No JobBrowser, JobDesigner, Beeswax Job information access through hue-plugins
  108. Yarn No JobDesigner, Beeswax Transitive dependency via Hive or Oozie
  109. Oozie No JobDesigner, Oozie Oozie access through REST API
  110. Hive No Beeswax Beeswax uses the Hive client libraries
  111. Flume No Shell Optionally provides access to the Flume shell
  112. HBase No Shell Optionally provides access to the HBase shell
  113. Pig No Shell Optionally provides access to the Pig shell
  114. -------------------------------------------------------------------------------------
  115. Hadoop Configuration
  116. ~~~~~~~~~~~~~~~~~~~~
  117. Configure WebHdfs
  118. ^^^^^^^^^^^^^^^^^
  119. You need to enable WebHdfs or run an HttpFS server. To turn on WebHDFS,
  120. add this to your `hdfs-site.xml` and *restart* your HDFS cluster.
  121. Depending on your setup, your `hdfs-site.xml` might be in `/etc/hadoop/conf`.
  122. <property>
  123. <name>dfs.webhdfs.enabled</name>
  124. <value>true</value>
  125. </property>
  126. You also need to add this to `core-site.html`.
  127. <property>
  128. <name>hadoop.proxyuser.hue.hosts</name>
  129. <value>*</value>
  130. </property>
  131. <property>
  132. <name>hadoop.proxyuser.hue.groups</name>
  133. <value>*</value>
  134. </property>
  135. If you place your Hue Server outside the Hadoop cluster, you can run
  136. an HttpFS server to provide Hue access to HDFS. The HttpFS service requires
  137. only one port to be opened to the cluster.
  138. Also add this in `httpfs-site.xml` which might be in `/etc/hadoop-httpfs/conf`.
  139. <property>
  140. <name>httpfs.proxyuser.hue.hosts</name>
  141. <value>*</value>
  142. </property>
  143. <property>
  144. <name>httpfs.proxyuser.hue.groups</name>
  145. <value>*</value>
  146. </property>
  147. Configure MapReduce 0.20 (MR1)
  148. ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  149. Hue communicates with the JobTracker via the Hue plugins, which is a jar
  150. file that you place in your MapReduce `lib` directory.
  151. If you JobTracker and Hue are located on the same host, copy it over.
  152. If you are using CDH3, your MapReduce library directory might be in `/usr/lib/hadoop/lib`.
  153. $ cd /usr/share/hue
  154. $ cp desktop/libs/hadoop/java-lib/hue-plugins-*.jar /usr/lib/hadoop-0.20-mapreduce/lib
  155. If you JobTracker runs on a different host, you need to `scp` the Hue plugins
  156. jar to the JobTracker host.
  157. Then add this to your `mapred-site.xml` and *restart* your JobTracker.
  158. Depending on your setup, your `mapred-site.xml` might be in `/etc/hadoop/conf`.
  159. <property>
  160. <name>jobtracker.thrift.address</name>
  161. <value>0.0.0.0:9290</value>
  162. </property>
  163. <property>
  164. <name>mapred.jobtracker.plugins</name>
  165. <value>org.apache.hadoop.thriftfs.ThriftJobTrackerPlugin</value>
  166. <description>Comma-separated list of jobtracker plug-ins to be activated.</description>
  167. </property>
  168. You can confirm that the plugins are running correctly by tailing the daemon
  169. logs:
  170. $ tail --lines=500 /var/log/hadoop-0.20/hadoop*jobtracker*.log | grep ThriftPlugin
  171. 2009-09-28 16:30:44,337 INFO org.apache.hadoop.thriftfs.ThriftPluginServer: Starting Thrift server
  172. 2009-09-28 16:30:44,419 INFO org.apache.hadoop.thriftfs.ThriftPluginServer:
  173. Thrift server listening on 0.0.0.0:9290
  174. Configure Oozie
  175. ^^^^^^^^^^^^^^^
  176. Hue submits MapReduce jobs to Oozie as the logged in user. You need to
  177. configure Oozie to accept the `hue` user to be a proxyuser. Specify this in
  178. your `oozie-site.xml` (even in a non-secure cluster), and restart Oozie:
  179. <property>
  180. <name>oozie.service.ProxyUserService.proxyuser.hue.hosts</name>
  181. <value>*</value>
  182. </property>
  183. <property>
  184. <name>oozie.service.ProxyUserService.proxyuser.hue.groups</name>
  185. <value>*</value>
  186. </property>
  187. Further Hadoop Configuration and Caveats
  188. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  189. `HADOOP_CLASSPATH` Caveat
  190. ^^^^^^^^^^^^^^^^^^^^^^^^^
  191. If you are setting `$HADOOP_CLASSPATH` in your `hadoop-env.sh`, be sure
  192. to set it in such a way that user-specified options are preserved. For example:
  193. Correct:
  194. # HADOOP_CLASSPATH=<your_additions>:$HADOOP_CLASSPATH
  195. Incorrect:
  196. # HADOOP_CLASSPATH=<your_additions>
  197. This enables certain components of Hue to add to
  198. Hadoop's classpath using the environment variable.
  199. `hadoop.tmp.dir`
  200. ^^^^^^^^^^^^^^^^
  201. If your users are likely to be submitting jobs both using Hue and from the
  202. same machine via the command line interface, they will be doing so as the `hue`
  203. user if they're using Hue and via their own user account on the command line.
  204. This leads to some contention on the directory specified by `hadoop.tmp.dir`,
  205. which defaults to `/tmp/hadoop-${user.name}`. Specifically, `hadoop.tmp.dir`
  206. is used to unpack jars in `bin/hadoop jar`. One work around to this is
  207. to set `hadoop.tmp.dir` to `/tmp/hadoop-${user.name}-${hue.suffix}` in the
  208. core-site.xml file:
  209. <property>
  210. <name>hadoop.tmp.dir</name>
  211. <value>/tmp/hadoop-${user.name}${hue.suffix}</value>
  212. </property>
  213. Unfortunately, when the variable is unset, you'll end up
  214. with directories named `/tmp/hadoop-user_name-${hue.suffix}` in
  215. `/tmp`. Despite that, Hue will still work.
  216. IMPORTANT: The Beeswax server writes into a local directory on the Hue machine
  217. that is specified by `hadoop.tmp.dir` to unpack its jars. That directory
  218. needs to be writable by the `hue` user, which is the default user who starts
  219. Beeswax Server, or else Beeswax server will not start. You may also make that
  220. directory world-writable.
  221. Configuring Your Firewall for Hue
  222. ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  223. Hue currently requires that the machines within your cluster can connect to
  224. each other freely over TCP. The machines outside your cluster must be able to
  225. open TCP port 8888 on the Hue Server (or the configured Hue web HTTP port)
  226. to interact with the system.
  227. Hive Configuration
  228. ~~~~~~~~~~~~~~~~~~
  229. Hue's Beeswax application helps you use Hive to query your data.
  230. It depends on a Hive installation on your system. Please read
  231. this section to ensure a proper integration.
  232. Your Hive data is stored in HDFS, normally under `/user/hive/warehouse`
  233. (or any path you specify as `hive.metastore.warehouse.dir` in your
  234. `hive-site.xml`). Make sure this location exists and is writable by
  235. the users whom you expect to be creating tables. `/tmp` (on the local file
  236. system) must be world-writable (1777), as Hive makes extensive use of it.
  237. [NOTE]
  238. If you used the embedded Hive MetaStore functionality of Beeswax in Hue from
  239. versions prior to Hue 1.2, read this section. Hue 1.2 includes changes in the
  240. Hive MetaStore schema that are part of the Hive 0.7 release. If you want to use
  241. Beeswax in Hue 1.2, it is imperative that you upgrade the Hive MetaStore schema
  242. by running the appropriate schema upgrade script located in the
  243. `apps/beeswax/hive/scripts/metastore/upgrade` directory in the Hue installation.
  244. Scripts for Derby and MySQL databases are available. If you are using a
  245. different database for your MetaStore, you will need to provide your own
  246. upgrade script.
  247. No Existing Hive Installation
  248. ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  249. Familiarize yourself with the configuration options in
  250. `hive-site.xml`. See
  251. https://ccp.cloudera.com/display/CDH4DOC/Hive+Installation#HiveInstallation-ConfiguringtheHiveMetastore[Hive
  252. Installation and Configuration].
  253. Having a `hive-site.xml` is optional but often useful, particularly on setting
  254. up a http://wiki.apache.org/hadoop/Hive/AdminManual/MetastoreAdmin[metastore].
  255. You may store the `hive-site.xml` in `/etc/hue/conf`, or instruct
  256. Beeswax to locate it using the `hive_conf_dir` configuration variable. See
  257. `/etc/hue/conf/hue.ini`.
  258. Existing Hive Installation
  259. ^^^^^^^^^^^^^^^^^^^^^^^^^^
  260. In `/etc/hue/conf/hue.ini`, modify `hive_conf_dir` to point to the
  261. directory containing `hive-site.xml`.
  262. Configuring Hue
  263. ---------------
  264. Hue ships with a default configuration that will work for
  265. pseudo-distributed clusters. If you are running on a real cluster, you must
  266. make a few changes to the `/etc/hue/hue.ini` configuration file (or ``pseudo-distributed.ini`
  267. when in development mode). The following sections describe the key configuration options you must make to
  268. configure Hue.
  269. [TIP]
  270. .Listing all Configuration Options
  271. ============================================================
  272. To list all available configuration options, run:
  273. $ /usr/share/hue/build/env/bin/hue config_help | less
  274. This commands outlines the various sections and options in the configuration,
  275. and provides help and information on the default values.
  276. ============================================================
  277. [TIP]
  278. .Viewing Current Configuration Options
  279. ============================================================
  280. To view the current configuration from within Hue, open:
  281. http://<hue>/dump_config
  282. ============================================================
  283. [TIP]
  284. .Using Multiple Files to Store Your Configuration
  285. ============================================================
  286. Hue loads and merges all of the files with extension `.ini`
  287. located in the `/etc/hue` directory. Files that are alphabetically later
  288. take precedence.
  289. ============================================================
  290. Web Server Configuration
  291. ~~~~~~~~~~~~~~~~~~~~~~~~
  292. These configuration variables are under the `[desktop]` section in
  293. the `/etc/hue/hue.ini` configuration file.
  294. Specifying the Hue HTTP Address
  295. ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  296. Hue uses a Spawning or a CherryPy web server (configurable). You can use
  297. the following options to change the IP address and port that the web server
  298. listens on. The default setting is port 8888 on all configured IP addresses.
  299. # Webserver listens on this address and port
  300. http_host=0.0.0.0
  301. http_port=8888
  302. Specifying the Secret Key
  303. ^^^^^^^^^^^^^^^^^^^^^^^^^
  304. For security, you should also specify the secret key that is used for secure
  305. hashing in the session store. Enter a long series of random characters
  306. (30 to 60 characters is recommended).
  307. secret_key=jFE93j;2[290-eiw.KEiwN2s3['d;/.q[eIW^y#e=+Iei*@Mn<qW5o
  308. NOTE: If you don't specify a secret key, your session cookies will not be
  309. secure. Hue will run but it will also display error messages telling you to
  310. set the secret key.
  311. Authentication
  312. ^^^^^^^^^^^^^^
  313. By default, the first user who logs in to Hue can choose any
  314. username and password and becomes an administrator automatically. This
  315. user can create other user and administrator accounts. User information is
  316. stored in the Django database in the Django backend.
  317. The authentication system is pluggable. For more information, see the
  318. link:sdk/sdk.html[Hue SDK Documentation].
  319. Configuring Hue for SSL
  320. ^^^^^^^^^^^^^^^^^^^^^^^
  321. You can configure Hue to serve over HTTPS. To do so, you must install
  322. "pyOpenSSL" within Hue's context and configure your keys.
  323. To install `pyOpenSSL`, from the root of your Hue installation path,
  324. do the following steps:
  325. 1. Run this command:
  326. $ ./build/env/bin/easy_install pyOpenSSL
  327. 2. Configure Hue to use your private key by adding the following
  328. options to the `/etc/hue/hue.ini` configuration file:
  329. ssl_certificate=/path/to/certificate
  330. ssl_private_key=/path/to/key
  331. 3. Ideally, you would have an appropriate key signed by a Certificate Authority.
  332. If you're just testing, you can create a self-signed key using the `openssl`
  333. command that may be installed on your system:
  334. ### Create a key
  335. $ openssl genrsa 1024 > host.key
  336. ### Create a self-signed certificate
  337. $ openssl req -new -x509 -nodes -sha1 -key host.key > host.cert
  338. [NOTE]
  339. .Self-signed Certificates and File Uploads
  340. ============================================================
  341. To upload files using the Hue File Browser over HTTPS requires
  342. using a proper SSL Certificate. Self-signed certificates don't
  343. work.
  344. ============================================================
  345. Hue Configuration for Hadoop
  346. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  347. These configuration variables are under the `[hadoop]` section in
  348. the `/etc/hue/hue.ini` configuration file.
  349. HDFS Cluster
  350. ^^^^^^^^^^^^
  351. Hue only support one HDFS cluster currently. That cluster should be defined
  352. under the `[[[default]]]` sub-section.
  353. fs_defaultfs::
  354. This is the equivalence of `fs.defaultFS` (aka `fs.default.name`) in
  355. Hadoop configuration.
  356. webhdfs_url::
  357. You can also set this to be the HttpFS url. The default value is the HTTP
  358. port on the NameNode.
  359. hadoop_hdfs_home::
  360. This is the home of your Hadoop HDFS installation. It is the
  361. root of the Hadoop untarred directory, or usually
  362. `/usr/lib/hadoop`.
  363. hadoop_bin::
  364. Use this as the HDFS Hadoop launcher script, which is usually
  365. `/usr/bin/hadoop`.
  366. hadoop_conf_dir::
  367. This is the configuration directory of the HDFS, typically
  368. `/etc/hadoop/conf`.
  369. MapReduce (MR1) Cluster
  370. ^^^^^^^^^^^^^^^^^^^^^^^
  371. Hue only support one MapReduce cluster currently. That cluster should be defined
  372. under the `[[[default]]]` sub-section. Note that JobBrowser only works with MR1.
  373. jobtracker_host::
  374. The host running the JobTracker. In a secured environment, this needs to
  375. be the FQDN of the JobTracker host, and match the "host" portion of the
  376. `mapred' Kerberos principal full name.
  377. jobtracker_port::
  378. The port for the JobTracker IPC service.
  379. submit_to::
  380. If your Oozie is configured with to talk to a 0.20 MapReduce service, then
  381. set this to `true`. Hue will be submitting jobs to this MapReduce cluster.
  382. hadoop_mapred_home::
  383. This is the home of your Hadoop MapReduce installation. It is the
  384. root of the Hadoop MR1 untarred directory, or the root of the
  385. Hadoop 0.20 untarred directory, or `/usr/lib/hadoop-0.20-mapreduce` for
  386. CDH packages. If `submit_to` is true for this cluster, this
  387. config value becomes the `$HADOOP_MAPRED_HOME` for
  388. BeeswaxServer and child shell processes.
  389. hadoop_bin::
  390. Use this as the MR1 Hadoop launcher script, which is usually
  391. `/usr/bin/hadoop`.
  392. hadoop_conf_dir::
  393. This is the configuration directory of the MR1 service,
  394. typically `/etc/hadoop/conf`.
  395. Yarn (MR2) Cluster
  396. ^^^^^^^^^^^^^^^^^^
  397. Hue only support one Yarn cluster currently. That cluster should be defined
  398. under the `[[[default]]]` sub-section.
  399. resourcemanager_host::
  400. The host running the ResourceManager.
  401. resourcemanager_port::
  402. The port for the ResourceManager IPC service.
  403. submit_to::
  404. If your Oozie is configured with to talk to a Yarn cluster, then
  405. set this to `true`. Hue will be submitting jobs to this Yarn cluster.
  406. But note that JobBrowser will not be able to show MR2 jobs.
  407. hadoop_mapred_home::
  408. This is the home of your Hadoop MapReduce installation. It is the
  409. root of the Hadoop 0.23 untarred directory, or
  410. `/usr/lib/hadoop-mapreduce` for CDH packages. If `submit_to` is
  411. true for this cluster, this config value becomes the
  412. `$HADOOP_MAPRED_HOME` for BeeswaxServer and child shell
  413. processes.
  414. hadoop_bin::
  415. Use this as the Yarn/MR2 Hadoop launcher script, which is usually
  416. `/usr/bin/hadoop`.
  417. hadoop_conf_dir::
  418. This is the configuration directory of the Yarn/MR2 service,
  419. typically `/etc/hadoop/conf`.
  420. Beeswax Configuration
  421. ~~~~~~~~~~~~~~~~~~~~~
  422. In the `[beeswax]` section of the configuration file, you can
  423. _optionally_ specify the following:
  424. beeswax_server_host::
  425. The hostname or IP that the Beeswax Server should bind to. By
  426. default it binds to `localhost`, and therefore only serves local
  427. IPC clients.
  428. hive_home_dir::
  429. The base directory of your Hive installation.
  430. hive_conf_dir::
  431. The directory containing your `hive-site.xml` Hive
  432. configuration file.
  433. beeswax_server_heapsize::
  434. The heap size (-Xmx) of the Beeswax Server.
  435. JobDesigner and Oozie Configuration
  436. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  437. In the `[liboozie]` section of the configuration file, you should
  438. specify:
  439. oozie_url::
  440. The URL of the Oozie service. It is the same as the `OOZIE_URL`
  441. environment variable for Oozie.
  442. UserAdmin Configuration
  443. ~~~~~~~~~~~~~~~~~~~~~~~
  444. In the `[useradmin]` section of the configuration file, you can
  445. _optionally_ specify the following:
  446. default_user_group::
  447. The name of a default group that is suggested when creating a
  448. user manually. If the LdapBackend or PamBackend are configured
  449. for doing user authentication, new users will automatically be
  450. members of the default group.
  451. Configuration Validation
  452. ~~~~~~~~~~~~~~~~~~~~~~~~
  453. Hue can detect certain invalid configuration. It will show a red alert icon on
  454. the top navigation bar. image:images/val.png[]
  455. To view the configuration of a running Hue instance, navigate to
  456. `http://myserver:8888/dump_config`, also accessible through the About
  457. application.
  458. Starting Hue from the Tarball
  459. -----------------------------
  460. After your cluster is running with the plugins enabled, you can start Hue on
  461. your Hue Server by running:
  462. # build/env/bin/supervisor
  463. This will start several subprocesses, corresponding to the different Hue
  464. components. Your Hue installation is now running.
  465. Administering Hue
  466. -----------------
  467. Now that you've installed and started Hue, you can feel free to skip ahead
  468. to the <<usage,Using Hue>> section. Administrators may want to refer to this
  469. section for more details about managing and operating a Hue installation.
  470. Hue Processes
  471. ~~~~~~~~~~~~~
  472. Process User
  473. ^^^^^^^^^^^^
  474. Filebrowser requires Hue to be running as the 'hue' user.
  475. Process Hierarchy
  476. ^^^^^^^^^^^^^^^^^
  477. A script called `supervisor` manages all Hue processes. The supervisor is a
  478. watchdog process -- its only purpose is to spawn and monitor other processes.
  479. A standard Hue installation starts and monitors the following processes:
  480. * `runcpserver` - a web server based on CherryPy that provides the core web
  481. functionality of Hue
  482. * `beeswax server` - a daemon that manages concurrent Hive queries
  483. If you have installed other applications into your Hue instance, you may see
  484. other daemons running under the supervisor as well.
  485. You can see the supervised processes running in the output of `ps -f -u hue`:
  486. UID PID PPID C STIME TTY TIME CMD
  487. hue 8685 8679 0 Aug05 ? 00:01:39 /usr/share/hue/build/env/bin/python /usr/share/hue/build/env/bin/desktop runcpserver
  488. hue 8695 8679 0 Aug05 ? 00:00:06 /usr/java/jdk1.6.0_14/bin/java -Xmx1000m -Dhadoop.log.dir=/usr/lib/hadoop-0.20/logs -Dhadoop.log.file=hadoop.log ...
  489. Note that the supervisor automatically restarts these processes if they fail for
  490. any reason. If the processes fail repeatedly within a short time, the supervisor
  491. itself shuts down.
  492. [[logging]]
  493. Hue Logging
  494. ~~~~~~~~~~~
  495. The Hue logs are found in `/var/log/hue`, or in a `logs` directory under your
  496. Hue installation root. Inside the log directory you can find:
  497. * An `access.log` file, which contains a log for all requests against the Hue
  498. web server.
  499. * A `supervisor.log` file, which contains log information for the supervisor
  500. process.
  501. * A `supervisor.out` file, which contains the stdout and stderr for the
  502. supervisor process.
  503. * A `.log` file for each supervised process described above, which contains
  504. the logs for that process.
  505. * A `.out` file for each supervised process described above, which contains
  506. the stdout and stderr for that process.
  507. If users on your cluster have problems running Hue, you can often find error
  508. messages in these log files. If you are unable to start Hue from the init
  509. script, the `supervisor.log` log file can often contain clues.
  510. Viewing Recent Log Messages Online
  511. ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  512. In addition to logging `INFO` level messages to the `logs` directory, the Hue
  513. web server keeps a small buffer of log messages at all levels in memory. You can
  514. view these logs by visiting `http://myserver:8888/logs`. The `DEBUG` level
  515. messages shown can sometimes be helpful in troubleshooting issues.
  516. The Hue Database
  517. ~~~~~~~~~~~~~~~~
  518. Hue requires a SQL database to store small amounts of data, including user
  519. account information as well as history of job submissions and Hive queries.
  520. By default, Hue is configured to use the embedded database SQLite for this
  521. purpose, and should require no configuration or management by the administrator.
  522. However, MySQL is the recommended database to use. This section contains
  523. instructions for configuring Hue to access MySQL and other databases.
  524. Inspecting the Hue Database
  525. ^^^^^^^^^^^^^^^^^^^^^^^^^^^
  526. The default SQLite database used by Hue is located in: `/usr/share/hue/desktop/desktop.db`.
  527. You can inspect this database from the command line using the `sqlite3`
  528. program or typing `/usr/share/hue/build/env/bin/hue dbshell'. For example:
  529. # sqlite3 /usr/share/hue/desktop/desktop.db
  530. SQLite version 3.6.22
  531. Enter ".help" for instructions
  532. Enter SQL statements terminated with a ";"
  533. sqlite> select username from auth_user;
  534. admin
  535. test
  536. sample
  537. sqlite>
  538. It is strongly recommended that you avoid making any modifications to the
  539. database directly using SQLite, though this trick can be useful for management
  540. or troubleshooting.
  541. Backing up the Hue Database
  542. ^^^^^^^^^^^^^^^^^^^^^^^^^^^
  543. If you use the default SQLite database, then copy the `desktop.db` file to
  544. another node for backup. It is recommended that you back it up on a regular
  545. schedule, and also that you back it up before any upgrade to a new version of
  546. Hue.
  547. Configuring Hue to Access Another Database
  548. ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  549. Although SQLite is the default database type, some advanced users may prefer
  550. to have Hue access an alternate database type. Note that if you elect to
  551. configure Hue to use an external database, upgrades may require more manual
  552. steps in the future.
  553. The following instructions are for MySQL, though you can also configure Hue to
  554. work with other common databases such as PostgreSQL and Oracle.
  555. [NOTE]
  556. .Tested Database Backends
  557. ============================================================
  558. Note that Hue has only been tested with SQLite and MySQL database backends.
  559. ============================================================
  560. Configuring Hue to Store Data in MySQL
  561. ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  562. To configure Hue to store data in MySQL:
  563. 1. Create a new database in MySQL and grant privileges to a Hue user to manage
  564. this database.
  565. mysql> create database hue;
  566. Query OK, 1 row affected (0.01 sec)
  567. mysql> grant all on hue.* to 'hue'@'localhost' identified by 'secretpassword';
  568. Query OK, 0 rows affected (0.00 sec)
  569. 2. Shut down Hue if it is running.
  570. 3. To migrate your existing data to MySQL, use the following command to dump the
  571. existing database data to a text file. Note that using the ".json" extension
  572. is required.
  573. $ /usr/share/hue/build/env/bin/hue dumpdata > <some-temporary-file>.json
  574. 4. Open the `/etc/hue/hue.ini` file in a text editor. Directly below the
  575. `[[database]]` line, add the following options (and modify accordingly for
  576. your MySQL setup):
  577. host=localhost
  578. port=3306
  579. engine=mysql
  580. user=hue
  581. password=secretpassword
  582. name=hue
  583. 5. As the Hue user, configure Hue to load the existing data and create the
  584. necessary database tables:
  585. $ /usr/share/hue/build/env/bin/hue syncdb --noinput
  586. $ mysql -uhue -psecretpassword -e "DELETE FROM hue.django_content_type;"
  587. $ /usr/share/hue/build/env/bin/hue loaddata <temporary-file-containing-dumped-data>.json
  588. Your system is now configured and you can start the Hue server as normal.
  589. [[usage]]
  590. Using Hue
  591. ---------
  592. After installation, you can use Hue by navigating to `http://myserver:8888/`.
  593. The following login screen appears:
  594. image:images/login.png[]
  595. The Help application guides users through the various installed applications.
  596. Supported Browsers
  597. ~~~~~~~~~~~~~~~~~~
  598. Hue is primarily tested on Firefox, Chrome and Safari on Windows, Mac,
  599. and Linux.
  600. Most of Hue should work in IE8+ and Opera is not tested.
  601. Feedback
  602. ~~~~~~~~
  603. Your feedback is welcome. The best way to send feedback is to join the
  604. https://groups.google.com/a/cloudera.org/group/hue-user[mailing list], and
  605. send e-mail, to mailto:hue-user@cloudera.org[hue-user@cloudera.org].
  606. Reporting Bugs
  607. ~~~~~~~~~~~~~~
  608. If you find that something doesn't work, it'll often be helpful to include logs
  609. from your server. (See the <<logging,Hue Logging>> section. Please include the
  610. logs as a zip (or cut and paste the ones that look relevant) and send those with
  611. your bug reports.
  612. image:images/logs.png[]