eclipse/che-init-plugin-broker

che-init-plugin-broker 镜像文档

镜像概述

che-init-plugin-broker 是 Eclipse Che 生态中的核心组件之一，作为插件代理的初始化服务，负责启动并配置插件代理（Plugin Broker）。该组件通过处理插件元数据、协调插件仓库与Che IDE之间的交互，实现IDE插件的发现、下载、缓存与分发，是确保Che IDE环境中插件功能可用的关键服务。

核心功能与特性

• 插件代理初始化：加载默认或自定义配置，完成插件代理服务的启动参数设置、网络配置及依赖检查。
• 插件生命周期管理：支持插件的发现（从插件仓库获取可用插件列表）、下载（从指定源拉取插件包）、缓存（本地存储以加速后续加载）与分发（向Che IDE实例推送所需插件）。
• Che服务集成：通过Che API与Che Server通信，获取IDE实例的插件需求，动态调整插件提供策略，确保插件与IDE版本兼容性。
• 可配置化：支持通过环境变量或配置文件自定义插件仓库地址、缓存路径、日志级别等参数，适应不同部署场景。

使用场景与适用范围

• Eclipse Che IDE部署：作为Che部署流程的关键组件，用于初始化插件代理服务，保障IDE基础插件与扩展插件的正常加载。
• Che集群环境：在多节点Che集群中，协调跨节点的插件分发与缓存共享，提升插件加载效率。
• 自定义插件管理：集成私有插件仓库时，通过配置初始化参数，实现私有插件的发现与分发。
• 开发环境标准化：在团队开发环境中，确保所有成员使用统一版本的插件，维持开发环境一致性。

使用方法与配置说明

基本部署（Docker Run示例）

bash
docker run -d \
  --name che-init-plugin-broker \
  --network che-network \  # 连接至Che服务所在网络
  -e CHE_API_URL=http://che-server:8080/api \  # Che Server API地址（必填）
  -e PLUGIN_REGISTRY_URL=https://che-plugin-registry.eclipse.org/v3 \  # 插件仓库地址（默认值）
  -e CACHE_DIR=/var/cache/che-plugins \  # 插件缓存目录
  -e LOG_LEVEL=INFO \  # 日志级别：DEBUG/INFO/WARN/ERROR
  -v /host/path/to/cache:/var/cache/che-plugins \  # 挂载本地目录持久化缓存
  -v /host/path/to/config:/etc/che/plugin-broker \  # 挂载自定义配置文件（可选）
  eclipse/che-init-plugin-broker:latest

关键环境变量配置

配置文件挂载（可选）

若需使用自定义配置文件（如broker-config.yaml），可通过挂载配置目录实现：

bash
-v /host/path/to/config:/etc/che/plugin-broker  # 配置文件需命名为broker-config.yaml并放置于该目录

配置文件示例（broker-config.yaml）：

yaml
pluginRegistryUrl: "https://private-plugin-registry.example.com/v3"
cacheDir: "/var/cache/che-plugins"
log:
  level: "DEBUG"
timeout:
  pluginDownload: 300
  registryRequest: 60

注意事项

1. 网络依赖：需确保容器可访问CHE_API_URL与PLUGIN_REGISTRY_URL，建议与Che Server部署在同一网络。
2. 权限要求：挂载本地目录时，需确保容器对挂载目录有读写权限（可通过-u $(id -u):$(id -g)指定用户ID）。
3. 版本兼容性：需使用与Che Server版本匹配的镜像（如Che 7.70.0对应镜像标签为7.70.0），避免兼容性问题。
4. 缓存清理：若需更新插件版本，可删除缓存目录或通过环境变量CLEAR_CACHE=true启动容器以清理缓存。

常见问题

• 插件加载失败：检查CHE_API_URL是否可访问、插件仓库地址是否有效，查看容器日志（docker logs che-init-plugin-broker）定位具体错误。
• 缓存占用过大：通过配置CACHE_TTL（插件缓存过期时间，单位小时）自动清理过期缓存，或手动删除缓存目录中无用插件包。
• 私有仓库集成：确保私有仓库支持HTTPS（或配置INSECURE_REGISTRY=true允许HTTP），并验证仓库返回的插件元数据格式符合Che规范。