DES/Current/DESPEGuide/Upgrade - Revision history

WikiSysop at 10:15, July 25, 2022

2022-07-25T10:15:44Z

WikiSysop at 20:00, June 9, 2022

2022-06-09T20:00:39Z

WikiSysop at 08:30, June 1, 2022

2022-06-01T08:30:49Z

WikiSysop at 08:00, June 1, 2022

2022-06-01T08:00:46Z

Show changes

Marudhu.pandian@genesys.com: Published

2021-06-30T11:11:12Z

Published

New page

{{Article
|Standalone=No
|DisplayName=Upgrade, rollback, or uninstall Designer
|TocName=Upgrade, rollback, or uninstall
|Context=Learn how to upgrade, rollback or uninstall Designer.
|ComingSoon=No
|Section={{Section
|sectionHeading=Upgrade Designer
|alignment=Vertical
|structuredtext=For instructions on upgrading Designer or DAS, based on the deployment strategy adopted, refer to the corresponding section in the {{Link-SomewhereInThisVersion|manual=DESPEGuide|topic=Deploy|display text=Deploy Designer}} topic.
|Status=No
}}{{Section
|sectionHeading=Rollback Designer
|alignment=Vertical
|structuredtext=For instructions on performing a rollback for Designer or DAS, based on the deployment strategy adopted, refer to the corresponding section in the {{Link-SomewhereInThisVersion|manual=DESPEGuide|topic=Deploy|display text=Deploy Designer}} topic.
|Status=No
}}{{Section
|sectionHeading=Uninstall Designer
|alignment=Vertical
|structuredtext=To uninstall a release of Designer or DAS, use the following command:

* <code>helm uninstall <release-name></code>
|Status=No
}}{{Section
|sectionHeading=Elasticsearch maintenance recommendations
|anchor=esmaintrec
|alignment=Vertical
|structuredtext=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>
|Status=No
}}
|PEPageType=2cad3824-b3b9-43aa-a726-143cc1aaefe2
}}

@@ Line 23: / Line 23: @@
 *Designer: <source lang="text">helm upgrade --install --namespace designer 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 --namespace designer designer-das -f designer-das-values.yaml designer-das-100.0.112+1401.tgz  --set das.image.tag=9.0.111.05.5</source>
 |RollUpdRollbackExt=Follow the same instructions to roll back Designer and DAS. For example, the respective commands are:
@@ Line 43: / Line 48: @@
 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>
+<source lang="text">helm upgrade --install --namespace designer 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>
 |BlueGreenUpgCutover=Once testing is completed on the non-production color, move traffic to the new version by updating the Ingress rules:

@@ Line 21: / Line 21: @@
 |RollUpdUpgradeExt=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>
+*Designer: <source lang="text">helm upgrade --install --namespace designer 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>
+*DAS: <source lang="text">helm upgrade --install --namespace designer designer-das -f designer-das-values.yaml designer-das-100.0.112+1401.tgz  --set das.image.tag=9.0.111.05.5</source>
 |RollUpdRollbackExt=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.112.11</source>
+*Designer: <source lang="text">helm upgrade --install --namespace designer 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>
+*DAS: <source lang="text">helm upgrade --install --namespace designer designer-das -f designer-das-values.yaml designer-das-100.0.112+1401.tgz  --set das.image.tag=9.0.111.05.5</source>
 |OptRollUpdVerifyRollbackExt=*Ensure that the image version in the <service>-values.yaml file reflects the version that you rolled back to.
 |PEBlueGreenUpgrade={{PEBlueGreenUpgrade
@@ Line 35: / Line 35: @@
 #:[[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 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 />
+#:<source lang="text">helm upgrade --install --namespace designer 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 />
 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.
@@ Line 47: / Line 47: @@
 *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):
-*:<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>
+*:<source lang="text">helm upgrade --install --namespace designer 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>
 |BlueGreenUpgVerify=*Verify the ingress rules by running the following command:<br /> <code>kubectl describe ingress designer-ingress</code>
 *:The production host name must point to the new color service, that is, <code>blue</code>.
@@ Line 53: / Line 53: @@
 *Perform a cutover using the following command:
-*:<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>
+*:<source lang="text">helm upgrade --install --namespace designer 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>
 |BlueGreenRollbackVerify=*Verify the rollback in the same way that you verified the upgrade (see [[{{FULLPAGENAME}}#Blue.2FGreen|Blue-Green: Verify the upgrade]]).
 *:The type label must have the active color's label, that is, <code>color=green</code>.
@@ Line 59: / Line 59: @@
 |BlueGreenService=DAS
 |BlueGreenUpg=#Identify the current production color by checking the <code>designer-das</code> service selector labels:
-#:<source lang="text">kubectl describe service designer-das</code>.
+#:<source lang="text">kubectl describe service designer-das</source>
-#:Green is the production color in the below example as the selector label is <code>color=green</source>.
+#:Green is the production color in the below example as the selector label is <code>color=green</code>.
 #:[[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>):
-#:<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>
+#:<source lang="text">helm upgrade --install --namespace designer 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>
 Use the non-production service name to access the non-production color.
@@ Line 71: / Line 71: @@
 The <code>designer-das-green</code> release creates a service called <code>designer-das-green</code> and the <code>designer-das-blue</code> release creates a service called <code>designer-das-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 '''30280'''. If this was applied to <code>designer-das-green</code>, use a different value for <code>designer-das-blue</code>, for example, '''30281'''. Use the below helm command to achieve this:
-<source lang="text">helm upgrade --install designer-das designer-das-100.0.106+xxx.tgz -f designer-das-values.yaml --set das.deployment.strategy=blue-green-service --set das.deployment.color=green --set das.service.nodePort=30281</source>
+<source lang="text">helm upgrade --install --namespace designer designer-das designer-das-100.0.106+xxx.tgz -f designer-das-values.yaml --set das.deployment.strategy=blue-green-service --set das.deployment.color=green --set das.service.nodePort=30281</source>
 |BlueGreenUpgCutover=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)
-*:<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>
+*:<source lang="text">helm upgrade --install --namespace designer 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>
 |BlueGreenUpgVerify=*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>.
@@ Line 81: / Line 81: @@
 *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>
+*:<source lang="text">helm upgrade --install --namespace designer 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>
 |BlueGreenRollbackVerify=*Verify the rollback in the same way that you verified the upgrade (see [[{{FULLPAGENAME}}#Blue.2FGreen:_Upgrade_DAS|Blue-Green: Verify the upgrade]]).
 *:The type label must have the active color's label, <code>color=green</code>.
@@ Line 89: / Line 89: @@
 #Identify the current production color by checking the <code>designer-das</code> service selector labels (<code>kubectl describe service designer-das</code>). Green is the production color in the below example as the selector label is <code>color=green</code>.<br> [[File:CanaryInDepStep1.png|border]]
-#To deploy canary pods, the <code>das.deployment.strategy</code> value must be set to <code>canary</code> in the '''designer-das-values.yaml''' file or using the <code>-- set</code> flag as shown in the command below:<br /> <code>helm upgrade --install designer-das-canary -f das-values.yaml designer-das-100.0.106+xxxx.tgz --set das.deployment.strategy=canary --set das.image.tag=9.0.1xx.xx.xx --set das.deployment.color=green</code><br /> The values.yaml overrides passed as an argument to the above Helm upgrade command:<br /> <code>das.deployment.strategy=canary</code> - This denotes that the Helm install will create canary pods.<br /> <code>das.deployment.color=green</code> - This denotes that the current production (active) color is green.{{NoteFormat|1=To make sure Canary pods receive live traffic, they have to be exposed to the <code>designer-das</code> service by setting <code>das.deployment.color=<active_color></code>, which is obtained from step 1.|2=}}
+#To deploy canary pods, the <code>das.deployment.strategy</code> value must be set to <code>canary</code> in the '''designer-das-values.yaml''' file or using the <code>-- set</code> flag as shown in the command below:<br /> <code>helm upgrade --install --namespace designer designer-das-canary -f das-values.yaml designer-das-100.0.106+xxxx.tgz --set das.deployment.strategy=canary --set das.image.tag=9.0.1xx.xx.xx --set das.deployment.color=green</code><br /> The values.yaml overrides passed as an argument to the above Helm upgrade command:<br /> <code>das.deployment.strategy=canary</code> - This denotes that the Helm install will create canary pods.<br /> <code>das.deployment.color=green</code> - This denotes that the current production (active) color is green.{{NoteFormat|1=To make sure Canary pods receive live traffic, they have to be exposed to the <code>designer-das</code> service by setting <code>das.deployment.color=<active_color></code>, which is obtained from step 1.|2=}}
 #Once canary pods are up and running, ensure that the designer-das service points to the canary pods using the <code>kubectl describe svc designer-das</code> command.<br /> [[File:CanaryEndpoints.png|border]]<br /> The IP address present in the Endpoints must match the IP address of the canary pod. The canary pod's IP address is obtained using the <code>kubectl describe pod <canary_pod_name></code> command.<br /> [[File:CanaryIPs.png|border]]
@@ Line 96: / Line 96: @@
 The <code>das.deployment.replicaCount</code> must be made zero and the release is upgraded. It can be changed in the '''designer-das-values.yaml''' file or through the <code>--set</code> flag as follows:
-*<code>helm upgrade --install designer-das-canary -f das-values.yaml designer-das-100.0.106+xxxx.tgz --set das.deployment.strategy=canary --set das.image.tag=9.0.1xx.xx.xx --set das.deployment.color=blue --set das.deployment.replicaCount=0</code>
+*<code>helm upgrade --install --namespace designer designer-das-canary -f das-values.yaml designer-das-100.0.106+xxxx.tgz --set das.deployment.strategy=canary --set das.image.tag=9.0.1xx.xx.xx --set das.deployment.color=blue --set das.deployment.replicaCount=0</code>
 |OptPostUpgradeProc====Upgrading the Designer workspace===
 Workspace resources must be upgraded after cutover. Perform the following steps to upgrade the system resources in the Designer workspace:

@@ Line 5: / Line 5: @@
 |IncludedServiceId=1fc73d24-f1e5-45e1-a5ef-b642bbd83c9e
 |IncludedServiceUpgradeStrategy=40f069a2-01ae-4027-9aef-13f54bc53613, adcd5516-e0cf-4525-a74e-1467389675c9, d58cea3b-ff08-4fad-8b9d-7579b4145ba8
-|Notes={{Editgrn_open}}<font color=red>'''Template note for PE reviewers:''' This note is not boilerplate and is specific to Designer.</font>{{Editgrn_close}}<br />Canary is used in combination with Blue/Green.
+|Notes=Canary is used in combination with Blue/Green.
 }}{{IncludedServiceUpgradeStrategy
 |IncludedServiceId=e8818b81-a976-498c-bac3-3293d0b93b73
 |IncludedServiceUpgradeStrategy=40f069a2-01ae-4027-9aef-13f54bc53613, adcd5516-e0cf-4525-a74e-1467389675c9, d58cea3b-ff08-4fad-8b9d-7579b4145ba8
-|Notes={{Editgrn_open}}<font color=red>'''Template note for PE reviewers:''' This note is not boilerplate and is specific to Designer.{{Editgrn_close}}<br /></font>Canary is used in combination with Blue/Green.
+|Notes=Canary is used in combination with Blue/Green.
 }}{{IncludedServiceUpgradeStrategy
 |IncludedServiceId=1fc73d24-f1e5-45e1-a5ef-b642bbd83c9e
 |IncludedServiceUpgradeStrategy=40f069a2-01ae-4027-9aef-13f54bc53613, adcd5516-e0cf-4525-a74e-1467389675c9, d58cea3b-ff08-4fad-8b9d-7579b4145ba8
-|Notes={{Editgrn_open}}<font color=red>'''Template note for PE reviewers:''' This note is not boilerplate and is specific to Designer.</font>{{Editgrn_close}}<br />Canary is used in combination with Blue/Green.
+|Notes=Canary is used in combination with Blue/Green.
 }}{{IncludedServiceUpgradeStrategy
 |IncludedServiceId=e8818b81-a976-498c-bac3-3293d0b93b73
 |IncludedServiceUpgradeStrategy=40f069a2-01ae-4027-9aef-13f54bc53613, adcd5516-e0cf-4525-a74e-1467389675c9, d58cea3b-ff08-4fad-8b9d-7579b4145ba8
-|Notes={{Editgrn_open}}<font color=red>'''Template note for PE reviewers:''' This note is not boilerplate and is specific to Designer.{{Editgrn_close}}<br /></font>Canary is used in combination with Blue/Green.
+|Notes=Canary is used in combination with Blue/Green.
 }}
 |RollUpdUpgradeExt=Follow the same instructions to upgrade Designer and DAS. For example, the respective commands are: