cQube_Base Installation

Prerequisites to install cQube_Base:

• ubuntu 18.04 (supported)
• 32GB of System RAM (minimum requirement)
• 8 core CPU (minimum requirement)
• Domain name (with SSL)
• 1 TB Storage

Reverse proxy rules (public routing)

The following ports have to be configured in the nginix server with reverse proxy:

• Port 4200 should be proxied to the '/'
• Port 8080 should be proxied to the '/auth'
• Port 3000 should be proxied to the '/api'
• Port 8000 should be proxied to the '/data'

Nginx - cQube server firewall configuration

• Port 4200 should be open from nginx to the cQube server
• Port 8080 should be open from nginx to the cQube server
• Port 8000 should be open from nginx to the cQube server

Openvpn - cQube server firewall configuration

• Port 9000 should be open from openvpn to the cQube server
• Port 4201 should be open from openvpn to the cQube server

Reverse proxy rules (internal routing)

The following ports have to be configured in the nginix # server with reverse proxy:

• Port 4201 should be proxied to the '/'
• Port 3001 should be proxied to the '/api'

Nginx - cQube server firewall configuration

• Port 4201 should be open from nginx to the cQube server
• Port 3001 should be open from nginx to the cQube server

Openvpn - cQube server firewall configuration

• Port 80 should be open from openvpn to the nginx server

Note: For Installation: follow the below steps directly, for upgradation follow the Upgradation: steps mentioned in the last section.

Installation Steps:

• Open Terminal

• Navigate to the directory where cQube_Base has been downloaded or cloned

  cd cQube_Base/
  git checkout maser
  git pull
  
  

• Copy the config.yml.template to config.yml

  cp config.yml.template config.yml
  

• Edit using nano config.yml

• If you are opting for mode_of_installation as localhost then storage_type should be local. Copy the local_storage_config.yml.template to local_storage_config.yml

  cp local_storage_config.yml.template local_storage_config.yml
  

• If you are opting for mode_of_installation as public then storage_type should be s3. Copy the aws_s3_config.yml.template to aws_s3_config.yml

  cp aws_s3_config.yml.template aws_s3_config.yml
  

• Edit using nano aws_s3_config.yml

• Fill the configuration details for the below mentioned list in config.yml (* all the values are mandatory)

• cQube_Base installation process installs the components in a sequence as mentioned below:

  • Installs Ansible
  • Installs Openjdk
  • Installs Python, pip and flask
  • Installs Postgresql
  • Installs NodeJS
  • Installs Angular and Chart JS
  • Installs Apache Nifi
  • Installs Keycloak
  • Installs Grafana
  • Installs Prometheus and node exporter

• Save and Close the file

• For more information to configure the weights & columns for udise/infrastucture, please refer operational document.

• Update the diksha parameters(api_url,token,encryption key,dataset name channel_id,org_id) in the development/python/cQube-raw-data-fetch-parameters.txt

• Give the following permission to the install.sh file

  chmod u+x install.sh
  

• Install cQube using the non-root user with sudo privilege

• Configuration filled in config.yml will be validated first. If there is any error during validation, you will be prompted with the appropriate error message and the installation will be aborted. Refer the error message and solve the errors appropriately, then re-run the installation script sudo ./install.sh

• Start the installation by running install.sh shell script file as mentioned below:

  sudo ./install.sh
  

Once installation is completed without any errors, you will be prompted the following message. **CQube installed successfully!!**

cQube_Base Upgradation:

Upgradation Steps:

• Open Terminal

• Navigate to the directory where cQube has been downloaded or cloned

  cd cQube_Base/
  git checkout master
  git pull
  

• Copy the config.yml.template to config.yml cp config.yml.template config.yml

• If you are opting for mode_of_installation as localhost then storage_type should be local. Copy the local_storage_config.yml.template to local_storage_config.yml

  cp local_storage_config.yml.template local_storage_config.yml
  

• If you are opting for mode_of_installation as public then storage_type should be s3. Copy the aws_s3_config.yml.template to aws_s3_config.yml

  cp aws_s3_config.yml.template aws_s3_config.yml
  

• This script will update the below cQube components:

  • Creates & Updates table,sequence,index in postgresql database
  • Updates NodeJS server side code
  • Updates Angular and Chart JS client side code
  • Updates & configure Apache Nifi template
  • Updates & configure Keycloak

• Fill the configuration details in config.yml (* all the values are mandatory, make sure to fill the same configuration details which were used during installation)

• Edit using nano config.yml

• Save and Close the file

• Give the following permission to the upgrade.sh file

  chmod u+x upgrade.sh
  

• Run the script to update cQube using the non-root user with sudo privilege Start the upgradation by running upgrade.sh shell script file as mentioned below:

  sudo ./upgrade.sh
  

Configuration filled in config.yml will be validated first. If there is any error during validation, you will be prompted with the appropriate error message and the upgradation will be aborted. Refer the error message and solve the errors appropriately. Restart the upgradation process sudo ./upgrade.sh

Once upgradation is completed without any errors, you will be prompted the following message. **CQube upgraded successfully!!**