blackducksoftware/blackduck-scan

Black Duck SCA Docker镜像技术文档

1. 镜像概述和主要用途

Black Duck SCA（Software Composition Analysis，软件成分分析）Docker镜像是一个容器化的软件成分分析解决方案，由多个服务容器组成。该镜像旨在通过Docker Swarm、Kubernetes或OpenShift等容器编排工具进行部署和管理，帮助用户识别软件项目中的开源组件、检测安全漏洞及许可合规风险。

2. 核心功能和特性

• 多容器架构：由多个协同工作的容器组成，支持分布式部署和扩展。
• 多编排平台支持：兼容Docker Swarm、Kubernetes及OpenShift等主流容器编排工具，适应不同的容器化环境。
• 集中化管理：提供容器化部署的配置与管理能力，简化企业级SCA工具的部署流程。

3. 使用场景和适用范围

适用场景

• 企业级软件项目的开源组件识别与管理。
• 软件供应链安全风险检测（如漏洞、***软件）。
• 开源许可合规性审计与管理。

适用范围

• 采用容器化部署架构的开发/测试/生产环境。
• 已使用Docker Swarm、Kubernetes或OpenShift进行容器编排的技术团队。
• 需要自动化开源成分分析流程的软件研发或安全团队。

4. 使用方法和配置说明

4.1 部署准备

使用前需确保环境满足以下条件：

• 已安装对应版本的Docker Swarm、Kubernetes或OpenShift编排平台。
• 具备容器镜像拉取权限（需联系Black Duck获取镜像访问凭证）。
• 已获取有效的Black Duck SCA许可证（详见4.3节）。

4.2 部署指南

Black Duck SCA的容器化部署需参考官方文档进行配置，具体步骤因编排平台而异：

4.2.1 Docker Swarm部署

详细部署指南（含配置步骤、服务编排文件说明等）请参考官方文档：
Docker Swarm部署文档

4.2.2 Kubernetes和OpenShift部署

Kubernetes及OpenShift环境的部署配置（包括命名空间设置、资源配置、服务暴露等）请参考官方文档：
Kubernetes和OpenShift部署文档

4.3 许可证获取

Black Duck SCA的使用必须具备有效许可证密钥，获取方式如下：

1. 联系Black Duck账户代表申请许可证。
2. 访问Black Duck官网获取更多信息：[***]

5. 配置参数与环境变量

容器的具体配置参数（如服务端口、存储路径、数据库连接等）及环境变量设置因部署平台和版本而异，详细说明请参考对应编排平台的官方安装文档（见4.2节链接）。部署前需根据实际环境调整配置，确保容器间网络通信、数据持久化及资源分配符合要求。

6. 注意事项

• 部署前请确认本地容器编排平台版本与Black Duck SCA的兼容性，具体要求以官方文档为准。
• 所有容器服务需持续运行以确保SCA功能正常，建议配置服务健康检查及自动恢复机制。
• 许可证密钥需妥善保管，部署时需通过环境变量或配置文件注入容器。
• 最新版本及更新日志可通过GitHub发布页获取：https://github.com/blackducksoftware/hub/releases/latest