integrations

Author: Blargian

docs/integrations/data-ingestion/clickpipes/postgres/source/supabase.md

@@ -73,7 +73,7 @@ Head over to your Supabase Project's `Project Settings` -> `Database` (under `Co
 
 **Important**: Disable `Display connection pooler` on this page and head over to the `Connection parameters` section and note/copy the parameters.
 
-<img src={supabase_connection_details} alt="Locate Supabase Connection Details"/>
+<Image img={supabase_connection_details} size="lg" border alt="Locate Supabase Connection Details"/>
 
 :::info
 

docs/integrations/data-ingestion/dbms/jdbc-with-clickhouse.md

@@ -7,6 +7,7 @@ description: 'The ClickHouse JDBC Bridge allows ClickHouse to access data from a
 title: 'Connecting ClickHouse to external data sources with JDBC'
 ---
 
+import Image from '@theme/IdealImage';
 import Tabs from '@theme/Tabs';
 import TabItem from '@theme/TabItem';
 import Jdbc01 from '@site/static/images/integrations/data-ingestion/dbms/jdbc-01.png';
@@ -21,7 +22,7 @@ Using JDBC requires the ClickHouse JDBC bridge, so you will need to use `clickho
 
 **Overview:** The <a href="https://github.com/ClickHouse/clickhouse-jdbc-bridge" target="_blank">ClickHouse JDBC Bridge</a> in combination with the [jdbc table function](/sql-reference/table-functions/jdbc.md) or the [JDBC table engine](/engines/table-engines/integrations/jdbc.md) allows ClickHouse to access data from any external data source for which a <a href="https://en.wikipedia.org/wiki/JDBC_driver" target="_blank">JDBC driver</a> is available:
 
-<img src={Jdbc01} class="image" alt="ClickHouse JDBC Bridge"/>
+<Image img={Jdbc01} size="lg" alt="ClickHouse JDBC Bridge architecture diagram" background='white'/>
 This is handy when there is no native built-in [integration engine](/engines/table-engines/integrations), table function, or external dictionary for the external data source available, but a JDBC driver for the data source exists.
 
 You can use the ClickHouse JDBC Bridge for both reads and writes. And in parallel for multiple external data sources, e.g. you can run distributed queries on ClickHouse across multiple external and internal data sources in real time.
@@ -41,7 +42,7 @@ You have access to a machine that has:
 
 ## Install the ClickHouse JDBC Bridge locally {#install-the-clickhouse-jdbc-bridge-locally}
 
-The easiest way to use the ClickHouse JDBC Bridge is to install and run it on the same host where also ClickHouse is running:<img src={Jdbc02} class="image" alt="ClickHouse JDBC Bridge locally"/>
+The easiest way to use the ClickHouse JDBC Bridge is to install and run it on the same host where also ClickHouse is running:<Image img={Jdbc02} size="lg" alt="ClickHouse JDBC Bridge locally deployment diagram" background='white'/>
 
 Let's start by connecting to the Unix shell on the machine where ClickHouse is running and create a local folder where we will later install the ClickHouse JDBC Bridge into (feel free to name the folder anything you like and put it anywhere you like):
 ```bash
@@ -142,7 +143,7 @@ As the first parameter for the jdbc table function we are using the name of the
 ## Install the ClickHouse JDBC Bridge externally {#install-the-clickhouse-jdbc-bridge-externally}
 
 For a distributed ClickHouse cluster (a cluster with more than one ClickHouse host) it makes sense to install and run the ClickHouse JDBC Bridge externally on its own host:
-<img src={Jdbc03} class="image" alt="ClickHouse JDBC Bridge externally"/>
+<Image img={Jdbc03} size="lg" alt="ClickHouse JDBC Bridge external deployment diagram" background='white'/>
 This has the advantage that each ClickHouse host can access the JDBC Bridge. Otherwise the JDBC Bridge would need to be installed locally for each ClickHouse instance that is supposed to access external data sources via the Bridge.
 
 In order to install the ClickHouse JDBC Bridge externally, we do the following steps:

docs/integrations/data-ingestion/emqx/index.md

@@ -32,6 +32,7 @@ import mqttx_new from '@site/static/images/integrations/data-ingestion/emqx/mqtt
 import mqttx_publish from '@site/static/images/integrations/data-ingestion/emqx/mqttx-publish.png';
 import rule_monitor from '@site/static/images/integrations/data-ingestion/emqx/rule_monitor.png';
 import clickhouse_result from '@site/static/images/integrations/data-ingestion/emqx/clickhouse_result.png';
+import Image from '@theme/IdealImage';
 
 # Integrating EMQX with ClickHouse
 
@@ -43,7 +44,7 @@ import clickhouse_result from '@site/static/images/integrations/data-ingestion/e
 
 With the infrastructure provided by cloud providers, EMQX Cloud serves dozens of countries and regions around the world, providing low-cost, secure, and reliable cloud services for 5G and Internet of Everything applications.
 
-<img src={emqx_cloud_artitecture} alt="EMQX Cloud Architecture" />
+<Image img={emqx_cloud_artitecture} size="lg" border alt="EMQX Cloud Architecture diagram showing cloud infrastructure components" />
 
 ### Assumptions {#assumptions}
 
@@ -53,27 +54,27 @@ With the infrastructure provided by cloud providers, EMQX Cloud serves dozens of
 * We are using [MQTT X](https://mqttx.app/)  as an MQTT client testing tool to connect the deployment of EMQX Cloud to publish MQTT data. Or other methods connecting to the MQTT broker will do the job as well.
 
 
-## Get Your ClickHouse Cloud Service {#get-your-clickhouse-cloudservice}
+## Get Your ClickHouse Cloud Service {#get-your-clickhouse-cloudservice}
 
 During this setup, we deployed the ClickHouse instance on AWS in N. Virginia (us-east -1), while an EMQX Cloud instance was also deployed in the same region.
 
-<img src={clickhouse_cloud_1} alt="ClickHouse Cloud Service Deployment" />
+<Image img={clickhouse_cloud_1} size="sm" border alt="ClickHouse Cloud Service Deployment interface showing AWS region selection" />
 
 During the setup process, you will also need to pay attention to the connection settings. In this tutorial, we choose "Anywhere", but if you apply for a specific location, you will need to add the [NAT gateway](https://docs.emqx.com/en/cloud/latest/vas/nat-gateway.html) IP address you got from your EMQX Cloud deployment to the whitelist.
 
-<img src={clickhouse_cloud_2} alt="ClickHouse Cloud Connection Settings" />
+<Image img={clickhouse_cloud_2} size="sm" border alt="ClickHouse Cloud Connection Settings showing IP access configuration" />
 
 Then you need to save your username and password for future use.
 
-<img src={clickhouse_cloud_3} alt="ClickHouse Cloud Credentials" />
+<Image img={clickhouse_cloud_3} size="sm" border alt="ClickHouse Cloud Credentials screen showing username and password" />
 
 After that, you will get a running Click house instance. Click "Connect" to get the instance connection address of Clickhouse Cloud.
 
-<img src={clickhouse_cloud_4} alt="ClickHouse Cloud Running Instance" />
+<Image img={clickhouse_cloud_4} size="lg" border alt="ClickHouse Cloud Running Instance dashboard with connection options" />
 
 Click "Connect to SQL Console" to create database and table for integration with EMQX Cloud.
 
-<img src={clickhouse_cloud_5} alt="ClickHouse Cloud SQL Console" />
+<Image img={clickhouse_cloud_5} size="lg" border alt="ClickHouse Cloud SQL Console interface" />
 
 You can refer to the following SQL statement, or modify the SQL according to the actual situation.
 
@@ -90,7 +91,7 @@ ENGINE = MergeTree()
 PRIMARY KEY (client_id, timestamp)
 ```
 
-<img src={clickhouse_cloud_6} alt="ClickHouse Cloud Create Database and Table" />
+<Image img={clickhouse_cloud_6} size="lg" border alt="ClickHouse Cloud Create Database and Table SQL query execution" />
 
 ## Create an MQTT service on EMQX Cloud {#create-an-mqtt-service-on-emqx-cloud}
 
@@ -102,41 +103,41 @@ EMQX Cloud provides a 14-day free trial for both standard deployment and profess
 
 Start at the [EMQX Cloud sign up](https://accounts.emqx.com/signup?continue=https%3A%2F%2Fwww.emqx.com%2Fen%2Fcloud) page and click start free to register an account if you are new to EMQX Cloud.
 
-<img src={emqx_cloud_sign_up} alt="EMQX Cloud Signup Page" />
+<Image img={emqx_cloud_sign_up} size="lg" border alt="EMQX Cloud Signup Page with registration form" />
 
 ### Create an MQTT cluster {#create-an-mqtt-cluster}
 
 Once logged in, click on "Cloud Console" under the account menu and you will be able to see the green button to create a new deployment.
 
-<img src={emqx_cloud_create_1} alt="EMQX Cloud Create Deployment Step 1" />
+<Image img={emqx_cloud_create_1} size="lg" border alt="EMQX Cloud Create Deployment Step 1 showing deployment options" />
 
 In this tutorial, we will use the Professional deployment because only Pro version provides the data integration functionality, which can send MQTT data directly to ClickHouse without a single line of code.
 
-Select Pro version and choose `N.Virginial` region and click `Create Now`. In just a few minutes, you will get a fully managed MQTT broker:
+Select Pro version and choose `N.Virginial` region and click `Create Now`. In just a few minutes, you will get a fully managed MQTT broker:
 
-<img src={emqx_cloud_create_2} alt="EMQX Cloud Create Deployment Step 2" />
+<Image img={emqx_cloud_create_2} size="lg" border alt="EMQX Cloud Create Deployment Step 2 showing region selection" />
 
 Now click the panel to go to the cluster view. On this dashboard, you will see the overview of your MQTT broker.
 
-<img src={emqx_cloud_overview} alt="EMQX Cloud Overview Dashboard" />
+<Image img={emqx_cloud_overview} size="lg" border alt="EMQX Cloud Overview Dashboard showing broker metrics" />
 
 ### Add Client Credential {#add-client-credential}
 
 EMQX Cloud does not allow anonymous connections by default，so you need add a client credential so you can use the MQTT client tool to send data to this broker.
 
 Click ‘Authentication & ACL’ on the left menu and click ‘Authentication’ in the submenu. Click the ‘Add’ button on the right and give a username and password for the MQTT connection later. Here we will use `emqx` and `xxxxxx` for the username and password.
 
-<img src={emqx_cloud_auth} alt="EMQX Cloud Authentication Setup" />
+<Image img={emqx_cloud_auth} size="lg" border alt="EMQX Cloud Authentication Setup interface for adding credentials" />
 
-Click ‘Confirm’ and now we have a fully managed MQTT broker ready.
+Click 'Confirm' and now we have a fully managed MQTT broker ready.
 
 ### Enable NAT gateway {#enable-nat-gateway}
 
 Before we can start setting up the ClickHouse integration, we need to enable the NAT gateway first. By default, the MQTT broker is deployed in a private VPC, which can not send data to third-party systems over the public network.
 
 Go back to the Overview page and scroll down to the bottom of the page where you will see the NAT gateway widget. Click the Subscribe button and follow the instructions. Note that NAT Gateway is a value-added service, but it also offers a 14-day free trial.
 
-<img src={emqx_cloud_nat_gateway} alt="EMQX Cloud NAT Gateway Configuration" />
+<Image img={emqx_cloud_nat_gateway} size="lg" border alt="EMQX Cloud NAT Gateway Configuration panel" />
 
 Once it has been created, you will find the public IP address in the widget. Please note that if you select "Connect from a specific location" during ClickHouse Cloud setup, you will need to add this IP address to the whitelist.
 
@@ -145,11 +146,11 @@ Once it has been created, you will find the public IP address in the widget. Ple
 
 The [EMQX Cloud Data Integrations](https://docs.emqx.com/en/cloud/latest/rule_engine/introduction.html#general-flow) is used to configure the rules for handling and responding to EMQX message flows and device events. The Data Integrations not only provides a clear and flexible "configurable" architecture solution, but also simplifies the development process, improves user usability, and reduces the coupling degree between the business system and EMQX Cloud. It also provides a superior infrastructure for customization of EMQX Cloud's proprietary capabilities.
 
-<img src={emqx_cloud_data_integration} alt="EMQX Cloud Data Integration Options" />
+<Image img={emqx_cloud_data_integration} size="lg" border alt="EMQX Cloud Data Integration Options showing available connectors" />
 
 EMQX Cloud offers more than 30 native integrations with popular data systems. ClickHouse is one of them.
 
-<img src={data_integration_clickhouse} alt="EMQX Cloud ClickHouse Data Integration" />
+<Image img={data_integration_clickhouse} size="lg" border alt="EMQX Cloud ClickHouse Data Integration connector details" />
 
 ### Create ClickHouse Resource {#create-clickhouse-resource}
 
@@ -158,20 +159,20 @@ Click "Data Integrations" on the left menu and click "View All Resources". You w
 Click the ClickHouse card to create a new resource.
 
 - Note: add a note for this resource.
-- Server address: this is the address of your ClickHouse Cloud service, remember don’t forget the port.
+- Server address: this is the address of your ClickHouse Cloud service, remember don't forget the port.
 - Database name: `emqx` we created in the above steps.
 - User: the username for connecting to your ClickHouse Cloud service.
 - Key: the password for the connection.
 
-<img src={data_integration_resource} alt="EMQX Cloud ClickHouse Resource Setup" />
+<Image img={data_integration_resource} size="lg" border alt="EMQX Cloud ClickHouse Resource Setup form with connection details" />
 
 ### Create A New Rule {#create-a-new-rule}
 
-During the creation of the resource, you will see a popup, and clicking ‘New’ will leads you to the rule creation page.
+During the creation of the resource, you will see a popup, and clicking 'New' will leads you to the rule creation page.
 
 EMQX provides a powerful [rule engine](https://docs.emqx.com/en/cloud/latest/rule_engine/rules.html) that can transform, and enrich the raw MQTT message before sending it to third-party systems.
 
-Here’s the rule used in this tutorial:
+Here's the rule used in this tutorial:
 
 ```sql
 SELECT
@@ -192,11 +193,11 @@ So, the raw JSON you send to the topic:
 {"temp": 28.5, "hum": 0.68}
 ```
 
-<img src={data_integration_rule_1} alt="EMQX Cloud Data Integration Rule Creation Step 1" />
+<Image img={data_integration_rule_1} size="md" border alt="EMQX Cloud Data Integration Rule Creation Step 1 showing SQL query" />
 
 You can use the SQL test to test and see the results.
 
-<img src={data_integration_rule_2} alt="EMQX Cloud Data Integration Rule Creation Step 2" />
+<Image img={data_integration_rule_2} size="md" border alt="EMQX Cloud Data Integration Rule Creation Step 2 showing test results" />
 
 Now click on the "NEXT" button. This step is to tell EMQX Cloud how to insert refined data into your ClickHouse database.
 
@@ -209,29 +210,29 @@ You only need to set the SQL template. Here’s the example used for this tutori
 INSERT INTO temp_hum (client_id, timestamp, topic, temp, hum) VALUES ('${client_id}', ${timestamp}, '${topic}', ${temp}, ${hum})
 ```
 
-<img src={data_integration_rule_action} alt="EMQX Cloud Data Integration Rule Action Setup" />
+<Image img={data_integration_rule_action} size="md" border alt="EMQX Cloud Data Integration Rule Action Setup with SQL template" />
 
 This is a template for inserting data into Clickhouse, you can see the variables are used here.
 
 ### View Rules Details {#view-rules-details}
 
 Click "Confirm" and "View Details". Now, everything should be well set. You can see the data integration works from rule details page.
 
-<img src={data_integration_details} alt="EMQX Cloud Data Integration Rule Details" />
+<Image img={data_integration_details} size="md" border alt="EMQX Cloud Data Integration Rule Details showing configuration summary" />
 
 All the MQTT messages sent to the `temp_hum/emqx` topic will be persisted into your ClickHouse Cloud database.
 
 ## Saving Data into ClickHouse {#saving-data-into-clickhouse}
 
 We will simulate temperature and humidity data and report these data to EMQX Cloud via the MQTT X and then use the EMQX Cloud Data Integrations to save the data into ClickHouse Cloud.
 
-<img src={work_flow} alt="EMQX Cloud to ClickHouse Workflow" />
+<Image img={work_flow} size="lg" border alt="EMQX Cloud to ClickHouse Workflow diagram showing data flow" />
 
 ### Publish MQTT messages to EMQX Cloud {#publish-mqtt-messages-to-emqx-cloud}
 
 You can use any MQTT client or SDK to publish the message. In this tutorial, we will use [MQTT X](https://mqttx.app/), a user friendly MQTT client application provided by EMQ.
 
-<img src={mqttx_overview} alt="MQTTX Overview" />
+<Image img={mqttx_overview} size="lg" border alt="MQTTX Overview showing the client interface" />
 
 Click "New Connection" on MQTTX and fill the connection form:
 
@@ -240,15 +241,15 @@ Click "New Connection" on MQTTX and fill the connection form:
 - Port: MQTT broker connection port. You can get it from the EMQX Cloud overview page.
 - Username/Password: Use the credential created above, which should be `emqx` and `xxxxxx` in this tutorial.
 
-<img src={mqttx_new} alt="MQTTX New Connection Setup" />
+<Image img={mqttx_new} size="lg" border alt="MQTTX New Connection Setup form with connection details" />
 
 Click the "Connect" button on top right and the connection should be established.
 
 Now you can send messages to the MQTT broker using this tool.
 Inputs:
-1. Set payload format to "JSON".
-2. Set to topic: `temp_hum/emqx` (the topic we just set in the rule)
-3. JSON body:
+1. Set payload format to "JSON".
+2. Set to topic: `temp_hum/emqx` (the topic we just set in the rule)
+3. JSON body:
 
 ```bash
 {"temp": 23.1, "hum": 0.68}
@@ -258,17 +259,17 @@ Click the send button on the right. You can change the temperature value and sen
 
 The data sent to EMQX Cloud should be processed by the rule engine and inserted into ClickHouse Cloud automatically.
 
-<img src={mqttx_publish} alt="MQTTX Publish MQTT Messages" />
+<Image img={mqttx_publish} size="lg" border alt="MQTTX Publish MQTT Messages interface showing message composition" />
 
 ### View rules monitoring {#view-rules-monitoring}
 
 Check the rule monitoring and add one to the number of success.
 
-<img src={rule_monitor} alt="EMQX Cloud Rule Monitoring" />
+<Image img={rule_monitor} size="lg" border alt="EMQX Cloud Rule Monitoring dashboard showing message processing metrics" />
 
 ### Check the data persisted {#check-the-data-persisted}
 
-Now it’s time to take a look at the data on the ClickHouse Cloud. Ideally, the data you send using MQTTX will go to the EMQX Cloud and persist to the ClickHouse Cloud’s database with the help of native data integration.
+Now it's time to take a look at the data on the ClickHouse Cloud. Ideally, the data you send using MQTTX will go to the EMQX Cloud and persist to the ClickHouse Cloud's database with the help of native data integration.
 
 You can connect to the SQL console on ClickHouse Cloud panel or use any client tool to fetch data from your ClickHouse. In this tutorial, we used the SQL console.
 By executing the SQL:
@@ -277,7 +278,7 @@ By executing the SQL:
 SELECT * FROM emqx.temp_hum;
 ```
 
-<img src={clickhouse_result} alt="ClickHouse Query Results" />
+<Image img={clickhouse_result} size="lg" border alt="ClickHouse Query Results showing persisted IoT data" />
 
 ### Summary {#summary}