Revision as of 17:23, June 30, 2020 by Mwest (talk | contribs) (Update with the copy of version: 9.0.0DRAFT)
Jump to: navigation, search

Deployment of Web Services and Applications version 9.0.002.57 in Kubernetes

Prerequisites

For hardware, software, Workspace Web Edition, and Gplus Adapter for Salesforce Requirements requirements, refer to Prerequisites. Also, ensure your environment has access to docker.io/library. If internet access is not available, manually load the following public container images to the Docker registry:

Configuring Web Services and Applications

To configure Web Services and Applications, refer to Configuring Web Services and Applications.

Configuring Security

Transport Layer Security (TLS) is available only in Kubernetes-based deployment. For more details, refer to Configuring Security.

Deploying GWS

  1. Unpack the installation package (e.g. IP_HTCCDev_9000253b1_ENU_dockerlinux.zip file) and navigate to the ip folder which contains the following files:
    • gws-microservices.tgz
    • exported microservices in tar.gz format (e.g. gws-platform-configuration_9.0.000.42.tar.gz)
  2. Unpack the gws-microservices.tgz archive to the /opt/genesys/gws directory. 
    mkdir -p /opt/genesys/gws
tar xvf gws-microservices.tgz -C /opt/genesys/gws
  3. Populate Docker images (presented in *.tar.gz format) from the installation package to your corporate docker registry. 
    for i in *.tar.gz; do /opt/genesys/gws/kubernetes/bin/push-containers-to-local-registry.sh $i %corporate_registry_address% --push; done
    Important
    This script must be run with Docker-capable privileges and you must login to your registry before pushing.
  4. Edit the following values in the /opt/genesys/gws/kubernetes/parameters.yaml file:

    Variable

    Default Value

    Description

    REGISTRY

    Corporate docker registry, which is accessible from all Kubernetes nodes.

    GWS_DOMAIN

    onpremiselab.com

    The host name that will be used by Ingress for routing rules creation. Note: If ingressTlsEnable is true, the deployment will be accessible though https://GWS_DOMAIN/ui/wwe/. If not, the deployment will be accessible through http://GWS_DOMAIN/ui/wwe/.

    LOCATION

    /USW2

    Location of Configuration Server.
    Note: The GWS cluster application object (typically named CloudCluster) in the Configuration Database must be configured with a specified location for each connection to Genesys servers, such as Configuration Server, Stat Server, T-Server, and so on. This setting defines which server instance is visible by the GWS node based on its position in the GWS cluster.

    CS_USERNAME

    default

    Username to connect to Configuration Server.

    CS_PASSWORD

    password

    Password to connect to Configuration Server.

    CS_APPNAME

    GWS_App

    Application name to connect to Configuration Server. For details, refer to Creating GWS Client Application.

    CS_ADDRESS

    127.0.0.1

    Address of the primary Configuration Server.

    CS_PORT

    8888

    Port of the primary Configuration Server.

    CS_BACKUP_ADDRESS

    127.0.0.1

    Address of the backup Configuration Server.

    CS_BACKUP_PORT

    8888

    Port of the backup Configuration Server.

    CS_TENANT

    Environment

    Configuration Server's tenant name.

    GWS_REDIRECT_URI

    http://onpremiselab.com

    Specifies an array by using double quotes and a comma to separate values with no white space in between. Used as part of OAuth authentication flow.

    ingressTlsEnable

    false

    Enables Ingress secured endpoint configuration for Web Services and Applications.
    Note: Refer to Configuring Security for more details.

    POST_DEPLOY_UPDATE

    false

    Enables the post deployment procedure, which creates the default Genesys environment, contact center and OAuth client.
    Note: If POST_DEPLOY_UPDATE is set to true, GWS_DOMAIN is used when the contact center domain is created, and agents should provide domain information at login (GWS_DOMAIN\%CfgPerson's username%).

    DEPLOY_POSTGRES

    false

    Enables the PostgreSQL deployment procedure in the same namespace as Web Services and Applications.
    Note: For lab deployments only.

    POSTGRES_ADDR

    postgres

    Address of the PostgreSQL installation.
    Note: If DEPLOY_POSTGRES is set to true, the default value is used.

    POSTGRES_DB

    gws_environment

    PostgreSQL database name.
    Note: If DEPLOY_POSTGRES is set to true, the default value is used.

    POSTGRES_USER

    gws_env_master

    PostgreSQL user, which can be used to connect to database.
    Note: If DEPLOY_POSTGRES is set to true, the default value is used.

    POSTGRES_PASS

    gws_env_password

    PostgreSQL user password.
    Note: If DEPLOY_POSTGRES is set to true, the default value is used.

    DEPLOY_REDIS

    false

    Enables the Redis cluster deployment procedure in the same namespace as Web Services and Applications.
    Note: For lab deployments only.

    REDIS_ADDR

    redis-cluster:6379

    Address of the Redis cluster installation.
    Note: If DEPLOY_REDIS is set to true, the default value is used.

    DEPLOY_ELASTICSEARCH

    false

    Enables ElasticSearch cluster deployment procedure in same namespace as Web Services and Applications.
    Note: For lab deployments only.

    ELASTICSEARCH

    elasticsearch:9200

    Address of the Elasticsearch cluster installation.
    Note: If DEPLOY_ELASTICSEARCH is set to true, the default value is used.

  5. Navigate to /opt/genesys/gws/kubernetes.
  6. Invoke Helm: 
    helm install gws gws/ -n gws-service -f gws-versions.yaml -f parameters.yaml

    Where:

    • gws is the name of deployment.
    • gws/ is the helm chart directory.
    • -n gws-service is the Kubernetes namespace name to deploy to.
    • -f gws-versions.yaml is the config file where versions of containers are defined.
    • -f parameters.yaml is the config file where deployment parameters are defined.
  7. Wait until the Helm-deployed Web Services and Applications and Kubernetes cluster start all the requested containers.


Verification

Use the following links to get the expected versions of the Web Services and Applications components and verify they are correct:

Service

Verification URLs

Authentication Service

http://GWS_DOMAIN/auth/v3/version

Configuration Service

http://GWS_DOMAIN/configuration/v3/version

Environment Service

http://GWS_DOMAIN/environment/v3/version

Data Collector Service

http://GWS_DOMAIN/datacollector/v3/version

Workspace Web Edition

http://GWS_DOMAIN/ui/wwe/index.html

Comments or questions about this documentation? Contact us for support!