Breadcrumbs

Deployment Guide

Solution Prerequisites

Following are the solution setup prerequisites.

Software requirements


Minimum requirement

OS

Red Hat 8,9, Centos 7, 8, Debian 9,10,11

MSSQLServer

2016,17

Docker CE

20+

Docker compose

2.15.1

Hardware requirements


Minimum requirement

CPU

4 cores

RAM

4 GB

Disk

300 GB

NICs

1 NIC per VM


On this page

Installation Steps

  1. Install Docker and Docker Compose on the host operating system.

  2. Download the deployment script deployment.sh and place it in the user home or any desired directory. This script will:

    1. delete the pcs-deployment directory if it exists.

  3. To execute the script, give it the execute permissions and execute it. 

    Bash
    $ chmod 755 pcs-deployment.sh
$ ./pcs-deployment.sh


  4. pcs-deployment directory has all the files required deployment

  5. Create a database in MSSQL Server for PCS application.

  6. Update following environment variables  in config.env file inside pcs-deployment folder.

Name

Description

API_URL

Backend API URL,

https://PCS-FQDN/api, Replace the PCS-FQDN with PCS machine FQDN

DB_URL

PCS database URL,

jdbc:sqlserver://192.168.1.200:1433;databaseName=PCS

Append ;integratedSecurity=true;authenticationScheme=NTLM to the DB_URL if Windows authentication is required. The Sql Server and PCS machine both should be on same domain.

DB_USER

PCS database username

DB_PASSWORD

PCS database password

CISCO_TYPE

UCCE or UCCX

UCCE_DB_UR

UCCE database URL, only required for UCCE

jdbc:sqlserver://192.168.1.89:1433;databaseName=uc12_awdb

UCCE_DB_USER

UCCE database user, only required for UCCE

UCCE_DB_PASSWORD

UCCE database password, only required for UCCE

UCCX_FQDN

UCCX FQDN, only required for UCCX

CCX IP or FQDN

UCCX_USER

CCX Admin username

UCCX_PASSWORD

CCX Admin user password

  1. Execute following commands to allow specific ports exposed in docker-compose. 

    $ firewall-cmd --zone=public --permanent --add-port=443/tcp

 $ firewall-cmd --reload


  2. Default self signed SSL certificates are provided with build. If it needs to be changed with domain signed certificate then replace server.crt(SSL certificate) and server.key (SSL key) in /root/pcs-deployment/docker/certificates folder.

  3. Having environment configurations done,  navigate to to the pcs-deployment directory and execute following commands: 

    Bash
    $  chmod 755 install.sh
$ ./install.sh


  4. Configure keycloak

  5. Update the following variables in pcs-deployment/docker/config.env

Name

Description

KEYCLOAK_REALM_NAME

Keyclaok realm created in step 10

KEYCLOAK_CLIENT_ID

Keyclaok client id created in step 10

KEYCLOAK_CLIENT_SECRET

Keyclaok client secret created in step 10

KEY_CLOAK_ADMIN

Keycloak admin user’s username

KEY_CLOAK_ADMIN_PASSWORD

Keycloak admin user’s password

  1. Run ./install.sh again,

  2. Run the following command to ensure that all the components are up and running:  

    docker ps

    Here is the docker pc output

    image-20240918-070043.png


  3. If everything goes well, you should be able to access the application on https://FQDN

  4. If deployment for UCCX  access link https://FQDN/#/configuration-setting and select  Cisco Survey Type = UCCX

  5. Once the application is up and running, configure the PCS CUIC Reports.


TroubleShooting

Logs for each container are available in files as well as within docker daemon. To see the logs for any container, execute docker ps and get the id of the container. Use that id to see the logs using docker logs <container_id>