Deployment Guide
Installation Steps
Install Docker and Docker Compose on the host operating system.
Download the deployment script deployment.sh and place it in the user home or any desired directory. This script will:
delete the pcs-deployment directory if it exists.
To execute the script, give it the execute permissions and execute it.
BASH$ chmod 755 pcs-deployment.sh $ ./pcs-deployment.sh
pcs-deployment directory has all the files required deployment
Create a database in MSSQL Server for PCS application.
Update following environment variables in config.env file inside pcs-deployment folder.
Name | Description |
---|---|
API_URL | Backend API URL, |
DB_URL | PCS database URL,
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
|
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 |
Execute following commands to allow specific ports exposed in docker-compose.
CODE$ firewall-cmd --zone=public --permanent --add-port=443/tcp $ firewall-cmd --reload
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.
Having environment configurations done, navigate to to the
pcs-deployment
directory and execute following commands:BASH$ chmod 755 install.sh $ ./install.sh
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 |
Run ./install.sh again,
Run the following command to ensure that all the components are up and running:
CODEdocker ps
Here is the docker pc output
If everything goes well, you should be able to access the application on https://FQDN
If deployment for UCCX access link https://FQDN/#/configuration-setting and select Cisco Survey Type = UCCX
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>