Odoo

Ansible role to install Odoo from a Git or Mercurial repository, or from pip, and configure it.

This role supports three types of installation:

• standard: install the Odoo dependencies from APT repositories and the Odoo project from a Git/Hg repository. Odoo is configured with Ansible options (odoo_config_* ones).

• pip: install Odoo and its dependencies (modules and Python packages) from a pip requirements.txt file. Odoo is configured with Ansible options (odoo_config_* ones).

• buildout: build the Odoo project from a Git/Hg repository containing a Buildout configuration file based on the anybox.recipe.odoo recipe. Odoo and its dependencies are then installed and executed inside a Python virtual environment. The configuration part is also managed by Buildout (odoo_config_* options are not used excepting the odoo_config_db_* ones for PostgreSQL related tasks).

Minimum Ansible Version: 2.4

Supported versions and systems

System / Odoo	8.0	9.0	10.0	11.0	12.0	13.0	14.0
Debian 8	yes	yes	yes	-	-	-	-
Debian 9	yes	yes	yes	yes	-	-	-
Ubuntu 14.04	yes	yes	yes	-	-	-	-
Ubuntu 16.04	yes	yes	yes	-	-	-	-
Ubuntu 18.04	-	-	-	yes	yes	yes	-
Ubuntu 20.04	-	-	-	-	-	yes	yes

Example (Playbook)

odoo_install_type: standard (default)

Standard installation (assuming that PostgreSQL is installed and running on the same host):

- name: Odoo
  hosts: odoo_server
  become: yes
  roles:
    - role: odoo
      odoo_version: 14.0
      odoo_config_admin_passwd: SuPerPassWorD

      ## Recommended directories
      ## Default/legacy settings to maintain backwards compatibility,
      ## so existing deployments won't break.
      # odoo_rootdir: /opt/odoo  # Default/legacy "/home/{{ odoo_user }}"
      # odoo_config_data_dir: "/srv/odoo"  # Default/legacy "/home/{{ odoo_user }}/.local/share/Odoo"

With the standard installation type you configure Odoo with the available odoo_config_* options.

Standard installation with Enterprise and addons (assuming that PostgreSQL is installed and running on the same host)

• odoo_enterprise_repo: Odoo Enterprise (mirrored)
• odoo_addons_repo: Project/customer addons (custom, external)
• odoo_addons_debian_packages: Debian/apt packages required by addons.

Consideration: It's also possible to put Python packages into the {{ odoo_addons_dir }}/requirements.txt file. So consider whether to install Python packages by either the PyPi requirements or odoo_addons_debian_packages

- name: Odoo
  hosts: odoo_server
  become: yes
  roles:
    - role: odoo
      odoo_version: 11.0
      odoo_config_admin_passwd: SuPerPassWorD

      # Odoo Enterprise
      odoo_enterprise_repo_url: git@example.com:customer/enterprise.git
      odoo_enterprise_repo_rev: 11.0

      # Odoo Addons
      odoo_addons_repo_url: git@example.com:customer/addons.git
      odoo_addons_repo_rev: 11.0

      odoo_config_addons_path:
        - "{{ odoo_workdir }}/odoo/enterprise"
        - "{{ odoo_workdir }}/odoo/addons/custom"
        - "{{ odoo_workdir }}/odoo/addons/external"
        - "{{ odoo_workdir }}/odoo/server/odoo/addons"
        - "{{ odoo_workdir }}/odoo/server/addons"

      odoo_addons_debian_packages:
        - python3-openpyxl
        - python3-numpy

Standard installation but with PostgreSQL installed on a remote host (and available from your Ansible inventory):

- name: Odoo
  hosts: odoo_server
  become: yes
  roles:
    - role: odoo
      odoo_version: 14.0
      odoo_config_admin_passwd: SuPerPassWorD
      odoo_config_db_host: pg_server
      odoo_config_db_user: odoo
      odoo_config_db_passwd: PaSsWoRd

      ## Recommended directories
      ## Default/legacy settings to maintain backwards compatibility,
      ## so existing deployments won't break.
      # odoo_rootdir: /opt/odoo  # Default/legacy "/home/{{ odoo_user }}"
      # odoo_config_data_dir: "/srv/odoo"  # Default/legacy "/home/{{ odoo_user }}/.local/share/Odoo"

Standard installation from a personnal Git repository such as your repository looks like this:

REPO/
├── server              # could be a sub-repository of https://github.com/odoo/odoo
├── addons_oca_web      # another sub-repository (https://github.com/OCA/web here)
├── addons_oca_connector    # yet another sub-repository (https://github.com/OCA/connector)
└── addons              # custom modules

Here we set some options required by the connector framework:

- name: Odoo
  hosts: odoo_server
  become: yes
  roles:
    - role: odoo
      odoo_version: 14.0
      odoo_repo_type: git
      odoo_repo_url: https://SERVER/REPO
      odoo_repo_rev: master
      odoo_repo_dest: "/home/{{ odoo_user }}/odoo"
      odoo_init_env:
        ODOO_CONNECTOR_CHANNELS: root:2
      odoo_config_admin_passwd: SuPerPassWorD
      odoo_config_addons_path:
        - "{{ odoo_workdir }}/odoo/server/openerp/addons"
        - "{{ odoo_workdir }}/odoo/server/addons"
        - "{{ odoo_workdir }}/odoo/addons_oca_web"
        - "{{ odoo_workdir }}/odoo/addons_oca_connector"
        - "{{ odoo_workdir }}/odoo/addons"
      odoo_config_server_wide_modules: web,web_kanban,connector
      odoo_config_workers: 8

odoo_install_type: pip

Pip installation (assuming that PostgreSQL is installed and running on the same host). We need to ensure that the environment variable LC_ALL is used if Odoo version 12 is to be used:

- name: Odoo
  hosts: odoo_server
  become: yes
  roles:
    - role: odoo
      odoo_install_type: pip
      odoo_version: 14.0
      odoo_pip_requirements_url: https://raw.githubusercontent.com/OCA/sample-oca-pip-requirements/14.0/requirements.txt
      odoo_config_admin_passwd: SuPerPassWorD
  environment:
    LC_ALL: en_US.UTF-8

odoo_install_type: buildout

With a Buildout installation type, Odoo is installed and configured directly by Buildout:

- name: Odoo
  hosts: odoo_server
  become: yes
  roles:
    - role: odoo
      odoo_install_type: buildout
      odoo_version: 14.0
      odoo_repo_type: git
      odoo_repo_url: https://github.com/osiell/odoo-buildout-example.git
      odoo_repo_rev: "{{ odoo_version }}"
      odoo_repo_dest: "{{ odoo_workdir }}/odoo"

The same but with PostgreSQL installed on a remote host (and available from your Ansible inventory):

- name: Odoo
  hosts: odoo_server
  become: yes
  roles:
    - role: odoo
      odoo_install_type: buildout
      odoo_version: 14.0
      odoo_repo_type: git
      odoo_repo_url: https://github.com/osiell/odoo-buildout-example.git
      odoo_repo_rev: "{{ odoo_version }}"
      odoo_repo_dest: "{{ odoo_workdir }}/odoo"
      odoo_config_db_host: pg_server
      odoo_config_db_user: odoo
      odoo_config_db_passwd: PaSsWoRd

By default Ansible is looking for a bootstrap.py script and a buildout.cfg file at the root of the cloned repository to call Buildout, but you can change that to point to your own files. Assuming your repository looks like this:

REPO/
├── addons              # custom modules
├── bin
│   └── bootstrap.py
├── builtout.cfg
├── builtout.dev.cfg
├── builtout.prod.cfg
└── builtout.test.cfg

We just set the relevant options to tell Ansible the files to use with the odoo_buildout_* options:

- name: Odoo
  hosts: odoo_server
  become: yes
  roles:
    - role: odoo
      odoo_install_type: buildout
      odoo_version: 14.0
      odoo_repo_type: git
      odoo_repo_url: https://SERVER/REPO
      odoo_repo_rev: master
      odoo_repo_dest: "{{ odoo_workdir }}/odoo"
      odoo_buildout_bootstrap_path: "{{ odoo_workdir }}/odoo/bin/bootstrap.py"
      odoo_buildout_config_path: "{{ odoo_workdir }}/odoo/buildout.prod.cfg"

Variables

See the defaults/main.yml file.

Bug Tracker

Bugs are tracked on GitHub Issues. In case of trouble, please check there if your issue has already been reported. If you spotted it first, help us smash it by providing detailed and welcomed feedback.

Credits

Contributors

• Sébastien Alix
• Jordi Ballester Alomar

Do not contact contributors directly about support or help with technical issues.

Maintainer

This module is maintained by the OCA.

OCA, or the Odoo Community Association, is a nonprofit organization whose mission is to support the collaborative development of Odoo features and promote its widespread use.

To contribute to this module, please visit https://odoo-community.org.

Licence

This project is licensed under the terms of the GPLv3 license.