PEC-REP/Current/GIMPEGuide/DeployGSP - Revision history

WikiSysop at 13:31, March 10, 2023

2023-03-10T13:31:43Z

WikiSysop at 17:01, September 29, 2022

2022-09-29T17:01:57Z

Show changes

WikiSysop at 16:46, September 2, 2022

2022-09-02T16:46:24Z

Show changes

WikiSysop at 16:16, September 2, 2022

2022-09-02T16:16:26Z

Show changes

WikiSysop at 20:45, June 13, 2022

2022-06-13T20:45:47Z

WikiSysop at 17:00, April 22, 2022

2022-04-22T17:00:50Z

WikiSysop at 19:53, March 30, 2022

2022-03-30T19:53:24Z

Jose.druker@genesys.com: Published

2021-09-15T22:32:32Z

Published

Jose.druker@genesys.com: Published

2021-09-15T13:31:11Z

Published

Jose.druker@genesys.com: Published

2021-07-01T03:02:22Z

Published

New page

{{Article
|Standalone=No
|DisplayName=Deploy GSP
|Context=Learn how to deploy GIM Stream Processor (GSP).
|ComingSoon=No
|Section={{Section
|alignment=Vertical
|structuredtext={{NoteFormat|Make sure to review {{Link-SomewhereInThisVersion|topic=PlanningGSP}} for the full list of prerequisites required to deploy GSP.|}}
|Status=No
}}{{Section
|sectionHeading=Set up your environment
|alignment=Vertical
|structuredtext=
# 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>
# (Optional) Check the cluster version:
#: <source lang="text">oc get clusterversion</source>
# If the cluster administrator has not already done so, create a new project for GSP:
#: <source lang="text">oc new-project gsp</source>
# Set the default project to gsp:
#: <source lang="text">oc project gsp</source>
# Bind the security context constraint (SCC) to the project-specific service accounts:
#: <source lang="text">oc adm policy add-scc-to-user genesys-restricted -z default -n gsp
oc adm policy add-scc-to-user genesys-restricted -z gsp -n gsp</source>
# 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 gsp</source>
|Status=No
}}

{{Section
|sectionHeading=Deploy in OpenShift
|alignment=Vertical
|structuredtext=Execute the following command:
<source lang="text">helm install gsp <gsp-helm-artifact> -f gsp-values.yaml -n gsp</source>
|Status=No
}}{{Section
|sectionHeading=Validate the deployment in OpenShift
|alignment=Vertical
|structuredtext={{Notices|Notice=PEComingSoon}}
|Status=No
}}
|PEPageType=45d1441f-dc69-4a17-bd47-af5d811ce167
}}

@@ Line 13: / Line 13: @@
 |structuredtext=To prepare your environment for the deployment, complete the steps in this section. Use the instructions for your environment:
 *[[Draft:PEC-REP/Current/GIMPEGuide/DeployGSP#GSP Env GKE|GKE]]
 *[[Draft:PEC-REP/Current/GIMPEGuide/DeployGSP#GSP Env AKS|AKS]]
 {{AnchorDiv|GSP_Env_GKE}}

@@ Line 57: / Line 57: @@
 }</source>
 ##Execute the following command to create the namespace:
-##:<source lang="text">kubectl apply -f apply create-gsp-namespace.json</source>
+##:<source lang="text">kubectl apply -f create-gsp-namespace.json</source>
 ##Confirm namespace creation:
 ##:<source lang="text">kubectl describe namespace gsp</source>

@@ Line 1: / Line 1: @@
-{{Article
+{{ArticlePEServiceDeploy
-|Standalone=No
+|ServiceId=3b2bdfd2-9eb1-4a99-a181-356f2704bc02
-|DisplayName=Deploy GSP
+|IncludedServiceId=c39fe496-c79e-4846-b451-1bc8bedb126b
-|Context=Learn how to deploy GIM Stream Processor (GSP).
+|IncludeAssumptions=Yes
 |Section={{Section
 |alignment=Vertical
@@ Line 30: / Line 29: @@
 #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 gsp</source>
-#<!--{{Editgrn_open}}<font color=red>'''Writer's note:''' This step is not in the PAT team instructions.</font>{{Editgrn_close}}-->
+<!--{{Editgrn_open}}<font color=red>'''Writer's note:''' This step is not in the PAT team instructions.</font>{{Editgrn_close}}-->
 #:Create a secret named <tt>kafka-secrets</tt> in order to access Kafka.
 #:When Kafka is deployed without authentication:
@@ Line 41: / Line 40: @@
 {{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:
@@ Line 89: / Line 89: @@
 #Review the logs to verify no errors.
 #Monitor the operations dashboard to verify that the services report their status as Ready, and pods are not continually restarting.
 <!--{{Editgrn_open}}<font color=red>'''Writer's note:''' To be extended to cover/link to troubleshooting tips like config resync.</font>{{Editgrn_close}}-->
 |Status=No

@@ Line 6: / Line 6: @@
 |Section={{Section
 |alignment=Vertical
-|structuredtext={{NoteFormat|Make sure to review {{Link-SomewhereInThisVersion|topic=PlanningGSP}} for the full list of prerequisites required to deploy GSP.|}}
+|structuredtext={{NoteFormat|Make sure to review {{Link-SomewhereInThisVersion|topic=PlanningGSP}} for the full list of prerequisites required to deploy GSP, including creation of the required S3-compatible storage (see {{Link-SomewhereInThisVersion|manual=GIMPEGuide|topic=PlanningGSP|anchor=S3|display text=Create object storage}}).}}
 |Status=No
 }}{{Section
 |sectionHeading=Set up your environment
 |alignment=Vertical
-|structuredtext=
+|structuredtext=To prepare your environment for the deployment, complete the steps in this section for:
-# 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>
+*[[{{FULLPAGENAME}}#PrepOpenShift|OpenShift]]
-# (Optional) Check the cluster version:
+*[[{{FULLPAGENAME}}#PrepGKE|GKE]]
-#: <source lang="text">oc get clusterversion</source>
-# If the cluster administrator has not already done so, create a new project for GSP:
+{{AnchorDiv|PrepOpenShift}}
-#: <source lang="text">oc new-project gsp</source>
+===Environment setup for OpenShift===
-{{Section
+{{AnchorDiv|PrepGKE}}
-|sectionHeading=Deploy in OpenShift
+===Environment setup for GKE===
 |alignment=Vertical
 |structuredtext=Execute the following command:
@@ Line 33: / Line 77: @@
 |Status=No
 }}{{Section
-|sectionHeading=Validate the deployment in OpenShift
+|sectionHeading=Validate the deployment
 |alignment=Vertical
-|structuredtext={{Notices|Notice=PEComingSoon}}
+|structuredtext=You can consider GSP 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.
 |Status=No
 }}
 |PEPageType=45d1441f-dc69-4a17-bd47-af5d811ce167
 }}

@@ Line 20: / Line 20: @@
 # Set the default project to gsp:
 #: <source lang="text">oc project gsp</source>
 # 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 gsp</source>