10. Manage AML-IP nodes with the AML Dashboard

10.1. Background

The AML Dashboard is a web-based tool that allows users to interact with the AML framework.

This tutorial guides you through the process of managing AML-IP nodes (creating, stopping and deleting) using the AML Dashboard.

10.2. Prerequisites

Ensure you have installed the AML Dashboard using one of the following methods:

For more information, check the AML Dashboard Interfaces and AML Dashboard Usage sections.

10.3. Running the demo

To run the necessary components for managing AML-IP nodes using the AML Dashboard, follow these steps:

10.3.1. Start the backend server

To begin, you need to launch the backend server:

  1. Navigate to the backend directory.

cd backend

  1. Load the AML-IP environment.

source /AML-IP/install/setup.bash

  1. Start the server:

python3 server.py

10.3.2. Start the AML Dashboard

Once the backend server is running, start the AML Dashboard frontend:

  1. Navigate to the frontend/aml_dashboard directory.

cd frontend/aml_dashboard

  1. Start the AML Dashboard:

npm run dev

  1. Access the dashboard at http://localhost:5173/.

10.4. Manage AML-IP nodes

To manage AML-IP nodes, in the AML Dashboard, go to the AML-IP tab.

10.5. Manage Agent Nodes

10.5.1. Create an Agent Node

To create an Agent Node (Client, Server or Repeater), follow these steps:

  1. In the AML-IP tab, go to the Agent Node tab.

  2. Specify the necessary parameters for the corresponding Agent Node creation.

Warning

In UDP communication the internal and the external port must coincide.

  1. Click on the Create button in the Create Agent Node.

  2. Once the node is successfully created, the corresponding Agent Node Status will update to Created !.

Note

Currently, each Agent Node can only be created once.

10.5.2. Stop and Delete an Agent Node

To stop an Agent Node, follow these steps:

  1. In the AML-IP tab, go to the Agent Node tab.

  2. Click on the Delete button in the Delete Agent Node.

  3. Once the node is successfully deleted, the corresponding Agent Node Status will update to Deleted !.

10.6. Manage Computing Nodes

10.6.1. Create a Computing Node

To create a Computing Node, follow these steps:

  1. In the AML-IP tab, go to the Computing Node tab.

  2. Click on the Create button in the Computing Node.

  3. Once the node is successfully created, the Computing Node Status will update to Created and running !.

10.6.2. Stop a Computing node

Computing nodes can be stopped without deleting them. This allows you to restart the node later when needed. To stop a Computing Node, follow these steps:

  1. In the AML-IP tab, go to the Computing Node tab.

  2. Indicate the ID of the node you want to stop.

  3. Alternatively, if you want to stop all Computing nodes, in the Indicate the ID of Computing Node to manage section, write all.

  4. Click on the Stop button in the Stop Computing Node.

  5. Once the node is successfully stopped, the corresponding Computing Node Status will update to Stopped !.

10.6.3. Run a Computing node

To run a stopped Computing Node, follow these steps:

  1. In the AML-IP tab, go to the Computing Node tab.

  2. Indicate the ID of the node you want to run.

  3. Alternatively, if you want to run all stopped Computing nodes, in the Indicate the ID of Computing Node to manage section, write all.

  4. Click on the Run button in the Run Computing Node.

  5. Once the node is successfully running, the corresponding Computing Node Status will update to Running !.

10.6.4. Delete a Computing Node

To delete a Computing Node, follow these steps:

  1. In the AML-IP tab, go to the Computing Node tab.

  2. Indicate the ID of the node you want to delete.

  3. Alternatively, if you want to delete all Computing nodes, in the Indicate the ID of Computing Node to manage section, write all.

  4. Click on the Stop and Delete button in the Stop and Delete Computing Node.

  5. Once the node is successfully deleted, the corresponding Computing Node Status will update to Deleted !.

10.7. Manage Inference Nodes

10.7.1. Create an Inference Node

To create an Inference Node, follow these steps:

  1. In the AML-IP tab, go to the Inference Node tab.

  2. Click on the Create button in the Inference Node.

  3. Once the node is successfully created, the Inference Node Status will update to Created !.

10.7.2. Stop an Inference node

Inference nodes can be stopped without deleting them. This allows you to restart the node later when needed. To stop an Inference Node, follow these steps:

  1. In the AML-IP tab, go to the Inference Node tab.

  2. Indicate the ID of the node you want to stop.

  3. Alternatively, if you want to stop all Inference nodes, in the Indicate the ID of Inference Node to manage section, write all.

  4. Click on the Stop button in the Stop Inference Node.

  5. Once the node is successfully stopped, the corresponding Inference Node Status will update to Stopped !.

10.7.3. Run an Inference node

To run a stopped Inference Node, follow these steps:

  1. In the AML-IP tab, go to the Inference Node tab.

  2. Indicate the ID of the node you want to run.

  3. Alternatively, if you want to run all stopped Inference nodes, in the Indicate the ID of Inference Node to manage section, write all.

  4. Click on the Run button in the Run Inference Node.

  5. Once the node is successfully running, the corresponding Inference Node Status will update to Running !.

10.7.4. Delete an Inference Node

To delete an Inference Node, follow these steps:

  1. In the AML-IP tab, go to the Inference Node tab.

  2. Indicate the ID of the node you want to delete.

  3. Alternatively, if you want to delete all Inference nodes, in the Indicate the ID of Inference Node to manage section, write all.

  4. Click on the Stop and Delete button in the Stop and Delete Inference Node.

  5. Once the node is successfully deleted, the corresponding Inference Node Status will update to Deleted !.

10.8. Manage Sender Node

10.8.1. Create a Sender Node

To create a Sender Node, follow these steps:

  1. In the AML-IP tab, go to the Sender Node tab.

  2. Click on the Create button in the Sender Node.

  3. Once the node is successfully created, the Sender Node Status will update to Created !.

Note

Currently, a Sender Node can only be created once.

10.8.2. Delete a Sender Node

To delete a Sender Node, follow these steps:

  1. In the AML-IP tab, go to the Sender Node tab.

  2. Click on the Delete button in the Delete Sender Node.

  3. Once the node is successfully deleted, the corresponding Sender Node Status will update to Deleted !.