¶ Initiate the creation
From the “Home” screen, click on “Create New”
¶ Picking between VALUE and PERFORMANCE
The first step requires that you pick an offer either in the VALUE or in the PERFORMANCE category.
You can look up the main differences between these two offers here.
These two Offers can be assessed better with the following diagrams:
Max Users: Recommended maximum number of Odoo users.
Power Index: This value helps understand the difference in performance between the VALUE and the PERFORMANCE offers.
Q&A:
Are the Odoo workers different between the VALUE and the PERFORMANCE offer?
Yes. The overall performance of the infrastructure makes a very big difference with both the Python execution time and the PostgreSQL overall speed.
Why is there such a big difference in the performance? What are the technical differences?
PERFORMANCE instances benefit from the following advantages:
- Different CPU class
- Higher IOPS and faster access time on PERFORMANCE storage
- CPU allocation per core and not per thread.
- Capability for PostgreSQL to manage large pages and higher table concurrency (acceleration of query processing is basically multiplied by the number of SQL workers)
¶ Service and Product plan
The VALUE offer contains only one category of instance while the PERFORMANCE offer, on the other hand contains 3 different types of instances:
PERFORMANCE STANDARD:
- Odoo engine Python workers: 3 to 21
- Max Heavy Users: 1 to 126
- Max Light Users: 75 to 275
- Recommended usage: The STANDARD type is called “standard” because it was designed to be polyvalent and capable of performing properly in most configurations for small to average-sized businesses relying on Odoo as their operational backend. It is the ideal candidate for companies that have deployed standard ERP modules (such as Accounting, Invoices, Inventory, Manufacturing, Sales and Purchasing for instance) and are running operations regularly, not involving a high transaction pace or large data.
PERFORMANCE COMPUTE:
- Odoo engine Python workers: 8 to 65
- Max Heavy Users: 48 to 204
- Max Light Users: 375 to 850
- Recommended usage: The COMPUTE type was created after we realized that many Odoo deployments had performance issues, months or years after going live, blocking productivity and compromising the stability of operations. These performance issues can be caused by multiple factors that our technical team has been studying and optimizing for over a decade. COMPUTE is more aggressive when executing all the Odoo flows. Its dedicated Linux Kernel, Python workers configuration, and PostgreSQL dedicated models simply allow spectacular improvements of speed.
PERFORMANCE MEMORY:
- Odoo engine Python workers: 36 to 65
- Max Heavy Users: 216 to 390
- Max Light Users: 900 to 1625
- Recommended usage: The MEMORY type could be considered as a scaled-up extension of the COMPUTE offer since it was developed to match the same standards of performance and aggressiveness with an increased capability in term of concurrent users and data size. Physical memory is specifically used to buffer and cache as much data as possible This becomes very useful once the size of the data in master and transaction tables or inside the file store has reached a very large number of rows or files and the number of user calls to these resources requires a maximal availability. Typically, it usually takes years for the Odoo data to become large enough and require a MEMORY instance.
Q&A:
What do you call an Odoo engine Python worker?
Odoo is an application using multiple Python threads to run. These threads are called “Odoo workers” and each can sustain a certain number of human users connected to Odoo and going about their daily tasks. The official documentation gives us a clear definition of the workers and explains that each Odoo worker has the capacity to support 6 human users.
Unfortunately, this “rule of the thumb” calculation is quite simplistic and does take the following parameters into consideration:
- CPU grade and core frequency: Low-end hardware and cheap VMs offer 1,8 GHz frequencies and no burst capabilities. On the other hand, high-grade hardware can support up to 5,3 GHz frequencies over burst per active core (intel XEON E2488 for instance). This is simply 4 to 5 times faster per execution…. Should we say in this case that an Odoo worker on a high-grade INTEL XEON E2488 can support 4 times more Odoo users per worker? This is the sort of calculation we had to integrate into our offer, in particular between the VALUE and PERFORMANCE offers.
- Heavy vs. Light users: The concept of “Odoo user” itself contains a lot of amplitude since people can have a very different use of the Odoo backend and impose a very different form of stress in the Odoo ORM application layer or the PostgreSQL database engine, depending on the following:
- Usage frequency of the Odoo system: Occasional users inputting expenses or time sheets, or E-commerce customers consulting products or making a purchase would all be considered as Light Users.
- Data and Reporting usage: Typically, a manager using PIVOT features or an accountant managing PnL reports or Trial Balances will access very large arrays of data while someone inputting manually sales orders line per line would impact the system very little.
Human user or API user:
Odoo allows the creation of API users which can be used to integrate and automate API exchanges with external systems. While this is very convenient, it also means that external machines and other stacks can be allowed to interact and exchange data with Odoo. While human users are limited in their speed when clicking, inputting, and reading data through the User Interface, external machines, automation, and batches can have a much higher pace and be a lot more aggressive in frequency and payload size. This is why it is crucial to make a proper assessment of these APIs. For example, one API flow of 10 endpoints can easily consume between 1 to 2 workers.
¶ Configuring your instance
Odoo workers: Select the number of workers you want to deploy inside your Odoo instance. The number of workers must be picked in relation to the expected number of light and heavy users.
How to relate the Max Heavy and Light users with the Run-odoo workers?
Example: If you select the offer in the first column, your system will be capable of supporting simultaneously the following scenarios:
- 18 ERP users running the Odoo solution in the office or from home at least 8 hours per day.
- 75 Websites users/clients
- 9 ERP users running the Odoo solution in the office + 36 Website users/clients
NB: The “Heavy” and “Light” user capacities must not be added.
Storage: This value indicates the amount of data storage you need to store the two major components of Odoo data:
- The Odoo database inside PostgreSQL
- The Odoo file store located inside the /opt/odoo/data directory
- The additional add ons code you are pulling from your Git repository (usually quite negligible in size)
Depending on the category of the instance and the number of workers you pick, some plans come with multiple storage capacities. Please note that inside each Odoo instance, some space is pre-allocated to the Operating system, the Odoo core add-ons, and the multiple logs generated and rotated by the multiple running services.
- Operating System and additional required services: 5 Gb
- Odoo Enterprise Core: 1,2 Gb
- Python environment: 0.6 Gb
- Odoo and Nginx logs: 0.1 to 2 GB (varies according to the number of workers, and levels of activity on the Odoo server)
Therefore, you are to expect an approximate 10Gb space loss that will be deducted from the total storage capacity.
Example: If you pick the offer in the first column, the actual space available for your Odoo data shall be around 60Gb (total capacity) - 10 Gb (OS, environment, and logs space ) = 50 Gb
In all cases, we are recommending to always avoid saturating the local storage since this can potentially alter system performance or even lead to blockage once the disk becomes full.
Plan: This selection helps determine your commitment as this can have an important impact on the cost of the service. Upon selecting the period, the monthly price of reference will be displayed in USD currency as a reference:
- VALUE instances can only be contracted on a monthly basis.
- PERFORMANCE instances offer three different types of subscriptions:
- Monthly: 1 invoice and 1 payment per month.
- Yearly: 1 invoice and one payment every 12 months.
- 3 years: 1 invoice and one payment every 36 months.
TIP: The longer the period, the better the price. Try the multiple plans available inside the Plan drop-selection and you can see the impact on the monthly price of reference.
¶ Completing Server information
Server Name: This is a “free input” tag that will help you identify and manage the instance later on. It has no technical relevance and we are recommending to use it as an internal reference.
Cloud environment: This selection helps categorize the purpose of the instance. Three choices are possible:
- Development
- Staging
- Production.
For more detailed information about the differences between these three, go to the dedicated section.
This selection will have 2 consequences:
1- Instances placed inside these 3 different environments will be available inside different sections of the console:
- All: Displays all instances from all environments.
- Production: Displays exclusively the production instances.
- Staging: Displays exclusively the staging instances.
- Development: Displays exclusively the development instances.
2- The xxx.run-odoo.com URL of your Odoo instance will be explicitly configured along with its SSL certificate as follows:
- Development: xxxxxxxxx-dev.run-odoo.com
- Staging: xxxxxxxxx-stag.run-odoo.com
- Production: xxxxxxxxx.run-odoo.com
Q&A:
Is it possible to use any VALUE or PERFORMANCE offer and use it for Development, Staging of Production?
Yes. You can use the instance you want and declare it as a Development, Staging, or Production instance. We are advising you to follow the recommendations of the price grid since the usage of low-spec instances or the absence of backups can represent a risk to the security of your production data.
What is the domain provided? Is the SSL certificate included? Do I need to set up anything?
By default, you will be given one of the three below domain extensions:
xxxxxxxxx-dev.run-odoo.com or xxxxxxxxx-stag.run-odoo.com or xxxxxxxxx.run-odoo.com
In the above examples, xxxxxxx represents the subdomain name you will pick provided it is still available.
Both SSL, DNS management and CDN replication are already set up. You have nothing to do.
Can I use my own domain name? How does SSL work in that case? Is Cloudflare usage mandatory?
The . Run-odoo.com based URL will always remain available by default, but it is possible to add your own domain(s) after the instance has been deployed. This process is also automated in the Run-Odoo console. Please read the adequate Cloud Flare and Domain section instructions to know more about this topic.
Odoo Version: This refers to the Odoo version you wish to use. Run-Odoo is supporting all Odoo versions starting from 13 and above.
Enterprise: Leaving this checkbox unchecked implies you wish to deploy Odoo Community Edition. Check the box if you wish to use the Odoo Enterprise version.
Q&A:
Can I use an older version than Odoo 13?
It is possible to adapt one instance to older versions of Odoo. In the case you want to migrate a system whose version is between Odoo 8 and Odoo 12 included, we are inviting you to contact our support team.
What are the costs of Community vs Enterprise? Are they already included in my subscription fee?
Odoo Community comes at no cost and is free to use. Odoo Enterprise on the other hand is subject to the editor’s license pricing. After it has been deployed, an Odoo Enterprise database can be used for a limited number of 30 days until it expires or is activated with paid licenses.
The subscription to Run-odoo does not include the Odoo Enterprise license cost.
Your Subdomain: enter a name or designation that will be used to compose the URL of the Odoo backend. In the above example, we have input “mycompany”.
Please make sure to enter values that are compliant with a standard browser URL address.
Reminder: Subdomains may only consist of alphanumeric (A-Za-z,0-9), underscore(_), and dash (-).
Once you have input this value, click the “Check Availability” button to verify that the sub-domain you picked is properly formatted and is not already used by another party.
In case of refusal, a warning box will indicate the issue to help change the value
Your URL Preview: This is a read-only field giving you a preview of the Odoo URL that will be accessible upon activation of the instance.
Git Repo Addons: This section is dedicated to developers who wish to add purchased addons, or their own developed addons to the Odoo deployment.
- Skip for now: This allows you to skip this section for now and move on to the next step. This section will be accessible as well after the instance has been deployed and there is no obligation to deal with it immediately.
- Use Existing Repo: This option allows you to synchronize automatically your Odoo deployment with additional code and modules stored in GitLab or Github
¶ Deploying with GitLab or GitHub
The Following fields are required:
Source Control Provider: Pick the Git repository manager where you manage your code.
Full Path of Repo: Input the entire SSH access URL. The format should be as follows:
[email protected]:your-user-name/reponame.git
Git Repo User Name: Your user name on the Git platform you are using. Please note this is not your email address. Example: john-doe
Git Repo Token: This token needs to be generated first in order to allow your Run-Odoo instance automation to control the contents of the repository and synchronize it.
TIP: Here is how to create a token from your Git account. In the upper-right corner of any page on GitHub, click your profile photo, then click Settings. In the left sidebar, click Developer settings. In the left sidebar, under Personal access tokens, click Tokens (classic). Select Generate new token, then click Generate new token (classic).
Git Repo Branch: If you have not created specific branches inside your project, you may leave this section with its default “development”. On the other hand, if you want to use s specific branch, please indicate the branch name here.
NB: Only input the branch name. No full path is required.
Example: staging1
¶ Instance creation validation
Once all of the above information has been entered, you may click on the CREATE SERVER button. A window will open with the summary information of your order.
Example:
Another click on the Start Server button shall launch the deployment process.
You should see the following message:
Q&A:
How long does the creation take?
This can vary between 10 to 30 minutes according to the plan you selected, the performance of the instance as well as the number of extra add-ons placed inside the Git repository you required to synchronize.
When will I be charged??
Your subscription fee shall be invoiced only once the instance has been created. The creation date shall also be used as the “anniversary” date to automatically renew the subscription according to the commitment you previously picked: Monthly subscription / Yearly subscription / 3-year subscription.
How many instances can I create? Is there a limit? Are there specific availability issues?
There is no maximum limit in the number of instances you can subscribe. Availability issues may arise in the VALUE offers in certain zones that are highly demanded. In this case, you will be notified by a specific message letting you know that the zone you have picked is currently unavailable.
TIP: Should the zone you picked be unavailable, you might want to check whether other regions inside the same zone are not available. Example: Amsterdam has 2 available zones. New York and San Francisco have 3. Changing zone has no impact on access time or performance and might be worth trying if you encounter availability issues.
¶ Instance activation and hand-over
You can see the creation status of your instance from the Home Page Dashboard.
As you can see above, the “demo-value” instance creation is still “In_Progress”.
You may refresh the page to check the evolution until the status changes to “Started”:
You should also receive an email formatted as follows:
NB: If you are not receiving the confirmation email, please check your SPAM folder and make sure you allow the reception of emails sent by [email protected].
The URL indicated inside the email is clickable and we recommend you bookmark it inside your browser.