wso2/wso2-integration-control-plane repository overview

⁠Supported tags and respective Dockerfile links

• 1.0.0, latest⁠

⁠Quick reference

• Where to get help:

  • WSO2 Community⁠
  • WSO2 Discord⁠
  • Stack Overflow⁠

• Related Source Repositories:

  • product-mi-tooling⁠

• Where to report issues:

  • WSO2 Micro Integrator⁠

• Maintained by:

  • WSO2 LLC⁠

• Supported Docker versions:

  • Docker v17.09.0 or above

⁠About WSO2 Integration Control Plane

The WSO2 Integration Control Plane provides the capability to monitor specified clusters/groups of Micro Integrator⁠ and Ballerina⁠ nodes. It provides a graphical view of the integration artifacts that are deployed. You can also perform various management and administration tasks using WSO2 the Integration Control Plane.

⁠How to use this image

⁠Configure the MI servers

Follow the steps given below to configure the MI servers to publish data to the WSO2 Integration Control Plane.

1. To connect the MI servers with the Integration Control Plane, 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. 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⁠.

⁠Configure Ballerina project with services

Follow the steps given below to configure Ballerina project with services to publish data to the WSO2 Integration Control Plane.

1. Add import ballerinax/wso2.controlplane as _; to the default module.

2. Add remoteManagement=true to [build-options] section of the Ballerina.toml file.

3. Create Config.toml file if it does not exist, and add the following configurations.

   [ballerinax.wso2.controlplane]
   # keyStorePath = "../keystore.p12"
   # trustStorePath = "../truststore.p12"
   # icpServicePort = 9264
   
   [ballerinax.wso2.controlplane.dashboard]
   url = "https://localhost:9743/dashboard/api"
   heartbeatInterval = 10
   groupId = "cluster1"
   mgtApiUrl ="https://localhost:9264/management/"
   # nodeId = "node1"
   # serviceAccount = "bal_admin"
   # serviceAccountPassword = "bal_secret"
   

   Copy

   Modify the configurations to match your integration control plane dashboard.

   If there are multiple nodes in the same machine, make sure to pick a unique icpServicePort (same in mgtApiUrl) for each node.

⁠Start the Integration Control Plane instance

$ docker run -p 9743:9743 --name integration-control-plane -d wso2/wso2-integration-control-plane:<tag_name>

⁠Viewing Integration Control Plane logs

$ docker logs -f integration-control-plane

⁠Accessing the Integration Control Plane

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

[2024-07-26 10:19:34,187]  INFO {DashboardServer} - Login to Integration Control Plane Dashboard : 'https://<HOSTNAME>:9743/login'

For more details on configuring the WSO2 Integration Control Plane, please refer the 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.