[IMP] odoo_sh doc update
closes odoo/documentation#1597 Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
This commit is contained in:
Stanislas Sobieski
parent
a7f0651773
commit
6c48f90739
@ -9,4 +9,4 @@ Advanced
|
||||
|
||||
advanced/containers
|
||||
advanced/submodules
|
||||
advanced/frequent_technical_questions
|
||||
advanced/scheduled_actions
|
||||
|
||||
@ -1,32 +0,0 @@
|
||||
|
||||
.. _odoosh-advanced-frequent_technical_questions:
|
||||
|
||||
==================================
|
||||
Frequent Technical Questions
|
||||
==================================
|
||||
|
||||
"Scheduled actions do not run at the exact time they were expected"
|
||||
-------------------------------------------------------------------
|
||||
|
||||
On the Odoo.sh platform, we cannot guarantee an exact running time for scheduled actions.
|
||||
|
||||
This is due to the fact that there might be multiple customers on the same server, and we must guarantee a fair share of the server for every customer. Scheduled actions are therefore implemented slightly differently than on a regular Odoo server, and are run on a *best effort* policy.
|
||||
|
||||
.. warning::
|
||||
Do not expect any scheduled action to be run more often than every 5 min.
|
||||
|
||||
Are there "best practices" regarding scheduled actions?
|
||||
-------------------------------------------------------
|
||||
|
||||
**Odoo.sh always limits the execution time of scheduled actions (*aka* crons).**
|
||||
Therefore, you must keep this fact in mind when developing your own crons.
|
||||
|
||||
We advise that:
|
||||
|
||||
- Your scheduled actions should work on small batches of records.
|
||||
- Your scheduled actions should commit their work after processing each batch;
|
||||
this way, if they get interrupted by the time-limit, there is no need to start over.
|
||||
- Your scheduled actions should be
|
||||
`idempotent <https://stackoverflow.com/a/1077421/3332416>`_: they must not
|
||||
cause side-effects if they are started more often than expected.
|
||||
|
||||
@ -0,0 +1,29 @@
|
||||
|
||||
.. _odoo-sh/scheduled_actions:
|
||||
|
||||
=================
|
||||
Scheduled actions
|
||||
=================
|
||||
|
||||
Special worker
|
||||
--------------
|
||||
|
||||
On Odoo.sh, cron jobs and incoming mails are handled by a specific worker that is not accounted in
|
||||
the workers on your subscription. It is a kind of "hidden free worker" bound to every Odoo.sh
|
||||
instance.
|
||||
|
||||
By default, this worker can spawn multiple concurrent threads to execute scheduled actions. The
|
||||
number of threads can be dynamically increased at runtime. However, its exact amount cannot be
|
||||
predicted as it varies according to the number of extra workers in the subscription, the current
|
||||
concurrency of incoming mails, the current server's load, etc.
|
||||
|
||||
Limitations
|
||||
-----------
|
||||
|
||||
- The delay between a scheduled task's next execution date and the actual triggering depends on many
|
||||
parameters and can be delayed according to the state of the execution pool of the shared server.
|
||||
- Scheduled actions on staging branches are executed less often than production build.
|
||||
- The platform deactivates scheduled actions that repeatedly time out.
|
||||
- If the execution time of a scheduled action is business-critical, then we recommend using a
|
||||
dedicated server as the scheduled actions timeout can be modified in the project settings.
|
||||
- We cannot guarantee an exact running time for scheduled actions on the Odoo.sh platform.
|
||||
@ -109,3 +109,7 @@ Ignore modules
|
||||
If you're adding a repository that contains a lot of modules, you may want to ignore some of them in case there are any
|
||||
that are installed automatically. To do so, you can prefix your submodule folder with a :code:`.`. The platform will
|
||||
ignore this folder and you can hand pick your modules by creating symlinks to them from another folder.
|
||||
|
||||
.. note::
|
||||
This symlink has to be done within your GitHub repository. Do not try to create the symlink
|
||||
with the container.
|
||||
|
||||
@ -74,8 +74,8 @@ The neutralization includes:
|
||||
* Setting payment acquirers and shipping providers in test mode.
|
||||
* Disabling IAP services
|
||||
|
||||
The latest database will be kept alive indefinitely, older ones from the same branch may get garbage collected
|
||||
to make room for new ones. It will be valid for 3 months, after which you will be expected to rebuild the branch.
|
||||
The latest database will be kept alive for one year after which you will be expected to rebuild the branch.
|
||||
Older ones from the same branch may get garbage collected to make room for new ones.
|
||||
If you make configuration or view changes in these databases, make sure to document them or write them directly
|
||||
in the modules of the branch, using XML data files overriding the default configuration or views.
|
||||
|
||||
@ -384,7 +384,7 @@ we are considering the feature if there is enough demand.
|
||||
In case the domain of your users email addresses use SPF (Sender Policy Framework) or DKIM
|
||||
(DomainKeys Identified Mail), don't forget to authorize Odoo as a sending host in your domain name
|
||||
settings to increase the deliverability of your outgoing emails.
|
||||
The configuration steps are explained in the documentation about :ref:`SPF
|
||||
The configuration steps are explained in the documentation about :ref:`SPF
|
||||
<email_communication/spf_compliant>` and :ref:`DKIM <email_communication/dkim_compliant>`.
|
||||
|
||||
|
||||
|
||||
@ -79,7 +79,9 @@ Import your database
|
||||
====================
|
||||
|
||||
You can import your database in your Odoo.sh project as long as it is in a :doc:`supported version
|
||||
</administration/maintain/supported_versions>` of Odoo.
|
||||
</administration/maintain/supported_versions>` of Odoo. The branch automatically switches to the
|
||||
Odoo version of the database.
|
||||
|
||||
|
||||
Push your modules in production
|
||||
-------------------------------
|
||||
|
||||
@ -151,14 +151,13 @@ This section shows the storage size used by your project.
|
||||
.. image:: ./media/interface-settings-storage.png
|
||||
:align: center
|
||||
|
||||
Storage size is computed as follows:
|
||||
Storage size of a build is computed as follows:
|
||||
|
||||
* the size of the PostgreSQL database
|
||||
|
||||
* the size of the disk files available in your container: database filestore, sessions storage directory...
|
||||
|
||||
.. Warning::
|
||||
In case you want to analyze disk usage, you can run the tool `ncdu <https://dev.yorhel.nl/ncdu/man>`_ in your Web Shell.
|
||||
The total storage accounts for the production database, the staging branches, and three backups.
|
||||
|
||||
Should your production database size grow to exceed what's provisioned in your subscription, it
|
||||
will automatically be synchronized with it.
|
||||
|
||||
@ -247,6 +247,7 @@ administration/deployment/install.rst administration/install/install.rst
|
||||
administration/maintain/db_premise.rst administration/maintain/on_premise.rst # db_premise -> on_premise
|
||||
administration/maintain/db_upgrade.rst administration/upgrade/process.rst # maintain/db_upgrade -> upgrade/process
|
||||
administration/odoo_sh/advanced/upgrade_your_database.rst administration/upgrade/odoo_sh.rst # odoo_sh/advanced/upgrade_your_database -> upgrade/odoo_sh
|
||||
administration/odoo_sh/advanced/frequent_technical_questions.rst administration/odoo_sh/advanced/scheduled_actions.rst # frequent_technical_questions -> scheduled
|
||||
|
||||
developer/webservices/iap.rst developer/misc/api/iap.rst
|
||||
developer/webservices/odoo.rst developer/misc/api/odoo.rst
|
||||
|
||||
Loading…
Reference in New Issue
Block a user