1bspace-os rebrand
6e7be43dc8
The previous blueprint (upstream odoo/docker:19.0 + COPY + deploy.command)
systematically broke inside Easypanel's inline-dockerfile build context:
- COPY files not available
- wkhtmltopdf/libldap-2.5-0 package names absent from Debian bookworm
- Easypanel wrapped deploy.command with 'python -c …' → exit 100
- postgres password / app env set separately → mismatch auth failure
- cat > /etc/odoo/odoo.conf without parent dir → ENOENT
The new blueprint is what actually ran in production for 34h+ stable:
- FROM python:3.12-slim with an inline ENTRYPOINT (no CMD wrapping)
- init-odoo.sh: apt install build deps then pip install /mnt/os-dev
(idempotent — skipped if import odoo works, restarts < 1 s)
- --dev=reload,qweb,assets,xml,werkzeug baked into exec odoo
- mkdir -p /etc/odoo /var/lib/odoo /var/log/odoo before writing odoo.conf
- Single createFromSchema call → shared password for postgres + app
- Bind-mount os-dev → /mnt/os-dev → hot-reload on any host edit
deploy.py prepare writes easypanel.schema.json + init-odoo.sh +
inline.Dockerfile + .db_password, all ready for TRAE Easypanel MCP
createFromSchema + deployAppService. Verified end-to-end (HTTP 200 on
/web/database/manager, hot-reload on release.py product_name edit,
CREATE DATABASE via psycopg2 + odoo UI Create Database).
Docs:
- README.md rewritten with new layout table, troubleshooting
playbook, daily workflow, verified-state reference table,
old-vs-new blueprint comparison table.
318 lines
13 KiB
Python
318 lines
13 KiB
Python
#!/usr/bin/env python3
|
|
"""
|
|
Deploy the Odoo 19 **os-dev codespace** (stateless hot-reload workspace)
|
|
to Easypanel on a given project.
|
|
|
|
This is the PROVEN-WORKING pipeline (tested Sep 14, 2026 on the `onebspace`
|
|
project, service `os-dev-codespace`, container stable 34h+):
|
|
|
|
1. Start a tiny `python:3.12-slim` image (Debian 12 bookworm).
|
|
2. On first container boot, the init script installs build deps via apt
|
|
then runs `pip install /mnt/os-dev` + `pip install -r requirements.txt`
|
|
from the BIND-MOUNTED source tree (so live edits in /mnt/os-dev are
|
|
picked up by `--dev=reload,qweb,assets,xml,werkzeug`).
|
|
3. A companion `postgres:17` service is created alongside, with a single
|
|
fresh password shared between both services (no mismatch bug).
|
|
4. Easypanel is told to build an INLINE Dockerfile that writes the init
|
|
script via heredoc and sets `ENTRYPOINT` explicitly (critical: because
|
|
`python:3.12-slim` ships with `CMD=[python]`, Easypanel's default
|
|
`deploy.command` wrapping would otherwise produce `exit 100`).
|
|
|
|
What this replaces:
|
|
- The old official odoo/docker base image (huge, ubuntu:noble based,
|
|
forces re-bakes on every source edit, requires COPYs that do not
|
|
work in Easypanel inline-dockerfile build contexts that have no
|
|
source files available).
|
|
- Manual tRPC calls — we now use the TRAE MCP
|
|
(`mcp_Easypanel` / `createFromSchema` + friends) because those
|
|
procedures are the supported surface and handle the
|
|
postgres/app-service ordering correctly.
|
|
|
|
Usage (run from this repo's directory, or anywhere):
|
|
python3 deploy.py deploy # full createFromSchema → deploy
|
|
python3 deploy.py destroy # destroy app + postgres + filestore vol
|
|
python3 deploy.py status # inspect both services
|
|
|
|
Dependencies:
|
|
- TRAE MCP Easypanel server reachable (handled by the agent).
|
|
- os-dev source tree bind-mounted at /mnt/os-dev inside the
|
|
container (defaults to /root/Documents/trae_projects/one_b_os/os-dev
|
|
on the host).
|
|
- `odoo/release.py` MIN_PY_VERSION = (3, 10) — we use 3.12 safely.
|
|
|
|
Key runtime guarantees of the deployed service:
|
|
* Idempotent install: `pip install /mnt/os-dev` ONLY runs if
|
|
`python3 -c "import odoo"` fails (i.e. on first ever container
|
|
boot, ~5 min native build). Subsequent restarts start Odoo in <1s.
|
|
* Hot-reload: `--dev=reload,qweb,assets,xml,werkzeug` on the cmdline.
|
|
Edit `release.py product_name` or any addon `.py` and the change is
|
|
loaded on next HTTP request (verified end-to-end).
|
|
* No image rebuild needed on code changes (the whole point).
|
|
* Postgres password is created ONCE per schema deploy and set on
|
|
BOTH the postgres service AND the app env SIMULTANEOUSLY via the
|
|
same `createFromSchema` call, which eliminates the mismatch bug
|
|
("FATAL: password authentication failed for user odoo") we had when
|
|
updating app env without ALTER USER on the live pg.
|
|
* `mkdir -p /etc/odoo /var/lib/odoo /var/log/odoo` before `cat >
|
|
/etc/odoo/odoo.conf` — otherwise the redirect fails with ENOENT on
|
|
the non-existent directory (another bug this blueprint fixes).
|
|
"""
|
|
from __future__ import annotations
|
|
|
|
import json, pathlib, secrets, string, sys, subprocess, textwrap
|
|
|
|
ROOT = pathlib.Path(__file__).resolve().parent
|
|
|
|
# ---------- CONFIGURATION (edit these per project) --------------------------
|
|
|
|
EASYPANEL_PROJECT = "onebspace" # project name in Easypanel
|
|
APP_SERVICE = "os-dev-codespace" # app service name
|
|
DB_SERVICE = f"{APP_SERVICE}-db" # companion postgres service
|
|
HOST_PORT = 18069 # host port → 8069 inside container
|
|
FILESTORE_VOLUME = f"{APP_SERVICE}-filestore"
|
|
OS_DEV_HOST_PATH = "/root/Documents/trae_projects/one_b_os/os-dev"
|
|
BASE_IMAGE = "python:3.12-slim" # Debian 12 bookworm, slim, ~45MB
|
|
PG_IMAGE = "postgres:17"
|
|
|
|
# Resource budgets. The 5-min first-boot pip install is memory-hungry
|
|
# (lxml builds ~2 GB). Allocate headroom.
|
|
APP_RESOURCES = {"memoryReservation": 512, "memoryLimit": 2048,
|
|
"cpuReservation": 0.5, "cpuLimit": 2}
|
|
PG_RESOURCES = {"memoryReservation": 256, "memoryLimit": 1024,
|
|
"cpuReservation": 0.25, "cpuLimit": 1}
|
|
|
|
# ---------- helpers ----------------------------------------------------------
|
|
|
|
def gen_password(n: int = 24) -> str:
|
|
alphabet = string.ascii_letters + string.digits
|
|
return "".join(secrets.choice(alphabet) for _ in range(n))
|
|
|
|
|
|
def build_init_script() -> str:
|
|
"""The bash entrypoint that runs inside each container.
|
|
|
|
It is written into the built image via heredoc in the inline
|
|
Dockerfile. The script MUST be short, idempotent, and tolerant of
|
|
missing optional packages.
|
|
|
|
* CRITICAL FIX #1: no `wkhtmltopdf` + no `libldap-2.5-0`. Those
|
|
package names do NOT exist in Debian bookworm/trixie repos that
|
|
ship with `python:3.12-slim` (it's `libldap2` in bookworm, and
|
|
wkhtmltopdf was removed upstream). Referencing them causes
|
|
`apt-get install` to fail and the container dies with `exit 100`.
|
|
* CRITICAL FIX #2: `mkdir -p /etc/odoo /var/lib/odoo /var/log/odoo`
|
|
BEFORE `cat > /etc/odoo/odoo.conf <<EOF` — otherwise the bash
|
|
redirect fails with `line 37: /etc/odoo/odoo.conf: No such file
|
|
or directory`, then odoo is exec'd with -c pointing to nothing
|
|
→ `odoo: error: the config file '/etc/odoo/odoo.conf' doesn't
|
|
exist or is not readable` → exit 2 → service flapping.
|
|
* CRITICAL FIX #3: DO NOT `set -e`. Pip's `--quiet --break-system-
|
|
packages` + `--no-cache-dir` can exit non-zero on transient
|
|
warnings (e.g. "Running as root") that should NOT kill the
|
|
container. We instead rely on explicit early-exit points.
|
|
"""
|
|
return textwrap.dedent(r"""
|
|
#!/bin/bash
|
|
exec > /tmp/init.log 2>&1
|
|
set -x
|
|
|
|
if command -v apt-get >/dev/null 2>&1; then
|
|
apt-get update -qq
|
|
DEBIAN_FRONTEND=noninteractive apt-get install -y --no-install-recommends \
|
|
build-essential pkg-config \
|
|
libpq-dev libpq5 \
|
|
libxml2-dev libxslt1-dev \
|
|
libldap2-dev libsasl2-dev \
|
|
libjpeg-dev zlib1g-dev \
|
|
libcurl4-openssl-dev libssl-dev libffi-dev \
|
|
libxml2 libxslt1.1 libldap2 libsasl2-2 \
|
|
libjpeg62-turbo zlib1g libcurl4 libssl3 libffi8 \
|
|
fonts-noto-cjk node-less \
|
|
>>/tmp/init.log 2>&1 || echo "[init] WARN: apt-get install had errors (continuing)"
|
|
fi
|
|
|
|
ODOO_INSTALLED=0
|
|
python3 -c "import odoo" 2>/dev/null && ODOO_INSTALLED=1
|
|
|
|
if [ "$ODOO_INSTALLED" = "0" ]; then
|
|
echo "[init] Installing Odoo from /mnt/os-dev (first boot — this takes ~5 min)..."
|
|
pip install --quiet --no-cache-dir --break-system-packages --upgrade pip wheel
|
|
pip install --quiet --no-cache-dir --break-system-packages psycopg2-binary
|
|
pip install --quiet --no-cache-dir --break-system-packages /mnt/os-dev
|
|
if [ -s /mnt/os-dev/requirements.txt ]; then
|
|
pip install --quiet --no-cache-dir --break-system-packages \
|
|
-r /mnt/os-dev/requirements.txt
|
|
fi
|
|
echo "[init] Odoo install complete."
|
|
else
|
|
echo "[init] Odoo already installed; skipping pip install."
|
|
fi
|
|
|
|
mkdir -p /etc/odoo /var/lib/odoo /var/log/odoo
|
|
cat > /etc/odoo/odoo.conf <<EOF
|
|
[options]
|
|
admin_passwd = ${ADMIN_PASSWD:-admin}
|
|
db_host = ${HOST}
|
|
db_port = ${PORT:-5432}
|
|
db_user = ${USER:-odoo}
|
|
db_password = ${PASSWORD}
|
|
dbfilter = .*
|
|
list_db = True
|
|
addons_path = /mnt/os-dev/addons,/mnt/os-dev/odoo/addons
|
|
data_dir = /var/lib/odoo
|
|
dev_mode = reload,qweb,assets,xml,werkzeug
|
|
xmlrpc_port = 8069
|
|
workers = 0
|
|
log_level = info
|
|
EOF
|
|
|
|
echo "[init] Waiting for postgres at ${HOST}:${PORT}..."
|
|
for i in $(seq 1 30); do
|
|
python3 -c "
|
|
import socket, sys
|
|
s = socket.socket()
|
|
s.settimeout(2)
|
|
try:
|
|
s.connect(('${HOST}', int('${PORT:-5432}')))
|
|
sys.exit(0)
|
|
except Exception:
|
|
sys.exit(1)
|
|
" && break || sleep 2
|
|
done
|
|
|
|
echo "[init] Starting Odoo with --dev=reload (live edits auto-apply)..."
|
|
exec odoo -c /etc/odoo/odoo.conf \
|
|
--dev=reload,qweb,assets,xml,werkzeug \
|
|
--db-filter='.*' \
|
|
--limit-time-real=120 \
|
|
--log-level=info
|
|
""").strip() + "\n"
|
|
|
|
|
|
def build_inline_dockerfile() -> str:
|
|
"""Return the inline Dockerfile that Easypanel will build.
|
|
|
|
Why an inline Dockerfile at all, rather than `source.type=image`
|
|
with `deploy.command`? Because `python:3.12-slim` ships with
|
|
`CMD=["python"]` and Easypanel then REWRITES `deploy.command` as
|
|
args to that python entrypoint, resulting in the container running
|
|
`python -c "bash /usr/local/bin/init-odoo.sh"` which is a Python
|
|
syntax error → exit 100.
|
|
|
|
By building a trivial 2-layer Dockerfile we set ENTRYPOINT to our
|
|
init script explicitly, bypassing Easypanel's wrapping entirely.
|
|
"""
|
|
init = build_init_script()
|
|
# Use single-quote heredoc delimiter so NO shell expansion happens
|
|
# during Dockerfile RUN — env vars like $HOST are expanded at
|
|
# container runtime by bash, not at build time.
|
|
return (
|
|
f"FROM {BASE_IMAGE}\n"
|
|
f"RUN cat > /usr/local/bin/init-odoo.sh <<'__INIT_EOF__'\n"
|
|
f"{init}"
|
|
f"__INIT_EOF__\n"
|
|
f"RUN chmod +x /usr/local/bin/init-odoo.sh\n"
|
|
f'ENTRYPOINT ["/usr/local/bin/init-odoo.sh"]\n'
|
|
f"CMD []\n"
|
|
)
|
|
|
|
|
|
def build_schema(password: str) -> dict:
|
|
dockerfile = build_inline_dockerfile()
|
|
env_block = (
|
|
f"HOST=$(PROJECT_NAME)_{DB_SERVICE}\n"
|
|
f"PORT=5432\n"
|
|
f"USER=odoo\n"
|
|
f"PASSWORD={password}\n"
|
|
f"ADMIN_PASSWD=admin\n"
|
|
f"PYTHONUNBUFFERED=1\n"
|
|
f"PIP_DISABLE_PIP_VERSION_CHECK=1\n"
|
|
)
|
|
return {
|
|
"name": f"{APP_SERVICE} (stateless hot-reload workspace)",
|
|
"projectName": EASYPANEL_PROJECT,
|
|
"schema": {
|
|
"services": [
|
|
{"type": "postgres", "data": {
|
|
"serviceName": DB_SERVICE, "image": PG_IMAGE,
|
|
"databaseName": "postgres", "user": "odoo",
|
|
"password": password, "exposedPort": 0,
|
|
"pgWeb": {"enabled": True},
|
|
"dbGate": {"enabled": True},
|
|
"resources": PG_RESOURCES}},
|
|
{"type": "app", "data": {
|
|
"serviceName": APP_SERVICE,
|
|
"source": {"type": "dockerfile", "dockerfile": dockerfile},
|
|
"env": env_block,
|
|
"ports": [{"protocol": "tcp", "published": HOST_PORT, "target": 8069}],
|
|
"domains": [{"host": "$(EASYPANEL_DOMAIN)", "port": 8069,
|
|
"https": True, "path": "/"}],
|
|
"mounts": [
|
|
{"type": "bind", "hostPath": OS_DEV_HOST_PATH,
|
|
"mountPath": "/mnt/os-dev"},
|
|
{"type": "volume", "name": FILESTORE_VOLUME,
|
|
"mountPath": "/var/lib/odoo"}],
|
|
"resources": APP_RESOURCES}},
|
|
],
|
|
},
|
|
}
|
|
|
|
|
|
# ---------- commands (via MCP) ---------------------------------------------
|
|
|
|
def mcp_call(kind: str, procedure: str, payload: dict) -> dict:
|
|
"""Invoke an Easypanel MCP procedure via `run_mcp`.
|
|
|
|
We shell out to `trae mcp run` equivalent — but because we are
|
|
already executing inside an agent context with the MCP available,
|
|
callers that are the agent use the MCP tool directly. This
|
|
function is a helper for unit testing and returns a JSON payload
|
|
representation of a schema/result.
|
|
"""
|
|
return {"kind": kind, "procedure": procedure, "payload": payload}
|
|
|
|
|
|
def save_schema_and_password(schema: dict, password: str) -> None:
|
|
(ROOT / "easypanel.schema.json").write_text(
|
|
json.dumps(schema, indent=2))
|
|
(ROOT / ".db_password").write_text(password + "\n")
|
|
(ROOT / "inline.Dockerfile").write_text(schema["schema"]["services"][1]
|
|
["data"]["source"]["dockerfile"])
|
|
(ROOT / "init-odoo.sh").write_text(build_init_script())
|
|
print(f"[deploy] wrote easypanel.schema.json, inline.Dockerfile, "
|
|
f"init-odoo.sh, .db_password")
|
|
|
|
|
|
def cmd_prepare() -> tuple[dict, str]:
|
|
"""Build schema/artifacts — used by `deploy` and also dry-run."""
|
|
pwd = gen_password()
|
|
schema = build_schema(pwd)
|
|
save_schema_and_password(schema, pwd)
|
|
return schema, pwd
|
|
|
|
|
|
def main() -> int:
|
|
cmds = {"prepare", "dockerfile", "help"}
|
|
if len(sys.argv) < 2 or sys.argv[1] == "help":
|
|
print(__doc__)
|
|
print("Subcommands: prepare | dockerfile | help")
|
|
print(" prepare -> write easypanel.schema.json + inline.Dockerfile + init-odoo.sh + .db_password")
|
|
print(" (then use TRAE Easypanel MCP: createFromSchema + deployAppService)")
|
|
print(" dockerfile -> just print the generated inline Dockerfile to stdout")
|
|
return 0
|
|
cmd = sys.argv[1]
|
|
if cmd == "dockerfile":
|
|
print(build_inline_dockerfile())
|
|
return 0
|
|
if cmd == "prepare":
|
|
schema, pwd = cmd_prepare()
|
|
print(f"Password: {pwd}")
|
|
print(f"Schema project: {schema['projectName']} app={APP_SERVICE} db={DB_SERVICE}")
|
|
return 0
|
|
print(__doc__)
|
|
return 2
|
|
|
|
|
|
if __name__ == "__main__":
|
|
sys.exit(main())
|