COOG ADMIN

Coog Admin is a toolkit that makes it easy to manage Coog (Insurance ERP from Coopengo). It is aimed to provide all useful commands to:

• Deploy Coog (in all recommended configurations)
• Administrate Coog (monitor in runtime, upgrade, maintenance procedure, etc)
• Help on Coog troubleshooting (shared knowledge base between all Coog installations)

Coog Admin should be installed (cloned) on Coog host server. All other resources are provides via Docker images.

Docker is the recommended platform to deploy Coog:

• Makes it easy to communicate with system administrators
• Designed to support all kind of Operating Systems
• Helpful to get integrated with third party softwares (right now we use postgresql, redis, nginx, sentry, etc)

Coog Admin is a passive tool. It does not launch any agent on your server. All provided deployment scripts are just docker calls wrappings.

For the first versions, Coog Admin will be focused on deployment.

What is this tool

• Set of shell scripts to ensure operations

• All Coog data are stored in one folder named $PREFIX

  • This ensures that the host server is kept clean (no files at different locations).
  • By default $PREFIX is mapped to /usr/local/coog.
  • It could be overridden by setting COOG_DATA (maybe in user's .profile)
  • A good practice is to use data folder inside coog-admin (git ignored)

• Coog data includes postgresql databases, redis persistency, coog documents. All those are stored in sub-fodlers of $PREFIX.

• All operations scripts source a special script (config) that sets the configuration

• config last line is:

  [ -f $PREFIX/config ] && source $PREFIX/config
  

  Basically, all the configuration is done through environment variables, which are defined in config. To modify the configuration, just set your updated environment variables in $PREFIX/config.

• To clean your environment, you can just remove $PREFIX folder

It is very recommended to read the scripts to have a deep understanding of how it works:

• config: configuration items explained
• postgres: typical launcher

Commands

It is recommended to launch the command without any argument to see possible actions Commands wrap docker commandline to make it easy to call docker without giving the container name

edit-config

It customizes the environment by setting images tags, database name, or any other runtime parameter

net (create)

Creates a network where all containers will live: ./net create

redis (server, client)

• ./redis server: launches redis server
• ./redis client: launches a redis client connected to the server

postgres (server, client, dump)

• ./postgres server: launches postgres server
• ./postgres client: launches postgres client
• ./postgres dump: dumps current database (to be piped to a file)

coog (build, init, server, celery, etc.)

Coog image contains all resources to run Coog backend and Sao Web client

Environment variables to customize process exec (DB_NAME and LOG_LEVEL)

• ./coog build coog/coog:master trytond:master trytond-modules:master coog:master coog-bench:master sao:master: builds a coog image
• ./coog init: inits coog volume
• ./coog server 4: launches a coog server with 4 uwsgi workers
• ./coog celery 4: launches a coog set of 4 celery workers
• ./coog admin: launches trytond admin utilities on current database
• ./coog batch ir.ui.view.validate: executes a batch
• ./coog chain coog_core.check: executes a batch chain
• ./coog redis celery qlist ir.ui.view.validate: list queue jobs

web (build, run)

Web image contains all resources to run Coog api and Coog App web application

Environment variables to customize process exec (DEBUG)

• ./web build coog/web:master coog-api:master coog-app:master: builds a web image
• ./web run

nginx (init, run)

• ./nginx init: initializes configuration folder for nginx (depending on WEB_IMAGE value)
• ./nginx run: runs nginx server

Once running, the url mapping is:

• /: Coog RPC and Sao client
• /bench: Bench Web app (when present)
• /web/svc: Coog API
• /web: Coog App

upgrade

This command updates a running environment. It stops and drops running containers, mount new ones and launches ./coog admin -u ir on current database to migrate database.