wso2/wso2mi-dashboard repository overview

⁠Supported tags and respective Dockerfile links

• 4.1.0, latest⁠
• 4.0.0⁠
• 1.2.0⁠

⁠Quick reference

• Where to get help:
  - Docker Community Forums⁠ - Docker Community Slack⁠ - WSO2 Micro Integrator Slack⁠ - Stack Overflow⁠ - WSO2 Developer mailing list⁠

• Related Source Repositories:
  product-mi-tooling⁠

• Where to report issues:
  WSO2 Micro Integrator⁠

• Maintained by:
  WSO2 Inc.⁠

• Supported Docker versions:
  Docker v17.09.0 or above

⁠About Micro Integrator Dashboard

The Micro Integrator (MI) dashboard monitors the MI instances in a deployment. This can be a single MI instance or multiple MI instances in a group (cluster). It provides a graphical view of the integration artifacts that are deployed in the MI instances. You can also perform various management and administration tasks using the dashboard.

The dashboard communicates with the management APIs of each Micro Integrator instance in the group (cluster) to get and manipulate data.

⁠Capabilities of the MI dashboard

You can use the dashboard to perform the following administration tasks related to your Micro Integrator deployment:

• View the MI servers in the deployment

  View basic information of each server node.

• View integration artifacts deployed in a group

  View details of the artifacts deployed in a cluster or group of Micro Integrator instances.

• Identify the MI servers where a specified artifact is deployed

  View the MI server instances where each artifact is deployed.

• Update deployed artifacts

  !!! Note When you update an artifact, only the specified MI instance will be updated. Cluster-wide updates are not available with the dashboard.

  You can activate/deactivate the following artifacts from the dashboard: Proxy Services, Endpoints, and Message Processors.

  You can enable/disable tracing for the following artifacts: Proxy Services, Endpoints, APIs Sequences and Inbound Endpoints.

• View logs

  You can view the log files generated for each Micro Integrator instance of the cluster/group.

• View, update, and add loggers

  This page can be accessed by users with admin rights only. You can view log configurations of each instance and update the log level. You can update the log levels on a single node or apply the change to the entire cluster/group as well. Furthermore, you can add new loggers, which will be applied to the entire cluster/group.

• Manage users

  This page can be accessed by users with admin rights only. You can view details of users stored in the external user store⁠. You can also add new users to the specified cluster/group.

⁠How to use this image

⁠Configure the MI servers

Follow the steps given below to configure the MI servers to publish data to the dashboard.

1. To connect the MI servers with the dashboard, add the following configuration to the deployment.toml file (stored in the <MI_HOME>/conf/ folder) of each server instance.

   [dashboard_config]
   dashboard_url = "https://{hostname/ip}:{port}/dashboard/api/"
   heartbeat_interval = 5
   group_id = "mi_dev"
   node_id = "dev_node_2"
   

   Copy

   dashboard_url	Required. This is the url to access dashboard server. Replace hostname/ip and port (default - 9743) with relevant values from your environment.
   heartbeat_interval	Required. The time interval (in seconds) between two heartbeats sent from the Micro Integrator to the dashboard server.
   group_id	Optional. In a clustered deployment, the group ID should be the same in all Micro Integrator Instances. The dashboard displays information from one group at a time. By default, the group_id is set to `default`.
   node_id	Optional. By default, in a clustered deployment, the relevant node_id is used as this configuration. For more information about the cluster node ID, see the instructions on configuring an MI cluster⁠. In a non-clustered deployment, a random uuid is used if the node_id is not set for this configuration.

2. Optionally, configure the Micro Integrator user store⁠.

⁠Start a Dashboard instance

$ docker run -p 9743:9743 --name mi-dashboard -d wso2/wso2mi-dashboard:<tag_name>

⁠Viewing Dashboard logs

$ docker logs -f mi-dashboard

⁠Accessing the Dashboard

You will see the following log in console when the dashboard has started. Copy the https://localhost:9743/login URL and open it in your browser

[2021-05-17 15:53:10,301]  INFO {Bootstrap} - Login to Micro Integrator Dashboard : 'https://<HOSTNAME>:9743/login'

For more details on connecting to a Micro Integrator instance, please refer to the documentation section below.

⁠Documentation

• For 4.0.0 and later versions please refer to APIM documentation⁠
• For versions prior to 4.0.0, please refer to EI documentation⁠

⁠License

View license information⁠ for the software contained in this image.

As with all Docker images, these are likely to contain other software which may be under other licenses (such as Bash, etc. from the base distribution, along with any direct or indirect dependencies of the primary software being contained).

As for any pre-built image usage, it is the image user's responsibility to ensure that any use of this image complies with any relevant licenses for all software contained within.