Jump to: navigation, search

Installing BDS - Docker Compose

Before you install the Billing Data Server (BDS), ensure that your environment meets the minimum System Requirements.

During BDS deployment, several directories on the deployment host are automatically created on the volume that is mounted into the container, as follows:

Directory Contents Mapping
Directories created during deployment
./cloudbilling-prem.local/etc Configuration file, BDS passwords, encryption keys, configuration dump, and the .env (environment variables) file. /genesys/etc
./cloudbilling-prem.local/templates All BDS configuration templates. /genesys/templates
./cloudbilling-prem.local/log All log files, statistic file, concurrent and enabled reports. /genesys/log
./cloudbilling-prem.local/data Persistent non-configuration (extracted) data. /genesys/data

Install BDS using the Setup script

The BDS installation script (deploy_prem_install.sh) helps you to easily install BDS on the premise host.

Procedure: Install BDS

Purpose: Use the steps in this procedure to deploy BDS.


  • You have downloaded the installation package to a local folder on the machine where you will deploy the software.
  • The local folder that contains the BDS installation files should allow users with genesys owner and group owner permissions to access the files.
  • Create a user by name genesys and provide sudo privileges. Use the following command:
    sudo useradd genesys
    sudo usermod -aG wheel genesys
    sudo usermod -aG docker genesys
    su – genesys


  1. Log in to the premise host as a genesys user.
  2. If you are installing BDS in the default installation directory (/home/genesys), skip this step. If you are installing BDS in the custom directory, create one by running the following commands:
    mkdir /<local directory>  
    sudo chown -R genesys:genesys /<local directory>
  3. Save the installation package into the default /home/genesys directory or the custom directory created in Step-2.
  4. Execute the following commands to list the contents of the installation package:
    1. cd <local directory>
      Where <local directory> is the location (default or custom directory) where you saved the installation package.
    2. ls
      The output should be similar to the following list:
    IP_BDS_PRR_v10000030009b1_ENU_linux.tar.gz  bds-config-100.0.003+0009-pe.tgz  bds-cronjob-100.0.003+0009.tgz  bds-grafana-dashboard-100.0.003+0009.tgz  cloudbilling  ip_description.xml  read_me.html
  5. Execute the following command to untar the deployment script, saving it into the current folder:
    tar -xf IP_BDS_PRR_v<VERSION>b1_ENU_linux.tar.gz devbox/deploy_prem_install.sh
  6. Execute the following command to start the script:
    bash ./devbox/deploy_prem_install.sh
    Beginning with release, BDS supports installing the software in an arbitrary directory instead of a default directory. To change to the custom installation directory of your choice, type y when you are prompted with the question, Do you want to change it? [y/N]. You can then type the new preferred directory. If you want to continue using the default directory, you can either press Enter or type n. For more details, refer the following sample code.
    $ ./devbox/deploy_prem_install.sh
    Current base directory is /opt/genesys
    Do you want to change it? [y/N] y
    Add new directory without trailing slash: /tmp/genesys/bds
    New base directory: /tmp
    The installation script deploys the software, and adds the Docker image to the local registry.
  7. Execute the following command to check the uploaded images:
    docker images | egrep ''^cloudbilling/scripts''
    cloudbilling/scripts                                         12b2cc7f9a05        1 min ago         1.46GB
    cloudbilling/scripts                                         prem                    12b2cc7f9a05        1 min ago         1.46GB
    Installation is now complete. Images are assigned an ID, for example, 12b2cc7f9a05. Any images from previous installations are also displayed.
  8. Execute the following command to list the installed files:
    ls <directory_name>
    Where, <directory_name> is the exact installation path where BDS is installed; it could be the default /home/genesys directory or the custom directory.
    The output should match the following:
    cloudbilling-prem cloudbilling-prem.local cloudbilling-prem.sh
  9. Execute the following command to start the BDS application in configuration mode and log in as a genesys user:
    ./cloudbilling-prem.sh config
    Note: If BDS is installed in a custom directory, make sure to manually update the custom directory path in the BASEDIR variable in ./cloudbilling-prem.sh.
    Errors sometimes appear at this point, but do not affect the installation, so you can ignore them. On the successful execution of the script, the output should be similar to the following and you can log in to the container:
    Waiting for init finalization...
    cat: /tmp/status: No such file or directory
    Waiting for init finalization...
    cat: /tmp/status: No such file or directory
    Waiting for init finalization...
    Use ./brsctl.py tool to view/update current configuration
    [genesys@bda75afbc250 brs]$

Next Steps

Complete the steps on the following pages:

If you're upgrading to a later release, refer to the Upgrade procedure.

This page was last edited on July 13, 2022, at 20:07.
Comments or questions about this documentation? Contact us for support!