OmniDeq Appliance Installation using CHCTL

Recommended resource requirements

Operating System Requirement

OS	Version
Ubuntu	16+
RHEL	7.6+,8.x
CentOS	7.5+

In below table, target directory is the partition where OmniDeq needs to be installed.

For e.g. /opt

Resource	CPU	RAM	Disk space
Requirement	4 cores	16 GB	50 GB at target directory /opt

Assumptions

Linux user has privilege permissions.
Selinux is disabled on workstation. Can be verified as

sestatus

For reference visit link | Kindly visit your operating system's official guidlines to disable selinux

Docker and Docker-compose are installed. Can be verified as

docker --version
docker compose version
# OR docker-compose --version

If not, you can refer to Docker's Official Documentation.

For reference, visit the link to install the Docker and Docker-Compose.

Download the OmniDeq installation package from AWS S3

Download the singlefile.tar.gz file using the signed URL. The URL will be provided by the OmniDeq team. Please note the URL is timebound. Click on URL and the download will start automatically, else you can download it using the commandline utility like wget.
Example to download the singlefile.tar.gz using wget command

wget '<Provided-URL>' -O 'singlefile.tar.gz'  ( note the single quote in  '<Provided-URL>')

Extract singlefile.tar.gz.

Run the following command to extract the downloaded file

tar -xvzf singlefile.tar.gz

Run the following command and verify that it has created the following files in the same directory:

ls -ltr

# expected output
-rw-r--r-- 1 cloudhedge cloudhedge       5276 May 26 12:20 compose.yaml
-rw-r--r-- 1 cloudhedge cloudhedge     100852 May 26 12:20 cloudhedge-db-setup-appliance.js
-rw-r--r-- 1 cloudhedge cloudhedge       5619 May 26 12:20 chctl-compose.yaml
-rw-r--r-- 1 cloudhedge cloudhedge       5619 May 26 12:20 chctl_linux
-rw------- 1 cloudhedge cloudhedge 5244433408 May 26 12:24 containers.tar
-rw-r--r-- 1 cloudhedge cloudhedge       2643 May 26 12:24 cloudhedgeenv
-rw-rw-r-- 1 cloudhedge cloudhedge 2038630626 May 26 12:29 singlefile.tar.gz

Getting the CHCTL to work

Move CHCTL Binary (named chctl_linux) to /bin/chctl directory and provide executable permission using following command.

sudo mv chctl_linux /bin/chctl &&  chmod +x /bin/chctl

Run below command to verify if you can run chctl.

chctl --version

# expected output: version can be newer than shown
OmniDeq CLI version 2.1.0-5

Setup OmniDeq

Run the following command to install appliance:

sudo chctl setup appliance

# NOTE: By default the following command will install the appliance in /opt/appliance directory. If you want to install that at a different location, you can specify the location using --target-directory flag

Actions getting performed in the backend :

Verification of docker and docker-compose installation
Creation of targeted directory structure
Loading of required docker containers into the memory. You can skip this operation by using --skip-load-container parameter in setup command, if containers are already loaded.
Setting up database and seeding of the minimal required data. You can skip this operation by using --skip-db-setup parameter in the setup command, if DB setup is already done.

Start OmniDeq

After successfully setting up appliance, one need to start it. Start it by running the following command.

sudo chctl start appliance

Verify the appliance

sudo chctl status appliance

Post-Installation

Access the application via Google Chrome Browser as,

https://<ip_or_dns_of_the_machine>

Username : onprem@cloudhedge.io
Password : chdevrocks ( change this on first login )

Update the 'App Host' URL in the UI
On the UI, click on Settings > Configuration.
Open the tab named 'App Host'.
Paste your URL using which you have accessed the appliance UI and click on "Save URL" button as shown below::

Misc Commands

Command	Usage
`sudo chctl setup appliance`	Setup the appliance
`sudo chctl start appliance`	Start appliance
`sudo chctl stop appliance`	Stop appliance
`sudo chctl status appliance`	Check status of the appliance
`sudo chctl patch appliance`	Apply a fix to a specific service