DES/Current/DESPEGuide/Deploy - Revision history

WikiSysop at 07:30, July 13, 2023

2023-07-13T07:30:40Z

WikiSysop at 12:30, February 20, 2023

2023-02-20T12:30:37Z

WikiSysop at 10:15, July 25, 2022

2022-07-25T10:15:41Z

WikiSysop at 20:00, June 9, 2022

2022-06-09T20:00:36Z

Show changes

WikiSysop at 08:00, June 1, 2022

2022-06-01T08:00:43Z

Show changes

WikiSysop at 17:00, April 8, 2022

2022-04-08T17:00:25Z

MPandian: Published

2022-03-28T08:34:57Z

Published

MPandian: Published

2022-02-01T07:32:19Z

Published

MPandian: Published

2021-12-22T18:10:47Z

Published

Marudhu.pandian@genesys.com: Published

2021-11-23T09:25:44Z

Published

@@ Line 92: / Line 92: @@
      DES_GWS_CLIENT_ID: xxxx
      DES_GWS_CLIENT_SECRET: xxxx
-     DES_REDIS_PASSWORD: xxxxx</source>
+     DES_REDIS_PASSWORD: xxxxx
 |Status=No
 }}{{Section

@@ Line 177: / Line 177: @@
 #Deploy the Designer service color selected in step 2. In this case, green is selected and assuming the service name is <code>designer-green</code>:<br /> <code>helm upgrade --install --namespace designer designer-green -f designer-values.yaml designer-100.0.112+xxxx.tgz --set designer.deployment.strategy=blue-green --set designer.image.tag=9.0.1xx.xx.xx --set designer.deployment.color=green</code>
+{{AnchorDiv|dascutover}}
 ===DAS===

@@ Line 125: / Line 125: @@
 <code>designer.image.tag=9.0.1xx.xx.xx</code> - This is the new Designer version to be installed, for example, <code>9.0.111.05.5</code>.
 ===DAS===
@@ Line 135: / Line 139: @@
 <code>das.image.tag=9.0.1xx.xx.xx</code> - This is the new DAS version to be installed, for example, <code>9.0.111.05.5</code>.
 |Status=No
 }}{{Section
@@ Line 227: / Line 235: @@
 #Extract the Designer Helm Chart and find the '''flowsettings.yaml''' file under the ''Designer Chart > Config'' folder.
 #Modify the necessary settings (refer to the ''Post deployment configuration settings reference table'' for the different settings and their allowed values).
-#Execute the below Helm upgrade command on the non-production color service. It can be done as part of the Designer upgrade by passing the '''flowsettings.yaml''' file using the <code>--values</code> flag. In this case, a new Designer version can be used for the upgrade. If it is only a '''flowsettings.json''' update, the same Designer version is used.<br /> <code>helm upgrade --install designer-blue -f designer-values.yaml -f flowsettings.yaml designer-9.0.xx.tgz --set designer.deployment.strategy=blue-green --set designer.image.tag=9.0.1xx.xx.xx --set designer.deployment.color=blue</code>
+#Execute the below Helm upgrade command on the non-production color service. It can be done as part of the Designer upgrade by passing the '''flowsettings.yaml''' file using the <code>--values</code> flag. In this case, a new Designer version can be used for the upgrade. If it is only a '''flowsettings.json''' update, the same Designer version is used.<br /> <code>helm upgrade --install --namespace designer designer-blue -f designer-values.yaml -f flowsettings.yaml designer-9.0.xx.tgz --set designer.deployment.strategy=blue-green --set designer.image.tag=9.0.1xx.xx.xx --set designer.deployment.color=blue</code>
 #Once testing is completed on the non-production service, perform the cutover step as mentioned in the Cutover section (Designer Blue-Green deployment). After cutover, the production service will contain the updated settings.  The non-active color Designer must also be updated with the updated settings after the cutover.<br /><br />
 |Status=No

@@ Line 314: / Line 314: @@
 |alignment=Vertical
 |structuredtext====Upgrading the Designer workspace===
 Workspace resources must be upgraded after cutover. This will upgrade the system resources in the Designer workspace:

@@ Line 60: / Line 60: @@
 *From the NFS server, execute the '''chmod -R 777 <export_path>''' and '''chown -R 500:500''' '''<export_path>''' commands to set the required permissions.
-*Create a dummy Linux based pod that mounts the NFS storage. From the pod, execute the '''chmod -R 777 <mount_path>''' and '''chown -R 500:500 <mount_path>''' commands. This sets the required permissions. However, this method might require the Linux based pods to be run as privileged.
+*Create a dummy Linux based pod that mounts the NFS storage. From the pod, execute the '''chmod -R 777 <mount_path>''' and '''chown -R 500:500 <mount_path>''' commands. This sets the required permissions. However, this method might require the Linux based dummy pods to be run as privileged pods, that is, as root.
 '''SMB / CIFS'''
-For SMB / CIFS based RWX storages, for instance, Azure file share, the below <nowiki><code>mountOptions</code></nowiki> must be used in the '''StorageClass''' or the '''PersistentVolume''' template:
+For SMB / CIFS based RWX storages, for instance, Azure file share, the below <code>mountOptions</code> must be used in the '''StorageClass''' or the '''PersistentVolume''' template using the <code>designer.volumes.workspacePv.mountOptions</code> helm values. The <code>mountOptions</code> can also be used with the storage class template though it is not recommended.
-<nowiki><code></nowiki>'''mountOptions'''<nowiki></code></nowiki><syntaxhighlight>
+'''Kubernetes clusters'''
 - dir_mode=0777
 - file_mode=0777
@@ Line 74: / Line 78: @@
 - cache=strict
 </syntaxhighlight>
 ===Set up Secrets===
 Secrets are required by the Designer service to connect to GWS and Redis (if you are using them).

@@ Line 26: / Line 26: @@
 *Header requirements - client IP & redirect,  passthrough.
 *Session stickiness - enabled.
-*Whitelisting - optional.
+*Allowlisting - optional.
 *TLS for ingress - optional (should be able to enable or disable TLS on the connection).

@@ Line 8: / Line 8: @@
 |anchor=prep
 |alignment=Vertical
-|structuredtext={{NoteFormat|Make sure to review {{Link-SomewhereInThisVersion|topic=Planning}} for the full list of prerequisites required to deploy Designer.|}}
+|structuredtext={{NoteFormat|Review the {{Link-SomewhereInThisVersion|topic=Planning}} topic for the full list of prerequisites required to deploy Designer.|}}
 Before you deploy Designer and DAS using Helm charts, complete the following preparatory steps:
@@ Line 19: / Line 19: @@
 #Download the Designer package and extract to the current working directory.
 #Configure Designer and DAS value overrides ('''designer-values.yaml''' and '''das-values.yaml'''); ensure the mandatory settings are configured. If the Blue-Green deployment process is used, Ingress settings are explained in the {{Link-SomewhereInThisVersion|manual=DESPEGuide|topic=Deploy|display text=Blue-Green deployment}} section.
+{{NoteFormat|Depending on the Kubernetes platform or the container orchestration platform that you are deploying Designer on, you might have to carry out some additional steps specific to that platform. For more information, navigate to the required topic in the '''Kubernetes platform specific information''' section on the {{Link-SomewhereInThisVersion|manual=DESPEGuide|display text=About}} page.|}}
 ===Set up Ingress===
 Given below are the requirements to set up an Ingress for the Designer UI:

@@ Line 53: / Line 53: @@
 *Max IOPS (Max IOPS w/ bursting) - 2,300 (3,500)
 *Max throughput (Max throughput w/ bursting) - 150 MB/second (170 MB/second)
 ===Set up Secrets===
@@ Line 186: / Line 207: @@
 #Create Persistent Volume Claims required for the Designer service (assuming the volume service name is <code>designer-volume</code>).<br /> <code>helm upgrade --install designer-volume -f designer-values.yaml designer-9.0.xx.tgz --set designer.deployment.strategy=blue-green-volume</code><br /> The values.yaml overrides passed as an argument to the above Helm upgrade command:<br /> <code>designer.deployment.strategy=blue-green-volume</code> - This denotes that the Helm install will create a persistent volume claim in the blue/green strategy.
 #Create Ingress rules for the Designer service (assuming the ingress service name will be designer-ingress):<br /> <code>helm upgrade --install designer-ingress -f designer-values.yaml designer-100.0.112+xxxx.tgz --set designer.deployment.strategy=blue-green-ingress --set designer.deployment.color=green</code><br /> The values.yaml overrides passed as an argument to the above Helm upgrade command:<br /> <code>designer.deployment.strategy=blue-green-ingress</code> - This denotes that the Helm install will create ingress rules for the Designer service.<br /> <code>designer.deployment.color=green</code> - This denotes that the current production (active) color is green.
-#Deploy the Designer service color selected in step 2. In this case, green is selected and assuming the service name is <code>designer-green</code>:<br /> <code>helm upgrade --install designer-green -f designer-values.yaml designer-100.0.112+xxxx.tgz --set designer.deployment.strategy=blue-green --set designer.image.tag=9.0.1xx.xx.xx --set designer.deployment.color=green</code><br /> The values.yaml overrides passed as an argument to the above Helm upgrade command:<br /> <code>designer.deployment.strategy=blue-green</code> - This denotes that the Designer service will be installed using the blue-green strategy.<br /> <code>designer.image.tag=9.0.1xx.xx.xx</code> - This denotes the Designer version to be installed, for example, <code>9.0.116.07.10</code>.<br /> <code>designer.deployment.color=green</code> - This denotes that the green color service is installed.
+#Deploy the Designer service color selected in step 2. In this case, green is selected and assuming the service name is <code>designer-green</code>:<br /> <code>helm upgrade --install designer-green -f designer-values.yaml designer-100.0.112+xxxx.tgz --set designer.deployment.strategy=blue-green --set designer.image.tag=9.0.1xx.xx.xx --set designer.deployment.color=green</code>
 ====Upgrade====
@@ Line 227: / Line 248: @@
 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:
 <code>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</code>
 ====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. If you are not opting for Canary, skip the steps in this section.
@@ Line 260: / Line 279: @@
 #If the upgrade must be rolled back, cutover has to performed again to make the service point to the old deployment (green) again. Use the below command to perform the cutover:<br /> <code>helm upgrade --install designer-das-service -f designer-das-values.yaml designer-das-100.0.106+xxxx.tgz --set das.deployment.strategy=blue-green-service --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=blue-green-service</code> - This denotes that the Helm install will create ingress rules for the DAS service.<br /> <code>das.deployment.color=green</code> - This denotes that the current production (active) color is green.
-#Verify the service by executing the <code>kubectl describe service designer-das</code> the command. The type label must have the active color's label, that is, <code>color=green</code>.<br /> <br /><br /><br />
+#Verify the service by executing the <code>kubectl describe service designer-das</code> the command. The type label must have the active color's label, that is, <code>color=green</code>.
 |Status=No
 }}{{Section