logilab/cubicweb-base

CubicWeb Docker镜像

概述

该项目帮助将基于CubicWeb的应用构建为Docker镜像，使用Debian基础镜像，包含多种版本的CubicWeb和Python，适用于生产环境部署。

标签

可用镜像标签：

• latest
• 1.0

包含内容

该镜像包含构建生产环境CubicWeb应用镜像所需的必要组件，设计为应用Dockerfile的父镜像使用。具体包含：

• 带psycopg2的Python环境
• /usr/bin/python和/usr/bin/pip符号链接到选定的Python版本（2.7、3.5或3.7）
• gettext、graphviz工具
• uwsgi及配置文件/etc/uwsgi/uwsgi.ini
• 基于环境变量的pyramid配置模板/pyramid.ini
• 入口点脚本，用于配置pyramid.ini、处理/etc/cubicweb.d/instance/data中的静态数据文件及数据库自动升级

入口点还支持运行各类命令（如db-create创建数据库）或任意命令。

镜像约定

• 顶层cube源代码需位于/src目录；若从其他位置或PyPI安装cube，需设置CUBE环境变量
• 默认实例名称为"instance"，配置目录位于/etc/cubicweb.d/instance，可通过CW_INSTANCE环境变量修改（通常无需修改）

如何构建CubicWeb应用镜像

根据集成级别不同，有多种使用方式，选择建议：

• 预安装CubicWeb的镜像构建速度更快
• 未预安装CubicWeb的镜像可使用自定义版本的CubicWeb

示例

假设在cubicweb-blog的源代码目录中：

dockerfile
FROM docker.xuanyuan.run/logilab/cubicweb-base
USER root
COPY . /src
RUN pip install -e /src
USER cubicweb
RUN docker-cubicweb-helper create-instance

若从PyPI安装或源代码不在/src目录，需设置CUBE环境变量：

dockerfile
FROM docker.xuanyuan.run/logilab/cubicweb-base
USER root
RUN pip install cubicweb-blog
USER cubicweb
ENV CUBE=blog
RUN docker-cubicweb-helper create-instance

如何运行生成的镜像

环境变量

环境变量控制all-in-one.conf中的设置，关键变量包括：

• CW_BASE_URL：实例访问URL（默认http://localhost:8080），需包含协议，如https://myapp.demo.logilab.org
• 数据库设置：CW_DB_DRIVER（默认postgres）、CW_DB_NAME、CW_DB_USER、CW_DB_PASSWORD
• 管理员账号：CW_LOGIN（默认admin）、CW_PASSWORD（默认admin）

使用非持久化SQLite数据库快速测试

用于验证镜像可用性：

bash
docker run --rm -it -e CW_DB_NAME=db.sqlite docker.xuanyuan.run/myimage sh -c "cubicweb-ctl db-create -a instance && uwsgi --ini /etc/uwsgi/uwsgi.ini"

访问http://localhost:8080即可打开实例。

创建初始数据库

需先运行db-create命令创建初始数据库：

示例

bash
# 在本地PostgreSQL集群创建名为"myapp"的数据库
docker run --rm -it -e CW_DB_NAME=myapp -e CW_DB_USER=me -v /var/run/postgresql:/var/run/postgresql docker.xuanyuan.run/myimage db-create

# 在远程PostgreSQL服务器创建名为"myapp"的数据库
docker run --rm -it -e CW_DB_NAME=myapp -e CW_DB_USER=me -e CW_DB_PASSWORD=secret -e CW_DB_HOST=dbserver docker.xuanyuan.run/myimage db-create

# 在本地/tmp/db.sqlite文件中创建数据库
docker run --rm -it -e CW_DB_NAME=/tmp/db.sqlite -v /tmp/db.sqlite:/tmp/db.sqlite docker.xuanyuan.run/myimage db-create

运行WSGI服务器

在本地8080端口启动uwsgi服务器：

bash
# 前台运行
docker run --rm -it -p 8080:8080 docker.xuanyuan.run/myapp

# 后台运行
docker run -d --restart=always --name docker.xuanyuan.run/myapp myapp

运行循环任务（调度器）

需启动scheduler以运行CubicWeb循环任务：

bash
# 前台运行
docker run --rm -it docker.xuanyuan.run/myapp cubicweb-ctl scheduler instance

# 后台运行
docker run -d --restart=always --name myapp-scheduler docker.xuanyuan.run/myapp cubicweb-ctl scheduler instance

最佳实践

• 源代码构建时，添加.dockerignore文件避免复制无用文件，示例：

  .*
  *.egg-info
  **/__pycache__
  Dockerfile
  Jenkinsfile
  Makefile
  tox.ini
  test
  debian
  

• 构建前拉取基础镜像，基础镜像会随Debian安全更新或PyPI新版本重建以包含最新更新。