Skip to content

Commit bdc749e

Browse files
committed
[IMP] upgrade: update and improve the upgrade processes and information
task ID: 2684744 closes #1509 Signed-off-by: Antoine Vandevenne (anv) <[email protected]>
1 parent ad21a7a commit bdc749e

22 files changed

+463
-345
lines changed

content/administration/maintain/online.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -36,8 +36,8 @@ Upgrade
3636
=======
3737

3838
If you are *not* on the latest **Online version**, you should receive an invitation to :doc:`upgrade
39-
<../upgrade/process>` your database. A **Rolling Release button** on your database's main screen
40-
proposes an upgrade to the latest version (e.g., 13.0 to 15.1).
39+
<../upgrade>` your database. A **Rolling Release button** on your database's main screen proposes an
40+
upgrade to the latest version (e.g., 13.0 to 15.1).
4141

4242
.. important::
4343
- | **If your Odoo database's version is lower than the latest major release:**
@@ -53,7 +53,7 @@ proposes an upgrade to the latest version (e.g., 13.0 to 15.1).
5353
allows you to request a test upgrade of your database to check for any discrepancies.
5454

5555
.. seealso::
56-
- :doc:`../upgrade/process`
56+
- :doc:`../upgrade`
5757
- :doc:`supported_versions`
5858

5959
.. _online/duplicate:

content/administration/maintain/supported_versions.rst

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,8 +11,7 @@ Odoo provides support and bug fixing **for the 3 last major versions** of Odoo.
1111
Odoo releases intermediary versions called **Online versions** on the :doc:`Odoo Online <online>`
1212
hosting every two months. Odoo Online users can then benefit from the latest features of Odoo.
1313

14-
- Admins of Odoo Online databases are invited to :doc:`upgrade <../upgrade/process>` them
15-
regularly.
14+
- Admins of Odoo Online databases are invited to :doc:`upgrade <../upgrade>` them regularly.
1615
- Online versions are *not* released for Odoo.sh and On-Premise installations.
1716
- Online versions are listed below as *SaaS*.
1817

content/administration/upgrade.rst

Lines changed: 250 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,257 @@
1-
:nosearch:
1+
:show-content:
2+
3+
.. |assistance-contact| replace::
4+
If you need Odoo assistance on this matter, please get in touch with your Odoo Account Manager or
5+
our `Sales department`_.
6+
.. _Sales department: mailto:[email protected]
27

38
=======
49
Upgrade
510
=======
611

712
.. toctree::
13+
:titlesonly:
14+
15+
upgrade/online_hosting
16+
upgrade/odoo_sh
17+
upgrade/on_premise
18+
upgrade/faq
19+
20+
An upgrade is switching to a newer version of Odoo (e.g., Odoo 14.0 to Odoo 15.0).
21+
22+
An upgrade does not cover:
23+
24+
* Changing :ref:`editions <upgrade-faq/editions-change>` (i.e., Community to Enterprise edition)
25+
* Switching :ref:`hosting type <upgrade-faq/hosting-types-switch>` (i.e., On-Premise to Online or
26+
Odoo.sh)
27+
* Migration from another ERP to Odoo
28+
29+
.. note:: |assistance-contact|
30+
31+
.. seealso::
32+
- :ref:`upgrade/sla`
33+
34+
.. _upgrade/process-workflow:
35+
36+
Process workflow
37+
================
38+
39+
The upgrade process in a nutshell:
40+
41+
#. You create a test upgrade request.
42+
#. Odoo processes the request automatically by running the database through an upgrade script, which
43+
takes between 20 and 120 minutes.
44+
#. Odoo delivers a test database.
45+
#. You test your database for possible discrepancies (see :ref:`upgrade/test-guidance`).
46+
#. If there are any discrepancies, you report them to the Upgrade support team via the help portal
47+
(see :ref:`upgrade/test-assistance`).
48+
#. We fix the issues and send you a new test database.
49+
#. Once you have completed the testing and are happy with the result, you decide on a date and time
50+
when you stop users from accessing Odoo, freeze all data entries, and create an upgrade request
51+
for the production upgrade.
52+
#. Odoo delivers the production database through the automated process.
53+
#. You restore it in your Production environment a few short hours later and continue working on the
54+
newly upgraded database (this is done automatically on Odoo Online).
55+
56+
.. seealso::
57+
- :doc:`upgrade/online_hosting`
58+
- :doc:`upgrade/odoo_sh`
59+
- :doc:`upgrade/on_premise`
60+
61+
.. _upgrade/testing-phase:
62+
63+
Testing
64+
=======
65+
66+
This phase allows you to review an upgraded version of your database without affecting your
67+
production database in any way. We suggest that you run the test upgrade process at least once, but
68+
you can do it as many times as you need (one at a time).
69+
70+
Once you receive your upgraded test database, check that all data, processes, and functionality are
71+
still correct and working as expected.
72+
73+
If you do find discrepancies, :ref:`report your issues <upgrade/test-assistance>` and :ref:`request
74+
a new test database <upgrade/test-db-request>` when the reported issues are fixed in the upgrade
75+
script.
76+
77+
If you do not find any discrepancies, you can move on to the upgrade of your production database.
78+
79+
.. important::
80+
A test database is only intended for testing and remains completely unrelated to your present or
81+
future production database. Any data you add, or changes you make, will not be reflected in your
82+
upgraded production database.
83+
84+
.. note::
85+
Test databases are neutered and features are disabled to prevent them from having an impact on
86+
the production database:
87+
88+
#. The serial number of the database is modified (to prevent it from sending information as if it
89+
was the production database).
90+
#. The :ref:`base URL of the database <domain-name/web-base-url>` is reset to
91+
``http://localhost:8069`` and the email domain to ``localhost``.
92+
#. Scheduled actions are disabled (the calendar synchronization, the bank statement
93+
synchronization, the planned automated actions, the fetching of incoming mail servers, etc.).
94+
#. Outgoing mail servers are disabled by archiving the existing ones and adding a
95+
fake/non-working one.
96+
#. Payment providers and delivery carriers are reset to test environment.
97+
#. Accounting localization Electronic Data Interchange (EDI) services are disabled.
98+
#. A system parameter is set to tell the database has been neutered.
99+
100+
.. _upgrade/test-db-request:
101+
102+
Request a test database
103+
=======================
104+
105+
Follow the instructions available per hosting type on the `website form
106+
<https://upgrade.odoo.com>`_ and select *Testing* purpose.
107+
108+
.. image:: upgrade/test-purpose.png
109+
:align: center
110+
:alt: Selection of the "Testing" purpose in the upgrade form on Odoo
111+
112+
.. _upgrade/test-guidance:
113+
114+
Test guidance
115+
=============
116+
117+
Every business and organization has its own operational needs and has to test its specific Odoo
118+
database individually. We recommend you look at `the test scenario
119+
<https://docs.google.com/document/d/1ypNs7JKPOsjNbKpdiKFH7Al6g6whZ9jr7f7duAQ5E1w/>`_ for further
120+
information.
121+
122+
.. todo:: change link "test scenario" once the related doc is published
123+
124+
.. _upgrade/test-assistance:
125+
126+
Assistance
127+
----------
128+
129+
If you encounter an issue in the **test database**, please get in touch with Odoo Upgrade Support
130+
via the `Odoo Support page <https://www.odoo.com/help>`_.
131+
132+
Under the *Ticket Description* section, select *An issue related to my upgrade* ticket type.
133+
134+
.. image:: upgrade/test-assistance.png
135+
:align: center
136+
:alt: Selection of "An issue related to my upgrade" as Ticket Type in the support form on Odoo
137+
138+
.. warning::
139+
If you choose another *Ticket Description* type, the request will be redirected to another
140+
team. This will slow down the processing and response time.
141+
142+
Please provide as much detail as you can (i.e., videos and screenshots to illustrate your issue).
143+
This will avoid clarifying questions and speed up the resolution process significantly.
144+
145+
.. note::
146+
* The purpose of the test phase is not to correct existing data or configurations in your
147+
database.
148+
* |assistance-contact|
149+
150+
.. _upgrade/steps-production:
151+
152+
The production launch
153+
=====================
154+
155+
The production upgrade request is when you decide to upgrade your current database with all your
156+
production data (invoices, VAT returns, inventories, current orders) to a new version of your
157+
choice.
158+
159+
After your :ref:`tests <upgrade/testing-phase>` are completed to your satisfaction, submit the
160+
request to upgrade your production database via our `website form <https://upgrade.odoo.com>`_.
161+
Select *Production* purpose.
162+
163+
.. important::
164+
Going into production without first testing may lead to:
165+
166+
- business interruptions (e.g., no longer having the possibility to validate an action)
167+
- poor customer experiences (e.g., an eCommerce website that does not work correctly)
168+
169+
.. _upgrade/production-assistance:
170+
171+
Assistance
172+
----------
173+
174+
If you encounter issues or problems in the **production database**, please get in touch with **Odoo
175+
Support**:
176+
177+
#. Connect to our `Odoo Support page <https://www.odoo.com/help>`_.
178+
#. Under the *Ticket Description* section, select the appropriate type related to your issue but
179+
**do not select** the option *An issue related to my upgrade*.
180+
181+
.. note::
182+
After upgrading to production, the support will be provided by the Support team instead of the
183+
Upgrade team.
184+
185+
#. Please provide as much detail as you can (i.e., videos and screenshots to illustrate your issue).
186+
This will avoid clarifying questions and speed up the resolution process significantly.
187+
188+
.. warning::
189+
If you choose *An issue related to my upgrade* as ticket type, the request will be redirected
190+
to another team than the support one and will slow down the processing and response time.
191+
192+
.. _upgrade/assistance:
193+
194+
Help
195+
====
196+
197+
.. _upgrade/contact:
198+
199+
Contact our Upgrade service support
200+
-----------------------------------
201+
202+
Should you have any more questions about the upgrade, do not hesitate to send a message to `Odoo
203+
Upgrade Team <mailto:[email protected]>`_. We will be happy to answer it as soon as possible.
204+
205+
.. _upgrade/supported-versions:
206+
207+
Supported versions
208+
------------------
209+
210+
Please note that Odoo provides support and bug fixing only for the three last major versions of
211+
Odoo.
212+
213+
This is a factor to take into consideration before upgrading. If you are on an older version, we
214+
suggest you to prefer the most recent version to benefit from longer support (before having to
215+
upgrade again).
216+
217+
.. seealso::
218+
:doc:`maintain/supported_versions`
219+
220+
.. _upgrade/sla:
221+
222+
Service Level Agreement
223+
=======================
224+
225+
What is covered by the Enterprise Licence?
226+
------------------------------------------
227+
228+
Databases hosted on Odoo’s Cloud platforms (Saas and Odoo.sh) or On-Premise (Self-Hosting) enjoy the
229+
following services at all times.
230+
231+
The upgrade of:
232+
233+
* standard applications
234+
* Studio customization (as long as the :guilabel:`Studio` app is still active)
235+
* customizations done by our consulting and developer services *if* they are covered by a
236+
‘Maintenance of Customisations’ subscription
237+
238+
The Upgrade Service is limited to your database's technical conversion and adaptation (standard
239+
modules and data) to make it compatible with the targeted version.
240+
241+
What upgrading does NOT cover
242+
-----------------------------
243+
244+
* The cleaning of pre-existing data & configuration while upgrading
245+
* Any new developments and/or upgrades of your own :ref:`custom modules
246+
<upgrade-faq/custom-modules>`
247+
* `Training <https://www.odoo.com/learn>`_ on the latest version
248+
249+
You can get more information about your Enterprise Licence on our :ref:`Odoo Enterprise Subscription
250+
Agreement <upgrade>` page.
251+
252+
.. note:: |assistance-contact|
8253

9-
upgrade/process
10-
upgrade/odoo_sh
11-
upgrade/service_level
12-
upgrade/faq
254+
.. seealso::
255+
- :doc:`upgrade/faq`
256+
- :doc:`odoo_sh`
257+
- :doc:`maintain/supported_versions`

0 commit comments

Comments
 (0)