Template:PEUpgradeBoilerplate - Revision history

WikiSysop at 12:30, February 20, 2023

2023-02-20T12:30:53Z

WikiSysop at 10:45, July 1, 2022

2022-07-01T10:45:45Z

WikiSysop at 15:15, May 31, 2022

2022-05-31T15:15:58Z

WikiSysop at 07:45, May 25, 2022

2022-05-25T07:45:39Z

WikiSysop at 21:33, May 20, 2022

2022-05-20T21:33:47Z

WikiSysop: Created page with "{{#switch:{{NAMESPACENUMBER}}|620=|#default=}}{{#switch:{{{BoilerplateSection|}}}..."

2022-05-19T22:45:40Z

Created page with "<onlyinclude>{{#switch:{{NAMESPACENUMBER}}|620=|#default=}}{{#switch:{{{BoilerplateSection|}}}..."

New page

<onlyinclude>{{#switch:{{NAMESPACENUMBER}}|620=|#default=}}{{#switch:{{{BoilerplateSection|}}}
|UpgradeIntro={{NoteFormat|The instructions on this page assume you have deployed the services in service-specific namespaces or OpenShift projects. 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.}}
==Supported upgrade strategies==
{{#sub:{{MINTYDOCSMANUAL}}|0|-22}} supports the following upgrade strategies:
{{#switch:{{{AddIncluded|}}}
|Yes=
{{#cargo_query:tables=IncludedServiceUpgradeStrategy,IncludedService
|join on=IncludedServiceUpgradeStrategy.IncludedServiceId=IncludedService.Id
|fields=IncludedService.Name=Service,IncludedServiceUpgradeStrategy=UpgradeStrategy,IncludedServiceUpgradeStrategy.Notes=Notes
|default=
|where=IncludedServiceUpgradeStrategy._pageName="{{FULLPAGENAME}}"
|named args=yes
|format=template
|template=IncludedServiceUpgradeStrategyPrint|intro=<table><tr><th>Service</th><th>Upgrade Strategy</th><th>Notes</th></tr>|outro=</table>}}
The upgrade or rollback process to follow depends on how you deployed the service initially. Based on the deployment strategy adopted during initial deployment, refer to the corresponding upgrade or rollback section on this page for related instructions.
|No
|#default=
{{{!}}
!Service
! Upgrade Strategy
! Notes
{{!}}-
{{!}} {{#cargo_query:tables=ArticlePEServiceUpgrade,Service|join on=ArticlePEServiceUpgrade.ServiceId=Service.Id|fields=Service.Name|default=|where=ArticlePEServiceUpgrade._pageNamespace="{{NAMESPACENUMBER}}" AND ServiceId="{{{ServiceId}}}" }}
{{!}} {{#arraymap:{{{UpgradeStrategy|}}}|,|x|{{#cargo_query:tables=UpgradeStrategy|fields= CONCAT('[[{{FULLPAGENAME}}#',StrategyName,'|',StrategyName,']]')|where=Id="x"|default={{{UpgradeStrategy|}}}}}| Or }}
{{!}}{{#cargo_query:tables=ArticlePEServiceUpgrade,Service|join on=ArticlePEServiceUpgrade.ServiceId=Service.Id|fields=ArticlePEServiceUpgrade.Notes|default=|where=ArticlePEServiceUpgrade._pageNamespace="{{NAMESPACENUMBER}}" AND ServiceId="{{{ServiceId}}}" }}
{{!}}}
}}

For a conceptual overview of the upgrade strategies, refer to {{Link-AnywhereElse|product=PrivateEdition|version=Current|manual=PEGuide|topic=UpgradStrats}} in the {{Link-AnywhereElse|product=PrivateEdition|version=Current|manual=PEGuide}} guide.
{{{IncludedServiceUpgradeStrategy|}}}[[Category:Linkable]]
|Timing=<nowiki/>
==Timing==
A regular upgrade schedule is necessary to fit within the Genesys policy of supporting N-2 releases, but a particular release might warrant an earlier upgrade (for example, because of a critical security fix).
===Scheduling considerations===
Genesys recommends that you upgrade the services methodically and sequentially: Complete the upgrade for one service and verify that it upgraded successfully before proceeding to upgrade the next service. If necessary, roll back the upgrade and verify successful rollback. 
|Monitoring=<nowiki/>
==Monitoring==
Monitor the upgrade process using standard Kubernetes and Helm metrics, as well as service-specific metrics that can identify failure or successful completion of the upgrade (see [[{{#replace:{{FULLPAGENAME}}|{{#explode:{{FULLPAGENAME}}|/|3}}|Observability}}|Observability in {{#sub:{{MINTYDOCSMANUAL}}|0|-22}}]]).

Genesys recommends that you create custom alerts for key indicators of failure — for example, an alert that a pod is in pending state for longer than a timeout suitable for your environment. Consider including an alert for the absence of metrics, which is a situation that can occur if the Docker image is not available. Note that Genesys does not provide support for custom alerts that you create in your environment.
|PrepSteps={{AnchorDiv|PreparatorySteps}}
==Preparatory steps==
Ensure that your processes have been set up to enable easy rollback in case an upgrade leads to compatibility or other issues.

Each time you upgrade a service:
#Review the release note to identify changes.
#Ensure that the new package is available for you to deploy in your environment.
#Ensure your existing '''<override>-values.yaml''' file is available and update it if required to implement changes.
|RollUpdUpgrade={{AnchorDiv|RollUpd}}
==Rolling Update==
===Rolling Update: Upgrade===
Execute the following command to upgrade <service>:
<source lang="text">helm upgrade --install <service> -f <override>-values.yaml <Helm package> -n <namespace></source>
'''Tip:''' If the only update you need to make to your existing '''<override>-values.yaml''' file is to update the image version, you can pass the image tag as an argument by using the <tt>--set</tt> flag in the command:
<source lang="text">helm upgrade --install <service> -f <override>-values.yaml <Helm package> --set <service>.image.tag=<new service version></source>
|RollUpdVerify={{AnchorDiv|RollUpdVerify}}
===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 the service has upgraded successfully.
|RollUpdRollback={{AnchorDiv|RollUpdRollback}}
===Rolling Update: Rollback===
{{Editgrn_open}}'''Writer's note:''' This section's boilerplate has been revised since the first review.{{Editgrn_close}} 
Execute the following command to roll back the upgrade to the previous version:
<source lang="text">helm rollback <service></source>
or, to roll back to an even earlier version:
<source lang="text">helm rollback <service> <revision version></source>

Alternatively, you can re-install the previous package:
# Revert the image version in the <tt><service>.image.tag</tt> parameter in the '''<override>-values.yaml''' file. If applicable, also revert any configuration changes you implemented for the new release.
# Execute the following command to roll back the upgrade:
#: <source lang="text">helm upgrade --install <service> -f <override>-values.yaml <old Helm package></source>
#: '''Tip:''' You can also directly pass the image tag as an argument by using the <tt>--set</tt> flag in the command:
#: <source lang="text">helm upgrade --install <service> -f <override>-values.yaml <old Helm package> --set <service>.image.tag=<old service version></source>
|RollUpdVerifyRollback=<nowiki/>
===Rolling Update: Verify the rollback===
Verify the rollback in the same way that you verified the upgrade (see [[{{FULLPAGENAME}}#RollUpdVerify|Rolling Update: Verify the upgrade]]).
|Uninstall={{AnchorDiv|Uninstall}}
==Uninstall==
{{NoteFormat|{{Editgrn_open}}Uninstalling a service removes all Kubernetes resources associated with that service. Genesys recommends that you contact [https://www.genesys.com/customer-care Genesys Customer Care] before uninstalling any private edition services, particularly in a production environment, to ensure that you understand the implications and to prevent unintended consequences arising from, say, unrecognized dependencies or purged data.{{Editgrn_close}}|3}}
*Execute the following command to uninstall <service>:
<source lang="text">helm uninstall <service> -n <namespace></source>
|#default=}}{{#switch:{{NAMESPACENUMBER}}|620=|#default=}}</onlyinclude>

@@ Line 1: / Line 1: @@
 <onlyinclude>{{#switch:{{NAMESPACENUMBER}}|620=<font color=green>|#default=}}{{#switch:{{{BoilerplateSection|}}}<!--Boilerplate text for the intro on the PE Upgrade topic.-->
-|UpgradeIntro={{NoteFormat|The instructions on this page assume you have deployed the services in service-specific namespaces or OpenShift projects. 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.}}
+|UpgradeIntro={{NoteFormat|The instructions on this page assume you have deployed the services in service-specific namespaces. 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.}}
 ==Supported upgrade strategies==
 {{#sub:{{MINTYDOCSMANUAL}}|0|-22}} supports the following upgrade strategies:

@@ Line 32: / Line 32: @@
 ==Timing==
 A regular upgrade schedule is necessary to fit within the Genesys policy of supporting N-2 releases, but a particular release might warrant an earlier upgrade (for example, because of a critical security fix).
 ===Scheduling considerations===
-Genesys recommends that you upgrade the services methodically and sequentially: Complete the upgrade for one service and verify that it upgraded successfully before proceeding to upgrade the next service. If necessary, roll back the upgrade and verify successful rollback. <!--End of Timing section -->
+Genesys recommends that you upgrade the services methodically and sequentially: Complete the upgrade for one service and verify that it upgraded successfully before proceeding to upgrade the next service. If necessary, roll back the upgrade and verify successful rollback.
 |Monitoring=<nowiki/>
 ==Monitoring==

@@ Line 43: / Line 43: @@
 Ensure that your processes have been set up to enable easy rollback in case an upgrade leads to compatibility or other issues.
 Each time you upgrade a service:
 #Review the release note to identify changes.
@@ Line 52: / Line 53: @@
 Execute the following command to upgrade <service>:
 <source lang="text">helm upgrade --install <service> -f <override>-values.yaml <Helm package> -n <namespace></source>
-'''Tip:''' If the only update you need to make to your existing '''<override>-values.yaml''' file is to update the image version, you can pass the image tag as an argument by using the <tt>--set</tt> flag in the command:
+'''Tip:''' If your review of Helm chart changes (see [[{{FULLPAGENAME}}#PrepStep3|Preparatory Step 3]]) identifies that the only update you need to make to your existing '''<override>-values.yaml''' file is to update the image version, you can pass the image tag as an argument by using the <tt>--set</tt> flag in the command:
 <source lang="text">helm upgrade --install <service> -f <override>-values.yaml <Helm package> --set <service>.image.tag=<new service version></source><!-- End of RollUpdUpgrade section-->
 |RollUpdVerify={{AnchorDiv|RollUpdVerify}}

@@ Line 59: / Line 59: @@
 |RollUpdRollback={{AnchorDiv|RollUpdRollback}}
 ===Rolling Update: Rollback===
 Execute the following command to roll back the upgrade to the previous version:
 <source lang="text">helm rollback <service></source>
@@ Line 76: / Line 75: @@
 |Uninstall={{AnchorDiv|Uninstall}}
 ==Uninstall==
-{{NoteFormat|{{Editgrn_open}}Uninstalling a service removes all Kubernetes resources associated with that service. Genesys recommends that you contact [https://www.genesys.com/customer-care Genesys Customer Care] before uninstalling any private edition services, particularly in a production environment, to ensure that you understand the implications and to prevent unintended consequences arising from, say, unrecognized dependencies or purged data.{{Editgrn_close}}|3}}
+{{NoteFormat|Uninstalling a service removes all Kubernetes resources associated with that service. Genesys recommends that you contact [https://www.genesys.com/customer-care Genesys Customer Care] before uninstalling any private edition services, particularly in a production environment, to ensure that you understand the implications and to prevent unintended consequences arising from, say, unrecognized dependencies or purged data.|3}}
 Execute the following command to uninstall <service>:
 <source lang="text">helm uninstall <service> -n <namespace></source>
 |#default=}}{{#switch:{{NAMESPACENUMBER}}|620=</font>|#default=}}</onlyinclude>

@@ Line 46: / Line 46: @@
 #Review the release note to identify changes.
 #Ensure that the new package is available for you to deploy in your environment.
-#Ensure your existing '''<override>-values.yaml''' file is available and update it if required to implement changes.<!--End of PrepSteps section-->
+#Ensure that your existing '''<override>-values.yaml''' file is available and update it if required to implement changes.<!--End of PrepSteps section-->
 |RollUpdUpgrade={{AnchorDiv|RollUpd}}
 ==Rolling Update==
@@ Line 77: / Line 77: @@
 ==Uninstall==
 {{NoteFormat|{{Editgrn_open}}Uninstalling a service removes all Kubernetes resources associated with that service. Genesys recommends that you contact [https://www.genesys.com/customer-care Genesys Customer Care] before uninstalling any private edition services, particularly in a production environment, to ensure that you understand the implications and to prevent unintended consequences arising from, say, unrecognized dependencies or purged data.{{Editgrn_close}}|3}}
-*Execute the following command to uninstall <service>:
+Execute the following command to uninstall <service>:
 <source lang="text">helm uninstall <service> -n <namespace></source>
 |#default=}}{{#switch:{{NAMESPACENUMBER}}|620=</font>|#default=}}</onlyinclude>