Merge pull request #47 from anuruddhal/main

Add guide on ICP integration

Author: anuruddhal

en/docs/assets/img/deploy/icp/config-toml.png

@@ -0,0 +1,63 @@
+# Deploy with Integration Control Plane
+
+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.
+In this guide, you will learn how to enable Integration Control Plane (ICP) for a Ballerina integration. 
+
+
+## Prerequisites
+1. Java 11 or later versions should be installed on your machine.
+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.
+
+## Step 1: Download and start ICP server
+
+1. Go to the [WSO2 Integration Control Plane](https://wso2.com/integrator/integration-control-plane/) web page. 
+2. Click Download. 
+3. Provide the necessary details. 
+4. Click Zip Archive to download the Integration Control Plane as a ZIP file. 
+5. Extract the archive file to a dedicated directory for the Integration Control Plane, which will hereafter be referred to as <ICP_HOME>.
+6. Open a terminal and navigate to the `<ICP_HOME>/bin` folder.
+7. Execute one of the commands given below.
+=== "On MacOS/Linux"
+
+    ``` bash
+    ./dashboard.sh
+    ```
+
+=== "On Windows"
+
+    ``` bash
+    dashboard.bat
+    ``` 
+
+## Step 2: Access the ICP dashboard
+1. Open a web browser and navigate to `https://localhost:9743/dashboard`.
+2. Log in using the default credentials: 
+    - Username: `admin`
+    - Password: `admin`
+   
+<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>
+
+## Step 3: Deploy the Ballerina integration
+1. Navigate to the Visualizer view by clicking on the Ballerina Integrator icon on the sidebar.
+2. Check **`Enable ICP`** under the **`Integration Control Plane`** section in the right panel.
+<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>
+3. Click on the **`Run`** button to start the integration. 
+4. Click on the **`Create Config.toml`** on the prompt to create the `Config.toml` file.
+<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>
+5. Replace the `Config.toml` file config with the following configurations.   
+    ```toml
+      [ballerinax.wso2.controlplane.dashboard]
+      url = "https://localhost:9743/dashboard/api"
+      heartbeatInterval = 10
+      groupId = "cluster1"
+      mgtApiUrl ="https://localhost:9264/management/"
+    ```
+6. Click on the **`Run`** button to start the integration.
+<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>
+7. 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
+1. Go to the ICP dashboard and log in `https://localhost:9743/dashboard`.
+2. In the dashboard, you will see the integration details.
+<img src="{{base_path}}/assets/img/deploy/icp/icp-dashboard.png" alt="ICP Dashboard" width="70%">

en/docs/assets/img/deploy/icp/enable-icp.png

@@ -4,7 +4,7 @@ This guide explains how to deploy an integration as an executable JAR file.
 
 1. Navigate to the Visualizer view by clicking on the Ballerina Integrator icon on the sidebar.
 2. Click on the **`Deploy on VM`** under the **`Deployment Options`** section in the right panel.
-3. Click **`Executable JAR`** button.       
+3. Click **`Create Executable`** button.       
 <a href="{{base_path}}/assets/img/deploy/jar.gif"><img src="{{base_path}}/assets/img/deploy/jar.gif" alt="Build JAR" width="70%"></a>
 
 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/assets/img/deploy/icp/icp-dashboard.png

@@ -23,7 +23,7 @@ Download and install the [Visual Studio Code](https://code.visualstudio.com/down
 
 ???+ info "Update Ballerina Integrator's Ballerina Distribution"
     The setup wizard will install the Ballerina distribution required for Ballerina Integrator in to `<USER_HOME>/.ballerina/ballerina-home` directory.
-    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.
+    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.
 
 ### Step 4: Create a new integration project
 1. Click on the Ballerina Integrator icon on the sidebar.

en/docs/assets/img/deploy/icp/icp-login.png

@@ -68,7 +68,7 @@ The following instructions demonstrate how to build an integration that transfor
 2. In the design view, click on the **`Add Artifact`** button.
 3. Select **`HTTP Service`** under the **`Integration as API`** category.
 4. Select the **`+ Listeners`** option from the **`Listeners`** dropdown to add a new listener.
-5. Enter the listener name as `transformListner`, `8290` as the port and click on the **`Save`** button.
+5. Enter the listener name as `transformListener`, `8290` as the port and click on the **`Save`** button.
 6. Add the service base path as `/` and select the **`Design from Scratch`** option as the **`The contract of the service`**.
 7. Click on the **`Create`** button to create the new service with the specified configurations.
     <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>

en/docs/assets/img/deploy/icp/run-integration.gif

@@ -44,7 +44,7 @@ In this tutorial, you’ll create an HTTP service to add key-value pairs to a Re
 1. In the `Integrator overview`, click on the **`Configurations`**.
 2. Set `redisHost` value to `localhost`.
 3. Set `redisPort` value to `6379`.   
-<a href="{{base_path}}/assets/img/integration-ai/configurtaion.gif"><img src="{{base_path}}/assets/img/integration-ai/configuration.gif" alt="Configurations" width="70%"></a>
+<a href="{{base_path}}/assets/img/integration-ai/configuration.gif"><img src="{{base_path}}/assets/img/integration-ai/configuration.gif" alt="Configurations" width="70%"></a>
 
 ### Step 5: Generate the curl commands to test the integration
 1. Add the following prompt and press `Enter` to generate the curl command to add key-value pairs to the Redis server.:

en/docs/assets/img/get-started/bi-extension.png

@@ -178,12 +178,12 @@ Follow the steps below to implement the message routing service.
 
     **clemency:**
 
-    |Field| Value                         |
-     |---|-------------------------------|
-    |Variable Name| `clemncyEPResponse`           |
-    |Variable Type| `ReserveResponse`             |
+    |Field| Value                                  |
+     |---|----------------------------------------|
+    |Variable Name| `clemencyEPResponse`                   |
+    |Variable Type| `ReserveResponse`                      |
     |Resource Path| ```  string `/${category}/reserve` ``` |
-    |message| `hospitalRequset`             |
+    |message| `hospitalRequset`                      |
 
     **pinevalley:**
 

en/docs/deploy/icp.md

@@ -18,7 +18,7 @@
 site_name: Ballerina Integrator Documentation
 site_description: Documentation for Ballerina Integrator
 site_author: WSO2
-# site_url: https://bi.docs.wso2.com/en/latest/
+site_url: https://bi.docs.wso2.com/
 
 # Repository information
 repo_name: wso2/docs-ballerina-integrator
@@ -84,6 +84,7 @@ nav:
   - Deploy:
       - Deploy on a VM: deploy/jar.md
       - Deploy with Docker: deploy/docker.md
+      - Deploy with Integration Control Plane: deploy/icp.md
   - Roadmap:
       - Features & Roadmap : roadmap/overview.md
       - Ballerina language features: roadmap/language-support.md
@@ -114,13 +115,13 @@ markdown_extensions:
   - pymdownx.mark
   - pymdownx.smartsymbols
   - pymdownx.superfences
+  - pymdownx.tabbed:
+      alternate_style: true
   - pymdownx.tasklist:
       custom_checkbox: true
   - pymdownx.tilde
   - pymdownx.snippets:
       base_path: docs
-  - pymdownx.tabbed:
-        alternate_style: true
   - attr_list
 
 # Plugins configuration

en/docs/deploy/jar.md

@@ -8,7 +8,6 @@
     {% block site_meta %}
       <meta charset="utf-8">
       <meta name="viewport" content="width=device-width,initial-scale=1">
-      <meta name="robots" content="noindex, nofollow">
       {% if page.meta and page.meta.description %}
         <meta name="description" content="{{ page.meta.description }}">
       {% elif config.site_description %}

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

@@ -3,7 +3,28 @@
 -#}
 {% extends "base.html" %}
 
-<!-- wip banner -->
-{% block announce %}
-This documentation is a work in progress.
+{% block analytics %}
+<!-- Google Tag Manager -->
+<script>(function(w,d,s,l,i){
+    w[l]=w[l]||[];w[l].push({
+        'gtm.start':
+            new Date().getTime(),event:'gtm.js'
+    });var f=d.getElementsByTagName(s)[0],
+        j=d.createElement(s),dl=l!='dataLayer'?'&l='+l:'';j.setAttributeNode(d.createAttribute('data-ot-ignore'));j.async=true;j.src=
+        'https://www.googletagmanager.com/gtm.js?id='+i+dl;f.parentNode.insertBefore(j,f);
+})(window,document,'script','dataLayer','GTM-5CR98L58');</script>
+<!-- End Google Tag Manager -->
+{% endblock %}
+
+{% block extrahead %}
+<meta name="google-site-verification" content="pRwRUP0jDUECheRt5DziuVd3gSs2UTw6EhL4nud3NMk" />
+{{ super() }}
+{% endblock %}
+
+{% block content %}
+{{ super() }}
+<!-- Google Tag Manager (noscript) -->
+<noscript><iframe src="https://www.googletagmanager.com/ns.html?id=GTM-5CR98L58" height="0" width="0"
+                  style="display:none;visibility:hidden"></iframe></noscript>
+<!-- End Google Tag Manager (noscript) -->
 {% endblock %}