Skip to content

Commit cb6f019

Browse files
authored
Merge pull request #47 from anuruddhal/main
Add guide on ICP integration
2 parents ff8263f + 7ed600b commit cb6f019

File tree

15 files changed

+100
-16
lines changed

15 files changed

+100
-16
lines changed
159 KB
Loading
338 KB
Loading
Loading
61.7 KB
Loading
Loading
13.1 KB
Loading

en/docs/deploy/icp.md

Lines changed: 63 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,63 @@
1+
# Deploy with Integration Control Plane
2+
3+
The [WSO2 Integration Control Plane (ICP)](https://wso2.com/integrator/integration-control-plane/) monitors the Ballerina runtime artifacts in a deployment. It provides a graphical view of the integration artifacts that are deployed.
4+
In this guide, you will learn how to enable Integration Control Plane (ICP) for a Ballerina integration.
5+
6+
7+
## Prerequisites
8+
1. Java 11 or later versions should be installed on your machine.
9+
2. You must set your `JAVA_HOME` environment variable to point to the directory where the Java Development Kit (JDK) is installed on the computer.
10+
11+
## Step 1: Download and start ICP server
12+
13+
1. Go to the [WSO2 Integration Control Plane](https://wso2.com/integrator/integration-control-plane/) web page.
14+
2. Click Download.
15+
3. Provide the necessary details.
16+
4. Click Zip Archive to download the Integration Control Plane as a ZIP file.
17+
5. Extract the archive file to a dedicated directory for the Integration Control Plane, which will hereafter be referred to as <ICP_HOME>.
18+
6. Open a terminal and navigate to the `<ICP_HOME>/bin` folder.
19+
7. Execute one of the commands given below.
20+
=== "On MacOS/Linux"
21+
22+
``` bash
23+
./dashboard.sh
24+
```
25+
26+
=== "On Windows"
27+
28+
``` bash
29+
dashboard.bat
30+
```
31+
32+
## Step 2: Access the ICP dashboard
33+
1. Open a web browser and navigate to `https://localhost:9743/dashboard`.
34+
2. Log in using the default credentials:
35+
- Username: `admin`
36+
- Password: `admin`
37+
38+
<a href="{{base_path}}/assets/img/deploy/icp-login.png"><img src="{{base_path}}/assets/img/deploy/icp/icp-login.png" alt="ICP Login" width="70%"></a>
39+
40+
## Step 3: Deploy the Ballerina integration
41+
1. Navigate to the Visualizer view by clicking on the Ballerina Integrator icon on the sidebar.
42+
2. Check **`Enable ICP`** under the **`Integration Control Plane`** section in the right panel.
43+
<a href="{{base_path}}/assets/img/deploy/enable-icp.png"><img src="{{base_path}}/assets/img/deploy/icp/enable-icp.png" alt="Enable ICP" width="70%"></a>
44+
3. Click on the **`Run`** button to start the integration.
45+
4. Click on the **`Create Config.toml`** on the prompt to create the `Config.toml` file.
46+
<a href="{{base_path}}/assets/img/deploy/config-toml.png"><img src="{{base_path}}/assets/img/deploy/icp/config-toml.png" alt="Create Config.toml" width="70%"></a>
47+
5. Replace the `Config.toml` file config with the following configurations.
48+
```toml
49+
[ballerinax.wso2.controlplane.dashboard]
50+
url = "https://localhost:9743/dashboard/api"
51+
heartbeatInterval = 10
52+
groupId = "cluster1"
53+
mgtApiUrl ="https://localhost:9264/management/"
54+
```
55+
6. Click on the **`Run`** button to start the integration.
56+
<a href="{{base_path}}/assets/img/deploy/run-integration.gif"><img src="{{base_path}}/assets/img/deploy/icp/run-integration.gif" alt="Run Integration" width="70%"></a>
57+
7. A log message will be displayed in the console indicating that the integration is connected to the ICP dashboard.
58+
```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"```
59+
60+
## Step 4: View the integration in the ICP dashboard
61+
1. Go to the ICP dashboard and log in `https://localhost:9743/dashboard`.
62+
2. In the dashboard, you will see the integration details.
63+
<img src="{{base_path}}/assets/img/deploy/icp/icp-dashboard.png" alt="ICP Dashboard" width="70%">

en/docs/deploy/jar.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ This guide explains how to deploy an integration as an executable JAR file.
44

55
1. Navigate to the Visualizer view by clicking on the Ballerina Integrator icon on the sidebar.
66
2. Click on the **`Deploy on VM`** under the **`Deployment Options`** section in the right panel.
7-
3. Click **`Executable JAR`** button.
7+
3. Click **`Create Executable`** button.
88
<a href="{{base_path}}/assets/img/deploy/jar.gif"><img src="{{base_path}}/assets/img/deploy/jar.gif" alt="Build JAR" width="70%"></a>
99

1010
4. The integration will be built as an executable JAR and the JAR file will be available in the `target\bin` directory of the project.

en/docs/get-started/quick-start-guide.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ Download and install the [Visual Studio Code](https://code.visualstudio.com/down
2323

2424
???+ info "Update Ballerina Integrator's Ballerina Distribution"
2525
The setup wizard will install the Ballerina distribution required for Ballerina Integrator in to `<USER_HOME>/.ballerina/ballerina-home` directory.
26-
Press `Ctrl + Shift + P` on Windows and Linux, or `shift + ⌘ + P` on a Mac and type `Ballerina: Update Ballerina Integrator` to update the installed Ballerina distribution.
26+
Press `Ctrl + Shift + P` on Windows and Linux, or `shift + ⌘ + P` on a Mac and type `Ballerina: Update Ballerina Dev Pack` to update the installed Ballerina distribution.
2727

2828
### Step 4: Create a new integration project
2929
1. Click on the Ballerina Integrator icon on the sidebar.

en/docs/learn/data-mapping.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,7 @@ The following instructions demonstrate how to build an integration that transfor
6868
2. In the design view, click on the **`Add Artifact`** button.
6969
3. Select **`HTTP Service`** under the **`Integration as API`** category.
7070
4. Select the **`+ Listeners`** option from the **`Listeners`** dropdown to add a new listener.
71-
5. Enter the listener name as `transformListner`, `8290` as the port and click on the **`Save`** button.
71+
5. Enter the listener name as `transformListener`, `8290` as the port and click on the **`Save`** button.
7272
6. Add the service base path as `/` and select the **`Design from Scratch`** option as the **`The contract of the service`**.
7373
7. Click on the **`Create`** button to create the new service with the specified configurations.
7474
<a href="{{base_path}}/assets/img/data-mapping/create-service.png"><img src="{{base_path}}/assets/img/data-mapping/create-service.png" alt="Create Service" width="70%"></a>

0 commit comments

Comments
 (0)