Difference between revisions of "PEC-REP/Current/GIMPEGuide/DeployGCA"

From Genesys Documentation
Jump to: navigation, search
(Published)
Line 6: Line 6:
 
|Section={{Section
 
|Section={{Section
 
|alignment=Vertical
 
|alignment=Vertical
−
|structuredtext={{NoteFormat|Make sure to review {{Link-SomewhereInThisVersion|topic=PlanningGCA}} for the full list of prerequisites required to deploy GCA.|}}
+
|structuredtext={{NoteFormat|Make sure to review {{Link-SomewhereInThisVersion|topic=PlanningGCA}} for the full list of prerequisites required to deploy GCA, including creation of the required S3-compatible storage (see {{Link-SomewhereInThisVersion|manual=GIMPEGuide|topic=PlanningGSP|anchor=S3|display text=Create object storage}}).|}}
 
|Status=No
 
|Status=No
 
}}{{Section
 
}}{{Section
 
|sectionHeading=Set up your environment
 
|sectionHeading=Set up your environment
 
|alignment=Vertical
 
|alignment=Vertical
−
|structuredtext=
+
|structuredtext=To prepare your environment for the deployment, complete the steps in this section for:
 +
* [[{{FULLPAGENAME}}#PrepOpenShift|OpenShift]]
 +
* [[{{FULLPAGENAME}}#PrepGKE|GKE]]
 +
 
 +
{{AnchorDiv|PrepOpenShift}}
 +
===Environment setup for OpenShift===
 
# Log in to the OpenShift cluster from the remote host via CLI:
 
# Log in to the OpenShift cluster from the remote host via CLI:
 
#: <source lang="text">oc login --token <token> --server <URL of the API server></source>
 
#: <source lang="text">oc login --token <token> --server <URL of the API server></source>
 
# (Optional) Check the cluster version:
 
# (Optional) Check the cluster version:
 
#: <source lang="text">oc get clusterversion</source>
 
#: <source lang="text">oc get clusterversion</source>
−
# If the cluster administrator has not already done so, create a new project for GIM:
+
# If the cluster administrator has not already done so, create a new project for GCA:
−
#: <source lang="text">oc new-project gim</source>
+
#: <source lang="text">oc new-project gca</source>
−
# Set the default project to GIM:
+
# Set the default project to GCA:
−
#: <source lang="text">oc project gim</source>
+
#: <source lang="text">oc project gca</source>
 
# Create a secret for docker-registry in order to pull images from the Genesys JFrog repository:
 
# Create a secret for docker-registry in order to pull images from the Genesys JFrog repository:
−
#: <source lang="text">oc create secret docker-registry <repository secret name> --docker-server=<repository> --docker-username=<username> --docker-password=<password/API key> --docker-email=<email id> -n gim</source>
+
#: <source lang="text">oc create secret docker-registry <repository secret name> --docker-server=<repository> --docker-username=<username> --docker-password=<password/API key> --docker-email=<email id> -n gca</source>
 +
 
 +
{{AnchorDiv|PrepGKE}}
 +
===Environment setup for GKE===
 +
# Ensure that the gcloud CLI and required Helm version are installed on the host where you will run the deployment.
 +
# Log in to the GKE cluster from the host where you will run the deployment:
 +
#: <source lang="text">gcloud container clusters get-credentials <cluster></source>
 +
# If the cluster administrator has not already done so, create a new namespace for GCA:
 +
## Create a .json file specifying the namespace metadata. For example, '''create-gca-namespace.json''':
 +
##: <source lang="bash">{
 +
  "apiVersion": "v1",
 +
  "kind": "Namespace",
 +
  "metadata": {
 +
    "name": "gca",
 +
    "labels": {
 +
      "name": "gca"
 +
    }
 +
  }
 +
}</source>
 +
## Execute the following command to create the namespace:
 +
##: <source lang="text">kubectl apply -f apply create-gca-namespace.json</source>
 +
## Confirm namespace creation:
 +
##: <source lang="text">kubectl describe namespace gca</source>
 +
# Create a secret for docker-registry in order to pull images from the Genesys JFrog repository:
 +
#: <source lang="text">kubectl create secret docker-registry <repository secret name> --docker-server=<repository> --docker-username=<username> --docker-password=<password/API key> --docker-email=<email id> -n gca</source>
 
|Status=No
 
|Status=No
 
}}{{Section
 
}}{{Section
−
|sectionHeading=Deploy in OpenShift
+
|sectionHeading=Deploy
 
|alignment=Vertical
 
|alignment=Vertical
 
|structuredtext=Execute the following command to install GCA:
 
|structuredtext=Execute the following command to install GCA:
Line 32: Line 61:
 
|Status=No
 
|Status=No
 
}}{{Section
 
}}{{Section
−
|sectionHeading=Validate the deployment in OpenShift
+
|sectionHeading=Validate the deployment
 
|alignment=Vertical
 
|alignment=Vertical
−
|structuredtext={{Notices|Notice=PEComingSoon}}
+
|structuredtext=You can consider GCA deployment successful when the pod is running and in ready state. Genesys Info Mart does not report the ready state for pods until internal health checks are satisfied and the pods are operational. You can use standard <tt>kubectl</tt> commands like <tt>list</tt> and <tt>get</tt> to verify the successful deployment and readiness status of the Kubernetes objects, including connection to the database.
 +
 
 +
However, from a functional point of view, you cannot validate deployment of GCA unless GSP and GIM have been deployed as well. Do not expect consistent data until all three Genesys Info Mart services are up and running. For more details about functional checks you can perform to validate GCA deployment, see the equivalent validation section on the {{Link-SomewhereInThisVersion|manual=GIMPEGuide|topic=DeployGSP|anchor=Validate}} page.
 
|Status=No
 
|Status=No
 
}}
 
}}
 
|PEPageType=45d1441f-dc69-4a17-bd47-af5d811ce167
 
|PEPageType=45d1441f-dc69-4a17-bd47-af5d811ce167
 
}}
 
}}

Revision as of 19:53, March 30, 2022

This topic is part of the manual Genesys Info Mart Private Edition Guide for version Current of Reporting.

Learn how to deploy GIM Config Adapter (GCA).

Important
Make sure to review Before you begin GCA deployment for the full list of prerequisites required to deploy GCA, including creation of the required S3-compatible storage (see Create object storage).

Set up your environment

To prepare your environment for the deployment, complete the steps in this section for:

Environment setup for OpenShift

  1. Log in to the OpenShift cluster from the remote host via CLI: 
    oc login --token <token> --server <URL of the API server>
  2. (Optional) Check the cluster version: 
    oc get clusterversion
  3. If the cluster administrator has not already done so, create a new project for GCA: 
    oc new-project gca
  4. Set the default project to GCA: 
    oc project gca
  5. Create a secret for docker-registry in order to pull images from the Genesys JFrog repository: 
    oc create secret docker-registry <repository secret name> --docker-server=<repository> --docker-username=<username> --docker-password=<password/API key> --docker-email=<email id> -n gca

Environment setup for GKE

  1. Ensure that the gcloud CLI and required Helm version are installed on the host where you will run the deployment.
  2. Log in to the GKE cluster from the host where you will run the deployment: 
    gcloud container clusters get-credentials <cluster>
  3. If the cluster administrator has not already done so, create a new namespace for GCA:
    1. Create a .json file specifying the namespace metadata. For example, create-gca-namespace.json: 
      {
  "apiVersion": "v1",
  "kind": "Namespace",
  "metadata": {
    "name": "gca",
    "labels": {
      "name": "gca"
    }
  }
}
    2. Execute the following command to create the namespace: 
      kubectl apply -f apply create-gca-namespace.json
    3. Confirm namespace creation: 
      kubectl describe namespace gca
  4. Create a secret for docker-registry in order to pull images from the Genesys JFrog repository: 
    kubectl create secret docker-registry <repository secret name> --docker-server=<repository> --docker-username=<username> --docker-password=<password/API key> --docker-email=<email id> -n gca

Deploy

Execute the following command to install GCA: 

helm upgrade --install <gca-helm-artifact> -f <gca-values.yaml> -n gca

Execute the following command to install GCA monitoring: 

helm upgrade --install gca-monitoring <gca-monitoring-helm-artifact> -n gca

Validate the deployment

You can consider GCA deployment successful when the pod is running and in ready state. Genesys Info Mart does not report the ready state for pods until internal health checks are satisfied and the pods are operational. You can use standard kubectl commands like list and get to verify the successful deployment and readiness status of the Kubernetes objects, including connection to the database.

However, from a functional point of view, you cannot validate deployment of GCA unless GSP and GIM have been deployed as well. Do not expect consistent data until all three Genesys Info Mart services are up and running. For more details about functional checks you can perform to validate GCA deployment, see the equivalent validation section on the Deploy GIM Stream Processor page.

Retrieved from "https://all.docs.genesys.com/PEC-REP/Current/GIMPEGuide/DeployGCA (2025-07-21 23:33:13)"
Comments or questions about this documentation? Contact us for support!