doodba (Docker Odoo Base)

Doodba supports hot code reloading for Odoo versions 11.0 and later. When starting Odoo with the --dev flag, you can pass reload or all as an argument to enable this feature via inotify.

If you use the Doodba Copier Template, this is enabled by default in development environments.

Project source code resides in /opt/odoo/custom/src. Doodba uses two main files to manage this:

1. repos.yaml: A git-aggregator configuration that defines remotes, targets (branches), and merges for your repositories. This is used to pull in Odoo core, OCA modules, or custom repos at build time.
2. addons.yaml: Defines which specific addons/modules from the downloaded repositories should be activated in your project.

Important Folders:

• /opt/odoo/custom/src/odoo: REQUIRED. Contains the Odoo source code.
• /opt/odoo/custom/src/private: REQUIRED. Contains your project's private addons.

Recommendation: Use repos.yaml for everything except the private folder. In your .gitignore and .dockerignore, ignore everything in odoo/custom/src/* except for the private folder.

Doodba organizes files into three main directories under /opt/odoo. Understanding this structure is key to customizing your Odoo environment:

• /opt/odoo/custom: The primary location for your project-specific files (source code, configuration, dependencies, SSH keys).
• /opt/odoo/common: Contains internal logic and shared scripts used by the build and entrypoint processes.
• /opt/odoo/auto: Contains automatically generated files at build time, such as symlinks to selected addons and the merged odoo.conf.

Note: For Doodba to function correctly, your Odoo source code must be located in the odoo folder within the structure.

Doodba automatically downloads repositories based on DEFAULT_REPO_PATTERN and DEFAULT_REPO_PATTERN_ODOO. You can override these patterns by passing them as build arguments in your docker-compose.yaml file.

services:
  odoo:
    build:
      args:
        DEFAULT_REPO_PATTERN: &origin "https://github.com/Tecnativa/{}.git"
        DEFAULT_REPO_PATTERN_ODOO: *origin

You can extend the container's lifecycle by placing executables in the following directories within /opt/odoo/custom:

• /opt/odoo/custom/entrypoint.d: Executables here run when the container launches, immediately before the main command.
• /opt/odoo/custom/build.d: Executables here are aggregated with /opt/odoo/common/build.d, sorted alphabetically, and executed during the build process.

Doodba is a base image containing tools and ONBUILD instructions. You must build your own project subimage from it. Your project's Dockerfile should look like this:

FROM tecnativa/doodba
MAINTAINER Me <me@example.com>

Crucial: Your project must include a ./custom folder alongside your Dockerfile for the ONBUILD logic to work.

The /opt/odoo/custom/ssh directory functions like a standard ~/.ssh directory (equivalent to ~root/.ssh). This is used to provide deployment keys for accessing private git repositories.

• Default keys: Files named id_rsa, id_rsa.pub, id_dsa, or identity[.pub] are used by default.
• Custom keys: Use a config file to specify IdentityFile paths.
• Host checking: Host key checking is enabled by default. You must provide a known_hosts file for any repositories accessed via SSH. To disable this for a specific host, use StrictHostKeyChecking no in your config file.

# Example config for a private repo
Host repo.example.com
  IdentityFile ~/.ssh/my_private_key

# Example to disable host key checking
Host repo.example.com
  StrictHostKeyChecking no

To ensure stability and prevent unexpected updates, pin your Doodba image version using its sha256 digest rather than a tag.

1. Find the digest by inspecting a local image:

docker image inspect --format='{{.RepoDigests}}' tecnativa/doodba:10.0-onbuild

2. Use the digest in your Dockerfile:

# Hash-pinned version of tecnativa/doodba:10.0-onbuild
FROM tecnativa/doodba@sha256:fba69478f9b0616561aa3aba4d18e4bcc2f728c9568057946c98d5d3817699e1

The autoaggregate script (a wrapper for git-aggregator) allows you to merge multiple git repositories into your project. You define these in a repos.yaml file.

Example repos.yaml configuration:

./odoo:
  defaults:
    # Shallow repositories are faster & thinner.
    depth: $DEPTH_MERGE
  remotes:
    ocb: https://github.com/OCA/OCB.git
    odoo: https://github.com/odoo/odoo.git
  target: ocb $ODOO_VERSION
  merges:
    - ocb $ODOO_VERSION
    - odoo refs/pull/13635/head
  shell_command_after:
    # Useful to merge a diff when there's no git history correlation
    - curl -sSL https://github.com/odoo/odoo/pull/37187.diff | patch -fp1