How to Install the Cloudmon Controller (Reference Guide)

Cloudmon Installation Reference Guide

Installation and Deployment

Cloudmon Installation Reference Guide

Install the Cloudmon Controller using the Cloudmon installation script, register it, and verify that all required services are running successfully using the Cloudmon CLI.

Overview

Cloudmon can be deployed as a single-host installation for small environments, or as a distributed installation where the Controller and database are hosted on separate servers for production use. The sections below walk through both paths, from downloading the installation script to verifying that the deployment is healthy.

For High Availability (HA) deployments, contact the Cloudmon Support team at support@cloudmon.ai.

Before You Begin

Confirm the following prerequisites are in place before starting the installation.
RequirementDetails
Server sizing and OSVerify that the server meets the requirements specified in System Requirements.
Deployment modelDetermine whether you are deploying Cloudmon as Single Network, Distributed, DMZ, or MSP. See Deployment Models.
Root privilegesRoot or sudo access is required to run the installation script.
Internet accessInternet connectivity is required because the installation script downloads the required packages and dependencies.
Note: For environments without internet access, contact the Cloudmon team for the applicable offline installation package.

Install Cloudmon

Warning
A single-host deployment is intended for lab and small environments. For production deployments, use a distributed deployment where the Controller and database are hosted separately.

      Option-1: Single-Host Deployment 

Linux Terminal
$ curl -fsSL https://repo.cloudmon.ai/scripts/install.sh | sudo bash  # This downloads the Cloudmon CLI and allows you to run the installer.
$ cloudmon install all  # This sets up Cloudmon components completely on the same server.
Follow the prompts displayed to complete the installation.

      Option-2: Distributed Deployment  

            Step-1: Install the Database

 The script installs the required database components and configures the default database settings.

Important

Install and configure the database before installing the Controller. The Controller installation requires a reachable database.

Linux Terminal
$ curl -fsSL https://repo.cloudmon.ai/scripts/install.sh |  sudo bash  # This downloads the Cloudmon CLI and allows you to run the installer.
$ cloudmon install database # prompts for database credentials and configures the database using the provided credentials
            Step-2: Install the Controller

On the Controller server, download the installation script if it is not already available, then run:

Linux Terminal
$ curl -fsSL https://repo.cloudmon.ai/scripts/install.sh | sudo bash  # This downloads the Cloudmon CLI and allows you to run the installer.
$ cloudmon install controller # This installs the Cloudmon controller and prompts for the database credentials you configured earlier.
After the installation finishes, verify the Controller:
Linux Terminal
$ cloudmon status
All required services should show a running status. If a service is not running, restart Cloudmon and check the status again:
Linux Terminal
$ cloudmon restart
$ cloudmon status

 Register the Controller

  1. Open the following URL in a browser, replacing <controller-ip> with the IP address or hostname of your Controller:  https://<controller-ip>
  2. Sign in with the user name and password shown at the end of the installation. The password is generated randomly during the installation.
  3. Complete the registration form with the requested details
  4. Select Register to complete registration. Refer to: Controller Registration
  5. Licensing is applied after registration. Refer to: License Activation
Important

The email address entered during registration becomes the login username and has to be valid.

Verify the Installation

After installing all required components, perform the following checks on each host.

Verification Commands

Linux Terminal
$ cloudmon check # Cloudmon Health Check
$ cloudmon version # current version of Cloudmon

Installation Verification Checklist

The installation is considered successful when the following conditions are met: 

 cloudmon check reports the system and required services as healthy.

  cloudmon status shows the required services as running.

The Controller is accessible usinghttps://<controller-ip>  and the login page opens successfully.

The Cloudmon license is successfully applied.

Troubleshooting

Common Installation and Deployment issue

The following table lists common installation and deployment issues.
IssuePossible CauseRecommended Action
Installation fails partway throughMissing prerequisite or database was not installed before the ControllerRun cloudmon check. Review the installation logs using cloudmon log server cloudmon.log.

See
Where can I find the logs if the installation fails?
502 Bad GatewayIncorrect database credentials or Controller service is not runningVerify the database configuration in /usr/local/cloudmon/server/.env, run cloudmon restart, and verify using cloudmon status.
Default NGINX welcome page is displayedNGINX is serving its default site instead of CloudmonRun cloudmon show open-ports, remove /etc/nginx/sites-enabled/default if applicable, and reload NGINX.

See
Cloudmon UI shows "Welcome to nginx"
A service is stopped or repeatedly failsService failed to start or crashed after a configuration changeRun cloudmon status, followed by cloudmon restart. If the issue persists, enable debug logging using cloudmon debug enable server and check the logs using cloudmon log server cloudmon.log.
Disk usage is increasing rapidlyData retention, insufficient disk capacity, or debug logging is enabledCheck debug logging using cloudmon debug status server. Disable debug logging when it is no longer required.

See
Resolve disk space issues

Need Help?

If you are still experiencing issues after following the troubleshooting steps, raise a support request through the Cloudmon support portal or contact the Cloudmon Support team at support@cloudmon.ai.

When contacting Support, include:

  • Cloudmon version
  • Affected component
  • Error message or screenshot
  • Relevant cloudmon check output
  • Relevant Cloudmon logs
  • Upload folder name, if logs have been uploaded