Difference between revisions of "Template: PEUpgradeBoilerplate"
From Genesys Documentation
(Created page with "<onlyinclude>{{#switch:{{NAMESPACENUMBER}}|620=<font color=green>|#default=}}{{#switch:{{{BoilerplateSection|}}}<!--Boilerplate text for the intro on the PE Upgrade topic.-->...") |
|||
| (4 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
<onlyinclude>{{#switch:{{NAMESPACENUMBER}}|620=<font color=green>|#default=}}{{#switch:{{{BoilerplateSection|}}}<!--Boilerplate text for the intro on the PE Upgrade topic.--> | <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 | + | |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== | ==Supported upgrade strategies== | ||
{{#sub:{{MINTYDOCSMANUAL}}|0|-22}} supports the following upgrade strategies: | {{#sub:{{MINTYDOCSMANUAL}}|0|-22}} supports the following upgrade strategies: | ||
| Line 32: | Line 32: | ||
==Timing== | ==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). | 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). | ||
| + | |||
| + | If the service you are upgrading requires a later version of any third-party services, upgrade the third-party service(s) before you upgrade the private edition service. For the latest supported versions of third-party services, see the {{Link-AnywhereElse|product=PrivateEdition|version=Current|manual=PEGuide|topic=Prerequisites}} page in the suite-level guide. | ||
===Scheduling considerations=== | ===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. |
| + | |||
| + | {{#switch:{{NAMESPACENUMBER}}|620= | ||
| + | {{Editgrn_open}}<font color=red>In addition to providing info on any specific scheduling considerations for your service, please also include information on any specific needs for upgrading the 3rd party services that your service uses.</font>{{Editgrn_close}} | ||
| + | |#default= | ||
| + | }} | ||
| + | <!--End of Timing section --> | ||
|Monitoring=<nowiki/> | |Monitoring=<nowiki/> | ||
==Monitoring== | ==Monitoring== | ||
| Line 43: | Line 51: | ||
Ensure that your processes have been set up to enable easy rollback in case an upgrade leads to compatibility or other issues. | Ensure that your processes have been set up to enable easy rollback in case an upgrade leads to compatibility or other issues. | ||
| + | {{AnchorDiv|PrepStep3}} | ||
Each time you upgrade a service: | Each time you upgrade a service: | ||
#Review the release note to identify changes. | #Review the release note to identify changes. | ||
#Ensure that the new package is available for you to deploy in your environment. | #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}} | |RollUpdUpgrade={{AnchorDiv|RollUpd}} | ||
==Rolling Update== | ==Rolling Update== | ||
| Line 52: | Line 61: | ||
Execute the following command to upgrade <service>: | Execute the following command to upgrade <service>: | ||
<source lang="text">helm upgrade --install <service> -f <override>-values.yaml <Helm package> -n <namespace></source> | <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--> | <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}} | |RollUpdVerify={{AnchorDiv|RollUpdVerify}} | ||
| Line 59: | Line 68: | ||
|RollUpdRollback={{AnchorDiv|RollUpdRollback}} | |RollUpdRollback={{AnchorDiv|RollUpdRollback}} | ||
===Rolling Update: Rollback=== | ===Rolling Update: Rollback=== | ||
| − | |||
Execute the following command to roll back the upgrade to the previous version: | Execute the following command to roll back the upgrade to the previous version: | ||
<source lang="text">helm rollback <service></source> | <source lang="text">helm rollback <service></source> | ||
| Line 76: | Line 84: | ||
|Uninstall={{AnchorDiv|Uninstall}} | |Uninstall={{AnchorDiv|Uninstall}} | ||
==Uninstall== | ==Uninstall== | ||
| − | {{NoteFormat| | + | {{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> | <source lang="text">helm uninstall <service> -n <namespace></source> | ||
|#default=}}{{#switch:{{NAMESPACENUMBER}}|620=</font>|#default=}}</onlyinclude> | |#default=}}{{#switch:{{NAMESPACENUMBER}}|620=</font>|#default=}}</onlyinclude> | ||