Device Onboarding

Through this module, Users can place a request for installing the agent on the devices. Below are the steps of onboarding:

  1. On the main menu, click Onboarding then in the sub-menu click Device Onboarding .
  2. The Device Onboarding screen appears, and it lists down already placed requests for agent installation in a tabular view.
    Figure 1. Device Onboarding

Add Device Onboarding

To add a new request for agent installation on the devices, follow the steps below:

  1. Click on Add Device Onboarding button.
  2. Select the Agent Type.
  3. Select Deployment.
  4. Enter Onboarding Name.
  5. Enter Onboarding Description.
  6. Enter Collection Interval.
  7. Check monitor database metrics. This option will allow user to provide details of monitoring databases on the next page.
  8. Now provide the host/IP details with username, password and OS type.
  9. Click on Next.
    Figure 2. Add Device Onboarding)
    Note:
    Fields for the respective Integration Type can be different as per tool configuration.

  10. Refer to the table below to understand the fields mentioned in the above figure.

    Table 1. Device Onboarding Fields
    Fields Description
    Agent Type This field contains the Agent Name for Agent Type.
    Deployment Name This field contains the Deployment name; we can select deployment from all Deployments.
    Onboarding Name This field contains the Onboarding Name.
    Onboarding Description This field contains the Onboarding Description.
    Collection Interval This field contains the Circuit breaker Event Threshold value.
    Device Type This field indicates the type of agents can be onboarding on the devices
    Authentication Type This field indicates the Authentication Type supported by the Devices
    IP Address/Hostname This field contains the IP/Hostname of the Device/VM
    Username This field contains the username of the Device/VM
    Password This field contains the password of the Device/VM
    Preserve Credentials Check this field when entering multiple Devices/VM with same credentials, otherwise for every Device/VM credentials need to be provided.
    Figure 3. Add node for Device Onboarding
    Note:
    All fields marked with an asterisk (*) are mandatory.

Database Configuration

A Monitor Database Metrics tab appears (If user has selected the Monitoring Database checkbox of previous screen)

Figure 4. Device Onboarding for database configuration
  1. Select the metric from the list and provide the nested details.
  2. For example user wants to collect the data for MySQL, then select the checkbox before MySQL option and then provide following details:
  3. Enter IP Address/Hostname
  4. Enter Username
  5. Enter Password. To enter the API password, follow the below-mentioned steps:
    1. Click on () icon.
    2. Credentials popup will open
    3. Now Select the Input Type:
    4. Input Text – To enter the credential manually.
    5. Enter the secret information in Password field.
    6. Click on Save button.
  6. Select Deployment Environment (Container/Host, representing the Database is hosted on Container or Host)
  7. Click Next, Device Destination screen will appear.
    Figure 5. IP Address/Hostname

Device Destination Screen

The Device Destination screen allows users to configure the endpoint for the Agent—that is, where the Agent sends its data. Currently, there are two out-of-the-box options available, including Kafka Topics and the NiFi OTel Adapter. Below are the steps to configure:

  1. In the Device Destination drop-down, select a device destination. For example: Apache Kafka
  2. Once the destination is selected, the corresponding fields are displayed.
  3. The following fields are displayed when Apache Kafka is selected as the device destination:
    Table 2. Device Destination Field
    Fields Description
    Broker This field contains the name or address of the Kafka broker.
    Topic Name This field contains the Kafka topic name where metrics will be published.
    Group Id This field contains the Kafka consumer group ID.
  4. Enter Broker Name.
  5. Enter Topic Name.
  6. Enter Group Id.
    Figure 6. Select Device Destination
  7. Click on the Save button to save the configuration.
  8. Click Save & Publish to save and activate the configuration.
  9. Click Back to return to the previous page.
  10. Click Cancel to discard the changes.
    Figure 7. Device On boarding Saved Successfully

Detail Device Onboarding View

To view the details of a device onboarding, the user needs to follow the steps below:

  1. Click Details corresponding to the device onboarding to view its details.
    Figure 8. Device On boarding table
  2. The Details page displays the following information:
    1. Lists the IP addresses associated with the device onboarding.
    2. Each IP address can be expanded to view additional information.
    3. Displays the current status of the device onboarding (for example, Draft).
      Figure 9. IP Address Details Table

Edit Device Onboarding

The edit option is only available when user has save the record. That mean user had not published.

To Edit/ Modify the information of an existing Device Onboarding, user needs to follow the below steps:

  1. On the main screen, click Onboarding then select Device Onboarding from the sub-menu.
  2. Available Device Onboarding list is shown in tabular view.
    Figure 10. Edit Device Onboarding
  3. Click Edit () corresponding to the Device Onboarding to be updated.
  4. Modify the details as required and click Update.
    Figure 11. Edit Device Onboarding (Cont.)
  5. A success message appears on the screen.
    Figure 12. Device Onboarding Updated Successfully

Delete Device Onboarding

To delete an existing Device Onboarding, user needs to follow the below steps:
  1. On the main screen, click Onboarding then select Device Onboarding from the sub-menu.
  2. Available Device Onboarding list will be shown in a tabular view.
    Figure 13. Delete Device Onboarding
  3. Click Delete () icon.
    Figure 14. Delete Device Onboarding (Cont.)
  4. Click on Confirm.
  5. The success message appears on the screen.
    Figure 15. Success Message

View Device Onboarding

To View the information of an existing Device Onboarding, user needs to follow the below steps:

  1. On the main screen, click Onboarding then select Device Onboarding from the sub-menu.
  2. Available Device Onboarding list is shown in tabular view.
    Figure 16. View
  3. Click the View (👁️) icon corresponding to the Device Onboarding you want to view.
  4. The details of the selected Device Onboarding are displayed.
    Figure 17. View Detail