|
@@ -195,6 +195,249 @@ default_user_group::
|
|
|
for doing user authentication, new users will automatically be
|
|
for doing user authentication, new users will automatically be
|
|
|
members of the default group.
|
|
members of the default group.
|
|
|
|
|
|
|
|
|
|
+# Administration
|
|
|
|
|
+
|
|
|
|
|
+## Quick Start 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
|
|
|
|
|
+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
|
|
|
|
|
+ usage information.
|
|
|
|
|
+4. **Go!** - displays the Hue home screen, which contains links to the
|
|
|
|
|
+ different categories of applications supported by Hue: Query,
|
|
|
|
|
+ Hadoop, and Workflow.
|
|
|
|
|
+
|
|
|
|
|
+## 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.
|
|
|
|
|
+
|
|
|
|
|
+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.
|
|
|
|
|
+
|
|
|
|
|
+## Server Logs
|
|
|
|
|
+
|
|
|
|
|
+Displays the Hue Server log and allows you to download the log to your
|
|
|
|
|
+local system in a zip file.
|
|
|
|
|
+
|
|
|
|
|
+
|
|
|
|
|
+## User management
|
|
|
|
|
+
|
|
|
|
|
+The User Admin application lets a superuser add, delete, and manage Hue
|
|
|
|
|
+users and groups, and configure group permissions. Superusers can add
|
|
|
|
|
+users and groups individually, or import them from an LDAP directory.
|
|
|
|
|
+Group permissions define the Hue applications visible to group members
|
|
|
|
|
+when they log into Hue and the application features available to them.
|
|
|
|
|
+
|
|
|
|
|
+
|
|
|
|
|
+Click the **User Admin** icon in the top right navigation bar under your username.
|
|
|
|
|
+
|
|
|
|
|
+### Users
|
|
|
|
|
+
|
|
|
|
|
+The User Admin application provides two levels of user privileges:
|
|
|
|
|
+superusers and users.
|
|
|
|
|
+
|
|
|
|
|
+- Superusers — The first user who logs into Hue after its initial
|
|
|
|
|
+ installation becomes the first superuser. Superusers have
|
|
|
|
|
+ permissions to perform administrative functions:
|
|
|
|
|
+ - Add and delete users
|
|
|
|
|
+ - Add and delete groups
|
|
|
|
|
+ - Assign permissions to groups
|
|
|
|
|
+ - Change a user into a superuser
|
|
|
|
|
+ - Import users and groups from an LDAP server
|
|
|
|
|
+
|
|
|
|
|
+- Users — can change their name, e-mail address, and password and log
|
|
|
|
|
+ in to Hue and run Hue applications, subject to the permissions
|
|
|
|
|
+ provided by the Hue groups to which they belong.
|
|
|
|
|
+
|
|
|
|
|
+#### Adding a User
|
|
|
|
|
+
|
|
|
|
|
+1. In the **User Admin** page, click **Add User**.
|
|
|
|
|
+2. In the **Credentials** screen, add required information about the
|
|
|
|
|
+ user. Once you provide the required information you can click the
|
|
|
|
|
+ wizard step tabs to set other information.
|
|
|
|
|
+
|
|
|
|
|
+ <table>
|
|
|
|
|
+<tr><td>Username</td><td> A user name that contains only letters, numbers, and underscores;
|
|
|
|
|
+ blank spaces are not allowed and the name cannot begin with a
|
|
|
|
|
+ number. The user name is used to log into Hue and in file
|
|
|
|
|
+ permissions and job submissions. This is a required field.
|
|
|
|
|
+</td></tr>
|
|
|
|
|
+<tr><td>Password and Password confirmation</td><td> A password for the user. This is a required field.</td></tr>
|
|
|
|
|
+<tr><td>Create home directory</td><td> Indicate whether to create a directory named /user/username in HDFS.
|
|
|
|
|
+ For non-superusers, the user and group of the directory are
|
|
|
|
|
+ username. For superusers, the user and group are username and
|
|
|
|
|
+ supergroup.</td></tr></table>
|
|
|
|
|
+
|
|
|
|
|
+
|
|
|
|
|
+
|
|
|
|
|
+3. Click **Add User** to save the information you specified and close
|
|
|
|
|
+ the **Add User** wizard or click **Next**.
|
|
|
|
|
+4. In the **Names and Groups** screen, add optional information.
|
|
|
|
|
+
|
|
|
|
|
+<table>
|
|
|
|
|
+<tr><td>First name and Last name</td><td> The user's first and last name.
|
|
|
|
|
+</td></tr>
|
|
|
|
|
+<tr><td>E-mail address</td><td>The user's e-mail address. The e-mail address is used by the Job
|
|
|
|
|
+ Designer and Beeswax applications to send users an e-mail message
|
|
|
|
|
+ after certain actions have occurred. The Job Designer sends an
|
|
|
|
|
+ e-mail message after a job has completed. Beeswax sends a message
|
|
|
|
|
+ after a query has completed. If an e-mail address is not specified,
|
|
|
|
|
+ the application will not attempt to email the user.</td></tr>
|
|
|
|
|
+<tr><td>Groups</td><td> The groups to which the user belongs. By default, a user is assigned
|
|
|
|
|
+ to the **default** group, which allows access to all applications.
|
|
|
|
|
+ See [Permissions](#permissions).</td></tr></table>
|
|
|
|
|
+
|
|
|
|
|
+
|
|
|
|
|
+5. Click **Add User** to save the information you specified and close
|
|
|
|
|
+ the **Add User** wizard or click **Next**.
|
|
|
|
|
+6. In the **Advanced** screen, add status information.
|
|
|
|
|
+
|
|
|
|
|
+<table>
|
|
|
|
|
+<tr><td>Active</td><td> Indicate that the user is enabled and allowed to log in. Default: checked.</td></tr>
|
|
|
|
|
+<tr><td>Superuser status</td><td> Assign superuser privileges to the user.</td></tr></table>
|
|
|
|
|
+
|
|
|
|
|
+7. Click **Add User** to save the information you specified and close
|
|
|
|
|
+ the **Add User** wizard.
|
|
|
|
|
+
|
|
|
|
|
+#### Deleting a User
|
|
|
|
|
+
|
|
|
|
|
+1. Check the checkbox next to the user name and click **Delete**.
|
|
|
|
|
+2. Click **Yes** to confirm.
|
|
|
|
|
+
|
|
|
|
|
+#### Editing a User
|
|
|
|
|
+
|
|
|
|
|
+1. Click the user you want to edit in the **Hue Users** list.
|
|
|
|
|
+2. Make the changes to the user and then click **Update user**.
|
|
|
|
|
+
|
|
|
|
|
+#### Importing Users from an LDAP Directory
|
|
|
|
|
+
|
|
|
|
|
+Hue must be configured to use an external LDAP directory (OpenLDAP or
|
|
|
|
|
+Active Directory). See Hue Installation in [CDH4
|
|
|
|
|
+Installation](http://www.cloudera.com/content/cloudera-content/cloudera-docs/CDH4/latest/CDH4-Installation-Guide/CDH4-Installation-Guide.html).
|
|
|
|
|
+
|
|
|
|
|
+ **Note**:
|
|
|
|
|
+
|
|
|
|
|
+Importing users from an LDAP directory does not import any password
|
|
|
|
|
+information. You must add passwords manually in order for a user to log
|
|
|
|
|
+in.
|
|
|
|
|
+
|
|
|
|
|
+To add a user from an external LDAP directory:
|
|
|
|
|
+
|
|
|
|
|
+1. Click **Add/sync LDAP user**.
|
|
|
|
|
+2. Specify the user properties:
|
|
|
|
|
+
|
|
|
|
|
+<table>
|
|
|
|
|
+<tr><td>Username</td><td>The user name.</td></tr>
|
|
|
|
|
+<tr><td>Distinguished name</td><td>Indicate that Hue should use a full distinguished name for the user.
|
|
|
|
|
+ This imports the user's first and last name, username, and email,
|
|
|
|
|
+ but does not store the user password.</td></tr>
|
|
|
|
|
+ <tr><td>Create home directory</td><td> Indicate that Hue should create a home directory for the user in
|
|
|
|
|
+ HDFS.</td></tr></table>
|
|
|
|
|
+
|
|
|
|
|
+
|
|
|
|
|
+3. Click **Add/sync user**.
|
|
|
|
|
+
|
|
|
|
|
+ If the user already exists in the User Admin, the user information
|
|
|
|
|
+ in User Admin is synced with what is currently in the LDAP
|
|
|
|
|
+ directory.
|
|
|
|
|
+
|
|
|
|
|
+#### Syncing Users and Groups with an LDAP Directory
|
|
|
|
|
+
|
|
|
|
|
+You can sync the Hue user database with the current state of the LDAP
|
|
|
|
|
+directory using the **Sync LDAP users/groups** function. This updates
|
|
|
|
|
+the user and group information for the already imported users and
|
|
|
|
|
+groups. It does not import any new users or groups.
|
|
|
|
|
+
|
|
|
|
|
+1. Click **Sync LDAP users/groups**.
|
|
|
|
|
+2. The **Create Home Directories** checkbox creates home directories in
|
|
|
|
|
+ HDFS for existing imported members that don't have home directories.
|
|
|
|
|
+3. In the **Sync LDAP users and groups** dialog, click **Sync** to
|
|
|
|
|
+ perform the sync.
|
|
|
|
|
+
|
|
|
|
|
+### Groups
|
|
|
|
|
+
|
|
|
|
|
+Superusers can add and delete groups, configure group permissions, and
|
|
|
|
|
+assign users to group memberships.
|
|
|
|
|
+
|
|
|
|
|
+#### Adding a Group
|
|
|
|
|
+
|
|
|
|
|
+You can add groups, and delete the groups you've added. You can also
|
|
|
|
|
+import groups from an LDAP directory.
|
|
|
|
|
+
|
|
|
|
|
+1. In the **User Admin** window, click **Groups** and then click **Add
|
|
|
|
|
+ Group**.
|
|
|
|
|
+2. Specify the group properties:
|
|
|
|
|
+
|
|
|
|
|
+<table>
|
|
|
|
|
+<tr><td>Name</td><td> The name of the group. Group names can only be letters, numbers, and
|
|
|
|
|
+ underscores; blank spaces are not allowed.</td></tr>
|
|
|
|
|
+<tr><td>Members</td><td>The users in the group. Check user names or check Select all.</td></tr>
|
|
|
|
|
+ <tr><td>Permissions</td><td>The applications the users in the group can access. Check
|
|
|
|
|
+ application names or check Select all.</td></tr></table>
|
|
|
|
|
+
|
|
|
|
|
+3. Click **Add group**.
|
|
|
|
|
+
|
|
|
|
|
+#### Adding Users to a Group
|
|
|
|
|
+
|
|
|
|
|
+1. In the **User Admin** window, click **Groups**.
|
|
|
|
|
+2. Click the group.
|
|
|
|
|
+3. To add users to the group, check the names in the list provided or
|
|
|
|
|
+ check **Select All**.
|
|
|
|
|
+4. Click **Update group**.
|
|
|
|
|
+
|
|
|
|
|
+#### Deleting a Group
|
|
|
|
|
+
|
|
|
|
|
+1. Click **Groups**.
|
|
|
|
|
+2. Check the checkbox next to the group and click **Delete**.
|
|
|
|
|
+3. Click **Yes** to confirm.
|
|
|
|
|
+
|
|
|
|
|
+#### Importing Groups from an LDAP Directory
|
|
|
|
|
+
|
|
|
|
|
+1. From the **Groups** tab, click **Add/sync LDAP group**.
|
|
|
|
|
+2. Specify the group properties:
|
|
|
|
|
+
|
|
|
|
|
+<table>
|
|
|
|
|
+<tr><td>Name</td><td> The name of the group.</td></tr>
|
|
|
|
|
+<tr><td>Distinguished name</td><td> Indicate that Hue should use a full distinguished name for the
|
|
|
|
|
+ group.</td></tr>
|
|
|
|
|
+ <tr><td>Import new members</td><td> Indicate that Hue should import the members of the group.</td></tr>
|
|
|
|
|
+ <tr><td>Import new members from all subgroups</td><td>
|
|
|
|
|
+ Indicate that Hue should import the members of the subgroups.</td></tr>
|
|
|
|
|
+ <tr><td>Create home directories</td><td> Indicate that Hue should create home directories in HDFS for the
|
|
|
|
|
+ imported members.</td></tr></table>
|
|
|
|
|
+
|
|
|
|
|
+3. Click **Add/sync group**.
|
|
|
|
|
+
|
|
|
|
|
+<a id="permissions"></a>
|
|
|
|
|
+Permissions
|
|
|
|
|
+-----------
|
|
|
|
|
+
|
|
|
|
|
+Permissions for Hue applications are granted to groups, with users
|
|
|
|
|
+gaining permissions based on their group membership. Group permissions
|
|
|
|
|
+define the Hue applications visible to group members when they log into
|
|
|
|
|
+Hue and the application features available to them.
|
|
|
|
|
+
|
|
|
|
|
+1. Click **Permissions**.
|
|
|
|
|
+2. Click the application for which you want to assign permissions.
|
|
|
|
|
+3. Check the checkboxes next to the groups you want to have permission
|
|
|
|
|
+ for the application. Check **Select all** to select all groups.
|
|
|
|
|
+4. Click **Update permission**. The new groups will appear in the
|
|
|
|
|
+ Groups column in the **Hue Permissions** list.
|
|
|
|
|
+
|
|
|
|
|
|
|
|
## Configuration for external services
|
|
## Configuration for external services
|
|
|
|
|
|
|
@@ -556,6 +799,9 @@ To configure Hue to store data in MySQL:
|
|
|
Your system is now configured and you can start the Hue server as normal.
|
|
Your system is now configured and you can start the Hue server as normal.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
+The Quick Start Wizard open
|
|
|
|
|
+
|
|
|
|
|
+
|
|
|
# Reference Architecture
|
|
# Reference Architecture
|
|
|
3 Hues and 1 Load Balancer
|
|
3 Hues and 1 Load Balancer
|
|
|
Databases: MySQL InnoDB, PostgreSQL, Oracle
|
|
Databases: MySQL InnoDB, PostgreSQL, Oracle
|