Skip to content

Commit

Permalink
fixed openshift doc (ToolJet#5737)
Browse files Browse the repository at this point in the history
  • Loading branch information
withshubh authored Mar 13, 2023
1 parent cb5dc4e commit d988365
Show file tree
Hide file tree
Showing 10 changed files with 132 additions and 5 deletions.
68 changes: 68 additions & 0 deletions docs/docs/setup/openshift.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,68 @@
---
id: openshift
title: Openshift
---

# Deploying ToolJet on Openshift

:::info
You should setup a PostgreSQL database manually to be used by ToolJet.
:::

Follow the steps below to deploy ToolJet on Openshift.

1. Setup a PostgreSQL database ToolJet uses a postgres database as the persistent storage for storing data related to users and apps. We do not have plans to support other databases such as MySQL.

2. Create a Kubernetes secret with name `server`. For the minimal setup, ToolJet requires `pg_host`, `pg_db`, `pg_user`, `pg_password`, `secret_key_base` & `lockbox_key` keys in the secret.

Read **[environment variables reference](https://docs.tooljet.com/docs/setup/env-vars)**

3. Once you have logged into the Openshift developer dashboard click on `+Add` tab. Select import YAML from the local machine.

:::note
When entering one or more files and use --- to separate each definition
:::

Copy paste depolyment.yaml to the online editor

```
https://raw.githubusercontent.com/ToolJet/ToolJet/main/deploy/openshift/deployment.yaml
```


Copy paste the service.yaml to the online editor

```
https://raw.githubusercontent.com/ToolJet/ToolJet/main/deploy/openshift/service.yaml
```

<div style={{textAlign: 'center'}}>

<img className="screenshot-full" src="/img/setup/openshift/online-yaml-editor.png" alt="online yaml editor" />

</div>

Once you have added the files click on create.

:info
If there are self signed HTTPS endpoints that Tooljet needs to connect to, please make sure that `NODE_EXTRA_CA_CERTS` environment variable is set to the absolute path containing the certificates. You can make use of kubernetes secrets to mount the certificate file onto the containers.
:::


4. Navigate to topology tab and use the visual connector to establish the connect between tooljet-deployment and postgresql as shown in the screenshot below.

<div style={{textAlign: 'center'}}>

<img className="screenshot-full" src="/img/setup/openshift/toplogy.png" alt="toplogy" />

</div>

## ToolJet Database

You can know more about tooljet database [here](https://docs.tooljet.com/docs/tooljet-database)

If you intend to use this feature, you'd have to set up and deploy PostgREST server which helps querying ToolJet Database. Please [follow the instructions here](https://docs.tooljet.com/docs/setup/env-vars#tooljet-database) for additional environment variables configuration to be done.

```
https://raw.githubusercontent.com/ToolJet/ToolJet/main/deploy/openshift/postgrest.yaml
```
1 change: 1 addition & 0 deletions docs/sidebars.js
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@ const sidebars = {
'setup/heroku',
'setup/ec2',
'setup/ecs',
'setup/openshift',
'setup/kubernetes',
'setup/kubernetes-gke',
'setup/kubernetes-aks',
Expand Down
1 change: 1 addition & 0 deletions docs/src/components/DocsCard/DocsCard.jsx
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ export const DocsCard = ({ label, imgSrc, link, height = 40, width = 40, title }
Heroku: "Deploy ToolJet on Heroku using the one-click-deployment button.",
"AWS EC2": "Deploy ToolJet on AWS EC2 instances.",
"AWS ECS": "Deploy ToolJet on AWS ECS instances.",
Openshift: "Deploy ToolJet on Openshift",
Kubernetes: "Deploy ToolJet on a Kubernetes cluster.",
"Kubernetes (GKE)": "Deploy ToolJet on a GKE Kubernetes cluster.",
"Kubernetes (AKS)": "Deploy ToolJet on a AKS Kubernetes cluster.",
Expand Down
43 changes: 43 additions & 0 deletions docs/static/img/setup/icons/openshift.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
File renamed without changes
10 changes: 8 additions & 2 deletions docs/versioned_docs/version-2.0.0/setup/openshift.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,8 +36,11 @@ Copy paste the service.yaml to the online editor
https://raw.githubusercontent.com/ToolJet/ToolJet/main/deploy/openshift/service.yaml
```

<img className="screenshot-full" src="/img/setup/openshift/online-yaml-editor.png" alt="online yaml editor" />
<div style={{textAlign: 'center'}}>

<img className="screenshot-full" src="/img/setup/openshift/online-yaml-editor.png" alt="online yaml editor" />

</div>

Once you have added the files click on create.

Expand All @@ -48,8 +51,11 @@ If there are self signed HTTPS endpoints that Tooljet needs to connect to, pleas

4. Navigate to topology tab and use the visual connector to establish the connect between tooljet-deployment and postgresql as shown in the screenshot below.

<img className="screenshot-full" src="/img/setup/openshift/toplogy.png" alt="toplogy" />
<div style={{textAlign: 'center'}}>

<img className="screenshot-full" src="/img/setup/openshift/toplogy.png" alt="toplogy" />

</div>

## ToolJet Database

Expand Down
10 changes: 8 additions & 2 deletions docs/versioned_docs/version-2.1.0/setup/openshift.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,8 +36,11 @@ Copy paste the service.yaml to the online editor
https://raw.githubusercontent.com/ToolJet/ToolJet/main/deploy/openshift/service.yaml
```

<img className="screenshot-full" src="/img/setup/openshift/online-yaml-editor.png" alt="online yaml editor" />
<div style={{textAlign: 'center'}}>

<img className="screenshot-full" src="/img/setup/openshift/online-yaml-editor.png" alt="online yaml editor" />

</div>

Once you have added the files click on create.

Expand All @@ -48,8 +51,11 @@ If there are self signed HTTPS endpoints that Tooljet needs to connect to, pleas

4. Navigate to topology tab and use the visual connector to establish the connect between tooljet-deployment and postgresql as shown in the screenshot below.

<img className="screenshot-full" src="/img/setup/openshift/toplogy.png" alt="toplogy" />
<div style={{textAlign: 'center'}}>

<img className="screenshot-full" src="/img/setup/openshift/toplogy.png" alt="toplogy" />

</div>

## ToolJet Database

Expand Down
1 change: 1 addition & 0 deletions docs/versioned_sidebars/version-2.0.0-sidebars.json
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@
"setup/heroku",
"setup/ec2",
"setup/ecs",
"setup/openshift",
"setup/kubernetes",
"setup/kubernetes-gke",
"setup/kubernetes-aks",
Expand Down
3 changes: 2 additions & 1 deletion docs/versioned_sidebars/version-2.1.0-sidebars.json
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@
"setup/heroku",
"setup/ec2",
"setup/ecs",
"setup/openshift",
"setup/kubernetes",
"setup/kubernetes-gke",
"setup/kubernetes-aks",
Expand Down Expand Up @@ -363,4 +364,4 @@
]
}
]
}
}

0 comments on commit d988365

Please sign in to comment.