Skip to content

Introduction to the Central Monitoring Dashboard

Prerequisites

  1. The CMD requires the same system requirements and environment setup that is required for STRATO.

Setup

  1. Clone the repository for the CMD tool onto the environment you will be using it from.
  2. Edit the initial node list in config file to include the initial list of nodes you wish to monitor: backend/config/initial-nodes.js If the STRATO node you wish to add is using a port other than 80, in the configuration settings for the node, include the put the port number after the IP address, for example
    "ip": "NODE_IP_ADDRESS:NODE_PORT_NUMBER"
    
  3. (Re)build the dashboard using docker-compose build
  4. Run the dashboard:

    With no SSL (port 80):

    ssl=${ssl:-false} \
      sslCertFileType=${sslCertFileType:-crt} \
      HOST=${HOST:-localhost} \
      authBasic=${authBasic:-true} \
      uiPassword=${uiPassword:-} \
      docker-compose up -d
    

Adding a Node

To add a node to the list of nodes monitored by the CMD, you can call the API endpoint at POST http://<HOST>/server/nodes with JSON raw body in this format:

{
"ip": "<node-ip-address-to-be-added>",
"host": "<node-host-name-to-be-added>",
"internal": true,
"protocol": "https"
}

With curl:

curl -X POST \
http://localhost/server/nodes \
-H 'Content-Type: application/json' \
-d '{
"ip": "<node-ip-address-to-be-added>",
"host": "<node-host-name-to-be-added>",
"internal": true,
"protocol": "https"
}'

Deleting a Node

To delete the node from the monitor, you can call the API endpoint at: DELETE http://<HOST>/server/nodes with raw JSON body in the format:

{
"ip": "<node-ip_address-to-be-deleted>"
}

With curl:

curl -X DELETE \
http://localhost/server/nodes \
-H 'Content-Type: application/json' \
-d '{
"ip": "<node-ip_address-to-be-deleted>"
}'

Restarting a Node (coming soon)

Setting Alerts (coming soon)