PEC-CAB/Current/CABPEGuide/Upgrade - Revision history

WikiSysop at 19:46, September 30, 2022

2022-09-30T19:46:01Z

Corinneh: Published

2022-01-12T19:35:57Z

Published

Ed.jamer@genesys.com: Text replacement - "Genesys Multicloud CXment" to "Genesys Engagement"

2021-11-09T21:15:20Z

Text replacement - "Genesys Multicloud CXment" to "Genesys Engagement"

Ed.jamer@genesys.com: Text replacement - "Genesys Engage" to "Genesys Multicloud CX"

2021-11-09T21:13:00Z

Text replacement - "Genesys Engage" to "Genesys Multicloud CX"

Barry.grenon@genesys.com: Published

2021-06-29T14:12:39Z

Published

New page

{{Article
|Standalone=No
|DisplayName=Upgrade, rollback, or uninstall Genesys Engagement Service
|TocName=Upgrade, rollback, or uninstall
|Context=Learn how to upgrade, rollback or uninstall Genesys Engagement Service.
|ComingSoon=No
|Section={{Section
|sectionHeading=Upgrade Genesys Engagement Service
|anchor=UpgradeGES
|alignment=Vertical
|structuredtext=GES uses a rolling upgrade approach.

During a prescribed maintenance window, upgrade the Helm deployment for GES by running the following command:

<code>> helm upgrade --install -n <GES_NAMESPACE> -f <path/to/values.yaml> <GES_RELEASE_NAME> <PATH_TO_GES_HELM_CHART></code>

<br />

{{{!}} class="wikitable"
{{!}}'''Versions must match'''
{{!}}Ensure that the version of GES and the Helm chart match. While Helm charts might work with other versions of GES, this is not tested and Genesys cannot guarantee success.
{{!}}}

Provided there are no issues or errors when running the Helm command, you can expect GES to work with any updates supplied in the latest version of the Helm charts. You can verify that GES has upgraded successfully by either looking at dashboards (if provisioned) or using the health check APIs for GES (through the internal port query <code>ges:3050/ges/v1/health/detail</code>) to make sure that all dependencies are working as provided. In some instances, there might be changes to the GES Helm manifest that, due to restrictions in Kubernetes, require the existing GES deployment to be uninstalled and then re-installed, rather than simply upgraded in place. Consult the {{Link-AnywhereElse|product=ReleaseNotes|version=Current|manual=GenesysEngage-cloud|topic=Callback|display text=Callback Release Notes}} to see if this will be necessary.
|Status=No
}}{{Section
|sectionHeading=Rollback Genesys Engagement Service
|anchor=RollbackGES
|alignment=Vertical
|structuredtext=To roll back to a previous iteration of GES, follow the same process you used to upgrade GES. Be sure to downgrade both the GES version and the Helm chart version that you're using. It might be necessary to use an older version of the Helm values file.
|Status=No
}}{{Section
|sectionHeading=Uninstall Genesys Engagement Service
|anchor=UninstallGES
|alignment=Vertical
|structuredtext=You can uninstall GES using the Helm <code>uninstall</code> command. Depending on how services like Postgres and Redis are provisioned for GES, you will have to decommission those services separately. Discussion of that process is outside the scope of this document.
|Status=No
}}
|PEPageType=2cad3824-b3b9-43aa-a726-143cc1aaefe2
}}

@@ Line 1: / Line 1: @@
-{{Article
+{{ArticlePEServiceUpgrade
-|Standalone=No
+|ServiceId=58e238b9-a7f6-4af9-8050-0fe1b7cb1c39
-|DisplayName=Upgrade, rollback, or uninstall Genesys Engagement Service
+|UpgradeStrategy=40f069a2-01ae-4027-9aef-13f54bc53613
-|TocName=Upgrade, rollback, or uninstall
+|AddIncluded=No
-|Context=Learn how to upgrade, rollback or uninstall Genesys Engagement Service.
+|OptionalServiceIntro={{{!}} class="wikitable"
 {{!}}'''Versions must match'''
 {{!}}Ensure that the version of GES and the Helm chart match. While Helm charts might work with other versions of GES, this is not tested and Genesys cannot guarantee success.
 {{!}}}
-Provided there are no issues or errors when running the Helm command, you can expect GES to work with any updates supplied in the latest version of the Helm charts. You can verify that GES has upgraded successfully by either looking at dashboards (if provisioned) or using the health check APIs for GES (through the internal port query <tt>ges:3050/ges/v1/health/detail</tt>) to make sure that all dependencies are working as provided. In some instances, there might be changes to the GES Helm manifest that, due to restrictions in Kubernetes, require the existing GES deployment to be uninstalled and then re-installed, rather than simply upgraded in place. Consult the {{Link-AnywhereElse|product=ReleaseNotes|version=Current|manual=GenesysEngage-cloud|topic=Callback|display text=Callback Release Notes}} to see if this will be necessary.
+Provided there are no issues or errors when running the Helm command, you can expect GES to work with any updates supplied in the latest version of the Helm charts. However, in some instances, there might be changes to the GES Helm manifest that, due to restrictions in Kubernetes, require the existing GES deployment to be uninstalled and then re-installed, rather than simply upgraded in place. Consult the {{Link-AnywhereElse|product=ReleaseNotes|version=Current|manual=GenesysEngage-cloud|topic=Callback|display text=Callback Release Notes}} to see if this will be necessary.
-|Status=No
+|SchedulingConsiderations=Upgrade the Helm deployment for GES during a prescribed maintenance window.
-}}{{Section
+|RollUpdUpgradeExt=====Example====
-|sectionHeading=Rollback Genesys Engagement Service
+<tt>> helm upgrade --install -n <GES_NAMESPACE> -f <path/to/values.yaml> <GES_RELEASE_NAME> <PATH_TO_GES_HELM_CHART></tt>
-|anchor=RollbackGES
+|RollUpdVerifyExt=You can verify that GES has upgraded successfully by either looking at dashboards (if provisioned) or using the health check APIs for GES (through the internal port query <code>ges:3050/ges/v1/health/detail</code>) to make sure that all dependencies are working as provided.
-|alignment=Vertical
+|UninstallExt=Depending on how services like Postgres and Redis are provisioned for GES, you will have to decommission those services separately. Discussion of that process is outside the scope of this document.
 }}

@@ Line 13: / Line 13: @@
 During a prescribed maintenance window, upgrade the Helm deployment for GES by running the following command:
-<code>> helm upgrade --install -n <GES_NAMESPACE> -f <path/to/values.yaml> <GES_RELEASE_NAME> <PATH_TO_GES_HELM_CHART></code>
+<tt>> helm upgrade --install -n <GES_NAMESPACE> -f <path/to/values.yaml> <GES_RELEASE_NAME> <PATH_TO_GES_HELM_CHART></tt>
 {{{!}} class="wikitable"
@@ Line 22: / Line 20: @@
 {{!}}}
+Provided there are no issues or errors when running the Helm command, you can expect GES to work with any updates supplied in the latest version of the Helm charts. You can verify that GES has upgraded successfully by either looking at dashboards (if provisioned) or using the health check APIs for GES (through the internal port query <tt>ges:3050/ges/v1/health/detail</tt>) to make sure that all dependencies are working as provided. In some instances, there might be changes to the GES Helm manifest that, due to restrictions in Kubernetes, require the existing GES deployment to be uninstalled and then re-installed, rather than simply upgraded in place. Consult the {{Link-AnywhereElse|product=ReleaseNotes|version=Current|manual=GenesysEngage-cloud|topic=Callback|display text=Callback Release Notes}} to see if this will be necessary.
 |Status=No
 }}{{Section
@@ Line 35: / Line 32: @@
 |anchor=UninstallGES
 |alignment=Vertical
-|structuredtext=You can uninstall GES using the Helm <code>uninstall</code> command. Depending on how services like Postgres and Redis are provisioned for GES, you will have to decommission those services separately. Discussion of that process is outside the scope of this document.
+|structuredtext=You can uninstall GES using the Helm <tt>uninstall</tt> command. Depending on how services like Postgres and Redis are provisioned for GES, you will have to decommission those services separately. Discussion of that process is outside the scope of this document.
 |Status=No
 }}
 |PEPageType=2cad3824-b3b9-43aa-a726-143cc1aaefe2
 }}