ADS Control UI overview

Olga Semme

Below you can find the overview of the features contained in the ADS Control UI.

Login window

This is the first window the user sees after connecting to ADS Control. In order to access to ADS Control, you are prompted to enter your credentials (login and password) in the corresponding fields. After you entered your credentials, click Sign in.

Login window
Login window
Login window
Login window

Main window

This is the window that the user sees after logging into ADS Control. The main window contains four sections:

  • Authorization section is located at the top of the screen.

  • Information section is located in the upper half of the screen.

  • Search section is located in the middle of the screen.

  • The cluster management section is located in the lower half of the screen.

Main window
Main window
Main window
Main window

All subsections and their contents are described in detail below.

Authorization section

The authorization section appears after clicking on the icon user dark user light located in the upper right corner. The authorization section contains:

  • username under which the session was logged in;

  • Log out button to exit ADS Control or change user.

Authorization section
Authorization section
Authorization section
Authorization section

Information section

The information section contains data on the percentage of the number of clusters in the online and offline state. The data is presented in graphical form. Also in this section is available a list of the latest clusters with which work was carried out.

Information section
Information section
Information section
Information section

Search section

In this section, you can search for clusters by the entered designation. You can also set filters to search — cluster states.

Search section
Search section
Search section
Search section

As a result of the search, clusters matching the search conditions will appear in the cluster management section.

Cluster management section

This section selects a cluster for management.

Cluster management section
Cluster management section
Cluster management section
Cluster management section

In the cluster management section, it is possible to set filters for sampling:

  • Sort — defines the sorting method:

    • Ascending — ascending name alphabetically;

    • Descending — in descending order of the name in alphabetical order;

    • Manual — manual sorting.

  • Status — defines the cluster status for the sample:

    • Online — clusters in the online state;

    • Offline — clusters in the offline state;

    • All — all clusters.

  • Show — indicates which clusters with which visibility should be included in the selection:

    • Hidden — hidden clusters;

    • Displayed — visible clusters

    • All — all clusters.

After clicking Manage it becomes possible to hide or open the clusters using the Show and Hide buttons.

Hiding and revealing clusters
Hiding and revealing clusters
Hiding and revealing clusters
Hiding and revealing clusters

At the bottom of the cluster management section there are graphical displays of the clusters in use.

Cluster example in the online state
Cluster example in the online state
Cluster example in the online state
Cluster example in the online state
Cluster example in the offline state
Cluster example in the offline state
Cluster example in the offline state
Cluster example in the offline state

The elements are described below using the example of the presented clusters:

  • Сluster status indicator:

    • circle green on — cluster is online;

    • circle grey off dark circle grey off light — cluster is offline.

  • ads — cluster name.

  • Flag that enables the ability to control the visibility of the cluster using the Show and Hide buttons:

    • check selected dark check selected light — the cluster is available for visibility control;

    • check default dark check default light — the cluster is not available for visibility control.

      Displayed only when Manage is enabled.

  • drag dark drag light — icon, dragging which it is possible to move the cluster image in the cluster management section. Available only when Manage is disabled.

  • Cluster data showing the total number of the following cluster elements:

    • topics;

    • brokers;

    • consumers;

    • Kafka Connect tools.

  • switch to change cluster visibility:

    • toggle on dark toggle on light — cluster is displayed ;

    • toggle off dark toggle off light — cluster hidden .

Cluster management

To manage a cluster, in the cluster management section, click on the graphical display of the cluster.

Selecting a cluster to manage
Selecting a cluster to manage
Selecting a cluster to manage
Selecting a cluster to manage

Next, a window opens with the available functionality for this cluster. At the moment, the functionality is available only for working with the Kafka Connect service. If this service is installed in this cluster, it becomes possible to go to the cluster to create connectors.

Available cluster management tools
Available cluster management tools
Available cluster management tools
Available cluster management tools

Next, the list of created connectors becomes available for viewing, if any, as well as the Create Connector button for creating new connectors.

To create a connector, do the following:

  1. Click Create Connector.

    Kafka Connect connector list page
    Kafka Connect connector list page
    Kafka Connect connector list page
    Kafka Connect connector list page

    Next, a window opens for selecting a connector to create.

  2. Select the desired connector.

    List of Kafka Connect connectors
    List of Kafka Connect connectors
    List of Kafka Connect connectors
    List of Kafka Connect connectors

    The following connectors are available for use:

    • FileStreamSinkConnector — connector designed to read data from Kafka and output it to a local file.

    • FileStreamSourceConnector — connector designed to read data from a file and send it to Kafka.

      For more information on working with FileStream connectors, see FileStream in ADS Control.

    • MirrorCheckpointConnector, MirrorHeartbeatConnector, MirrorSourceConnector — connectors designed to replicate topics using the Mirror Maker 2 mechanism. For more information on working with these connectors in ADS Control, see Mirror Maker 2 in ADS Control.

  3. Next, fill in the connector configuration in the window that opens. You can use populating the config as a JSON file. To do this, turn on the corresponding switch.

    Connector configuration
    Connector configuration
    Connector configuration
    Connector configuration
    Сonnector JSON configuration file
    Сonnector JSON configuration file
    Сonnector JSON configuration file
    Сonnector JSON configuration file

  4. After filling, click Save and get a message about the successful creation of the connector.

    Message about the successful creation of the connector
    Message about the successful creation of the connector
    Message about the successful creation of the connector
    Message about the successful creation of the connector

  5. Make sure that the page of the created connector is opened with the display of tasks.

    Created connector
    Created connector
    Created connector
    Created connector

  6. Check that the Connectors for ads page displays the created connectors in the working status. The status is determined depending on the indicator in front of the connector name:

    • green — the connector/task is running;

    • yellow — the connector/task has been administratively paused;

    • red — the connector/task has failed (usually by raising an exception, which is reported in the status output);

    • unassigned — the connector/task has not yet been assigned to a worker.

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