先决条件设置指南

简介

本文档提供了一份详尽的 HCL AppScan 360° 部署先决条件检查清单,内容涵盖部署服务器、Kubernetes 集群、外部依赖关系及资源要求。

部署服务器先决条件

部署服务器是一个基于 Linux 的系统,用于启动和管理 AppScan 360° 部署。

类别 需求
操作系统 Ubuntu 22.04 / Ubuntu 24.04 / RHEL 9
软件
  • Bash shell:运行安装脚本所必需
  • Docker:用于 Ubuntu 上的本地容器服务(请参阅 Docker 安装)
  • Podman:用于 RHEL 上的本地容器服务(通常已预装)
  • Kubectl:用于 Kubernetes 集群管理(请参阅 Kubectl 安装)
  • Helm 4:用于图表部署(请参阅 Helm 安装)
注:

对于全新安装和概念证明 (POC),请确保在开始安装之前将主机时区设置为 UTC。

如果主机设置为本地时区,则在部署完成后的一小段时间内扫描执行可能会失败,直到证书与 UTC 同步

。

Kubernetes 集群先决条件(适用于分布式环境)

  • 对于使用一键安装程序或基于 Helm 的安装程序的安装过程,Kubernetes 集群是必需的。该集群必须满足以下先决条件,以确保 AppScan 360° 平台的兼容性和最佳性能。

  • Kubernetes 集群用于托管 AppScan 360° 平台,并需要特定的组件和配置。

类别 需求
组件
  • 网关控制器(符合 Gateway API v1.4.0 的要求)

  • 证书管理器(v1.11.0 或兼容版本)

存储
  • 具有 ReadWriteMany (RWX) 访问模式的存储类

  • 支持 fsGroup 安全上下文的 Kubernetes CSI 驱动程序

联网
  • 双栈 IPv4/IPv6(如果需要 IPv6)

  • 针对加密通信的网络策略支持

工作程序节点
  • 确保为动态和静态扫描提供充足的资源(请参阅资源要求)
注: 对于动态扫描,请在运行动态扫描的所有节点中增加内核中的 inotify 实例数:
  • 将 fs.inotify.max_user_instances=524288 添加到 /etc/sysctl.conf 中。

  • 重新启动节点以使更改生效。

  • 对于较小的集群,32800 可能已足够,但建议使用 524288 以实现稳健的动态扫描。

验证配置

  • 使用以下命令验证先决条件:
    检查 命令
    Kubernetes 连接 kubectl version
    Docker 连接 docker version
    Helm 连接 helm version
    证书管理器 kubectl get pods --namespace cert-manager
    网关连接 kubectl get gatewayclass
    存储类 kubectl get storageclass
    持久卷 kubectl get pv
    SQL 连接 ping <MSSQL_SERVER_IP>
    容器注册表登录 docker login <PRIVATE_REGISTRY_URL>
  • 在部署之前,利用 AppScan 360° Setup Assistant 对配置参数和连接进行交互式验证。

外部依赖关系

AppScan 360° 依赖于必须配置且可访问的外部服务。
类别 需求
数据库

MSSQL Server 2019 或更高版本,并具有 db_creator 许可权。每次扫描执行大约需要 150 KB 存储空间。

认证 通过 OIDC (Keycloak / Okta) 或经端口 389/636/TCP 的 LDAP (Microsoft Active Directory / Domino) 实现 SSO
电子邮件 通过端口 25/TCP 访问 SMTP 服务器以发送通知
许可证发放 通过端口 443/TCP 访问 HCL 许可证管理门户网站(需要 HCL 标识)
容器注册表 用于存储和提取 AppScan 360° 容器映像的远程容器注册表
网络 用于安全通信的受信任证书(如果需要,请将不受信任的证书导入客户机 JRE 密钥库中)
存储 扫描数据的文件存储(请参阅“存储要求”)
HCL Harbor 用于维护 SCA 扫描的最新问题目录和漏洞数据

其他注意事项

  • HCL 标识:访问 HCL 许可证和下载门户网站及 HCL Harbor 时需要此项

  • 浏览器支持:对于 AppScan 360° 用户界面,使用最新版本的 Chrome、Safari、Edge 或 Firefox

  • 屏幕分辨率:建议使用 1920x1080 分辨率,可确保获得最佳显示效果

  • DNS:使用 DNS 服务器中的指定 IP 发布 FQDN

网络端口:

  • 22/TCP:通过 SSH 连接到部署服务器

  • 25/TCP:SMTP

  • 389/TCP:LDAP

  • 80, 443, 8080/TCP:Web 访问

  • 5443,6443,7443,8443/TCP:仅在采用单个 VM 安装时,需额外使用这些端口。

访问点:

  • 用户门户网站:https://<CK_CONFIGURATION_DISCLOSED_SITE_URL>
  • 用户 API:https://<CK_CONFIGURATION_DISCLOSED_SITE_URL>/api
  • 用户 API (Swagger):https://<CK_CONFIGURATION_DISCLOSED_SITE_URL>/swagger

缺省本地用户:

  • 管理员 — 密码:Admin12!

  • 用户 — 密码:User123!