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

WikiSysop at 13:31, March 10, 2023

2023-03-10T13:31:40Z

WikiSysop at 17:01, September 29, 2022

2022-09-29T17:01:53Z

WikiSysop at 16:46, September 2, 2022

2022-09-02T16:46:21Z

WikiSysop at 16:16, September 2, 2022

2022-09-02T16:16:22Z

WikiSysop at 17:00, April 22, 2022

2022-04-22T17:00:47Z

WikiSysop at 19:53, March 30, 2022

2022-03-30T19:53:19Z

Jose.druker@genesys.com: Published

2021-09-15T22:29:40Z

Published

Jose.druker@genesys.com: Published

2021-09-15T13:28:51Z

Published

Jose.druker@genesys.com: Published

2021-07-01T03:02:12Z

Published

New page

{{Article
|Standalone=No
|DisplayName=Deploy GIM
|Context=Learn how to deploy GIM.
|ComingSoon=No
|Section={{Section
|alignment=Vertical
|structuredtext={{NoteFormat|Make sure to review {{Link-SomewhereInThisVersion|topic=PlanningGIM}} for the full list of prerequisites required to deploy GIM.|}}
|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 GIM:
#: <source lang="text">oc new-project gim</source>
# Set the default project to GIM:
#: <source lang="text">oc project gim</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 gim
oc adm policy add-scc-to-user genesys-restricted -z gim -n gim
oc adm policy add-scc-to-user genesys-restricted -z gim-monitor -n gim</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 gim</source>
|Status=No
}}{{Section
|sectionHeading=Deploy in OpenShift
|alignment=Vertical
|structuredtext=Execute the following command to install GIM:
<source lang="text">helm upgrade --install gim <gim-helm-artifact> -f gim-values.yaml -n gim</source>
Execute the following command to install GIM monitoring:
<source lang="text">helm upgrade --install gim-monitoring <gim-monitoring-helm-artifact> -n gim</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 12: / Line 12: @@
 |structuredtext=To prepare your environment for the deployment, complete the steps in this section for:
 *[[{{FULLPAGENAME}}#GIM_Env_GKE|GKE]]
 *[[{{FULLPAGENAME}}#GIM_Env_AKS|AKS]]
 {{AnchorDiv|GIM_Env_GKE}}

@@ Line 12: / Line 12: @@
 |structuredtext=To prepare your environment for the deployment, complete the steps in this section for:
-*[[{{FULLPAGENAME}}#PrepOpenShift|OpenShift]]
+*[[{{FULLPAGENAME}}#GIM_Env_OpenShift|OpenShift]]
-*[[{{FULLPAGENAME}}#PrepGKE|GKE]]
+*[[{{FULLPAGENAME}}#GIM_Env_GKE|GKE]]
-{{AnchorDiv|PrepOpenShift}}
+{{AnchorDiv|GIM_Env_OpenShift}}
-===Environment setup for OpenShift===
+===OpenShift environment setup===
-#Log in to the OpenShift cluster via CLI on the host where you will run the deployment:
+#Using the CLI, log in to the OpenShift cluster on the host where you will run the deployment:
 #:<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 GIM:
+#If the cluster administrator has not already done so, create a new project <code>gim</code> for GIM:
 #:<source lang="text">oc new-project gim</source>
-#Set the default project to GIM:
+#Set the default project to <code>gim</code>:
 #:<source lang="text">oc project gim</source>
-#Create a secret for docker-registry in order to pull images from the Genesys JFrog repository:
+#Create the pull secret for the image registry.
 #:<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>
-{{AnchorDiv|PrepGKE}}
+{{AnchorDiv|GIM_Env_GKE}}
-===Environment setup for GKE===
+===GKE environment setup===
 #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:
+#Using the CLI, 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 GIM:
+#If the cluster administrator has not already done so, create a new namespace <code>gim</code> for GIM:
-##Create a .json file specifying the namespace metadata. For example, '''create-gim-namespace.json''':
+#*Create a JSON file specifying the namespace metadata. For example, '''create-gim-namespace.json''':
-##:<source lang="bash">{
+#:<source lang="bash">{
    "apiVersion": "v1",
    "kind": "Namespace",
@@ Line 47: / Line 50: @@
+   }
 }</source>
-##Execute the following command to create the namespace:
+#*Execute the following command to create the <code>gim</code> namespace:
-##:<source lang="text">kubectl apply -f apply create-gim-namespace.json</source>
+#*:<source lang="text">kubectl apply -f apply create-gim-namespace.json</source>
-##Confirm namespace creation:
+#*Confirm namespace creation:
-##:<source lang="text">kubectl describe namespace gim</source>
+#:<source lang="text">kubectl describe namespace gim</source>
-#Create a secret for docker-registry in order to pull images from the Genesys JFrog repository:
+#Create the pull secret for the image registry.
 #:<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 gim</source>
 |Status=No

@@ Line 12: / Line 12: @@
 |structuredtext=To prepare your environment for the deployment, complete the steps in this section for:
-*[[{{FULLPAGENAME}}#GIM_Env_OpenShift|OpenShift]]
+*[[{{FULLPAGENAME}}#PrepOpenShift|OpenShift]]
-*[[{{FULLPAGENAME}}#GIM_Env_GKE|GKE]]
+*[[{{FULLPAGENAME}}#PrepGKE|GKE]]
-{{AnchorDiv|GIM_Env_OpenShift}}
+{{AnchorDiv|PrepOpenShift}}
-===OpenShift environment setup===
+===Environment setup for OpenShift===
-#Using the CLI, log in to the OpenShift cluster on the host where you will run the deployment:
+#Log in to the OpenShift cluster via CLI on the host where you will run the deployment:
 #:<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 <code>gim</code> for GIM:
+#If the cluster administrator has not already done so, create a new project for GIM:
 #:<source lang="text">oc new-project gim</source>
-#Set the default project to <code>gim</code>:
+#Set the default project to GIM:
 #:<source lang="text">oc project gim</source>
-#Create the pull secret for the Genesys JFrog image registry.
+#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>
-{{AnchorDiv|GIM_Env_GKE}}
+{{AnchorDiv|PrepGKE}}
-===GKE environment setup===
+===Environment setup for GKE===
 #Ensure that the gcloud CLI and required Helm version are installed on the host where you will run the deployment.
-#Using the CLI, log in to the GKE cluster from 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 <code>gim</code> for GIM:
+#If the cluster administrator has not already done so, create a new namespace for GIM:
-#*Create a JSON file specifying the namespace metadata. For example, '''create-gim-namespace.json''':
+##Create a .json file specifying the namespace metadata. For example, '''create-gim-namespace.json''':
-#:<source lang="bash">{
+##:<source lang="bash">{
    "apiVersion": "v1",
    "kind": "Namespace",
@@ Line 51: / Line 47: @@
+   }
 }</source>
-#*Execute the following command to create the <code>gim</code> namespace:
+##Execute the following command to create the namespace:
-#*:<source lang="text">kubectl apply -f apply create-gim-namespace.json</source>
+##:<source lang="text">kubectl apply -f apply create-gim-namespace.json</source>
-#*Confirm namespace creation:
+##Confirm namespace creation:
-#:<source lang="text">kubectl describe namespace gim</source>
+##:<source lang="text">kubectl describe namespace gim</source>
-#Create the pull secret for the Genesys JFrog image registry.
+#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 gim</source>
 |Status=No

@@ Line 12: / Line 12: @@
 |structuredtext=To prepare your environment for the deployment, complete the steps in this section for:
-*[[{{FULLPAGENAME}}#PrepOpenShift|OpenShift]]
+*[[{{FULLPAGENAME}}#GIM_Env_OpenShift|OpenShift]]
-*[[{{FULLPAGENAME}}#PrepGKE|GKE]]
+*[[{{FULLPAGENAME}}#GIM_Env_GKE|GKE]]
-{{AnchorDiv|PrepOpenShift}}
+{{AnchorDiv|GIM_Env_OpenShift}}
-===Environment setup for OpenShift===
+===OpenShift environment setup===
-#Log in to the OpenShift cluster via CLI on the host where you will run the deployment:
+#Using the CLI, log in to the OpenShift cluster on the host where you will run the deployment:
 #:<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 GIM:
+#If the cluster administrator has not already done so, create a new project <code>gim</code> for GIM:
 #:<source lang="text">oc new-project gim</source>
-#Set the default project to GIM:
+#Set the default project to <code>gim</code>:
 #:<source lang="text">oc project gim</source>
-#Create a secret for docker-registry in order to pull images from the Genesys JFrog repository:
+#Create the pull secret for the Genesys JFrog image registry.
 #:<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>
-{{AnchorDiv|PrepGKE}}
+{{AnchorDiv|GIM_Env_GKE}}
-===Environment setup for GKE===
+===GKE environment setup===
 #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:
+#Using the CLI, 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 GIM:
+#If the cluster administrator has not already done so, create a new namespace <code>gim</code> for GIM:
-##Create a .json file specifying the namespace metadata. For example, '''create-gim-namespace.json''':
+#*Create a JSON file specifying the namespace metadata. For example, '''create-gim-namespace.json''':
-##:<source lang="bash">{
+#:<source lang="bash">{
    "apiVersion": "v1",
    "kind": "Namespace",
@@ Line 47: / Line 51: @@
+   }
 }</source>
-##Execute the following command to create the namespace:
+#*Execute the following command to create the <code>gim</code> namespace:
-##:<source lang="text">kubectl apply -f apply create-gim-namespace.json</source>
+#*:<source lang="text">kubectl apply -f apply create-gim-namespace.json</source>
-##Confirm namespace creation:
+#*Confirm namespace creation:
-##:<source lang="text">kubectl describe namespace gim</source>
+#:<source lang="text">kubectl describe namespace gim</source>
-#Create a secret for docker-registry in order to pull images from the Genesys JFrog repository:
+#Create the pull secret for the Genesys JFrog image registry.
 #:<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 gim</source>
 |Status=No

@@ Line 1: / Line 1: @@
-{{Article
+{{ArticlePEServiceDeploy
-|Standalone=No
+|ServiceId=3b2bdfd2-9eb1-4a99-a181-356f2704bc02
-|DisplayName=Deploy GIM
+|IncludedServiceId=e65e00cb-c1c8-4fb8-9614-80ac07c3a4e3
-|Context=Learn how to deploy GIM.
+|IncludeAssumptions=Yes
 |Section={{Section
 |alignment=Vertical
@@ Line 12: / Line 11: @@
 |alignment=Vertical
 |structuredtext=To prepare your environment for the deployment, complete the steps in this section for:
 * [[{{FULLPAGENAME}}#PrepOpenShift|OpenShift]]
-* [[{{FULLPAGENAME}}#PrepGKE|GKE]]
+*[[{{FULLPAGENAME}}#PrepOpenShift|OpenShift]]
 {{AnchorDiv|PrepOpenShift}}
 ===Environment setup for OpenShift===
 # Log in to the OpenShift cluster via CLI on the host where you will run the deployment:
-#: <source lang="text">oc login --token <token> --server <URL of the API server></source>
+#Log in to the OpenShift cluster via CLI on the host where you will run the deployment:
-# (Optional) Check the cluster version:
+#:<source lang="text">oc login --token <token> --server <URL of the API server></source>
-#: <source lang="text">oc get clusterversion</source>
+#(Optional) Check the cluster version:
-# If the cluster administrator has not already done so, create a new project for GIM:
+#:<source lang="text">oc get clusterversion</source>
-#: <source lang="text">oc new-project gim</source>
+#If the cluster administrator has not already done so, create a new project for GIM:
-# Set the default project to GIM:
+#:<source lang="text">oc new-project gim</source>
-#: <source lang="text">oc project gim</source>
+#Set the default project to GIM:
-# Create a secret for docker-registry in order to pull images from the Genesys JFrog repository:
+#:<source lang="text">oc project 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 gim</source>
+#Create a secret for docker-registry in order to pull images from the Genesys JFrog repository:
 {{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:
+#Ensure that the gcloud CLI and required Helm version are installed on the host where you will run the deployment.
-#: <source lang="text">gcloud container clusters get-credentials <cluster></source>
+#Log in to the GKE cluster from the host where you will run the deployment:
-# If the cluster administrator has not already done so, create a new namespace for GIM:
+#:<source lang="text">gcloud container clusters get-credentials <cluster></source>
-## Create a .json file specifying the namespace metadata. For example, '''create-gim-namespace.json''':
+#If the cluster administrator has not already done so, create a new namespace for GIM:
-##: <source lang="bash">{
+##Create a .json file specifying the namespace metadata. For example, '''create-gim-namespace.json''':
    "apiVersion": "v1",
    "kind": "Namespace",
@@ Line 45: / Line 47: @@
+   }
 }</source>
-## Execute the following command to create the namespace:
+##Execute the following command to create the namespace:
-##: <source lang="text">kubectl apply -f apply create-gim-namespace.json</source>
+##:<source lang="text">kubectl apply -f apply create-gim-namespace.json</source>
-## Confirm namespace creation:
+##Confirm namespace creation:
-##: <source lang="text">kubectl describe namespace gim</source>
+##:<source lang="text">kubectl describe namespace gim</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">kubectl 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">kubectl 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>
 |Status=No
 }}{{Section

@@ Line 27: / Line 27: @@
 |alignment=Vertical
 |structuredtext=Execute the following command to install GIM:
-<source lang="text">helm upgrade --install gim <gim-helm-artifact> -f gim-values.yaml -n gim</source>
+<source lang="text">helm upgrade --install gim <gim-helm-artifact> -f <gim-values.yaml> -n gim</source>
 Execute the following command to install GIM monitoring:
 <source lang="text">helm upgrade --install gim-monitoring <gim-monitoring-helm-artifact> -n gim</source>