Valentina.petrov@genesys.com
User page
Each service per container
https://jira.genesys.com/browse/VOICEMCS-1749
Service Documentation 1. Overview: Description of the service and how the service operates for private edition.
https://all.docs.genesys.com/Draft:VM/Current/Deployment/GetStarted https://all.docs.genesys.com/Draft:VM/Current/Deployment/Overview https://intranet.genesys.com/display/MIC/Multi-Tenant+Inbound+Voice+Services+Group https://intranet.genesys.com/display/MIC/2.+Multi-Tenant+Inbound+Voice+Services And call flows: https://intranet.genesys.com/display/MIC/5.+Call+Flows+Design
2. Architecture: Logical architecture diagram of all services in the container. • Single Region Architecture: https://all.docs.genesys.com/Draft:VM/Current/Deployment/Architecture • HA/DR- Describe high level architecture for HA/DR deployment: https://all.docs.genesys.com/Draft:VM/Current/Deployment/HADR
3. Prerequisites: https://all.docs.genesys.com/Draft:VM/Current/Deployment/Planning 1. Container and helm charts: provide information about the container and helm charts in Jfrog Link to platform doc where needed when describing Jfrog process. 2. Third Party Components: Provide list of third-party components specific to each service including version number. Ideally version number should match across private edition. If prerequisites are part of the platform list (Postgres, Redis, Elastic Search, or Consul) please call out any specific options or parameters needed for the service. Link to Platform list of third-party where applicable. 3. Third Party components: Any third-party components specific to each service 1. Example 1: Postgres need to be deployed as a separate DB for the service 2. Example 2: ElasticSearch options that are specific to the service
4. *Storage Requirements:*document all storage requirements such as 1. Size 2. Type (HDD, SDD, NVMe) 3. IOPS 4. Latency sensitive (local vs netapp disk) 5. Must document any service specific requirements on the third party services including HA setup, connectivity, expected sizing and scaling models. Whatever mechanism used should be documented so the equivalent type of setup can be used by the customer on the other platforms to protect their data 6. Teams must document which data/PVC storage are critical and need to be backed up for redundancy and data protection. Customers must know what data is critical to protect.
5. Network Requirements 1. Ingress- All required properties for ingress need to be documented and specified. These include: 2. Cookies usage 3. Header requirements - client IP & redirect, passthrough 4. Session stickiness 5. Whitelisting - optional 6. TLS - optional
6. HA/DR- Most services will need to be deployed in multiple regions to provide for HA and Disaster Recovery. Services must document whether the deployment is active-active across regions or active-backup. Document how HA/DR is accomplished and document any special considerations that customers will need to do. Any cross-region bandwidth requirements also need to be documented.
7. External Connections - Any external connection from the Kubernetes cluster to other systems need to be documented. This will include connecting to GenesysCloud for Hybrid services (such as AI, WEM) as well as "Mixed" Environments where some components are still deployed as VMs. Note that Mixed Environments will mainly be for transition periods when customers are migrating from a classic premise environment to Private Edition. https://jira.genesys.com/browse/VOICEMCS-1905
8. Genesys Service Dependency: Information on dependency of the service to other service (please link to the platform doc for service dependency). Example: Auth and GWS Service should be deployed and running before deploying WWE Service
4. Configuration(for the Service) - provide information on how to configure overrides for helm chart to prepare for deployment of services Example 1: Designer - Create Access Group specific for Designer Developer, Admin https://all.docs.genesys.com/Draft:VM/Current/Deployment/Configure https://all.docs.genesys.com/Draft:VM/Current/Deployment/Provision 1. Override Helm Chart Values- link back to the platform doc that describes how to override values in the Helm charts. For each service, provide descriptions of the override values specific to that service. 2. Security Requirements- List any specific security settings required (g. setting up credentials and certificates for 3rd party services). 3. Service Configuration Requirements- List any service configurations specific to deploy, run, or manage the service. 4. Example of these can be: 1. Designer - Create Access Group specific for Designer Developer, Admin 2. Agent Setup - Create Agent Setup options to provide access to Administrator, Supervisor or Ops access 3. InfoMart - update of CTL_CONFIG table in the GIM DB to control ETL and DB maintenance behavior
5. Deployment (for the Service) – There should be specific section in the deployment of service specific to Azure KS and Openshift. Each section should include 1. Steps to deploy the service in a single region. 2. If the service support multi-region, describe steps to configure Multi Region for the service. 3. Steps or ways to validate deployment (validation URL) https://intranet.genesys.com/display/MIC/24.1+Deployment+of+Voice+Service https://all.docs.genesys.com/Draft:VM/Current/Deployment/Deploy
6. Service Operation- Monitoring and Logging 1. Metrics(compatible with Prometheus end point) for the service must be documented for use by customers to create their own monitoring dashboard (example Grafana). In addition, metrics that are important to monitor for alarming purposes need to be identified with sample thresholds that the customer should alarm on. https://all.docs.genesys.com/Draft:VM/Current/Deployment/Metrics 2. Logging Rate- Services need to ensure that generated logs do not overwhelm the system. The recommended logging rate is 100 MB per minute. Each service must document any log rotation and log sizing requirements. If services don't log to stdout (which is preferred), those services must be able to log to a PVC pointing to a Log Volume. The storage characteristics of that log volume (g. IOPS, disk size, read-write) must be specified. https://all.docs.genesys.com/Draft:VM/Current/Deployment/Logging
https://intranet.genesys.com/display/MIC/9.+Logging
Function support in Voice MCS: This is the doc as the one we have for SIP Cluster:
https://intranet.genesys.com/pages/viewpage.action?pageId=210700138 https://docs.genesys.com/Documentation/SIPC/latest/Solution/UnsupportedFeatures
PE HLA: https://intranet.genesys.com/pages/viewpage.action?pageId=176430803
Tenant: https://intranet.genesys.com/display/MIC/Voice+Tenant%3A+Private+Edition