A Kubernetes operator that manages the full lifecycle of Odoo deployments — including database initialization, secrets, persistent storage, and services — via a single OdooDeployment custom resource.
Check out the sample OdooDeployment for an example of how to use this operator.
Check out the Odoo website for more information on Odoo.
| Feature | Status | Description |
|---|---|---|
| Deploy | available | Create and manage Odoo Deployments, Services, and PVCs |
| Module installation | available | Initialize the database and install Odoo modules via a Kubernetes Job |
| Configure Odoo | available | Manage odoo.conf settings dynamically via the CR spec |
| Backup | planned | Snapshot Odoo filestore and database |
| Restore | planned | Restore from a snapshot |
Feel free to request more features by creating an issue
Users can just run kubectl apply -f to install the project, i.e.:
kubectl apply -f https://github.com/mohanadAbugharbia/odoo-operator/releases/latest/download/install.yaml- go version v1.25.0+
- docker version 17.03+.
- kubectl version v1.28.0+.
- Access to a Kubernetes v1.28.0+ cluster.
Build and push your image to the location specified by IMG:
make docker-build docker-push IMG=<some-registry>/odoo-operator:tagNOTE: This image ought to be published in the personal registry you specified. And it is required to have access to pull the image from the working environment. Make sure you have the proper permission to the registry if the above commands don’t work.
Install the CRDs into the cluster:
make installDeploy the Manager to the cluster with the image specified by IMG:
make deploy IMG=<some-registry>/odoo-operator:tagNOTE: If you encounter RBAC errors, you may need to grant yourself cluster-admin privileges or be logged in as admin.
Create instances of your solution You can apply the samples (examples) from the config/sample:
kubectl apply -k config/samples/NOTE: Ensure that the samples has default values to test it out.
Delete the instances (CRs) from the cluster:
kubectl delete -k config/samples/Delete the APIs(CRDs) from the cluster:
make uninstallUnDeploy the controller from the cluster:
make undeployPlease first create an issue with your planned contribution. Anything and everything is welcome.
NOTE: Run make help for more information on all potential make targets
More information can be found via the Kubebuilder Documentation
MIT License
Copyright (c) 2026 Mohanad Abugharbia
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.