NAS-123658 / 24.04 / add odoo to community apps (#1468)

* add `odoo` to `community` apps

* add pg

* add config, svc, persistence

* add basic values for test

* add tmp and validation

* use the odoo user

* update readme

* remove interface config

* switch db name

* init

* do init

* extra values

* update UI

* remove redundant group

* fix typo

* bump common
This commit is contained in:
Stavros Kois
2023-08-30 14:22:20 +03:00
committed by GitHub
parent 149b4f9dc6
commit 56445771a5
21 changed files with 772 additions and 0 deletions

View File

@@ -0,0 +1,6 @@
dependencies:
- name: common
repository: file://../../../common
version: 1.1.0
digest: sha256:752ce76025f5b61094bd2b18ca11693eb9d26d0dde4eb2e63cd2330cbffe9e73
generated: "2023-08-29T19:18:30.154566753+03:00"

View File

@@ -0,0 +1,26 @@
name: odoo
description: Odoo is a suite of web based open source business apps.
annotations:
title: Odoo
type: application
version: 1.0.0
apiVersion: v2
appVersion: '16.0'
kubeVersion: '>=1.16.0-0'
maintainers:
- name: truenas
url: https://www.truenas.com/
email: dev@ixsystems.com
dependencies:
- name: common
repository: file://../../../common
version: 1.1.0
home: https://www.odoo.com/
icon: https://github.com/odoo/odoo/blob/16.0/addons/web/static/img/logo.png?raw=true
sources:
- https://hub.docker.com/_/odoo
- https://github.com/truenas/charts/tree/master/community/odoo
- https://github.com/odoo/odoo
keywords:
- erp
- odoo

View File

@@ -0,0 +1,12 @@
# Odoo
[Odoo](https://odoo.com) is a suite of web based open source business apps.
> When application is installed, a container will be launched with **root** privileges.
> This is required in order to apply the correct permissions to the `odoo` directories.
> Afterward, the `odoo` container will run as a **non**-root user (`101`).
> Same applies to the `postgres` container. This will run afterwards as a **non**-root user (`999`).
> On each upgrade, a container will be launched with **root** privileges in order to apply the correct
> permissions to the `postgres` **backups** directory. Container that performs the backup will run as a **non**-root user (`999`) afterwards.
> Keep in mind the permissions on the backup directory will be changed to `999:999` on **every** update.
> But will only be changed once for the `odoo` and `postgres` data directories.

View File

@@ -0,0 +1,12 @@
# Odoo
[Odoo](https://odoo.com) is a suite of web based open source business apps.
> When application is installed, a container will be launched with **root** privileges.
> This is required in order to apply the correct permissions to the `odoo` directories.
> Afterward, the `odoo` container will run as a **non**-root user (`101`).
> Same applies to the `postgres` container. This will run afterwards as a **non**-root user (`999`).
> On each upgrade, a container will be launched with **root** privileges in order to apply the correct
> permissions to the `postgres` **backups** directory. Container that performs the backup will run as a **non**-root user (`999`) afterwards.
> Keep in mind the permissions on the backup directory will be changed to `999:999` on **every** update.
> But will only be changed once for the `odoo` and `postgres` data directories.

Binary file not shown.

View File

@@ -0,0 +1,16 @@
odooNetwork:
webPort: 31000
odooStorage:
data:
type: hostPath
hostPath: /mnt/{{ .Release.Name }}/data
addons:
type: hostPath
hostPath: /mnt/{{ .Release.Name }}/addons
pgData:
type: hostPath
hostPath: /mnt/{{ .Release.Name }}/pgData
pgBackup:
type: hostPath
hostPath: /mnt/{{ .Release.Name }}/pgBackup

View File

@@ -0,0 +1,23 @@
odooNetwork:
webPort: 31000
odooConfig:
additionalConf:
- key: workers
value: "0"
- key: log_level
value: "info"
odooStorage:
data:
type: hostPath
hostPath: /mnt/{{ .Release.Name }}/data
addons:
type: hostPath
hostPath: /mnt/{{ .Release.Name }}/addons
pgData:
type: hostPath
hostPath: /mnt/{{ .Release.Name }}/pgData
pgBackup:
type: hostPath
hostPath: /mnt/{{ .Release.Name }}/pgBackup

View File

@@ -0,0 +1,8 @@
icon_url: https://github.com/odoo/odoo/blob/16.0/addons/web/static/img/logo.png?raw=true
categories:
- productivity
screenshots:
- https://odoocdn.com/web/image/25282942/project-Organize.jpg
- https://odoocdn.com/openerp_website/static/src/img/2023/timesheet/timesheet_02.png
tags:
- erp

View File

@@ -0,0 +1,13 @@
runAsContext:
- userName: odoo
groupName: odoo
gid: 101
uid: 101
description: Odoo runs as a non-root user
- userName: postgres
groupName: postgres
gid: 999
uid: 999
description: Postgres runs as a non-root user.
capabilities: []
hostMounts: []

View File

@@ -0,0 +1,298 @@
groups:
- name: Odoo Configuration
description: Configure Odoo
- name: Network Configuration
description: Configure Network for Odoo
- name: Storage Configuration
description: Configure Storage for Odoo
- name: Resources Configuration
description: Configure Resources for Odoo
portals:
web_portal:
protocols:
- "$kubernetes-resource_configmap_portal_protocol"
host:
- "$kubernetes-resource_configmap_portal_host"
ports:
- "$kubernetes-resource_configmap_portal_port"
path: "$kubernetes-resource_configmap_portal_path"
questions:
- variable: odooConfig
label: ""
group: Odoo Configuration
schema:
type: dict
attrs:
- variable: additionalConf
label: Additional File Configuration Options
description: |
Configure additional file configuration options for Odoo.</br>
Options are appended to the end of the configuration file.</br>
After the predefined configuration options.</br>
schema:
type: list
default: []
items:
- variable: conf
label: Configuration Option
schema:
type: dict
attrs:
- variable: key
label: Key
schema:
type: string
required: true
- variable: value
label: Value
schema:
type: string
required: true
- variable: additionalEnvs
label: Additional Environment Variables
description: Configure additional environment variables for Odoo.
schema:
type: list
default: []
items:
- variable: env
label: Environment Variable
schema:
type: dict
attrs:
- variable: name
label: Name
schema:
type: string
required: true
- variable: value
label: Value
schema:
type: string
required: true
- variable: odooNetwork
label: ""
group: Network Configuration
schema:
type: dict
attrs:
- variable: webPort
label: Web Port
description: The port for the Odoo WebUI.
schema:
type: int
default: 30062
min: 9000
max: 65535
required: true
- variable: hostNetwork
label: Host Network
description: |
Bind to the host network. It's recommended to keep this disabled.
schema:
type: boolean
default: false
- variable: odooStorage
label: ""
group: Storage Configuration
schema:
type: dict
attrs:
- variable: data
label: Odoo Data Storage
description: The path to store Odoo data.
schema:
type: dict
attrs:
- variable: type
label: Type
description: |
ixVolume: Is dataset created automatically by the system.</br>
Host Path: Is a path that already exists on the system.
schema:
type: string
required: true
default: ixVolume
enum:
- value: hostPath
description: Host Path (Path that already exists on the system)
- value: ixVolume
description: ixVolume (Dataset created automatically by the system)
- variable: datasetName
label: Dataset Name
schema:
type: string
show_if: [["type", "=", "ixVolume"]]
required: true
hidden: true
immutable: true
default: data
$ref:
- "normalize/ixVolume"
- variable: hostPath
label: Host Path
schema:
type: hostpath
show_if: [["type", "=", "hostPath"]]
immutable: true
required: true
- variable: addons
label: Odoo Addons Storage
description: The path to store Odoo addons storage.
schema:
type: dict
attrs:
- variable: type
label: Type
description: |
ixVolume: Is dataset created automatically by the system.</br>
Host Path: Is a path that already exists on the system.
schema:
type: string
required: true
default: ixVolume
enum:
- value: hostPath
description: Host Path (Path that already exists on the system)
- value: ixVolume
description: ixVolume (Dataset created automatically by the system)
- variable: datasetName
label: Dataset Name
schema:
type: string
show_if: [["type", "=", "ixVolume"]]
required: true
hidden: true
immutable: true
default: addons
$ref:
- "normalize/ixVolume"
- variable: hostPath
label: Host Path
schema:
type: hostpath
show_if: [["type", "=", "hostPath"]]
immutable: true
required: true
- variable: pgData
label: Odoo Postgres Data Storage
description: The path to store Odoo Postgres Data.
schema:
type: dict
attrs:
- variable: type
label: Type
description: |
ixVolume: Is dataset created automatically by the system.</br>
Host Path: Is a path that already exists on the system.
schema:
type: string
required: true
default: ixVolume
enum:
- value: hostPath
description: Host Path (Path that already exists on the system)
- value: ixVolume
description: ixVolume (Dataset created automatically by the system)
- variable: datasetName
label: Dataset Name
schema:
type: string
show_if: [["type", "=", "ixVolume"]]
required: true
hidden: true
immutable: true
default: pgData
$ref:
- "normalize/ixVolume"
- variable: hostPath
label: Host Path
schema:
type: hostpath
show_if: [["type", "=", "hostPath"]]
immutable: true
required: true
- variable: pgBackup
label: Odoo Postgres Backup Storage
description: The path to store Odoo Postgres Backup.
schema:
type: dict
attrs:
- variable: type
label: Type
description: |
ixVolume: Is dataset created automatically by the system.</br>
Host Path: Is a path that already exists on the system.
schema:
type: string
required: true
default: ixVolume
enum:
- value: hostPath
description: Host Path (Path that already exists on the system)
- value: ixVolume
description: ixVolume (Dataset created automatically by the system)
- variable: datasetName
label: Dataset Name
schema:
type: string
show_if: [["type", "=", "ixVolume"]]
required: true
hidden: true
immutable: true
default: pgBackup
$ref:
- "normalize/ixVolume"
- variable: hostPath
label: Host Path
schema:
type: hostpath
show_if: [["type", "=", "hostPath"]]
immutable: true
required: true
- variable: resources
label: ""
group: Resources Configuration
schema:
type: dict
attrs:
- variable: limits
label: Limits
schema:
type: dict
attrs:
- variable: cpu
label: CPU
description: CPU limit for Odoo.
schema:
type: string
max_length: 6
valid_chars: '^(0\.[1-9]|[1-9][0-9]*)(\.[0-9]|m?)$'
valid_chars_error: |
Valid CPU limit formats are</br>
- Plain Integer - eg. 1</br>
- Float - eg. 0.5</br>
- Milicpu - eg. 500m
default: "4000m"
required: true
- variable: memory
label: Memory
description: Memory limit for Odoo.
schema:
type: string
max_length: 12
valid_chars: '^[1-9][0-9]*([EPTGMK]i?|e[0-9]+)?$'
valid_chars_error: |
Valid Memory limit formats are</br>
- Suffixed with E/P/T/G/M/K - eg. 1G</br>
- Suffixed with Ei/Pi/Ti/Gi/Mi/Ki - eg. 1Gi</br>
- Plain Integer in bytes - eg. 1024</br>
- Exponent - eg. 134e6
default: "8Gi"
required: true

View File

@@ -0,0 +1 @@
{{ include "ix.v1.common.lib.chart.notes" $ }}

View File

@@ -0,0 +1,64 @@
{{- define "odoo.configuration" -}}
{{- $fullname := (include "ix.v1.common.lib.chart.names.fullname" $) -}}
{{- $dbHost := (printf "%s-postgres" $fullname) -}}
{{- $dbUser := "odoo" -}}
{{- $dbName := "odoo" -}}
{{- $dbPass := (randAlphaNum 32) -}}
{{- with (lookup "v1" "Secret" .Release.Namespace (printf "%s-postgres-creds" $fullname)) -}}
{{- $dbPass = ((index .data "POSTGRES_PASSWORD") | b64dec) -}}
{{- end -}}
{{/* Temporary set dynamic db details on values,
so we can print them on the notes */}}
{{- $_ := set .Values "odooDbPass" $dbPass -}}
{{- $_ := set .Values "odooDbHost" $dbHost -}}
{{- $dbURL := (printf "postgres://%s:%s@%s:5432/%s?sslmode=disable" $dbUser $dbPass $dbHost $dbName) }}
secret:
postgres-creds:
enabled: true
data:
POSTGRES_USER: {{ $dbUser }}
POSTGRES_DB: {{ $dbName }}
POSTGRES_PASSWORD: {{ $dbPass }}
POSTGRES_HOST: {{ $dbHost }}
POSTGRES_URL: {{ $dbURL }}
{{/* xmlrpc* keys are deprecated and http* keys are used in their place */}}
{{- $reservedKeys := (list "data_dir" "addons_path" "http_enable" "http_interface"
"http_port" "xmlrpc" "xmlrpc_port" "xmlrpc_interface"
"db_port" "db_host" "db_name" "db_user" "db_sslmode"
"db_password") -}}
{{- $userKeys := list -}}
odoo-config:
enabled: true
data:
odoo.conf: |
[options]
; Paths
data_dir = /var/lib/odoo
addons_path = /mnt/extra-addons
; Network Details
http_enable = True
http_port = {{ .Values.odooNetwork.webPort }}
; Database Details
db_port = 5432
db_host = {{ $dbHost }}
db_name = {{ $dbName }}
db_user = {{ $dbUser }}
db_sslmode = disable
db_password = {{ $dbPass }}
{{- range $opt := .Values.odooConfig.additionalConf -}}
{{- if (mustHas $opt.key $reservedKeys) -}}
{{- fail (printf "Odoo - Key [%v] is not allowed to be modified") -}}
{{- end -}}
{{- $userKeys = mustAppend $userKeys $opt.key -}}
{{- printf "%s = %s" $opt.key $opt.value | nindent 8 -}}
{{- end -}}
{{- if not (deepEqual $userKeys (uniq $userKeys)) -}}
{{- fail (printf "Odoo - Additional configuration keys must be unique, but got [%v]" (join ", " $userKeys)) -}}
{{- end -}}
{{- end -}}

View File

@@ -0,0 +1,68 @@
{{- define "odoo.workload" -}}
workload:
odoo:
enabled: true
primary: true
type: Deployment
podSpec:
hostNetwork: {{ .Values.odooNetwork.hostNetwork }}
containers:
odoo:
enabled: true
primary: true
imageSelector: image
securityContext:
runAsUser: 101
runAsGroup: 101
env:
ODOO_RC: /etc/odoo/odoo.conf
{{ with .Values.odooConfig.additionalEnvs }}
envList:
{{ range $env := . }}
- name: {{ $env.name }}
value: {{ $env.value }}
{{ end }}
{{ end }}
probes:
liveness:
enabled: true
type: http
path: /web/health
port: {{ .Values.odooNetwork.webPort }}
readiness:
enabled: true
type: http
path: /web/health
port: {{ .Values.odooNetwork.webPort }}
startup:
enabled: true
type: http
path: /web/health
port: {{ .Values.odooNetwork.webPort }}
initContainers:
{{- include "ix.v1.common.app.permissions" (dict "containerName" "01-permissions"
"UID" 101
"GID" 101
"type" "install") | nindent 8 }}
{{- include "ix.v1.common.app.postgresWait" (dict "name" "02-postgres-wait"
"secretName" "postgres-creds") | nindent 8 }}
{{- if .Release.IsInstall }} {{/* If we use type: install it will run before the postgres wait and fail */}}
03-db-init:
enabled: true
type: init
imageSelector: image
securityContext:
runAsUser: 101
runAsGroup: 101
env:
ODOO_RC: /etc/odoo/odoo.conf
command:
- /bin/bash
- -c
- |
/usr/bin/odoo --config=/etc/odoo/odoo.conf \
--stop-after-init \
--without-demo=all \
--init=base
{{- end -}}
{{- end -}}

View File

@@ -0,0 +1,82 @@
{{- define "odoo.persistence" -}}
persistence:
data:
enabled: true
type: {{ .Values.odooStorage.data.type }}
datasetName: {{ .Values.odooStorage.data.datasetName | default "" }}
hostPath: {{ .Values.odooStorage.data.hostPath | default "" }}
targetSelector:
odoo:
odoo:
mountPath: /var/lib/odoo
01-permissions:
mountPath: /mnt/directories/odoo_data
03-db-init:
mountPath: /var/lib/odoo
addons:
enabled: true
type: {{ .Values.odooStorage.addons.type }}
datasetName: {{ .Values.odooStorage.addons.datasetName | default "" }}
hostPath: {{ .Values.odooStorage.addons.hostPath | default "" }}
targetSelector:
odoo:
odoo:
mountPath: /mnt/extra-addons
01-permissions:
mountPath: /mnt/directories/odoo_addons
03-db-init:
mountPath: /mnt/extra-addons
tmp:
enabled: true
type: emptyDir
targetSelector:
odoo:
odoo:
mountPath: /tmp
03-db-init:
mountPath: /tmp
config:
enabled: true
type: secret
objectName: odoo-config
targetSelector:
odoo:
odoo:
mountPath: /etc/odoo/odoo.conf
readOnly: true
subPath: odoo.conf
03-db-init:
mountPath: /etc/odoo/odoo.conf
readOnly: true
subPath: odoo.conf
# Postgres
postgresdata:
enabled: true
type: {{ .Values.odooStorage.pgData.type }}
datasetName: {{ .Values.odooStorage.pgData.datasetName | default "" }}
hostPath: {{ .Values.odooStorage.pgData.hostPath | default "" }}
targetSelector:
# Postgres pod
postgres:
# Postgres container
postgres:
mountPath: /var/lib/postgresql/data
# Permissions container
permissions:
mountPath: /mnt/directories/postgres_data
postgresbackup:
enabled: true
type: {{ .Values.odooStorage.pgBackup.type }}
datasetName: {{ .Values.odooStorage.pgBackup.datasetName | default "" }}
hostPath: {{ .Values.odooStorage.pgBackup.hostPath | default "" }}
targetSelector:
# Postgres backup pod
postgresbackup:
# Postgres backup container
postgresbackup:
mountPath: /postgres_backup
# Permissions container
permissions:
mountPath: /mnt/directories/postgres_backup
{{- end -}}

View File

@@ -0,0 +1,12 @@
{{- define "odoo.portal" -}}
---
apiVersion: v1
kind: ConfigMap
metadata:
name: portal
data:
host: $node_ip
path: /
protocol: http
port: {{ .Values.odooNetwork.webPort | quote }}
{{- end -}}

View File

@@ -0,0 +1,6 @@
{{- define "postgres.workload" -}}
workload:
{{- include "ix.v1.common.app.postgres" (dict "secretName" "postgres-creds"
"resources" .Values.resources
"ixChartContext" .Values.ixChartContext) | nindent 2 }}
{{- end -}}

View File

@@ -0,0 +1,26 @@
{{- define "odoo.service" -}}
service:
odoo:
enabled: true
primary: true
type: NodePort
targetSelector: odoo
ports:
webui:
enabled: true
primary: true
port: {{ .Values.odooNetwork.webPort }}
nodePort: {{ .Values.odooNetwork.webPort }}
targetSelector: odoo
# Postgres
postgres:
enabled: true
type: ClusterIP
targetSelector: postgres
ports:
postgres:
enabled: true
primary: true
port: 5432
targetSelector: postgres
{{- end -}}

View File

@@ -0,0 +1,13 @@
{{- include "ix.v1.common.loader.init" . -}}
{{/* Merge the templates with Values */}}
{{- $_ := mustMergeOverwrite .Values (include "odoo.configuration" $ | fromYaml) -}}
{{- $_ := mustMergeOverwrite .Values (include "odoo.service" $ | fromYaml) -}}
{{- $_ := mustMergeOverwrite .Values (include "odoo.persistence" $ | fromYaml) -}}
{{- $_ := mustMergeOverwrite .Values (include "odoo.workload" $ | fromYaml) -}}
{{- $_ := mustMergeOverwrite .Values (include "postgres.workload" $ | fromYaml) -}}
{{/* Create the configmap for portal manually*/}}
{{- include "odoo.portal" $ -}}
{{- include "ix.v1.common.loader.apply" . -}}

View File

@@ -0,0 +1 @@
{"filename": "values.yaml", "keys": ["image"]}

View File

@@ -0,0 +1,31 @@
#!/usr/bin/python3
import json
import re
import sys
from catalog_update.upgrade_strategy import semantic_versioning
RE_STABLE_VERSION = re.compile(r'[0-9]+\.[0-9]+')
def newer_mapping(image_tags):
key = list(image_tags.keys())[0]
tags = {t: t for t in image_tags[key] if RE_STABLE_VERSION.fullmatch(t)}
version = semantic_versioning(list(tags))
if not version:
return {}
return {
'tags': {key: tags[version]},
'app_version': version,
}
if __name__ == '__main__':
try:
versions_json = json.loads(sys.stdin.read())
except ValueError:
raise ValueError('Invalid json specified')
print(json.dumps(newer_mapping(versions_json)))

View File

@@ -0,0 +1,54 @@
image:
repository: odoo
pullPolicy: IfNotPresent
tag: '16.0'
resources:
limits:
cpu: 4000m
memory: 8Gi
odooConfig:
additionalConf: []
additionalEnvs: []
odooNetwork:
webPort: 30062
hostNetwork: false
odooStorage:
data:
type: ixVolume
datasetName: data
addons:
type: ixVolume
datasetName: addons
pgData:
type: ixVolume
datasetName: pgData
pgBackup:
type: ixVolume
datasetName: pgBackup
notes:
custom: |
# Initial Admin Credentials
- Username: `admin`
- Password: `admin`
## Database
You can connect to the database using the pgAdmin App from the catalog
<details>
<summary>Database Details</summary>
- Database: `odoo`
- Username: `odoo`
- Password: `{{ .Values.odooDbPass }}`
- Host: `{{ .Values.odooDbHost }}.{{ .Release.Namespace }}.svc.cluster.local`
- Port: `5432`
</details>
{{- $_ := unset .Values "odooDbPass" }}
{{- $_ := unset .Values "odooDbHost" }}