Deployment Guide - Cisco Sync Service
Step 1: Clone the Repository
clone the repository using the following command.
git clone -b CX-4.9.3_f-CIM-28813 https://efcx:RecRpsuH34yqp56YRFUb@gitlab.expertflow.com/cim/cim-solution.git CX-4.9.3_f-CIM-28813
Change the directory.
cd CX-4.9.3_f-CIM-28813/kubernetes
Step 2: Update the Ingress
Open the helm/CiscoSyncService
/values.yaml
file and update the ingressRouter
vi helm/CiscoSyncService/values.yaml
Step 3: Change Host Aliases:
In values.yaml
, update the hostnames
and ip
of current Cisco Finesse instance under hostAliases
.
hostAliases:
- ip: "192.168.1.33"
hostnames:
- "uccx12-5p.ucce.ipcc"
Step 4: Update the Configurations
In values.yaml
we have extraEnvVars
containing all the configurations of qm-sync-service, change them according to your configurations:
Configuration | Value |
---|---|
REALM | value of REALM of Keycloak instance. in our case its |
AUTH_SERVER_URL | Keycloak Instance URL e.g: |
RESOURCE | The Keycloak client in our REALM that we are going to use, generally its |
SECRET | Client Secret, general secret used for Keycloak instances: |
CLIENT_ID | The Keycloak client in our REALM that we are going to use, generally its |
CLIENT_DB_ID | Client Secret, general secret used for Keycloak instances: |
USERNAME_ADMIN | Admin user credentials in our target realm. i.e |
PASSWORD_ADMIN | Admin user credentials in our target realm. i.e |
EF_SERVER_URL | URL of Unified-Admin instance where we want to sync teams. e.g: |
FINESSE_USERNAME | Administrator Username of Finesse instance |
FINESSE_PASSWORD | Administrator Password of Finesse instance |
FINESSE_URL | Finesse Instance URL. e.g: |
SYNC_AGENT_PASSWORD | Password assigned to each user when created/synced on Keycloak Side. |
PORT | PORT on which you want to run QM Sync Service. e.g |
Step 5: Update the Ingress Configuration in CiscoSyncService values.yaml
Disable the ingress by updating the following values:-
ingress:
## @param ingress.enabled Set to true to enable ingress record generation
##
enabled: false
Step 6: Deploy the Cisco Sync Service Helm Chart
Deploy the helm chart using the following command
helm upgrade --install --namespace expertflow cisco-sync-service --debug --values helm/CiscoSyncService/values.yaml helm/CiscoSyncService
Check the pods by running the following command
kubectl get pods -n expertflow | grep cisco-sync-service
Step 7: Call the Cisco Sync Service:
Once the deployment is complete, you can call this API to start the sync process of Users and Teams to CX:
https://${FQDN}/cisco-sync-service/api/v1/sync