Key concepts
This page defines the terms used throughout the documentation. Read it once before going further.
Overview
Project
A project is one Odoo platform. It brings together:
- a Git repository hosted on GitLab;
- a production branch and its Odoo instance, hosted with the cloud provider and in the region chosen in the order;
- a Karizma subdomain (
https://<project>.karizma.one) and, if you want, your own domains; - collaborators, settings and services;
- a subscription with an expiry date. Once it has passed, the project is marked Expired and most actions are disabled.
The project name uses lowercase letters and digits; it appears in addresses (/project/demo-erp) and in the GitLab repository.
Branch and environment
Every Git branch of the project has a stage that sets its purpose and what it runs. In the project page sidebar, branches are grouped into the PRODUCTION, STAGING, MIGRATION and DEVELOPMENT sections.
| Stage | What it is for | Odoo instance | Available tabs |
|---|---|---|---|
| prod | The production environment your teams use. Only one per project, created with the project and named after the Odoo version (for example 17.0). | Yes | HISTORY, SHELL, LOGS, MONITORING, BACKUP, SQL INSIGHTS, UPGRADE, CONFIG |
| staging | A test environment deployed from a branch, to validate changes before production. How many you can have depends on your plan. | Yes | HISTORY, SHELL, LOGS, MONITORING, BACKUP, SQL INSIGHTS, MCP, CONFIG (and UPGRADE when the branch targets a newer Odoo version) |
| dev | A development branch: code in Git, with no running environment. | No | HISTORY, CONFIG |
| migration | A branch created by the upgrade to a newer Odoo version. It can then be promoted to staging for testing. | No | HISTORY, CONFIG |
Some tabs are only shown or enabled for some roles. A branch's life cycle (deploy to staging, destroy a staging environment, merge into production) is described in Branches and environments.
Odoo version
Each project has an Odoo version (for example 17.0), shown on its card and on every branch. New development branches inherit this version. A migration branch, or a staging environment built from a migration, can target a newer version; you cannot deploy to staging a branch on an older version than the project's. To change versions, see Upgrade.
Git repository (GitLab)
Each project's code (your Odoo modules) is stored in a GitLab repository: https://gitlab.com/odoo-kzm/projet-client/<project>. You can work on it:
- in the browser, with the Web IDE;
- on your own machine, with the
git clonecommand that the Clone button copies for you.
Some collaborators can also be invited directly to the GitLab repository, with an access level based on their project role.
Pipeline and deployment
Every commit pushed to a branch starts a GitLab CI pipeline. Its progress shows in the branch's HISTORY tab, with these steps:
| Step shown | Branches |
|---|---|
| Build | All branches. |
| Mise en test | Staging branches. |
| Mise en prod | The production branch. |
A branch can only be deployed to staging if it has a successful pipeline. Changes reach production through a merge request from the staging branch to production. See also Deployments.
Collaborator and role
A collaborator is a Karizma One user added to a project. They have one role per project: the same person can be Admin on one project and Tester on another.
| Role | In short |
|---|---|
| Super Admin | Every right on the project, including the instance shell. |
| Admin | Manages the project: settings, collaborators, backups, merge requests, services. |
| Developer | Creates branches, deploys stagings and edits code in the Web IDE. |
| Tester | Views the project and its branches; read-only in the Web IDE. |
The full list of rights is in Roles and permissions. To add a collaborator, contact your Karizma representative.
Service
A service is an add-on feature you enable per project: WhatsApp, SMTP, mailboxes, CDN and load balancer, e-invoicing, payments, extra resources… Services are managed in Settings › Integrations › Services. Depending on the service, you buy it, then activate it; activation installs the matching module on the production Odoo instance. See Services.
Credits
Credits are a project's consumption reserve (Credit Pool, at the top of the Services page). They are deducted when a service is used, for example to send messages, and they also pay for the Web IDE's AI assistant. The Services page shows the available balance, the usage for the period and the history of movements. See Services.