codice/ddf Docker 镜像 - 轩辕镜像

DDF

镜像概述和主要用途

DDF镜像为部署DDF系统提供Docker化运行环境，支持灵活的系统配置、外部服务集成、应用管理、数据预处理及安全设置，适用于测试、演示和开发环境中快速搭建DDF基础架构。

核心功能和特性

• 系统网络配置：支持自定义内外主机名、端口及服务上下文
• 外部服务集成：可对接外部Solr（含Solr Cloud）和LDAP服务
• 应用生命周期管理：通过环境变量控制应用安装、卸载和启动
• 安全配置：支持自定义密钥库、自动生成演示证书及远程CA证书请求
• 数据预处理：支持从本地/远程源自动导入元数据和内容数据
• 目录监控：可配置多目录监控器，自动处理新增文件
• 扩展性：支持自定义注册中心和目录源模板

使用场景和适用范围

• 测试环境：快速部署DDF系统进行功能验证和兼容性测试
• 演示环境：展示DDF系统功能，支持自定义配置和数据预加载
• 开发环境：提供一致的运行环境，简化开发和调试流程

详细配置说明

基本配置

系统主机名

• 设置系统外部访问主机名：EXTERNAL_HOSTNAME=<hostname>（所有外部请求使用的主机名）
• 设置系统内部主机名：INTERNAL_HOSTNAME=<hostname>

内部系统端口

注意：修改这些选项会改变服务器实际绑定的端口，通常无需修改。

• 设置内部HTTPS端口：INTERNAL_HTTPS_PORT=<port>
• 设置内部HTTP端口：INTERNAL_HTTP_PORT=<port>

外部系统端口

注意：修改这些选项会影响服务器期望外部请求使用的URL。

• 设置外部HTTPS端口：EXTERNAL_HTTPS_PORT=<port>
• 设置外部HTTP端口：EXTERNAL_HTTP_PORT=<port>

内部服务上下文

修改所有服务的根上下文：INTERNAL_CONTEXT=<context_path>

外部服务上下文

修改代理/负载均衡器后的服务上下文：EXTERNAL_CONTEXT=<context_path>

站点名称

设置系统站点名称：SITE_NAME=<name>，未设置时默认使用外部主机名。

外部Solr

• 配置Solr后端：SOLR_URL=<external solr url>（默认使用内部Solr服务器）
• 配置Solr Cloud后端：SOLR_ZK_HOSTS=<zk host>,<zk host>,...（多个ZooKeeper主机用逗号分隔）

外部LDAP

配置LDAP客户端：LDAP_HOST=<hostname>

注意：目前仅用于测试，不支持配置协议、端口、用户名或密码。

Java内存

设置系统分配的内存：JAVA_MAX_MEM=<memory>（如2g）

高级配置

• 复制或挂载配置文件到APP_HOME/etc/目录
• 挂载或复制文件到$ENTRYPOINT_HOME/pre_config目录，系统启动前会自动复制到APP_HOME

应用和功能管理

通过环境变量控制应用和功能的安装与启动：

• 使用安装配置文件：INSTALL_PROFILE=<profile name>（支持注册的配置文件或位于APP_HOME/etc/profiles/的自定义JSON配置文件）
• 安装功能：INSTALL_FEATURES=<feature name>;<feature name>;...（多个功能用分号分隔）
• 卸载功能：UNINSTALL_FEATURES=<feature name>;<feature name>;...
• 启动应用：STARTUP_APPS=<app name>;<app name>;...

HTTPS配置

自定义密钥库

将自定义密钥库挂载到以下路径：

• 服务器密钥库：APP_HOME/etc/keystores/serverKeystore.jks
• 服务器信任库：APP_HOME/etc/keystores/serverTruststore.jks

自动生成演示证书

未使用自定义密钥库时，启动过程会动态生成证书：

• 默认使用DDF分发中内置的本地演示CA，为INTERNAL_HOSTNAME（未设置时使用hostname -f结果）生成证书
• 证书主题备用名称（SAN）默认包含：DNS:$INTERNAL_HOSTNAME(或hostname -f结果),$EXTERNAL_HOSTNAME,DNS:localhost,IP:127.0.0.1
• 添加额外SAN：CSR_SAN=<DNS|IP>:<value>,...（如CSR_SAN=DNS:example.com,IP:192.168.1.1）

导入现有证书

可通过环境变量在运行时导入证书链：

• 证书链：SSL_CERT=<certificate chain>
• 私钥：SSL_KEY=<private key>
• CA bundle：SSL_CA_BUNDLE=<ca bundle>
• 加密密钥密码：SSL_KEY_PASS=<password>

警告：生产环境不建议使用此方式，Docker守护进程访问者可获取环境变量中的敏感信息。

远程CA支持

支持从基于cffsl的远程CA请求证书：

• 启用远程CA：REMOTE_CA_URL=https://<host>:<port>（默认生成与本地CA相同的证书）

CSR自定义（仅当使用REMOTE_CA_URL时适用）

数据种子

种子目录元数据

系统启动后自动导入元数据档案：INGEST_DATA=<location>[|<transformer>],...

• 支持的档案类型：zip、tar、tar.gz、tgz
• 支持的协议：http://、https://、file://
• 可选转换器：在每个位置后添加|<transformerName>指定（如[***]|xml）

示例：INGEST_DATA=[***]|xml,[***]|geojson,file:///some/local/file.zip

种子内容数据

系统启动后自动预加载和索引内容档案：SEED_CONTENT=<location>,...

• 支持的档案类型：zip、tar、tar.gz、tgz
• 支持的协议：http://、https://、file://

示例：SEED_CONTENT=[***]

配置内容目录监控器

通过CDM环境变量配置任意数量的目录监控器，监控新增文件并自动存储和索引：
格式：CDM=<directory>|<processing_mechanism>|<threads>|<readlock>,...（仅<directory>为必填项）

• <directory>：监控目录路径
• <processing_mechanism>：处理机制（如in_place、delete）
• <threads>：线程数
• <readlock>：读锁超时（毫秒）

示例：CDM=/monitor|in_place|1|500,/foo|delete|1|200,/bar

配置IdP客户端

设置IdP客户端元数据位置：IDP_URL=<metadata_url>
示例：IDP_URL=[***]

配置注册中心

通过REGISTRY环境变量配置包含联合源列表的注册中心，格式：REGISTRY=url|option|option|...,url|option|...（仅URL为必填项）

创建目录源

通过SOURCES环境变量添加联合源，格式：逗号分隔的源列表，每个源参数用|分隔：
<source_type>|<source_name>|<url>[|<username>|<password>]（[]表示可选参数）

源类型

默认仅支持csw_federated类型。可添加自定义模板文件到${ENTRYPOINT_HOME}/templates/sources目录扩展支持的源类型（参考csw_federated.config）

目录扇出模式

设置目录使用扇出模式：CATALOG_FANOUT_MODE=true

扩展

默认基础镜像仅支持CSW类型注册中心。要支持其他注册中心类型，添加模板文件到$ENTRYPOINT_HOME/templates/registry/，模板文件命名格式：<name>.template

故障排除

系统启动时可能因资源限制（内存/CPU）导致初始化缓慢，可调整以下环境变量延长等待时间和重试次数：

• KARAF_CLIENT_DELAY=<time>：等待时间（秒，默认：10）
• KARAF_CLIENT_RETRIES=<number>：重试次数（默认：12）

已弃用功能

• APP_NODENAME=<node_name>：已弃用，使用CSR_SAN=<DNS|IP>:<value>,...替代
• APP_HOSTNAME=<hostname>：已弃用，使用INTERNAL_HOSTNAME=<hostname>替代