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

WikiSysop at 13:31, March 10, 2023

2023-03-10T13:31:37Z

WikiSysop at 03:30, September 30, 2022

2022-09-30T03:30:48Z

WikiSysop at 17:01, September 29, 2022

2022-09-29T17:01:50Z

WikiSysop at 16:46, September 2, 2022

2022-09-02T16:46:18Z

WikiSysop at 16:16, September 2, 2022

2022-09-02T16:16:19Z

WikiSysop at 17:00, April 22, 2022

2022-04-22T17:00:45Z

WikiSysop at 19:53, March 30, 2022

2022-03-30T19:53:15Z

Jose.druker@genesys.com: Published

2021-09-15T22:31:53Z

Published

Jose.druker@genesys.com: Published

2021-09-15T13:32:42Z

Published

Jose.druker@genesys.com: Published

2021-07-01T03:02:17Z

Published

New page

{{Article
|Standalone=No
|DisplayName=Deploy GCA
|Context=Learn how to deploy GIM Config Adapter (GCA).
|ComingSoon=No
|Section={{Section
|alignment=Vertical
|structuredtext={{NoteFormat|Make sure to review {{Link-SomewhereInThisVersion|topic=PlanningGCA}} for the full list of prerequisites required to deploy GCA.|}}
|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 gca
oc adm policy add-scc-to-user genesys-restricted -z gca -n gca
oc adm policy add-scc-to-user genesys-restricted -z gca-monitor -n gca</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 GCA:
<source lang="text">helm upgrade --install <gca-helm-artifact> -f gca-values.yaml -n gca</source>
Execute the following command to install GCA monitoring:
<source lang="text">helm upgrade --install gca-monitoring <gca-monitoring-helm-artifact> -n gca</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}}#GCA_Env_GKE|GKE]]
 *[[{{FULLPAGENAME}}#GCA_Env_AKS|AKS]]
 {{AnchorDiv|GCA_Env_GKE}}

@@ Line 53: / Line 53: @@
 #*:<source lang="text">kubectl apply -f apply create-gca-namespace.json</source>
 #*Confirm namespace creation:
-##*:<source lang="text">kubectl describe namespace gca</source>
+#*:<source lang="text">kubectl describe namespace gca</source>
 #Create the pull secret for the image registry.
 #*This step defines a secret so that Kubernetes can authenticate your image repository and pull artifacts from it. The repository is represented as <code>docker-registry</code> in the system.  For information about downloading artifacts from the repository, see {{Link-AnywhereElse|product=PrivateEdition|version=Current|manual=PEGuide|topic=ManageServices}}.

@@ Line 5: / Line 5: @@
 |Section={{Section
 |alignment=Vertical
-|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}}).|}}
+|structuredtext={{NoteFormat|Make sure to review {{Link-SomewhereInThisVersion|topic=PlanningGCA}} for the full list of prerequisites required to deploy GCA, including provisioning the required S3-compatible storage.|}}
 |Status=No
 }}{{Section
@@ Line 12: / Line 12: @@
 |structuredtext=To prepare your environment for the deployment, complete the steps in this section for:
-*[[{{FULLPAGENAME}}#PrepOpenShift|OpenShift]]
+*[[{{FULLPAGENAME}}#GCA_Env_OpenShift|OpenShift]]
-*[[{{FULLPAGENAME}}#PrepGKE|GKE]]
+*[[{{FULLPAGENAME}}#GCA_Env_GKE|GKE]]
-{{AnchorDiv|PrepOpenShift}}
+{{AnchorDiv|GCA_Env_OpenShift}}
-===Environment setup for OpenShift===
+===Openshift environment setup===
 #Log in to the OpenShift cluster from the remote host via CLI:
@@ Line 26: / Line 27: @@
 #Set the default project to GCA:
 #:<source lang="text">oc project gca</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 gca</source>
-{{AnchorDiv|PrepGKE}}
+{{AnchorDiv|GCA_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.
@@ Line 36: / Line 39: @@
 #:<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''':
+#*Create a .json file specifying the namespace metadata. For example, '''create-gca-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 namespace:
-##:<source lang="text">kubectl apply -f apply create-gca-namespace.json</source>
+#*:<source lang="text">kubectl apply -f apply create-gca-namespace.json</source>
-##Confirm namespace creation:
+#*Confirm namespace creation:
-##:<source lang="text">kubectl describe namespace gca</source>
+##*:<source lang="text">kubectl describe namespace gca</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 gca</source>
 |Status=No

@@ Line 5: / Line 5: @@
 |Section={{Section
 |alignment=Vertical
-|structuredtext={{NoteFormat|Make sure to review {{Link-SomewhereInThisVersion|topic=PlanningGCA}} for the full list of prerequisites required to deploy GCA, including provisioning the required S3-compatible storage.|}}
+|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
 }}{{Section
@@ Line 12: / Line 12: @@
 |structuredtext=To prepare your environment for the deployment, complete the steps in this section for:
-*[[{{FULLPAGENAME}}#GCA_Env_OpenShift|OpenShift]]
+*[[{{FULLPAGENAME}}#PrepOpenShift|OpenShift]]
-*[[{{FULLPAGENAME}}#GCA_Env_GKE|GKE]]
+*[[{{FULLPAGENAME}}#PrepGKE|GKE]]
-{{AnchorDiv|GCA_Env_OpenShift}}
+{{AnchorDiv|PrepOpenShift}}
-===Openshift environment setup===
+===Environment setup for OpenShift===
 #Log in to the OpenShift cluster from the remote host via CLI:
@@ Line 27: / Line 26: @@
 #Set the default project to GCA:
 #:<source lang="text">oc project gca</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 gca</source>
-{{AnchorDiv|GCA_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.
@@ Line 40: / Line 36: @@
 #:<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''':
+##Create a .json file specifying the namespace metadata. For example, '''create-gca-namespace.json''':
-#*:<source lang="bash">{
+##:<source lang="bash">{
    "apiVersion": "v1",
    "kind": "Namespace",
@@ Line 51: / 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-gca-namespace.json</source>
+##:<source lang="text">kubectl apply -f apply create-gca-namespace.json</source>
-#*Confirm namespace creation:
+##Confirm namespace creation:
-##*:<source lang="text">kubectl describe namespace gca</source>
+##:<source lang="text">kubectl describe namespace gca</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 gca</source>
 |Status=No

@@ Line 5: / Line 5: @@
 |Section={{Section
 |alignment=Vertical
-|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}}).|}}
+|structuredtext={{NoteFormat|Make sure to review {{Link-SomewhereInThisVersion|topic=PlanningGCA}} for the full list of prerequisites required to deploy GCA, including provisioning the required S3-compatible storage.|}}
 |Status=No
 }}{{Section
@@ Line 12: / Line 12: @@
 |structuredtext=To prepare your environment for the deployment, complete the steps in this section for:
-*[[{{FULLPAGENAME}}#PrepOpenShift|OpenShift]]
+*[[{{FULLPAGENAME}}#GCA_Env_OpenShift|OpenShift]]
-*[[{{FULLPAGENAME}}#PrepGKE|GKE]]
+*[[{{FULLPAGENAME}}#GCA_Env_GKE|GKE]]
-{{AnchorDiv|PrepOpenShift}}
+{{AnchorDiv|GCA_Env_OpenShift}}
-===Environment setup for OpenShift===
+===Openshift environment setup===
 #Log in to the OpenShift cluster from the remote host via CLI:
@@ Line 26: / Line 27: @@
 #Set the default project to GCA:
 #:<source lang="text">oc project gca</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 gca</source>
-{{AnchorDiv|PrepGKE}}
+{{AnchorDiv|GCA_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.
@@ Line 36: / Line 40: @@
 #:<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''':
+#*Create a .json file specifying the namespace metadata. For example, '''create-gca-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 namespace:
-##:<source lang="text">kubectl apply -f apply create-gca-namespace.json</source>
+#*:<source lang="text">kubectl apply -f apply create-gca-namespace.json</source>
-##Confirm namespace creation:
+#*Confirm namespace creation:
-##:<source lang="text">kubectl describe namespace gca</source>
+##*:<source lang="text">kubectl describe namespace gca</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 gca</source>
 |Status=No

@@ Line 1: / Line 1: @@
-{{Article
+{{ArticlePEServiceDeploy
-|Standalone=No
+|ServiceId=3b2bdfd2-9eb1-4a99-a181-356f2704bc02
-|DisplayName=Deploy GCA
+|IncludedServiceId=f05492f5-52ed-490a-b0d5-c318a4a7272b
-|Context=Learn how to deploy GIM Config Adapter (GCA).
+|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 from the remote host via CLI:
-#: <source lang="text">oc login --token <token> --server <URL of the API server></source>
+#Log in to the OpenShift cluster from the remote host via CLI:
-# (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 GCA:
+#:<source lang="text">oc get clusterversion</source>
-#: <source lang="text">oc new-project gca</source>
+#If the cluster administrator has not already done so, create a new project for GCA:
-# Set the default project to GCA:
+#:<source lang="text">oc new-project gca</source>
-#: <source lang="text">oc project gca</source>
+#Set the default project to GCA:
-# Create a secret for docker-registry in order to pull images from the Genesys JFrog repository:
+#:<source lang="text">oc project gca</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>
+#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 GCA:
+#:<source lang="text">gcloud container clusters get-credentials <cluster></source>
-## Create a .json file specifying the namespace metadata. For example, '''create-gca-namespace.json''':
+#If the cluster administrator has not already done so, create a new namespace for GCA:
-##: <source lang="bash">{
+##Create a .json file specifying the namespace metadata. For example, '''create-gca-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-gca-namespace.json</source>
+##:<source lang="text">kubectl apply -f apply create-gca-namespace.json</source>
-## Confirm namespace creation:
+##Confirm namespace creation:
-##: <source lang="text">kubectl describe namespace gca</source>
+##:<source lang="text">kubectl describe namespace 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">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>
+#:<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
 }}{{Section

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

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