Knox UI overview

Overview

Knox has two accessible web interfaces: Admin and Homepage. The URLs of these interfaces are presented below, where <knox_host> is a URL of an ADPS host, on which Knox is present:

  • Admin — https://<knox_host>:8443/gateway/manager/admin-ui/.

  • Homepage — https://<knox_host>:8443/gateway/homepage/home/.

You can also get direct links to them from ADCM by following the steps below:

  1. On the Clusters page in ADCM, select your ADPS cluster and navigate to the Services tab.

  2. In the list of services, select Knox.

  3. Head to the Info tab. The links are available in the Web links section.

    Knox web links
    Knox web links

Admin

The Admin web interface provides access to the resource types described below.

Provider Configurations

In this section, you can see and edit the available provider configurations and create a new one by clicking knox plus next to Provider Configuration. There is a default provider configuration named default-providers.

Knox provider configurations
Provider configurations
Knox provider configurations
Provider configurations

Here, you can enable/disable a provider. All the parameters in a provider configuration are editable: click on the parameter value, and a text box will appear. You can add a parameter to the configuration by clicking knox plus next to Params. To remove it, click knox cross on the left from it. To save the edited configuration, click knox save. To revert the changes, click knox revert.

Descriptors

This section shows the existing descriptors. A descriptor is a set of service roles that should be proxied with a provider configuration reference. By default, there are no descriptors, but you can create one by clicking knox plus next to Descriptors.

A created descriptor for Hive
A created descriptor for Hive
A created descriptor for Hive
A created descriptor for Hive

The created descriptor has information about its provider configuration, services for which it was created, and discovery details for the target cluster endpoints.

Topologies

This section shows the existing topologies.

The Knox admin topology
The Knox admin topology
The Knox admin topology
The Knox admin topology

To see the topology details, click the desired topology, and an XML editor will open on the right. Some topologies may be read-only.

NOTE
Manually added topologies disappear after the Reload topologies ADCM service action.

Service Definitions

This section shows the existing service definitions. Here you can see and edit service configurations (e.g. change timeout times).

An HBase UI service definition
An HBase UI service definition
An HBase UI service definition
An HBase UI service definition

Homepage

This interface contains general information about proxy and topologies.

Knox Homepage
Knox Homepage
Knox Homepage
Knox Homepage

General Proxy Information

This section provides the following information about the proxy:

  • Knox Version — the current version of Knox.

  • TLS Public Certificate — links to download the public certificate (available in PEM and JKS).

  • Admin UI URL — a link to the Knox Admin interface.

  • Admin API Details — a link to the Knox Admin API documentation.

  • Metadata API — contains two links that allow you to receive the XML file containing metadata (Knox version, Admin UI URL, and Admin API docs link) and the user-created topology information.

Topologies

This section shows a list of user-created topologies.

Found a mistake? Seleсt text and press Ctrl+Enter to report it