Kaynağa Gözat

HUE-8888 [docs] Refresh of the configuration and operation sections

Romain 6 yıl önce
ebeveyn
işleme
c8b087cd92

+ 26 - 68
docs/docs-site/content/administrator/administration/operations.md

@@ -7,90 +7,58 @@ weight: 2
 
 ## Admin Wizard
 
-The Quick Start wizard allows you to perform the following Hue setup
-operations by clicking the tab of each step or sequentially by clicking
+The Quick Start wizard allows you to perform the following Hue setup operations by clicking the tab of each step or sequentially by clicking
 Next in each screen:
 
-1.  **Check Configuration** validates your Hue configuration. It will
-    note any potential misconfiguration and provide hints as to how to
-    fix them. You can edit the configuration file described in the next
-    section or use Cloudera Manager, if installed, to manage your
-    changes.
-2.  **Examples** contains links to install examples into the Hive,
-    Impala, MapReduce, Spark, Oozie, Solr Dashboard and Pig Editor applications.
-3.  **Users** contains a link to the User Admin application to create or
-    import users and a checkbox to enable and disable collection of
+1.  **Check Configuration** validates your Hue configuration. It will note any potential misconfiguration and provide hints as to how to
+    fix them. You can edit the configuration file described in the next section.
+2.  **Connectors** The list of services to query or browse
+3.  **Examples** get started with examples of SQL tables, queries, workflows and jobs to run.
+4.  **Users** contains a link to the User Admin application to create or import users and a checkbox to enable and disable collection of
     usage information.
 
 ### Configuration
 
-Displays a list of the installed Hue applications and their
-configuration. The location of the folder containing the Hue
-configuration files is shown at the top of the page. Hue configuration
-settings are in the hue.ini configuration file.
+Displays a list of the installed Hue applications and their configuration. The location of the folder containing the Hue
+configuration files is shown at the top of the page. Hue configuration settings are in the hue.ini configuration file.
 
-Click the tabs under **Configuration Sections and Variables** to see the
-settings configured for each application. For information on configuring
-these settings, see Hue Configuration in the Hue installation manual.
+Hue ships with a default configuration that assumes a various set of services to be present in the cluster. If you are running on a real cluster, you can customize the `hue.ini` configuration file (`/etc/hue/hue.ini` when installed from the package version) or `pseudo-distributed.ini` in `desktop/conf` when in development mode).
 
+Click the tabs under **Configuration Sections** to see the settings configured for each application. For information on configuring
+these settings, see [Configuration](/administrator/configuration/).
 
-Hue ships with a default configuration that will work for
-pseudo-distributed clusters.  If you are running on a real cluster, you must
-make a few changes to the `hue.ini` configuration file (`/etc/hue/hue.ini` when installed from the
-package version) or `pseudo-distributed.ini` in `desktop/conf` when in development mode).
-The following sections describe the key configuration options you must make to configure Hue.
+Hue loads and merges all of the files with extension `.ini` located in the `/etc/hue` directory. Files that are alphabetically later take precedence.
 
-
-<div class="note">
 To list all available configuration options, run:
 
-    $ /usr/share/hue/build/env/bin/hue config_help | less
+    /usr/share/hue/build/env/bin/hue config_help | less
 
 This commands outlines the various sections and options in the configuration,
 and provides help and information on the default values.
-</div>
 
 
-<div class="note">
 To view the current configuration from within Hue, open:
 
     http://<hue>/hue/dump_config
-</div>
-
-<div class="note">
-Hue loads and merges all of the files with extension `.ini`
-located in the `/etc/hue` directory.  Files that are alphabetically later
-take precedence.
-</div>
 
 
 ### Configuration Validation
 
 Hue can detect certain invalid configuration.
 
-To view the configuration of a running Hue instance, navigate to
-`http://myserver:8888/hue/dump_config`, also accessible through the About
-application.
-
+To view the configuration of a running Hue instance, navigate to `http://myserver:8888/hue/dump_config`.
 
 ### Server Logs
 
-Displays the Hue Server log and allows you to download the log to your
-local system in a zip file.
+Displays the Hue Server log and allows you to download them to your local system in a zip file.
 
 ### Threads
 
-Read more on the [Threads and Metrics pages
- blog post](http://gethue.com/easier-administration-of-hue-with-the-new-threads-and-metrics-pages/)
-
-Threads page can be very helpful in debugging purposes. It includes a daemonic thread and the thread objects serving concurrent requests. The host name, thread name identifier and current stack frame of each are displayed. Those are useful when Hue “hangs”, sometimes in case of a request too CPU intensive. There is also a REST API to get the dump of Threads using 'desktop/debug/threads'
+Threads page can be very helpful in debugging purposes. It includes a daemonic thread and the thread objects serving concurrent requests. The host name, thread name identifier and current stack frame of each are displayed. Those are useful when Hue “hangs”, sometimes in case of a request too CPU intensive. There is also a REST API to get the dump of Threads using `desktop/debug/threads`.
 
 ### Metrics
 
-Read more on the [Threads and Metrics pages
- blog post](http://gethue.com/easier-administration-of-hue-with-the-new-threads-and-metrics-pages/)
-
-Hue uses the **PyFormance** Python library to collect the metrics. These metrics are represented as gauge, counters, meter, rate of events over time, histogram, statistical distribution of values. A REST API endpoint '/desktop/metrics/' to get all the metrics dump as json is also exposed
+Hue uses the **PyFormance** Python library to collect the metrics. These metrics are represented as gauge, counters, meter, rate of events over time, histogram, statistical distribution of values. A REST API endpoint `/desktop/metrics/` to get all the metrics dump as json is also exposed
 
 The below metrics of most concern to us are displayed on the page:
 
@@ -110,25 +78,15 @@ Admins can either filter a particular property in all the metrics or select a pa
 The Hue logs are found in `/var/log/hue`, or in a `logs` directory under your
 Hue installation root. Inside the log directory you can find:
 
-* An `access.log` file, which contains a log for all requests against the Hue
-web server.
-* A `supervisor.log` file, which contains log information for the supervisor
-process.
-* A `supervisor.out` file, which contains the stdout and stderr for the
-supervisor process.
-* A `.log` file for each supervised process described above, which contains
-the logs for that process.
-* A `.out` file for each supervised process described above, which contains
-the stdout and stderr for that process.
-
-If users on your cluster have problems running Hue, you can often find error
-messages in these log files. If you are unable to start Hue from the init
-script, the `supervisor.log` log file can often contain clues.
-
-In addition to logging `INFO` level messages to the `logs` directory, the Hue
-web server keeps a small buffer of log messages at all levels in memory. You can
-view these logs by visiting `http://myserver:8888/hue/logs`. The `DEBUG` level
-messages shown can sometimes be helpful in troubleshooting issues.
+* An `access.log` file, which contains a log for all requests against the Hue web server.
+* A `supervisor.log` file, which contains log information for the supervisor process.
+* A `supervisor.out` file, which contains the stdout and stderr for the supervisor process.
+* A `.log` file for each supervised process described above, which contains the logs for that process.
+* A `.out` file for each supervised process described above, which contains the stdout and stderr for that process.
+
+If users on your cluster have problems running Hue, you can often find error messages in these log files. If you are unable to start Hue from the init script, the `supervisor.log` log file can often contain clues.
+
+In addition to logging `INFO` level messages to the `logs` directory, the Hue web server keeps a small buffer of log messages at all levels in memory. You can view these logs by visiting `http://myserver:8888/hue/logs`. The `DEBUG` level messages shown can sometimes be helpful in troubleshooting issues.
 
 ## Commands
 

+ 4 - 11
docs/docs-site/content/administrator/configuration/_index.md

@@ -5,16 +5,9 @@ draft: false
 weight: 3
 ---
 
-## Hue
+The file to edit is `hue.ini` (wich is based on this [template](https://github.com/cloudera/hue/blob/master/desktop/conf.dist/hue.ini)) and the actual values used can be checked on the [Dump Config](/administrator/administration/operations/#configuration) page.
 
-The source of truth sits in the main [hue.ini](https://github.com/cloudera/hue/blob/master/desktop/conf.dist/hue.ini).
-It consists in several ini sections. Lines needs to be uncommented to be active.
+The most important sections to configure are about the:
 
-The most important things to configure are:
-
-* pointing to a relational database (where Hue saves users and queries)
-* pointing to external services to query or browse (which databases we want users to query with SQL, or filesystems to browse...)
-
-## Services
-
-Sometimes some Hadoop components need to be configured to properly work with Hue. Hue is using Hadoop `impersonation` to be able to communicate properly with certain services. This is described in the following [Service Configuration](/administrator/configuration/).
+* [Hue service](/administrator/configuration/server/). e.g. pointing the application to a relational database where Hue saves users and queries, selecting the login method, customizing the look & feel, activating the task server service...
+* [Connectors](/administrator/configuration/connectors/). e.g. pointing to Data Warehouse services you want to make easy to query or browse. Those are typically which databases we want users to query with SQL or filesystems to browse.