Automated Deployment on Red Hat OpenShift with the Joget Operator

Install Joget DX 8 operator from the operatorhub

The Joget DX Operator enables customers to rapidly deploy, manage, and scale a Joget DX cluster on Red Hat OpenShift. As a certified Operator, it is listed in the OpenShift Embedded OperatorHub catalog. Joget DX is a development platform and an application runtime, so the Joget DX Operator is listed under both the Application Runtime and Developer Tools categories. 

These steps assume that you already have a running OpenShift 4 cluster. If you don't have one set up yet, you can access Try Red Hat OpenShift and select Openshift 4 playground to create a new one. Then you can proceed with the steps provided in the instructions.

Install Joget DX 8 operator as cluster admin

Follow the steps below to install the Joget DX 8 Operator:

1. Log in to the OpenShift console as the cluster admin.
   
2. Go to Operators > OperatorHub and search for Joget DX8.
   
   
3. Select the Joget DX 8 Operator and click the Install button.
   
   
4. Click the Install button again to proceed installation of Joget DX.
   
   
5. Go to to Operators > Installed Operators.
6. Select Joget DX 8 Operator to verify if the installation was successful.
   

Create a Joget cluster with the Joget DX 8 operator

This process describes setting up a Joget cluster in Red Hat OpenShift using the Joget DX 8 operator. It involves creating a new project, deploying a MySQL or MariaDB database, and configuring the Joget DX 8 operator to start deploying Joget DX 8 instances. It also includes instructions on completing the database setup and accessing the Joget DX application center.

Create new project and deploy database

Before using Joget DX in your OpenShift environment, you must set up a new project and deploy a database. Follow the steps below to create the necessary project and deploy a MySQL or MariaDB database:

1. Once you've installed the Joget Operator, log in to the OpenShift console as a regular user.
2. Go to Home > Projects.
3. Click the Create Project button on your screen's right side. 
4. Enter a Name and click Create.
   
5. As a prerequisite, deploy a MySQL or MariaDB database in your project.
   
   
6. The fastest way to deploy MySQL would be to use the OpenShift CLI e.g.: 
   

   # deploy persistent mysql
   export DB_APP_NAME=jogetdb
   export MYSQL_DATABASE=jwdb
   export MYSQL_USER=joget
   export MYSQL_PASSWORD=joget
    
   oc new-app openshift/mysql-persistent --name $DB_APP_NAME -p DATABASE_SERVICE_NAME=$DB_APP_NAME -p MYSQL_USER=$MYSQL_USER -p MYSQL_PASSWORD=$MYSQL_PASSWORD -p MYSQL_DATABASE=$MYSQL_DATABASE
   

7. Alternatively, you can deploy using the OpenShift Console.
8. Go to the Projects > Workloads. click on add page.
9. Click Add page.
   
   
   
10. Select Databases.
    
    
11. Search for MySQL.
    
    
12. Select MySQL and click Instantiate Template.
    
    
13. Fill in the fields with the following information: 
    • Database Service Name: jogetdb
    • MySQL Connection Username: joget
    • MySQL Connection Password: joget
    • MySQL Database Name: jwdb
      
      
      
14.  Click Create.
15. Go to Workloads > Details and verify that the MySQL database deployment was successful.
    
    

Deploy Joget DX 8 using the Joget DX 8 operator

Before deploying Joget DX 8 using the Joget DX 8 operator, ensure you have previously installed the operator in your OpenShift environment. Once done, follow the steps below to deploy Joget DX 8:

1. Go to Operators > Installed Operators.
2. Select the Joget DX 8 Operator.
   
3. Click Create Instance.
   
   
4. By default, the configuration for name is example-joget and size is 1 (the number of required Joget instances).
5. Modify the values as required.
6. Click Create.
   
   The Joget DX 8 Operator will automatically start to deploy the required number of Joget DX 8 instances along with all the required resources, which should take a few minutes.
   
7. Select the created Joget name.
8. Click Resources to view the resources automatically created and managed by the Joget DX 8 Operator.
   
   
9. Select Workloads > Events to see the events as they happen.
   
   

Complete one-time Joget database set up

Before proceeding with the one-time Joget database setup, ensure you have completed the deployment steps for Joget DX on your OpenShift environment. Once the deployment is complete, follow the steps below to configure the database for Joget DX:

1. Go to Home > Projects.
2. Select the Joget DX project.
3. Click the Workloads tab and select Joget DX deployment.
   After a few minutes, you should see at least one available matching Pod.
   
   
4. Select Resources to view the created Services and Routes.
5. Copy the Location in the created Route.
   Note that is the URL to access Joget DX from an external browser.
   
6. Access the Joget DX 8 URL.
7. On the database set up page, enter the database configuration deployed earlier in OpenShift.

Database Setup:

• • Database Type: MySQL
  • Database Host: The service name of the database e.g. jogetdb
  • Database Port: 3306
  • Database Name: The configured database name e.g. jwdb
  • Database User: The configured username e.g. joget
  • Database Password: The configured password e.g. joget

8. Click the Save button.
   
   You will be redirected to the Joget DX App Center.