Pārlūkot izejas kodu

HUE-8888 [docs] Adding Admin Metadata configuration information

Romain 6 gadi atpakaļ
vecāks
revīzija
7940ff76a9

+ 4 - 4
docs/docs-site/content/administrator/administration/database.md

@@ -12,7 +12,7 @@ purpose, and should require no configuration or management by the administrator.
 However, MySQL is the recommended database to use. This section contains
 instructions for configuring Hue to access MySQL and other databases.
 
-### Inspecting the Database
+### Inspecting
 
 The default SQLite database used by Hue is located in: `/usr/share/hue/desktop/desktop.db`.
 You can inspect this database from the command line using the `sqlite3`
@@ -32,14 +32,14 @@ It is strongly recommended that you avoid making any modifications to the
 database directly using SQLite, though this trick can be useful for management
 or troubleshooting.
 
-### Backing up the Database
+### Backing up
 
 If you use the default SQLite database, then copy the `desktop.db` file to
 another node for backup. It is recommended that you back it up on a regular
 schedule, and also that you back it up before any upgrade to a new version of
 Hue.
 
-### Clean up the database
+### Clean up
 
 When the database has too many entries in certain tables, it will cause performance issue. Now Hue config check will help superuser to find this issue. Login as superuser and go to “Hue Administration”, this sample screenshot will be displayed in the quick start wizard when the tables have too many entries.
 
@@ -112,7 +112,7 @@ To configure Hue to store data in MySQL:
 
 Your system is now configured and you can start the Hue server as normal.
 
-### Migrate the Hue Database
+### Migrating
 Note: Hue Custom Databases includes database-specific pages on how to migrate from an old to a new database. This page summarizes across supported database types.
 When you change Hue databases, you can migrate the existing data to your new database. If the data is dispensable, there is no need to migrate.
 

+ 6 - 33
docs/docs-site/content/administrator/configuration/apps/_index.md

@@ -233,11 +233,11 @@ Then make sure the `hive` interpreter is present in the `[[interpreters]]` list.
 
 ### Custom
 
-A series of native connectors interacting with the editor have been developed and are listed in the [developer section](/developer/sdk/#sql-connectors).
+A series of native connectors (e.g. Livy, ksql...) interacting with the editor have been developed and are listed in the [developer section](/developer/sdk/#sql-connectors).
 
 ### JDBC
 
-**Note** This is an historical connector, SQLAlchemy should be prefered at this time as it does not require a proxy and is fully secure.
+**Note**: This is an historical connector, SQLAlchemy should be prefered at this time as it does not require a proxy and is fully secure.
 
 Use the query editor with any JDBC database.
 
@@ -245,7 +245,9 @@ The “rdbms” interface works great for MySQL, PostgreSQL, SQLite, and Oracle,
 
 Integrating an external JDBC database involves a 3-step process:
 
-Download the compatible client driver JAR file for your specific OS and database. Usually you can find the driver files from the official database vendor site; for example, the MySQL JDBC connector for Mac OSX can be found here: https://dev.mysql.com/downloads/connector/j/. (NOTE: In the case of MySQL, the JDBC driver is platform independent, but some drivers are specific to certain OSes and versions so be sure to verify compatibility.)
+Download the compatible client driver JAR file for your specific OS and database. Usually you can find the driver files from the official database vendor site; for example, the MySQL JDBC connector for Mac OSX can be found here: https://dev.mysql.com/downloads/connector/j/.
+
+**Note**: In the case of MySQL, the JDBC driver is platform independent, but some drivers are specific to certain OSes and versions so be sure to verify compatibility.)
 Add the path to the driver JAR file to your Java CLASSPATH. Here, we set the CLASSPATH environment variable in our `.bash_profile` script.
 
     # MySQL
@@ -267,7 +269,7 @@ be started if any interpreter is using it.
     ## Main flag to override the automatic starting of the DBProxy server.
     enable_dbproxy_server=true
 
-**Note**
+**Note**:
 Hue needs to be compiled with the flag `BUILD_DB_PROXY=true` in order to come with the JDBC connector.
 
 **Tip**: Testing JDBC Configurations
@@ -275,32 +277,3 @@ Before adding your interpreter's JDBC configurations to hue.ini, verify that the
 
 **Tip**: Prompt for JDBC authentication
 You can leave out the username and password in the JDBC options, and Hue will instead prompt the user for a username and password. This allows administrators to provide access to JDBC sources without granting all Hue users the same access.
-
-### Django DB Connectors
-
-**Note** This is an historical connector, SQLAlchemy should be prefered at this time.
-
-Those rely on the `[dbms]` lib an dedicated Python libs.
-
-First, in your hue.ini file, add the relevant database connection information under the `[librdbms]` section:
-
-    [librdbms]
-      [[databases]]
-        [[[postgresql]]]
-        nice_name=PostgreSQL
-        name=music
-        engine=postgresql_psycopg2
-        port=5432
-        user=hue
-        password=hue
-        options={}
-
-Secondly, add a new interpreter to the notebook app. This will allow the new database type to be registered as a snippet-type in the Notebook app. For query editors that use a Django-compatible database, the name in the brackets should match the database configuration name in the librdbms section (e.g. – postgresql). The interface will be set to rdbms. This tells Hue to use the librdbms driver and corresponding connection information to connect to the database. For example, with the above postgresql connection configuration in the librdbms section, we can add a PostgreSQL interpreter with the following notebook configuration:
-
-    [notebook]
-      [[interpreters]]
-        [[[postgresql]]]
-        name=PostgreSQL
-        interface=rdbms
-
-After updating the configuration and restarting Hue, we can access the new PostgreSQL interpreter in the Notebook app.

+ 34 - 2
docs/docs-site/content/administrator/configuration/connectors/_index.md

@@ -933,11 +933,43 @@ And from the HBase shell, authorize some ends users, e.g. to give full access to
 
     hbase shell> grant 'admin', 'RWXCA'
 
-## Others
+## Metadata
 
 ### Apache Atlas
 
-In the `[metadata]` section, Hue is supporting Cloudera Navigator and soon Apache Atlas ([HUE-8749](https://issues.cloudera.org/browse/HUE-8749)) in order to enrich the [data catalog](/user/browsing/).
+In the `[metadata]` section, Hue is supporting Cloudera Navigator and Apache Atlas in order to enrich the [data catalog](/user/browsing/#data-catalog).
+
+    [metadata]
+    [[catalog]]
+      # The type of Catalog: Apache Atlas, Cloudera Navigator...
+      interface=atlas
+      # Catalog API URL (without version suffix).
+      api_url=http://localhost:21000/atlas/v2
+
+      # Username of the CM user used for authentication.
+      ## server_user=hue
+      # Password of the user used for authentication.
+      server_password=
+
+      # Limits found entities to a specific cluster. When empty the entities from all clusters will be included in the search results.
+      ## search_cluster=
+
+      # Set to true when authenticating via kerberos instead of username/password
+      ## kerberos_enabled=false
+
+![Data Catalog Search](https://cdn.gethue.com/uploads/2019/06/SearchWithType_field_name.png)
+
+### Cloudera Navigator
+
+The integration was replaced with Apache Atlas but can still be used.
+
+### Cloudera Navigator Optimizer
+
+The integration is powering the [Risk Alerts and Popular Values](/user/querying/#query-troubleshooting) in the SQL Autocomplete.
+
+![Popular joins suggestion](https://cdn.gethue.com/uploads/2017/07/hue_4_query_joins.png)
+
+## Jobs
 
 ### Apache Spark
 

+ 1 - 1
docs/docs-site/content/user/browsing/_index.md

@@ -75,7 +75,7 @@ Navigator
 * owner:admin type:field usage → List all the fields created by the admin user that matches the usage string
 * parentPath:"/default/web_logs" type:FIELD  originalName:b* → List all the columns starting with `b` of the table `web_logs` in the database `default`.
 
-![Data Catalog Search](https://cdn.gethue.com/uploads/2019/06/SearchBy_Classification_Tag.png)
+![Data Catalog Search](https://cdn.gethue.com/uploads/2019/06/SearchWithType_field_name.png)
 
 Learn more on the [Search](http://gethue.com/realtime-catalog-search-with-hue-and-apache-atlas/).