部署 Docker 集群

背景说明

本篇将简述如何通过 docker run 或 docker-compose up 命令快速构建一套完整的元数分析平台集群。

适用场景

建议在 SIT 或者 DEV 环境中使用元数分析平台 Docker 容器来简化部署的流程。

源代码

本文的脚本源代码可以在 GitHub 上找到： https://github.com/meta-d/installer/

软件环境

软件	版本
Docker	20.0 及以上
docker-compose	2.10 及以上

标准版部署

请下载我们提供的安装脚本

git clone https://github.com/meta-d/installer.git

然后在 docker 目录下，首先配置环境变量文件 .env

cd installer/docker
cp env.tmpl .env

将 INSTALLATION_MODE 值设置为 standalone
其他密码字段可重新设置

最后执行以下命令启动服务：

docker-compose -f docker-compose.yml up -d

服务启动完成后访问 http://localhost/ （或者 http://your.ip/ 或 http://your.domain/ ）即可看到元数分析平台的系统初始化向导页面。

域名

如果系统部署在服务器（非 localhost ）上时，请修改 .env 文件中环境变量 API_BASE_URL 中的 localhost 为服务器的域名或者 IP 地址。例如：

http://localhost:3000 → http://[your-domain-or-ip]:3000

详细配置

Docker Compose 网络模式说明

元数分析平台部署 Docker 适用的网络模式有两种:

适合跨多节点部署的 HOST 模式，这种模式适合将不同服务部署到多个节点服务器上。
适合单节点部署多服务进程的 子网网桥模式，这种模式适合单节点部署多种服务的情况。

为便于展示，本章节仅演示子网网桥模式编写的脚本。

Docker Compose 脚本

部署元数分析平台需要 5 个基本的服务，在文件 docker-compose.yml 中定义了这些服务容器：

db: 数据库服务, 使用 postgres 数据库
redis: 服务端缓存服务, 使用 redis 数据库
olap: OLAP 引擎服务, 使用 metad-olap 镜像
api: 后端服务, 使用 ocap-api 镜像
webapp: 前端服务, 使用 ocap-webapp 镜像

环境变量说明

可以通过环境变量对系统各项参数进行控制，复制 env.tmpl 为 .env 并修改其中的参数即可。

部分参数说明如下：

环境变量	说明
API_BASE_URL	API 服务地址（需修改）
WEB_PORT	网站端口号
INSTALLATION_MODE	安装模式(`standalone`: 标准模式； `with-doris`: 集成 Doris 的模式; `with-starrocks`: 集成 Starrocks 的模式)
DB_NAME	数据库名称
DB_USER	数据库用户名
DB_PASS	数据库密码
DB_PORT	数据库端口
DB_HOST	数据库地址
REDIS_PASSWORD	缓存服务密码
WEBAPP_PORT	WEB UI 服务端口
NODE_ENV	运行环境: `development` or `production`
SENTRY_DSN	Sentry DSN
LOGGER_LEVEL	日志级别
DEFAULT_LATITUDE	默认纬度
DEFAULT_LONGITUDE	默认经度
DEFAULT_CURRENCY	默认货币
DEMO	演示系统

开启 HTTPS 服务

如果需要为本系统开启 HTTPS 服务，可以通过以下配置做到：

获取证书文件，将证书文件放到 volumes/webapp/ssl 目录下，文件名分别为 server.crt 和 server.key。
将自定义 Nginx 配置文件放到 volumes/webapp/conf 目录下，文件名为 nginx.conf，配置如下

user  nginx;
error_log  /var/log/nginx/error.log warn;
pid        /var/run/nginx.pid;

events {
  worker_connections 1024;
}

http {
  include /etc/nginx/mime.types;
  
  log_format  main  '$remote_addr - $remote_user [$time_local] "$request" '
                      '$status $body_bytes_sent "$http_referer" '
                      '"$http_user_agent" "$http_x_forwarded_for"';

  access_log  /var/log/nginx/access.log  main;

  #gzip  on;

  upstream api {
    server api:3000;
  }

  server {
    listen              80;
    listen              443 ssl;
    ssl_certificate     /webapp/ssl/server.crt;
    ssl_certificate_key /webapp/ssl/server.key;

    location / {
      root /srv/pangolin;
      try_files $uri $uri/ /index.html;
    }

    location /api/ {
      proxy_pass http://api;
      proxy_set_header Host $http_host;
      proxy_connect_timeout       5s;
      proxy_read_timeout          600s;
    }
    location /public/ {
      proxy_pass http://api;
      proxy_set_header Host $http_host;
      proxy_connect_timeout       5s;
      proxy_read_timeout          30s;
    }
  }
}

指定 nginx 配置文件：修改 command: ['nginx', '-g', 'daemon off;'] 改为 command: ['nginx', '-g', 'daemon off;', '-c', '/webapp/conf/nginx.conf']
修改 ports 配置开启 443 端口：- "443:443"
修改 .env 文件中的 API_BASE_URL 为 //your.domain。
修改 .env 文件中的 WEBAPP_PORT 为 443，如果想要两个（80/443）都启用则去掉此变量即可。

重新启动服务即可。

更多技术详情请参考 Enable HTTPS - [ocap wiki]

背景说明​

适用场景​

软件环境​

标准版部署​

详细配置​

Docker Compose 网络模式说明​

Docker Compose 脚本​

环境变量说明​

开启 HTTPS 服务​