esosaja / voodoo Goto Github PK

Odoo dockerized.

For beginners: get an odoo instance without effort

For developers: reproductible odoo environments

Voodoo leverage Docker-compose and Anybox's buildout for odoo.

In your host run voodoo commands to bootstrap the project and launch docker.

Then in your guest (container), run ak commands to update odoo dependencies (odoo modules), trigger update scripts and restart odoo server.

Create a new project

    voodoo new my_project

Enter in the project directory then run voodoo

   cd my_project
   voodoo run

It will run a new docker image with odoo and postgres inside.

Now let's start Odoo

First run ak build to build you project with anybox buildout recipe

   ak build

Then launch ak run to start odoo

   ak run

Go to http://localhost:8069 Odoo is here !

• You need a 64 bits architecture.
• You will need to install the Python development headers (python-dev)
• Your user needs to have system uid = 1000 (known issue)

wget -qO- https://get.docker.com/ | sh

More information on the installation on https://docs.docker.com/v1.6/installation/ubuntulinux/ in the section Docker-maintained Package Installation.

Please do not forget to install the latest version if you choose to install it manually

• Give non root access to Docker if not done already:

  sudo gpasswd -a ${USER} docker
  sudo service docker restart # use docker.io instead of docker in Ubuntu 14.04

you may have to LOGOUT and LOG BACK IN AGAIN for the group change to take effect!

• A simple test to see if you have non root access is to list your docker images with

   docker images # make sure you don't need sudo anymore here

  sudo pip install git+https://github.com/akretion/voodoo.git --upgrade

Voodoo extends docker-compose so it can do everything docker-compose can do. For more information about extra commands you can read the docker-compose documentation: http://docs.docker.com/compose

will bootstrap a new project by cloning a default project template.

will run your project and give you a bash session directly in the odoo container

will open a new session to an existing running container.

For example you may need a first terminal for running odoo and a second terminal for doing some psql.

will modify the voodoo.yml file of the project and link the odoo container to the new service. The service has to be set up in the service.yml file of this module

    Usage:
      voodoo [options] [COMMAND] [ARGS...]
      voodoo -h|--help

    Options:
      --verbose                 Show more output
      --version                 Print version and exit
      -f, --file FILE           Specify an alternate compose file
                                (default: voodoo.yml)
      -p, --project-name NAME   Specify an alternate project name
                                (default: directory name)

    Commands:
      build     Build or rebuild services
      help      Get help on a command
      kill      Kill containers
      logs      View output from containers
      new       Create a new project
      open      Open a new session inside the docker
      port      Print the public port for a port binding
      ps        List containers
      pull      Pulls service images
      rm        Remove stopped containers
      run       Run a one-off command
      scale     Set number of containers for a service
      start     Start services
      stop      Stop services
      restart   Restart services
      up        Create and start containers
      chefdk    Chef Development Kit wrapper

TODO improve me

    Usage:
      ak [COMMAND] [ARGS...]
      ak --help

    Commands:
      run           Run Odoo
      debug         Run Odoo in debug mode
      build         Build Your Project using frozen.conf if existing or buildout.dev.cfg
                    If you have an existing frozen.cfg and you want to force the update
                    just add --update as arguments "ak build --update"
      freeze        Freeze all dependency for your project
      console       Open a Odoo Shell
      code_test     Run flake8 and pylint tests on the module specified
                    If no modules provided, test all files in 'modules' directory
      server_test   Start Odoo with test enables (that launch unittest and yaml)
      psql          Open a Psql shell
      load          Load a database from a file args. ak load [file] [dbname]
      reload        Drop and load a database from a file args. ak reload [file] [dbname]
      dump          Dump a database ak dump [file] [dbname]
      help          Get help on a command

   Args:
      -o            ak build option to build in offline mode

Important files are

• buildout.cfg,
• buildout.dev.cfg,
• voodoo.yml

More information about buildout files are available here

Voodoo.yml is like docker-compose.yml. For more information read the docker-compose documentation.

There is 2 voodoo.yml files :

• in ~/.voodoo/config.yml
• in your project voodoo.yml

For now there is two option for you default config

shared_eggs [True or False]: If true the ~/.voodoo/shared/eggs will be mounted as eggs folder in your docker This mean that the eggs will be shared between you voodoo project saving some download and space

shared_odoo [string or False]: If a string is set as shared odoo git repo will be created in ~/.voodoo/shared/shared_odoo/your_string. This give you the posibility to share an odoo git repository between some container. If False an new odoo repository will be created.

odoo_repo_list [dict]: {'repo_name': 'repo_location'} : The list of the odoo repositories that can be used. Indeed you maybe want to use OCA repo for a project and the Odoo S.A. repo for another or even a specific repo. Ex: {'oca': 'https://github.com/oca/ocb.git'}

Note : to improve the performance when downloading odoo, an odoo project is downloaded in ~/.voodoo/shared/odoo. Then when you start a new project the new odoo part is created from this local repository.

Options 'shared_eggs' and 'shared_odoo' can be overrided in the project voodoo.yml. For that you just have to set those options in the voodoo section. For the repository you want to use, add: used_odoo_repo: 'name_of_the_repo' The name of the repo has to be in the odoo repo list in the file config.yml.

list of the available services that can be linked with odoo container. Defines also the default parameters of thoses services.

see wiki https://github.com/akretion/voodoo-cli/wiki

pgcli

Use as a simple Odoo project repository managed by Anybox recipe (without using Docker)

You can clone a voodoo branch to start your project as simple convenience repo for your project. With the buildout.cfg file you can pin exactly your shared branches dependencies. You also keep the project specific modules under revision control in the modules folder.

For further details, please simply refer to Anybox recipe documentation

Note that the Docker workdir is your repo that is shared with Docker, so you won't loose your source changes nor loose time copying files.

Your databases are also persisted in your repo folder in the .db hidden folder. But you can always trash all project databases by simply removing that folder.

• udpate/fix documentation
• add pre-copy of odoo repo in background for generating quickly a new project (mv .odoocache)
• review voodoo new (maybe it will better to have a template folder un voodoo cli)
• share vim info...
• generate automatically ssh key if missing
• debian package
• add bash completion
• add dynamic port