Skip to main content
Version: Next

Configuration

This section outlines the configuration steps required to integrate the DataHub module with the ASI 3 platform, enabling centralized management from ASI.

Pre-requisites​

Before proceeding, ensure that you have at least one Data Hub node (v2.0.0 or later) fully installed and configured.

For installation instructions, refer to the official documentation: Installing DataHub

Setting up ASI DataHub​

note

All actions in this section must be performed by the ppadmin user on the Data Hub node.

To initialize the ASI DataHub module, execute the setup script:

/opt/ISS/asi-datahub/bin/setupAsiDataHub

This script will configure the necessary components to allow the Data Hub node to communicate with and be managed by the ASI 3 platform.

Client Configuration​

note

All actions in this section must be performed by the ppadmin user on the ASI 3 system.

To enable secure communication between Data Hub and ASI 3, you need to configure a service client within the Authenticator module.

  1. Create the asi-datahub Service Client

Run the following command to create the service client:

/opt/ISS/asi/authenticator/utils/addServiceClient asi-datahub
important

Make a note of the client secret returned by this command. You will need it when registering the Data Hub node with ASI 3.

  1. Assign Required Scopes

Grant the necessary permissions to the asi-datahub client by assigning the following scopes:

  • metric_publisher
  • audit_publisher
  • notification_publisher

Execute the following commands:

/opt/ISS/utils/addServiceClientScope metric_publisher asi-datahub
/opt/ISS/utils/addServiceClientScope audit_publisher asi-datahub
/opt/ISS/utils/addServiceClientScope notification_publisher asi-datahub
  1. Retrieve the Member Join Secret

This secret is used by the asi-datahub module during registration with the ASI 3 system. To retrieve it, run:

/opt/ISS/utils/getMemberJoinSecret
important

Be sure to record the join secret that is returned. It is required during node registration.

First node / Single Node Setup​

note

All actions in this section must be performed as the ppadmin user on the designated Data Hub node.

Interactive Configuration​

To register a Data Hub node with ASI 3, use the registration script located at:

/opt/ISS/asi-datahub/bin/registerDataHubWithAsi

You will be prompted to enter the necessary configuration values.

Unattended (Automated) Configuration​

The script also supports command-line arguments for unattended setup:

Usage: /opt/ISS/asi-datahub/bin/registerDataHubWithAsi [-a|--authenticator_url <arg>] [-m|--management_service_url <arg>] [-j|--join_secret <arg>] [-s|--member_secret <arg>] [--(no-)quiet] [-h|--help]
        -a, --authenticator_url: The authenticator can be seen through the load balancer or the direct address of the authenticator if not (no default)
        -m, --management_service_url: Where a management service instance can be located (no default)
        -j, --join_secret: The client secret to operate with (no default)
        -s, --member_secret: The client secret for asi-datahub (no default)
        --quiet, --no-quiet: Don't prompt for input (off by default)
        -h, --help: Prints help

Start the Service​

Once registration is complete, start the iss-asi-datahub service:

systemctl start iss-asi-datahub.service && tail -F /opt/ISS/logs/asi-datahub/asi-datahub.log

Add a Node to an Existing ASI 3 Cluster​

note

All actions in this section must be performed as the ppadmin user on the designated Data Hub node.

Interactive Configuration​

To add a Data Hub node to an existing ASI 3 cluster, use the provided cluster join script located at:

/opt/ISS/asi-datahub/bin/joinAsiCluster

You will be prompted to supply the required configuration values.

Unattended (Automated) Configuration​

The script also supports command-line arguments for unattended setup:

Usage: ./joinAsiCluster [-a|--authenticator_url <arg>] [-m|--management_service_url <arg>] [-j|--join_secret <arg>] [--(no-)quiet] [-h|--help]
        -a, --authenticator_url: The authenticator can be seen through the load balancer or the direct address of the authenticator if not (no default)
        -m, --management_service_url: Where a management service instance can be located (no default)
        -j, --join_secret: The client secret to operate with (no default)
        --quiet, --no-quiet: Don't prompt for input (off by default)
        -h, --help: Prints help

Start the Services​

Once the node has been successfully registered with the cluster, start the required services:

systemctl start iss-datahub.service
systemctl start iss-asi-datahub.service

Validate​

In the ASI 3 web interface, you can verify that the Data Hub module has been successfully registered by confirming its presence in the left-hand navigation menu.

DataHub Module