User:Jdruker/PE Upgrade/PE DES SAMPLE - Revision history

WikiSysop at 16:00, April 28, 2022

2022-04-28T16:00:47Z

WikiSysop at 15:45, April 28, 2022

2022-04-28T15:45:41Z

WikiSysop at 21:15, April 19, 2022

2022-04-19T21:15:36Z

WikiSysop at 14:30, April 5, 2022

2022-04-05T14:30:40Z

WikiSysop at 14:15, April 5, 2022

2022-04-05T14:15:38Z

WikiSysop at 11:15, April 1, 2022

2022-04-01T11:15:29Z

WikiSysop: Created page with "==Upgrade strategies==
supports the following upgrade strategies {{Editgrn_open}}[templatizable plural and display]{{Ed..."

2022-03-30T14:40:37Z

Created page with "==Upgrade strategies== <div><font color=green><service> supports the following upgrade strategies {{Editgrn_open}}<font color=red>[templatizable plural and display]</font>{{Ed..."

New page

==Upgrade strategies==
<div><font color=green><service> supports the following upgrade strategies {{Editgrn_open}}<font color=red>[templatizable plural and display]</font>{{Editgrn_close}}:

*[[{{FULLPAGENAME}}#Rolling|Rolling Update]]
*[[{{FULLPAGENAME}}#BlueGreen|Blue/Green]]
*[[{{FULLPAGENAME}}#Canary|Canary]] (used in combination with Blue/Green)

The upgrade or rollback process to follow for <service(s)> depends on how you deployed <it/them> initially. Based on the deployment strategy adopted during initial deployment, refer to the corresponding upgrade or rollback section on this page for related instructions.

For more information refer to [[Draft:PrivateEdition/Current/PEGuide/UpgradStrats|Upgrade strategies]] in the ''[[Draft:PrivateEdition/Current/PEGuide|Private Edition guide]]''.</font></div>

<font color="#B24DE7">Placeholder for optional service-specific content.</font>

<div><font color=green>
==Timing==
A regular upgrade schedule is necessary (link to info about the s/w versioning policy) but fixes might warrant an earlier upgrade.

===Scheduling considerations===
</font></div>
<font color="#B24DE7">When is the best/least disruptive time for actually performing the upgrade, and how long it’ll take. Are there any service dependencies?</font>

<div><font color=green>
==Preparatory steps==
# Review the RN to identify changes.
# Ensure your previously customized values.yaml is available and update it as required to implement changes.
# Download the new package.</font></div>
{{Editgrn_open}}<font color=red>Any other templatizable, generic preparatory steps?</font>{{Editgrn_close}}
<div><font color="#B24DE7">Any other service-specific prep like:
* Recommended backups
* Any permissions-related changes </font></div>

<div><font color=green>
{{AnchorDiv|Rolling}}
==Rolling Update==
===Rolling Update: Upgrade===
Execute the following command to upgrade <service>:
<source lang="text">helm upgrade --install <service> -f <service>values.yaml -n <service package></source>
'''Tip:''' If the only update you need to make to your existing values.yaml is to update the image version, you can pass the image tag as an argument by using the --set flag in the command:
<source lang="text">helm upgrade --install <service> -f <service>-values.yaml <service package> --set <service>.image.tag=<new service version></source></font></div>

<div><font color="#B24DE7">Follow the same instructions to upgrade Designer and DAS. For example, the respective commands are:
* Designer: <source lang="text">helm upgrade --install designer -f designer-values.yaml designer-100.0.112+1401.tgz --set designer.image.tag=100.0.112.11</source>
* DAS: <source lang="text">helm upgrade --install designer-das -f designer-das-values.yaml designer-das-100.0.112+1401.tgz --set das.image.tag=9.0.111.05.5</source></font></div>

<div><font color=green>
{{AnchorDiv|RollingUpdateVerify}}
===Rolling Update: Verify the upgrade===
Follow usual Kubernetes best practices to verify that the new service version is deployed. See the information about initial deployment for additional functional validation that <service> has upgraded successfully.
</font></div>

<font color="#B24DE7">Optional additional service-specific info.</font>

<div><font color=green>
{{AnchorDiv|RollingUpdateRollback}}
===Rolling Update: Rollback===
# Update the image version in the <service>.image.tag option in the <service>-values.yaml file.
# Execute the following command to rollback <service>:
#: <source lang="text">helm upgrade --install <service> -f <service>-values.yaml <service package></source>
#: '''Tip:''' You can also directly pass the image tag as an argument by using the --set flag in the command:
#: <source lang="text">helm upgrade --install <service> -f <service>-values.yaml <service package> --set <service>.image.tag=<old service version></source></font></div>

<div><font color="#B24DE7">Follow the same instructions to rollback Designer and DAS. For example, the respective commands are:
* Designer: <source lang="text">helm upgrade --install designer -f designer-values.yaml designer-100.0.112+1401.tgz --set designer.image.tag=100.0.111.05.5</source>
* DAS: <source lang="text">helm upgrade --install designer-das -f designer-das-values.yaml designer-das-100.0.112+1401.tgz --set das.image.tag=9.0.111.05.5</source></font></div>

<div><font color=green>
===Verify the rollback===

Verify the rollback in the same way that you verified the upgrade (see [[{{FULLPAGENAME}}#RollingUpdateVerify|Rolling Update: Verify the upgrade]]).</font></div>

<font color="#B24DE7">Additional service-specific content.</font>

{{AnchorDiv|BlueGreen}}<div><font color=green>
==Blue/Green==
===Blue/Green: Upgrade===
===Designer===
</font></div>
<div><font color="#B24DE7">
#Identify the current production color by checking the Designer ingress rules:
#:<code>kubectl describe ingress designer-ingress</code><br />
#:Green is the production color in the below example as the production host name points to the green service.<br />
#:[[File:DesUpgStep1.png|border]]
#Deploy the Designer service on to the non-production color (in this example, blue is the non-production color and assuming the service name will be designer-blue):<br />
#: <source lang="text">helm upgrade --install designer-blue -f designer-values.yaml designer-100.0.112+1401.tgz --set designer.deployment.strategy=blue-green --set designer.image.tag=100.0.111.05.5 --set designer.deployment.color=blue</source><br />
The non-production color can be accessed with the non-production host name (for example, <code>designer.blue.example.com</code>). Testing can be done using this URL.

'''NodePort Service'''

The <code>designer-green</code> release creates a service called <code>designer-green</code> and the <code>designer-blue</code> release creates a service called <code>designer-blue</code>. If you are using NodePort services, ensure that the value of <code>designer.service.nodePort</code> is not the same for both the releases. In other words, you should assign dedicated node ports for the releases. The default value for <code>designer.service.nodePort</code> is '''30180'''. If this was applied to <code>designer-green</code>, use a different value for <code>designer-blue</code>, for example, '''30181'''. Use the below helm command to achieve this:

<source lang="text">helm upgrade --install designer-blue -f designer-values.yaml designer-100.0.112+1401.tgz --set designer.deployment.strategy=blue-green --set designer.image.tag=100.0.111.05.5 --set designer.deployment.color=blue --set designer.service.nodePort=30181</source></font></div>

<font color=green>
====Cutover====
</font>
<div><font color="#B24DE7">Once testing is completed on the non-production color, traffic can be moved to the new version by updating the Ingress rules:

*Update the Designer Ingress with the new deployment color by running the following command (in this case, blue is the new deployment color, that is, the non-production color):<br />
*: <source lang="text">helm upgrade --install designer-ingress -f designer-values.yaml designer-100.0.112+1401.tgz --set designer.deployment.strategy=blue-green-ingress --set designer.deployment.color=blue</source><br />

{{AnchorDiv|BGDESVerify}}
<font color=green>
====Verify the upgrade====
</font>

*Verify the ingress rules by running the following command:<br /> <code>kubectl describe ingress designer-ingress</code><br />
*:The production host name must point to the new color service, that is, <code>blue</code>.</font></div>

<div><font color=green>
===DAS===
</font></div>

<div><font color="#B24DE7">
#Identify the current production color by checking the <code>designer-das</code> service selector labels:
#: <source lang="text">kubectl describe service designer-das</code>.
#:Green is the production color in the below example as the selector label is <code>color=green</source>. <br />
#:[[File:DasBGUpgStep1.png|border]]
#Deploy the DAS service on to the non-production color (in this example, blue is the non-production color and assuming the service name is <code>designer-das-blue</code>):<br />
#: <source lang="text">helm upgrade --install designer-das-blue -f das-values.yaml designer-das-100.0.106+1401.tgz --set das.deployment.strategy=blue-green --set das.image.tag=9.0.111.05.5 --set das.deployment.color=blue</source><br />
The non-production color can be accessed with the non-production service name.
</font></div>

{{AnchorDiv|dascutover}}
<div><font color=green>
====Cutover====
</font></div>

<div><font color="#B24DE7">
Once testing is completed on the non-production color, traffic can be moved to the new version by updating the <code>designer-das</code> service.

*Update the <code>designer-das</code> service with the new deployment color (in this example, blue is the new deployment color, that is, non-production color)
*: <source lang="text">helm upgrade --install designer-das-service -f designer-das-values.yaml designer-das-100.0.106+1401.tgz --set das.deployment.strategy=blue-green-service --set das.deployment.color=blue</source>

</font></div>

{{AnchorDiv|BGDASVerify}}
<font color=green>
====Verify the upgrade====
</font>

<div><font color="#B24DE7">
*Verify the service by executing the <code>kubectl describe service designer-das</code> command.
*:The type label must have the active color's label, that is, <code>color=blue</code>.
</font></div>

<font color=green>
===Blue/Green: Rollback===
===Designer===
</font>

<div><font color="#B24DE7">
To rollback the upgrade, modify the ingress rules to point back to the old deployment pods (green, in this example) by performing a cutover again.

*Perform a cutover using the following command:<br/>
*:<source lang="text">helm upgrade --install designer-ingress -f designer-values.yaml designer-100.0.112+1401.tgz --set designer.deployment.strategy=blue-green-ingress --set designer.deployment.color=green</source><br />
</font></div>

<div><font color=green>
====Verify the rollback====

*Verify the rollback in the same way that you verified the upgrade (see [[{{FULLPAGENAME}}#BGDESVerify|Blue-Green: Verify the upgrade]]).</font></div>
*:<div><font color="#B24DE7">The type label must have the active color's label, that is, <code>color=green</code>.
</font></div>

<div><font color=green>
===DAS===
</font></div>

<div><font color="#B24DE7">
To rollback the upgrade, perform a cutover again to point the service back to the old deployment (green).

*Perform a cutover using the following command:<br/>
*:<source lang="text">helm upgrade --install designer-das-service -f designer-das-values.yaml designer-das-100.0.106+1401.tgz --set das.deployment.strategy=blue-green-service --set das.deployment.color=green</source><br>
</font></div>

<div><font color=green>
====Verify the rollback====

*Verify the rollback in the same way that you verified the upgrade (see [[{{FULLPAGENAME}}#BGDASVerify|Blue-Green: Verify the upgrade]]).</font></div>
*:<div><font color="#B24DE7"> The type label must have the active color's label, <code>color=green</code>.
</font></div>

{{AnchorDiv|#Canary}}
<div><font color=green>
==Canary==
Canary is optional and is only used along with Blue-Green. It is recommended in production. Canary pods are generally used to test new versions of images with live traffic.
</font></div>

<div><font color="#B24DE7">
You will not use Canary pods when you are installing the Designer and DAS services for the first time. You will only use Canary pods for testing the new versions when upgrading the services after initial deployment.

For more information on this, see deployment instructions for [[Draft:DES/Current/DESPEGuide/Upgrade2#Canary|Canary]].
</font></div>

<div><font color=green>
==Post-upgrade procedures==
</font></div>
<div><font color="#B24DE7">
===Upgrading the Designer workspace===
Workspace resources must be upgraded after cutover. This will upgrade the system resources in the Designer workspace:

#Login to one of the Designer pods using the <code>kubectl exec -it <pod_name ></code> bash command.
#Execute the following migration command (this will create new directories/new files introduced in the new version):<br /> <code>node ./bin/cli.js workspace-upgrade -m -t <contact_center_id></code>
#Execute the workspace resource upgrade command (this will upgrade system resources, such as system service PHP files, internal audio files and callback resources):<br /> <code>node ./bin/cli.js workspace-upgrade -t <contact_center_id></code><br /> In the above command, <code>contact_center_id</code> , is the Contact Center ID created in GWS for this tenant (workspace resources are located under the Contact Center ID folder (''/workspaces/<ccid>/workspace'')).

===Elasticsearch maintenance recommendations===
To help you better manage your indexes and snapshots, and to prevent too many indexes from creating an overflow of shards, Genesys recommends that you set up a scheduled execution of Elasticsearch Curator with the following two actions:

*Delete indexes older than the given threshold according to the index name and mask.
**<code>sdr-*</code> (3 months)
**<code>audit-*</code> (12 months)

*Make a snapshot of each index:
**<code>sdr-*</code> (yesterday and older)
**<code>audit-*</code>
**<code>kibana-int-*</code>
</font></div>

<div><font color=green>
==Uninstall==
{{Editgrn_open}}<font color=red>In addition to this instruction, are there any preparatory steps (e.g., processes to stop, data to save) and/or service dependencies?</font>{{Editgrn_close}}

* Execute the following command to uninstall <service>:
*: <source lang="text">helm uninstall <release-name></source>
</font></div>

@@ Line 22: / Line 22: @@
 <font color="#B24DE7">When is the best/least disruptive time for actually performing the upgrade, and how long it’ll take. Are there any service dependencies?</font>
 <font color=green>
 ==Monitoring==
 {{Editgrn_open}}<font color=red>'''Writer's note:''' Please especially consider if we want to include content like the following. Also consider if the following note on the Observability page is potentially confusing and should be reworded: "While you can use general third-party functionality to create rules to trigger alerts based on metrics values you specify, private edition does not enable you to create custom alerts, and Genesys does not provide support for custom alerting."</font>{{Editgrn_close}}

@@ Line 1: / Line 1: @@
 ==Upgrade strategies==
-<div><font color=green><service> supports the following upgrade strategies {{Editgrn_open}}<font color=red>[templatizable plural and display]</font>{{Editgrn_close}}:
+<div><font color=green>{{NoteFormat|The instructions on this page assume you have deployed the service in a service-specific namespace or OpenShift project. If you are using a single namespace for all private edition services, replace the namespace element in the commands on this page with the name of your single namespace or project.}}
 *[[{{FULLPAGENAME}}#Rolling|Rolling Update]]
@@ Line 21: / Line 23: @@
 <font color=green>
 ==Preparatory steps==
 Each time you upgrade a service:
@@ Line 224: / Line 232: @@
 <div><font color=green>
 ==Uninstall==
-{{Editgrn_open}}<font color=red>In addition to this instruction, are there any preparatory steps (e.g., processes to stop, data to save) and/or service dependencies?</font>{{Editgrn_close}}
+{{Editgrn_open}}<font color=red>In addition to this instruction, are there any boilerplate preparatory steps (e.g., processes to stop, data to save) and/or service dependencies?</font>{{Editgrn_close}}
-* Execute the following command to uninstall <service>:<br/>
+Execute the following command to uninstall <service>:<br/>
 {{Editgrn_open}}<font color=red>JD note: Confirm the syntax. Shouldn't it be "uninstall <service>" and shouldn't it include the namespace argument?</font>{{Editgrn_close}}
-*: <source lang="text">helm uninstall <release-name></source>
+<source lang="text">helm uninstall <release-name></source>
 </font></div>

@@ Line 6: / Line 6: @@
 *[[{{FULLPAGENAME}}#Canary|Canary]] (used in combination with Blue/Green)
-The upgrade or rollback process to follow for <service(s)> depends on how you deployed <it/them> initially. Based on the deployment strategy adopted during initial deployment, refer to the corresponding upgrade or rollback section on this page for related instructions.
+<font color=brown>The upgrade or rollback process to follow for <service(s)> depends on how you deployed <it/them> initially. Based on the deployment strategy adopted during initial deployment, refer to the corresponding upgrade or rollback section on this page for related instructions.</font>
-For more information refer to [[Draft:PrivateEdition/Current/PEGuide/UpgradStrats|Upgrade strategies]] in the ''[[Draft:PrivateEdition/Current/PEGuide|Private Edition guide]]''.</font></div>
+For a conceptual overview of the upgrade strategies, refer to [[Draft:PrivateEdition/Current/PEGuide/UpgradStrats|Upgrade strategies]] in the ''[[Draft:PrivateEdition/Current/PEGuide|Private Edition guide]]''.</font></div>
 <font color="#B24DE7">Placeholder for optional service-specific content.</font>
@@ Line 20: / Line 20: @@
 <font color="#B24DE7">When is the best/least disruptive time for actually performing the upgrade, and how long it’ll take. Are there any service dependencies?</font>
-<div><font color=green>
+<font color=green>
 ==Preparatory steps==
-# Review the RN to identify changes.
+Each time you upgrade a service:
-# Ensure your previously customized values.yaml is available and update it as required to implement changes.
+# Review the release note to identify changes.
-# Download the new package.</font></div>
+# Download the new package.
 {{Editgrn_open}}<font color=red>Any other templatizable, generic preparatory steps?</font>{{Editgrn_close}}
 <div><font color="#B24DE7">Any other service-specific prep like:
@@ Line 34: / Line 35: @@
 ==Rolling Update==
 ===Rolling Update: Upgrade===
-Execute the following command to upgrade <service>:
+Execute the following command to upgrade the service:
 <source lang="text">helm upgrade --install <service> -f <service>values.yaml -n <service package></source>
 '''Tip:''' If the only update you need to make to your existing values.yaml is to update the image version, you can pass the image tag as an argument by using the --set flag in the command:
@@ Line 56: / Line 58: @@
 {{AnchorDiv|RollingUpdateRollback}}
 ===Rolling Update: Rollback===
-# Update the image version in the <service>.image.tag option in the <service>-values.yaml file.
+To roll back an upgrade, you re-install the previous package.
-# Execute the following command to roll back <service>:
+# Revert the image version in the <service>.image.tag option in the <service>-values.yaml file. If applicable, also revert any configuration changes you implemented for the new release.
-#: <source lang="text">helm upgrade --install <service> -f <service>-values.yaml <service package></source>
+# Execute the following command to roll back the upgrade:
 #: '''Tip:''' You can also directly pass the image tag as an argument by using the --set flag in the command:
-#: <source lang="text">helm upgrade --install <service> -f <service>-values.yaml <service package>  --set <service>.image.tag=<old service version></source></font></div>
+#: <source lang="text">helm upgrade --install <service> -f <service>-values.yaml <old service package>  --set <service>.image.tag=<old service version></source></font></div>
 <div><font color="#B24DE7">Follow the same instructions to roll back Designer and DAS. For example, the respective commands are:
@@ Line 195: / Line 198: @@
 </font></div>
-<div><font color=green>
+<div><font color=brown>
 ==Post-upgrade procedures==
 </font></div>
@@ Line 223: / Line 226: @@
 {{Editgrn_open}}<font color=red>In addition to this instruction, are there any preparatory steps (e.g., processes to stop, data to save) and/or service dependencies?</font>{{Editgrn_close}}
-* Execute the following command to uninstall <service>:
+* Execute the following command to uninstall <service>:<br/>
 *: <source lang="text">helm uninstall <release-name></source>
 </font></div>

@@ Line 57: / Line 57: @@
 ===Rolling Update: Rollback===
 # Update the image version in the <service>.image.tag option in the <service>-values.yaml file.
-# Execute the following command to rollback <service>:
+# Execute the following command to roll back <service>:
 #: <source lang="text">helm upgrade --install <service> -f <service>-values.yaml <service package></source>
 #: '''Tip:''' You can also directly pass the image tag as an argument by using the --set flag in the command:
 #: <source lang="text">helm upgrade --install <service> -f <service>-values.yaml <service package>  --set <service>.image.tag=<old service version></source></font></div>
-<div><font color="#B24DE7">Follow the same instructions to rollback Designer and DAS. For example, the respective commands are:
+<div><font color="#B24DE7">Follow the same instructions to roll back Designer and DAS. For example, the respective commands are:
 * Designer: <source lang="text">helm upgrade --install designer -f designer-values.yaml designer-100.0.112+1401.tgz --set designer.image.tag=100.0.111.05.5</source>
 * DAS: <source lang="text">helm upgrade --install designer-das -f designer-das-values.yaml designer-das-100.0.112+1401.tgz --set das.image.tag=9.0.111.05.5</source></font></div>
@@ Line 86: / Line 86: @@
 #Deploy the Designer service on to the non-production color (in this example, blue is the non-production color and assuming the service name is designer-blue):<br />
 #: <source lang="text">helm upgrade --install designer-blue -f designer-values.yaml designer-100.0.112+1401.tgz --set designer.deployment.strategy=blue-green --set designer.image.tag=100.0.111.05.5 --set designer.deployment.color=blue</source><br />
-The non-production color can be accessed with the non-production host name (for example, <code>designer.blue.example.com</code>). Testing can be done using this URL.
+Use the non-production host name to access the non-production color. For example, <code>designer.blue.example.com</code>). You can use this URL for testing.
 '''NodePort Service'''
@@ Line 97: / Line 97: @@
 ====Cutover====
 </font>
-<div><font color="#B24DE7">Once testing is completed on the non-production color, traffic can be moved to the new version by updating the Ingress rules:
+<div><font color="#B24DE7">Once testing is completed on the non-production color, move traffic to the new version by updating the Ingress rules:
 *Update the Designer Ingress with the new deployment color by running the following command (in this case, blue is the new deployment color, that is, the non-production color):<br />
@@ Line 121: / Line 121: @@
 #Deploy the DAS service on to the non-production color (in this example, blue is the non-production color and assuming the service name is <code>designer-das-blue</code>):<br />
 #: <source lang="text">helm upgrade --install designer-das-blue -f das-values.yaml designer-das-100.0.106+1401.tgz --set das.deployment.strategy=blue-green --set das.image.tag=9.0.111.05.5 --set das.deployment.color=blue</source><br />
-The non-production color can be accessed with the non-production service name.
+Use the non-production service name to access the non-production color.
 </font></div>
@@ Line 130: / Line 130: @@
 <div><font color="#B24DE7">
-Once testing is completed on the non-production color, traffic can be moved to the new version by updating the <code>designer-das</code> service.
+Once testing is completed on the non-production color, move traffic to the new version by updating the <code>designer-das</code> service.
 *Update the <code>designer-das</code> service with the new deployment color (in this example, blue is the new deployment color, that is, non-production color)
@@ Line 152: / Line 152: @@
 <div><font color="#B24DE7">
-To rollback the upgrade, modify the ingress rules to point back to the old deployment pods (green, in this example) by performing a cutover again.
+To roll back the upgrade, modify the ingress rules to point back to the old deployment pods (green, in this example) by performing a cutover again.
 *Perform a cutover using the following command:<br/>
@@ Line 170: / Line 170: @@
 <div><font color="#B24DE7">
-To rollback the upgrade, perform a cutover again to point the service back to the old deployment (green).
+To roll back the upgrade, perform a cutover again to point the service back to the old deployment (green).
 *Perform a cutover using the following command:<br/>
@@ Line 202: / Line 202: @@
 Workspace resources must be upgraded after cutover. Perform the following steps to upgrade the system resources in the Designer workspace:
-#Login to one of the Designer pods using the <code>kubectl exec -it <pod_name ></code> bash command.
+#Log in to one of the Designer pods using the <code>kubectl exec -it <pod_name ></code> bash command.
 #Execute the following migration command (this creates new directories/new files introduced in the new version):<br /> <code>node ./bin/cli.js workspace-upgrade -m -t <contact_center_id></code>
 #Execute the workspace resource upgrade command (this upgrades system resources, such as system service PHP files, internal audio files and callback resources):<br /> <code>node ./bin/cli.js workspace-upgrade -t <contact_center_id></code><br /> In the above command, <code>contact_center_id</code> , is the Contact Center ID created in GWS for this tenant (workspace resources are located under the Contact Center ID folder (''/workspaces/<ccid>/workspace'')).

@@ Line 77: / Line 77: @@
 {{AnchorDiv|BlueGreen}}<div><font color=green>
 ==Blue/Green==
-===Blue/Green: Upgrade===
+===Blue/Green: Upgrade Designer===
 </font></div>
 <div><font color="#B24DE7">
@@ Line 112: / Line 111: @@
 <div><font color=green>
-===DAS===
+===Blue/Green: Upgrade DAS===
 </font></div>
@@ Line 149: / Line 148: @@
 <font color=green>
-===Blue/Green: Rollback===
+===Blue/Green: Rollback Designer===
 </font>
@@ Line 168: / Line 166: @@
 <div><font color=green>
-===DAS===
+===Blue/Green: Rollback DAS===
 </font></div>