Install Integration Control Plane¶
The WSO2 Integration Control Plane (ICP) monitors the Ballerina runtime artifacts in a deployment. It provides a graphical view of the integration artifacts that are deployed. In this guide, you will learn how to enable Integration Control Plane (ICP) for a Ballerina integration.
Prerequisites¶
- Java 11 or later versions should be installed on your machine.
- You must set your
JAVA_HOME
environment variable to point to the directory where the Java Development Kit (JDK) is installed on the computer.
Step 1: Download and start ICP server¶
- Go to the WSO2 Integration Control Plane web page.
- Click Download.
- Provide the necessary details.
- Click Zip Archive to download the Integration Control Plane as a ZIP file.
- Extract the archive file to a dedicated directory for the Integration Control Plane, which will hereafter be referred to as
<ICP_HOME>
. - Open a terminal and navigate to the
<ICP_HOME>/bin
folder. - Execute one of the commands given below.
./dashboard.sh
dashboard.bat
Step 2: Access the ICP dashboard¶
- Open a web browser and navigate to https://localhost:9743/dashboard.
-
Log in using the default credentials:
- Username:
admin
- Password:
admin
- Username:
Step 3: Deploy the Ballerina integration¶
- Navigate to the Visualizer view by clicking on the Ballerina Integrator icon on the sidebar.
-
Check Enable ICP under the Integration Control Plane section in the right panel.
-
Click on the Run button to start the integration.
-
Click on the Create Config.toml on the prompt to create the
Config.toml
file. -
Replace the
Config.toml
file content with the following configurations.[ballerinax.wso2.controlplane.dashboard] url = "https://localhost:9743/dashboard/api" heartbeatInterval = 10 groupId = "cluster1" mgtApiUrl ="https://localhost:9264/management/"
-
Click on the Run button to start the integration.
-
A log message will be displayed in the console indicating that the integration is connected to the ICP dashboard.
time=2025-03-17T15:14:59.970+05:30 level=INFO module=ballerinax/wso2.controlplane message="Connected to dashboard server https://localhost:9743/dashboard/api"
Step 4: View the integration in the ICP dashboard¶
- Go to the ICP dashboard and log in https://localhost:9743/dashboard.
- In the dashboard, you will see the integration details.
-
Click on the node to view the node details.
-
Click on the Services to view the listener and resources of the service.
-
Click on the Listeners to view details of the listener.