diff --git a/_static/banners/db-upgrade.png b/_static/banners/db-upgrade.png new file mode 100644 index 000000000..e6186e85d Binary files /dev/null and b/_static/banners/db-upgrade.png differ diff --git a/db_management/db_upgrade.rst b/db_management/db_upgrade.rst new file mode 100644 index 000000000..2f0d99161 --- /dev/null +++ b/db_management/db_upgrade.rst @@ -0,0 +1,418 @@ +:banner: banners/db-upgrade.png + +.. |assistance-contact| replace:: + If you need Odoo assistance on this matter, please contact your Odoo Account Manager or contact + our `Sales department`_. +.. _Sales department: mailto:sales@odoo.com + +.. _db-upgrade: + +======= +Upgrade +======= + +.. _db-upgrade/overview: + +Overview +======== + +.. _db-upgrade/process: + +The upgrade process +------------------- + +This documentation is for our *On-Premise* (self-hosted) and *Odoo.sh* customers. If you are hosted +Online, please check our :ref:`instruction page for our Online (SaaS) customers `. + +.. _db-upgrade/definition: + +Definition +~~~~~~~~~~ + +An upgrade is switching to a newer version of Odoo (e.g., Odoo 13.0 to Odoo 14.0) + +An upgrade does not cover: + +* changing :ref:`Editions ` (i.e., Community to Enterprise edition) +* switching :ref:`hosting type ` (i.e., On-Premise to Online or + Odoo.sh) +* migration from another ERP to Odoo + +.. note:: |assistance-contact| + +.. _db-upgrade/process-workflow: + +Process workflow +~~~~~~~~~~~~~~~~ + +The upgrade process in a nutshell: + +#. You create a test upgrade request. +#. | The request is processed by Odoo: + | This happens via an automated process that runs the database through an upgrade script and + takes between 20 and 120 minutes. Only if an issue(s) arises will we have to intervene + manually and adjust the script specifically to your database until the upgrade succeeds. +#. Odoo delivers a test database. +#. You test your database for possible discrepancies (see :ref:`db-upgrade/test-guidance`) +#. If there are any discrepancies, you report them to the Upgrade support team via the + :ref:`Help portal `. +#. We will fix the issues and send you a new test database. +#. Once you completed the testing and are happy with the result, you decide on a date and time when + you stop users from accessing Odoo, freeze all data entries and create an upgrade request for the + production upgrade. +#. Odoo delivers the production database through the automated process. +#. You restore it in your Production environment a few short hours later and continue working on the + newly upgraded database. + +.. _db-upgrade/service-level: + +Service Level Agreement +----------------------- + +What is covered by the Enterprise Licence? +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +Databases hosted on Odoo’s Cloud platforms (Saas and Odoo.sh) or On-Premise (Self-Hosting) enjoy the +following service at all times. + +The upgrade of: + +* standard applications +* Studio customization (as long as the Studio app is still active) +* customizations done by our consulting and developer services *if* they are covered by a + ‘Maintenance of Customisations’ subscription + +The Upgrade Service is limited to the technical conversion and adaptation of your database (standard +modules and data) to make it compatible with the targeted version. + +What upgrading does NOT cover +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +* The cleaning of pre-existing data & configuration while upgrading +* Any new developments and/or upgrade of your own :ref:`custom modules + ` +* `Training `_ on the new version + +You can get more information about your Enterprise Licence on our :ref:`Odoo Enterprise Subscription +Agreement ` page. + +.. note:: |assistance-contact| + +.. _db-upgrade/get-started: + +Get started +=========== + +The upgrade process varies depending on where your database is hosted. + +.. _db-upgrade/online: + +Online (SaaS) +------------- + +If you are hosted Online, please check our :ref:`instruction page for our Online (SaaS) customers +`. + +.. _db-upgrade/odoo-sh: + +Odoo.sh +------- + +If you are Odoo.sh hosted, check our :doc:`specific instructions to be able to upgrade +<../odoo_sh/advanced/upgrade_your_database>`. + +.. _db-upgrade/on-premise: + +On-Premise +---------- + +There are two possibilities: + +#. Via the interface of our `website form `_ +#. | For technically-advanced users and partners, via the following command line (to be used on the + machine where your database is hosted): + | ``python <(curl -s beta.upgrade.odoo.com/upgrade) test -d -t 14.0 -c `` + +What does it do? +~~~~~~~~~~~~~~~~ + +The above command will dump your database to a file, then send it to the upgrade platform for +upgrade, displaying you the live logs, then restore the upgraded database back on your server as a +duplicate test database. + +.. _db-upgrade/steps: + +Steps +===== + +.. _db-upgrade/steps-test: + +The testing phase +----------------- + +.. _db-upgrade/test-process: + +Test process +~~~~~~~~~~~~ + +Also referred to as the pre-production phase, the test phase allows you to review an upgraded +version of your database without affecting your production database in any way. + +We suggest that you run the test upgrade process at least once, but you can do it as often as you +want (one at a time). + +Once you receive your upgraded test database, you should check that all data, processes and +functionality are still correct and working as expected. + +If you do find discrepancies, you'll be able to: + +* | :ref:`Report your issues ` + | and/or +* Ask for a new :ref:`test request ` after the reported issues have + been fixed in the upgrade script. + +When you do not find any discrepancies, you'll be able to: + +* Move on to the upgrade of your :ref:`production database `. + +.. _db-upgrade/test-db-request: + +Request a test database +~~~~~~~~~~~~~~~~~~~~~~~ + +When filling the `website form `_, select *Testing* purpose. + +.. image:: media/db-upgrade-test-purpose.png + :align: center + :alt: Selection of the "Testing" purpose in the upgrade form on Odoo + +.. _db-upgrade/test-guidance: + +Test guidance +~~~~~~~~~~~~~ + +Every business and organization has its own operational needs and will have to test its specific +Odoo instance respectively. However, we recommend you look at `the test scenario +`_ we created, a high-level idea +of what you should test and look out for. + +.. todo:: change link "test scenario" once the related doc is published + +.. _db-upgrade/test-assistance: + +Assistance +~~~~~~~~~~ + +If you encounter issues or problems in the **test database**, please contact the Odoo Upgrade +Support: + +#. Connect to our `Odoo Support page `_. +#. Under the *Ticket Description* section, select *An issue related to my upgrade* ticket type. + + .. image:: media/db-upgrade-test-assistance.png + :align: center + :alt: Selection of "An issue related to my upgrade" as Ticket Type in the support form on Odoo + + .. warning:: + If you choose another *Ticket Description* type, the request will be redirected to another + team than the upgrade one and will slow down the processing and response time. + +#. Please provide as much detail as you can. Where applicable, illustrate the current and previous + flows with videos and/or screenshots. This will avoid clarifying questions and speed up the + resolution process significantly. + + .. image:: media/db-upgrade-test-assistance-details.png + :align: center + :alt: "Detailed Description" field in the support form on Odoo + +.. note:: + * The purpose of the test phase is not to correct existing data or configurations in your + database. + * |assistance-contact| + +.. _db-upgrade/steps-production: + +The production launch +--------------------- + +.. _db-upgrade/production-live: + +Production goes live +~~~~~~~~~~~~~~~~~~~~ + +The production upgrade request is when you decide to upgrade your current database with all your +production data (invoices, VAT returns, inventories, current orders) to a new version of your choice. + +After your :ref:`tests ` are completed to your satisfaction, submit the +request to upgrade your production database via our `website form `_. +Select *Production* purpose. + +.. image:: media/db-upgrade-production-purpose.png + :align: center + :alt: Selection of the "Production" purpose in the upgrade form on Odoo + +.. danger:: + Going into production without first testing may lead to: + + - business interruptions (e.g. no longer having the possibility to validate an action) + - poor customer experiences (e.g. an eCommerce website that does not work correctly) + +.. _db-upgrade/production-assistance: + +Assistance +~~~~~~~~~~ + +If you encounter issues or problems in the **production database**, please contact the Odoo Upgrade +Support: + +#. Connect to our `Odoo Support page `_. +#. Under the *Ticket Description* section, select *An issue related to my upgrade* ticket type. + Under the *Ticket Description* section, select the appropriate type related to your issue but + **do not select** the option *An issue related to my upgrade*. + + .. note:: + After upgrading to production, the support will be provided by the Support team instead of the + Upgrade team. + +#. Please provide as much detail as you can. Where applicable, illustrate the current and previous + flows with videos and/or screenshots. This will avoid clarifying questions and speed up the + resolution process significantly. + + .. image:: media/db-upgrade-production-assistance-details.png + :align: center + :alt: "Detailed Description" field in the support form on Odoo + + .. warning:: + If you choose another *Ticket Description* type, the request will be redirected to another + team than the upgrade one and will slow down the processing and response time. + +.. _db-upgrade/faq: + +FAQ +=== + +.. _db-upgrade/faq/why: + +Why upgrade? +------------ + +* You benefit from the latest features of the :ref:`new major version + ` released by Odoo. +* If you are in an :ref:`unsupported version `, you get a new version + with support. + +.. _db-upgrade/faq/when: + +When to upgrade? +---------------- + +Whenever you want. You can make your upgrade request as soon as a new version is released on our +`website form `_. + +.. _db-upgrade/faq/availability: + +Availability of the new version +------------------------------- + +Please kindly note that as soon as we announce the release of a new major version (usually at the +end of year), the Upgrade Service team needs to adapt the upgrade scripts to it, which is why the +new version is not immediately available for existing databases. + +.. _db-upgrade/faq/finalization: + +Finalization of the upgrade (:abbr:`ETA (Estimated Time of Arrival)`) +--------------------------------------------------------------------- + +Unfortunately, it is impossible to give time estimates for every upgrade request. Odoo offers so +many possibilities (e.g. branding, workflows, customization, etc) that it can get tricky to upgrade, +and translate to the new structure. If you use multiple apps managing sensitive data (e.g., +Accounting, Inventory, etc.), some cases may still require a human intervention, making the process +slower. + +This is especially true during the first months following the release of a new major version, which +can significantly lengthen the upgrade delay. + +In general, the ‘smaller’ the database, the quickest the upgrade. A single-user database that uses +only CRM will be processed faster than a multi-company, multi-user database that uses Accounting, +Sales, Purchase, and Manufacturing. + +So, in a nutshell, what can impact your upgrade lead time? + +* Source & targeted versions +* Installed apps +* Volume of data +* Amount of customization (models, fields, methods, workflows, reports, website, etc.) +* Installation of new apps or configuration changes after the start of the test phase + +Usually, the delays experienced during the first request (waiting time between the time you +submitted your first request for a test upgrade) can generally give you an idea of the time to wait +for the production request. + +.. _db-upgrade/faq/custom-modules: + +Upgrade of the custom modules +----------------------------- + +As stated in our :doc:`../legal/terms/enterprise`, section :ref:`charges_standard`, this optional +service is subject to additional fees. + +If you have a custom code, you can choose to have it upgraded by our services, by one of our +`partners `_ or you can do it yourself. + +.. note:: |assistance-contact| + +.. _db-upgrade/faq/editions-change: + +Editions change (from Community to Enterprise) +---------------------------------------------- + +An upgrade does not cover a change of `Editions `_ + +.. note:: |assistance-contact| + +.. _db-upgrade/faq/hosting-types-switch: + +Switching the hosting types (Self-hosted vs Online vs Odoo.sh) +-------------------------------------------------------------- + +An upgrade does not cover a change of `Hosting types `_. + +Open the following link to get :doc:`more information about how to change your hosting type +`. + +.. note:: |assistance-contact| + +.. _db-upgrade/faq/release-notes: + +Release Notes by version +------------------------ + +Open our `Release Note `_ page to get a summary of the new +features and improvements made in each version. + +.. _db-upgrade/assistance: + +Assistance +========== + +.. _db-upgrade/contact: + +Contact our Upgrade service support +----------------------------------- + +Should you have any more questions about the upgrade, do not hesitate to send a message to `Odoo +Upgrade Team `_. We will be very pleased to answer it as soon as possible. + +.. _db-upgrade/supported-versions: + +Supported versions +------------------ + +Please note that Odoo provides support and bug fixing only for the three last major versions of Odoo. + +This is a factor to take into consideration before upgrading. If you are on an older version, we +suggest you to prefer the most recent version to benefit from a longer support (before having to +upgrade again). + +You can get more information about our :doc:`supported versions <../support/supported_versions>`. \ No newline at end of file diff --git a/db_management/media/db-upgrade-production-assistance-details.png b/db_management/media/db-upgrade-production-assistance-details.png new file mode 100644 index 000000000..64658151c Binary files /dev/null and b/db_management/media/db-upgrade-production-assistance-details.png differ diff --git a/db_management/media/db-upgrade-production-purpose.png b/db_management/media/db-upgrade-production-purpose.png new file mode 100644 index 000000000..9ece9efcc Binary files /dev/null and b/db_management/media/db-upgrade-production-purpose.png differ diff --git a/db_management/media/db-upgrade-test-assistance-details.png b/db_management/media/db-upgrade-test-assistance-details.png new file mode 100644 index 000000000..9531e732f Binary files /dev/null and b/db_management/media/db-upgrade-test-assistance-details.png differ diff --git a/db_management/media/db-upgrade-test-assistance.png b/db_management/media/db-upgrade-test-assistance.png new file mode 100644 index 000000000..0cd605ccb Binary files /dev/null and b/db_management/media/db-upgrade-test-assistance.png differ diff --git a/db_management/media/db-upgrade-test-purpose.png b/db_management/media/db-upgrade-test-purpose.png new file mode 100644 index 000000000..99aee0eaa Binary files /dev/null and b/db_management/media/db-upgrade-test-purpose.png differ diff --git a/practical.rst b/practical.rst index 266af757a..386b9d52e 100644 --- a/practical.rst +++ b/practical.rst @@ -11,6 +11,7 @@ Practical Information db_management/db_online db_management/db_premise db_management/hosting_changes + db_management/db_upgrade portal/my_odoo_portal support legal