bitnamicharts/odoo
Bitnami Helm chart for Odoo
500K+
Odoo is an open source ERP and CRM platform, formerly known as OpenERP, that can connect a wide variety of business operations such as sales, supply chain, finance, and project management.
Trademarks: This software listing is packaged by Bitnami. The respective trademarks mentioned in the offering are owned by the respective companies, and use of them does not imply any affiliation or endorsement.
helm install my-release oci://registry-1.docker.io/bitnamicharts/odoo
Looking to use Odoo in production? Try VMware Tanzu Application Catalog, the commercial edition of the Bitnami catalog.
This chart bootstraps a Odoo deployment on a Kubernetes cluster using the Helm package manager.
Odoo Apps can be used as stand-alone applications, but they also integrate seamlessly so you get a full-featured Open Source ERP when you install several Apps.
Bitnami charts can be used with Kubeapps for deployment and management of Helm Charts in clusters.
To install the chart with the release name my-release
:
helm install my-release oci://REGISTRY_NAME/REPOSITORY_NAME/odoo
Note: You need to substitute the placeholders
REGISTRY_NAME
andREPOSITORY_NAME
with a reference to your Helm chart registry and repository. For example, in the case of Bitnami, you need to useREGISTRY_NAME=registry-1.docker.io
andREPOSITORY_NAME=bitnamicharts
.
The command deploys Odoo on the Kubernetes cluster in the default configuration. The Parameters section lists the parameters that can be configured during installation.
Tip: List all releases using
helm list
Bitnami charts allow setting resource requests and limits for all containers inside the chart deployment. These are inside the resources
value (check parameter table). Setting requests is essential for production workloads and these should be adapted to your specific use case.
To make this process easier, the chart contains the resourcesPreset
values, which automatically sets the resources
section according to different presets. Check these presets in the bitnami/common chart. However, in production workloads using resourcesPreset
is discouraged as it may not fully adapt to your specific needs. Find more information on container resource management in the official Kubernetes documentation.
It is strongly recommended to use immutable tags in a production environment. This ensures your deployment does not change automatically if the same tag is updated with a different image.
Bitnami will release a new chart updating its containers if a new version of the main container, significant changes, or critical vulnerabilities exist.
Bitnami charts configure credentials at first boot. Any further change in the secrets or credentials require manual intervention. Follow these instructions:
kubectl create secret generic SECRET_NAME --from-literal=odoo-password=PASSWORD --from-literal=smtp-password=SMTP_PASSWORD --dry-run -o yaml | kubectl apply -f -
To modify the application version used in this chart, specify a different version of the image using the image.tag
parameter and/or a different repository using the image.repository
parameter.
Sometimes you may want to have Odoo connect to an external database rather than installing one inside your cluster, e.g. to use a managed database service, or use a single database server for all your applications. To do this, the chart allows you to specify credentials for an external database under the externalDatabase
parameter. You should also disable the PostgreSQL installation with the postgresql.enabled
option. For example using the following parameters:
postgresql.enabled=false
externalDatabase.host=myexternalhost
externalDatabase.user=myuser
externalDatabase.password=mypassword
externalDatabase.port=3306
Note also if you disable PostgreSQL per above you MUST supply values for the externalDatabase
connection.
If you have a need for additional containers to run within the same pod as Odoo, you can do so via the sidecars
config parameter. Simply define your container according to the Kubernetes container spec.
sidecars:
- name: your-image-name
image: your-image
imagePullPolicy: Always
ports:
- name: portname
containerPort: 1234
Similarly, you can add extra init containers using the initContainers
parameter.
This chart allows you to set your custom affinity using the affinity
parameter. Find more information about Pod's affinity in the kubernetes documentation.
As an alternative, you can use of the preset configurations for pod affinity, pod anti-affinity, and node affinity available at the bitnami/common chart. To do so, set the podAffinityPreset
, podAntiAffinityPreset
, or nodeAffinityPreset
parameters.
To back up and restore Helm chart deployments on Kubernetes, you need to back up the persistent volumes from the source deployment and attach them to a new deployment using Velero, a Kubernetes backup/restore tool. Find the instructions for using Velero in this guide.
The Bitnami Odoo image stores the Odoo data and configurations at the /bitnami/odoo
path of the container.
Persistent Volume Claims are used to keep the data across deployments. This is known to work in GCE, AWS, and minikube. See the Parameters section to configure the PVC or to disable persistence.
Name | Description | Value |
---|---|---|
global.imageRegistry | Global Docker image registry | "" |
global.imagePullSecrets | Global Docker registry secret names as an array | [] |
global.defaultStorageClass | Global default StorageClass for Persistent Volume(s) | "" |
global.storageClass | DEPRECATED: use global.defaultStorageClass instead | "" |
global.security.allowInsecureImages | Allows skipping image verification | false |
global.compatibility.openshift.adaptSecurityContext | Adapt the securityContext sections of the deployment to make them compatible with Openshift restricted-v2 SCC: remove runAsUser, runAsGroup and fsGroup and let the platform use their allowed default IDs. Possible values: auto (apply if the detected running cluster is Openshift), force (perform the adaptation always), disabled (do not perform adaptation) | disabled |
Name | Description | Value |
---|---|---|
kubeVersion | Override Kubernetes version | "" |
nameOverride | String to partially override common.names.fullname | "" |
fullnameOverride | String to fully override common.names.fullname | "" |
commonLabels | Labels to add to all deployed objects | {} |
commonAnnotations | Annotations to add to all deployed objects | {} |
clusterDomain | Default Kubernetes cluster domain | cluster.local |
extraDeploy | Array of extra objects to deploy with the release | [] |
diagnosticMode.enabled | Enable diagnostic mode (all probes will be disabled and the command will be overridden) | false |
diagnosticMode.command | Command to override all containers in the the statefulset | ["sleep"] |
diagnosticMode.args | Args to override all containers in the the statefulset | ["infinity"] |
image.registry | Odoo image registry | REGISTRY_NAME |
image.repository | Odoo image repository | REPOSITORY_NAME/odoo |
image.digest | Odoo image digest in the way sha256:aa.... Please note this parameter, if set, will override the tag | "" |
image.pullPolicy | Odoo image pull policy | IfNotPresent |
image.pullSecrets | Odoo image pull secrets | [] |
image.debug | Enable image debug mode | false |
Name | Description | Value |
---|---|---|
odooEmail | Odoo user email | user@example.com |
odooPassword | Odoo user password | "" |
odooSkipInstall | Skip Odoo installation wizard | false |
odooDatabaseFilter | Filter odoo database by using a regex | .* |
loadDemoData | Whether to load demo data for all modules during initialization | false |
customPostInitScripts | Custom post-init.d user scripts | {} |
smtpHost | SMTP server host | "" |
smtpPort | SMTP server port | "" |
smtpUser | SMTP username | "" |
smtpPassword | SMTP user password | "" |
smtpProtocol | SMTP protocol | "" |
existingSecret | Name of existing secret containing Odoo credentials | "" |
smtpExistingSecret | The name of an existing secret with SMTP credentials | "" |
allowEmptyPassword | Allow the container to be started with blank passwords | false |
command | Override default container command (useful when using custom images) | [] |
args | Override default container args (useful when using custom images) | [] |
extraEnvVars | Array with extra environment variables to add to the Odoo container | [] |
extraEnvVarsCM | Name of existing ConfigMap containing extra env vars | "" |
extraEnvVarsSecret | Name of existing Secret containing extra env vars | "" |
Name | Description | Value |
---|---|---|
replicaCount | Number of Odoo replicas to deploy | 1 |
containerPorts.http | Odoo HTTP container port | 8069 |
extraContainerPorts | Optionally specify extra list of additional ports for Odoo container(s) | [] |
resourcesPreset | Set container resources according to one common preset (allowed values: none, nano, micro, small, medium, large, xlarge, 2xlarge). This is ignored if resources is set (resources is recommended for production). | large |
resources | Set container requests and limits for different resources like CPU or memory (essential for production workloads) | {} |
podSecurityContext.enabled | Enabled Odoo pods' Security Context | true |
podSecurityContext.fsGroupChangePolicy | Set filesystem group change policy | Always |
podSecurityContext.sysctls | Set kernel settings using the sysctl interface | [] |
podSecurityContext.supplementalGroups | Set filesystem extra groups | [] |
podSecurityContext.fsGroup | Set Odoo pod's Security Context fsGroup | 0 |
containerSecurityContext.enabled | Enabled containers' Security Context | true |
containerSecurityContext.seLinuxOptions | Set SELinux options in container | {} |
containerSecurityContext.runAsUser | Set containers' Security Context runAsUser | 0 |
containerSecurityContext.runAsGroup | Set containers' Security Context runAsGroup | 0 |
containerSecurityContext.runAsNonRoot | Set container's Security Context runAsNonRoot | false |
containerSecurityContext.privileged | Set container's Security Context privileged | false |
containerSecurityContext.readOnlyRootFilesystem | Set container's Security Context readOnlyRootFilesystem | false |
containerSecurityContext.allowPrivilegeEscalation | Set container's Security Context allowPrivilegeEscalation | false |
containerSecurityContext.capabilities.add | List of capabilities to be added | ["CHOWN","FOWNER","SYS_CHROOT","SETGID","SETUID","DAC_OVERRIDE"] |
containerSecurityContext.capabilities.drop | List of capabilities to be dropped | ["ALL"] |
containerSecurityContext.seccompProfile.type | Set container's Security Context seccomp profile | RuntimeDefault |
livenessProbe.enabled | Enable livenessProbe | true |
livenessProbe.initialDelaySeconds | Initial delay seconds for livenessProbe | 600 |
livenessProbe.periodSeconds | Period seconds for livenessProbe |
Note: the README for this chart is longer than the DockerHub length limit of 25000, so it has been trimmed. The full README can be found at https://github.com/bitnami/charts/blob/main/bitnami/odoo/README.md