From 2704ce113629a88ad9f4928f4be7218fa4463bd3 Mon Sep 17 00:00:00 2001 From: Shubhendra Date: Wed, 3 May 2023 18:54:51 +0530 Subject: [PATCH 1/6] grpc ds --- docs/docs/data-sources/grpc.md | 92 ++++++++++++++++-- docs/sidebars.js | 1 + .../datasource-reference/grpc/connection.png | Bin 0 -> 103847 bytes .../img/datasource-reference/grpc/grpcgds.png | Bin 0 -> 76662 bytes .../img/datasource-reference/grpc/proto1.png | Bin 0 -> 100428 bytes .../img/datasource-reference/grpc/proto2.png | Bin 0 -> 194294 bytes .../img/datasource-reference/grpc/query.png | Bin 0 -> 101444 bytes 7 files changed, 87 insertions(+), 6 deletions(-) create mode 100644 docs/static/img/datasource-reference/grpc/connection.png create mode 100644 docs/static/img/datasource-reference/grpc/grpcgds.png create mode 100644 docs/static/img/datasource-reference/grpc/proto1.png create mode 100644 docs/static/img/datasource-reference/grpc/proto2.png create mode 100644 docs/static/img/datasource-reference/grpc/query.png diff --git a/docs/docs/data-sources/grpc.md b/docs/docs/data-sources/grpc.md index 5afb81d526..f3d33be820 100644 --- a/docs/docs/data-sources/grpc.md +++ b/docs/docs/data-sources/grpc.md @@ -1,11 +1,91 @@ +--- +id: grpc +title: gRPC +--- -# grpc +
Self-hosted only
-ToolJet can connect to GRPC databases to read and write data. +:::caution +At present, gRPC can be deployed for self-hosting and has the capability to handle unary requests and responses. +::: -- [Connection](#connection) -- [Getting Started](#querying-grpc) +- [Setup](#setup) +- [Querying gRPC](#querying-grpc) -## Connection +## Setup -## Querying GRPC \ No newline at end of file +### Step 1: Upgrade ToolJet to the version 2.5 or above + +Find instructions on how to do this in the setup guides located here: https://docs.tooljet.com/docs/setup/. + +### Step 2: Add proto files + +Add proto files by creating a directory named "protos" and placing a file called "**service.proto**" inside it. + +:::info Note +Copy-pase the current service.proto service +::: + +### Step 3: Mount Volumes + +In the `docker-compose.yml` add + +```bash +./protos:/app/protos +``` + +to the 2 volume sections for **plugins** and **server** + + +
+ +gRPC: datasource + +
+ +
+ +gRPC: datasource + +
+ +### Step 4: Reboot the instance + +```bash +docker-compose up -d +``` + +## Querying gRPC + +After setting up your proto files, you should be able to establish a connection to gRPC by going to the [global datasource](/docs/data-sources/overview) page. + +### Connect the gRPC datasource + +ToolJet requires the following to connect to Amazon SES: + +- **Server URL** +- **Authentication type** (None, Basic, Bearer, and API key) + +
+ +gRPC: connection + +
+ +Once you have added the gRPC from the global datasource page, you'll find it on the query panel of the application. + +
+ +gRPC: connection + +
+ +### Creating query + +You can now query a particular of RPC of the added services. + +
+ +gRPC: connection + +
\ No newline at end of file diff --git a/docs/sidebars.js b/docs/sidebars.js index 73f65d0182..fddffa1d56 100644 --- a/docs/sidebars.js +++ b/docs/sidebars.js @@ -63,6 +63,7 @@ const sidebars = { 'data-sources/gcs', 'data-sources/google.sheets', 'data-sources/graphql', + 'data-sources/grpc', 'data-sources/influxdb', 'data-sources/mailgun', 'data-sources/mariadb', diff --git a/docs/static/img/datasource-reference/grpc/connection.png b/docs/static/img/datasource-reference/grpc/connection.png new file mode 100644 index 0000000000000000000000000000000000000000..48492b060b298afa37a4605f686da1e39eea4ced GIT binary patch literal 103847 zcmeFZXIN8N*FTJ4!44Kc0Z~vvkS5ZrAfO^3BE5rjLg+n2Mid1?RH~GK(v%)b=mbRw zy|+-67AXNj2{p<8V4r8a@0t7k@O~P&xUxAp>+G`HZ>_!dd3r}p`S5|$2dJp14&S_S z{Vo;NfkrAS8YJyr;EFcJw1A3g*I`=)g*!JD6wcmp0bAKRSW;1OJ-0A5eR1P5SH0OW zQ`7nuo=XQ@Jnuev5_;DZ+FIRM-CW&d+ME;>V`%u1iSAa}>M>eS(keg#TYjFM&b2DO>IpZ!?+WWb?kX`5I zXiSCah$r)6pPjWnyS3+8OZ09t3Kg>Jox{Z=bj)`A{fEQkJkzlRAm|`yB@wlW4xTX^=a&2Ajw|0zURT-OzKTqGGtP^SA5f-SdmU6V`0+ z>ALBv-j=WcgZRwugUv1Zyg*JnR8&%45