CHAI™ Appliance Installation using CHCTL¶

Recommended Resource Requirements¶

Operating System Requirement¶

OS	Version
RHEL (Recommended)	7.6+, 8.x, 9.x
Ubuntu	16+

Red Hat Enterprise Linux (RHEL) is recommended because it utilizes the XFS file system, which optimizes application efficiency and delivers superior performance.

If you are using a different Linux distribution, please ensure you configure a dedicated XFS-formatted partition with at least 100 GB of available storage.

Note: In the table below, target directory is the partition where CHAI™ needs to be installed (for example: /opt).

Hardware Requirements¶

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

ℹ️ NOTE: For portfolios with more than 1,000 target hosts or longer NetWatch runs, 8 CPU cores and 32 GB of RAM is a good-to-have configuration for optimal performance. CHAI™ will continue to work on the standard configuration listed above.

Prerequisites¶

Assumptions¶

Linux User Privileges: - Linux user has privilege permissions

SELinux Configuration: - SELinux is disabled on workstation

Can be verified as:

sestatus

For reference visit link | Kindly visit your operating system's official guidelines to disable SELinux

Docker and Docker-Compose: - Docker and Docker-Compose are installed

Can be verified as:

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

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

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

Installation Steps¶

Step 1: Download the CHAI™ Installation Package from AWS S3¶

Download the singlefile.tar.gz file using the signed URL. The URL will be provided by the CHAI™ team. Please note the URL is time-bound. Click on URL and the download will start automatically, else you can download it using the command-line utility like wget.

Example to download the singlefile.tar.gz using wget command:

wget '<Provided-URL>' -O 'singlefile.tar.gz'

Note: Keep the single quotes around the URL as shown: '<Provided-URL>'

Step 2: 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 -ltrh

Expected output:

-rw-r--r-- 1 cloudhedge cloudhedge  13M Apr 15 11:11 chaik8s-x64
-rw-r--r-- 1 cloudhedge cloudhedge  14M Apr 27 10:44 chctl_linux
-rw-r--r-- 1 cloudhedge cloudhedge  47M May  5 11:11 chai-mcp-server-linux
-rw-r--r-- 1 cloudhedge cloudhedge 147M May 25 13:57 chai-x64
-rw-r--r-- 1 cloudhedge cloudhedge 213M Jul 13 17:51 chai-report-builder.tar.gz
-rw-r--r-- 1 cloudhedge cloudhedge 6.6K Aug 31 13:40 compose.yaml
-rw-r--r-- 1 cloudhedge cloudhedge 134K Aug 31 13:40 cloudhedge-db-setup-appliance.js
-rw-r--r-- 1 cloudhedge cloudhedge 6.9K Aug 31 13:40 chctl-compose.yaml
-rw------- 1 cloudhedge cloudhedge 7.1G Aug 31 13:45 containers.tar
-rw-r--r-- 1 cloudhedge cloudhedge 3.6K Aug 31 13:45 cloudhedgeenv
-rw-rw-r-- 1 cloudhedge cloudhedge 2.9G Aug 31 13:51 singlefile.tar.gz
-rw-r--r-- 1 cloudhedge cloudhedge 5.3K Sep 28 16:15 indexesToBeApplied.js

Step 3: Getting the CHCTL to Work¶

Move CHCTL Binary (named chctl_linux) to /bin/chctl directory and provide executable permission:

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

Run below command to verify if you can run chctl:

chctl --version

Expected output (version can be newer than shown):

CHAI CLI version 2.1.8

Step 4: Setup CHAI™¶

Run the following command to install appliance:

sudo chctl setup appliance

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

Actions Performed in the Backend¶

The setup command performs the following actions:

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 CHAI™¶

Step 5: Start the Appliance¶

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

sudo chctl start appliance

Step 6: Verify the Appliance¶

sudo chctl status appliance

Post-Installation¶

Access the Application¶

Access the application via any Web Browser (Google Chrome is Recommended):

https://<ip_or_dns_of_the_machine>

Login using default username and password:

Username: onprem@cloudhedge.io
Password: chdevrocks

Important: Change this password on first login for security purposes.

Update the App Host URL¶

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:

Host URL

Enable DART Cache¶

On the UI, click on Settings → Configuration
Open the tab named Appliance Preferences
Click on Edit button and click on Use internal document cache for DART checkbox
Click on Update button.

Miscellaneous 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
`sudo chctl smoke-test`	Prove a freshly installed appliance works: login, add sample vault, add sample host (creates a project), then list projects and hosts