AppScan 360° 在单个虚拟机上的定制安装

定制模式适用于完整的单个 VM 配置和面向生产的部署。与快速模式相比,此模式支持更多部署选项,包括外部数据库配置、Docker 注册表选择、可选代理设置和 OpenTelemetry 集成。

注: 以管理员身份在目标系统上运行所有安装和配置步骤。

开始之前

  1. 查看设置单个 VM 环境,并收集设置过程中您需要的值。
  2. 将所有必需的工具包从 MyHCLSoftware 门户网站下载到一个目录中。例如,/home/username/AppScan360_singleVM。

    将所有安装工具包保存在同一文件夹中。

    典型工具包文件:
    • AppScan360_SingleVMsetup_v<version>.run
    • AppScan360_v<version>.run
    • AppScan360_ASRA_v<version>.run
    • AppScan360_DTCS_v<version>.run(DAST 模板功能所需)
    • AppScan360_SCA_v<version>.run (可选)
  3. 准备工作目录,并赋予工具包可执行权限:
    mkdir -p ~/aio-setup
    mv *.run ~/aio-setup/
    cd ~/aio-setup
    chmod +x *.run

放置证书(可选)

  1. 如果您使用定制或自签名证书来实现对 LDAP、OIDC、SMTP、Docker 注册表、Ingress 或 OpenTelemetry 收集器的信任关系,请先创建证书文件夹结构:
    sudo ./AppScan360_SingleVMsetup_v<version>.run -- "$PWD" prepareCertsFolders
    命令将创建:
    文件夹 函数
    ~/aio-setup/certs/ 主证书文件夹
    ~/aio-setup/certs/docker/ Docker 注册表证书
    ~/aio-setup/certs/ldap/ LDAP 证书 (LDAPS)
    ~/aio-setup/certs/smtp/ SMTP 证书 (SMTPS)
    ~/aio-setup/certs/oidc/ OIDC 证书 (OIDCS)
    ~/aio-setup/certs/otel/ 收集器使用专用 CA 时的 OpenTelemetry 证书
    ~/aio-setup/certs/ingress/ 入口证书(可选,如果未提供,将生成自签名)
  2. 创建文件夹后,请在开始安装之前将证书文件放入相应的路径中。

运行安装

  1. 启动安装程序:
    cd ~/aio-setup
    sudo ./AppScan360_SingleVMsetup_v2.1.0.run -- $PWD

    如果您需要停止并清理中断的安装,请运行以下命令:

    cd aioWorkspace
    ./disengageAS360-AIO.sh
    安装日志文件将写入 ./aioWorkspace/logs 中。
  2. 出现提示时,选择定制模式(生产)。
    Please select your installation path:
    1. 🚀  Express Mode (POC)
    2. 🛠️  Custom Mode (Production)
    Enter 1 or 2 [Default: 1]:

完成定制调查问卷

生产流程提出的问题比快速模式更广泛。

SCA 选择

Will this production deployment include Software Composition Analysis (SCA)? This requires license. (y/n) [Default: n]:

如果您启用了 SCA,则系统稍后将在流程中显示其他数据库和注册表提示。

数据库配置

选择数据库类型:

Please select the database type for this production deployment:
1. 🔷 Microsoft SQL Server (MSSQL)
2. 🐘 PostgreSQL
Enter 1 or 2 [Default: 1]:

然后,提供数据库连接详细信息:

> Enter Database Hostname or IP:
> Enter Database Port [Default: 1433]:
> Enter Database User for AppScan:
> Enter Database User Password:
> Enter the name for the main AppScan database [Default: AppScanCloudDB]:

如果您选择了 PostgreSQL,则缺省端口为 5432。

特定于 SCA 的配置

如果启用了 SCA,则安装程序还会要求提供以下信息:

> Please provide a name for the new SCA database [Default: AppScan360_SCA_DB]:
> Please provide a name for the new SCA Aggregation database [Default: AppScan360_SCA_Aggregation_DB]:
> SCA Registry Address [Default: hclcr.io]:
> SCA Registry Path [Default: appscan360/as360-k8s-docker-images]:
> SCA Helm Repository Path [Default: appscan360/as360-k8s-helm-packages]:
> SCA Registry Username (typically your HCL ID):
> SCA Registry Password/Token:

如果您要启用 SCA 漏洞数据库更新,请使用 HCL 凭证。

网络配置

主域:

Please enter the primary domain name for this installation. This will be used to create the access URL (e.g., yourcompany.com):

出站访问所需的外部域或 IP:

Provide the external domain(s) or IP address(es) this instance must access for external services (e.g., SSO, SMTP). Use commas to separate multiple values. If none, press Enter to skip:

本地 DNS 连接:

Is this VM connected to a local DNS server? (y/n) [Default: n]:

OpenTelemetry 端点:

Provide the OpenTelemetry collector endpoint URL. If not applicable, press Enter to skip (recommended format: http://<opentelemetry-collector-host>:4317):

共享存储大小:

To plan for long-term storage costs, estimate the number of scan results you plan to retain. > Specify the shared storage capacity in GB [Default: 200]:

SMTP 邮件中继(可选)

Do you want to configure an SMTP Mail Relay(SMR)? (y/n) [Default: n]:

如果启用了该选项,安装程序将询问以下问题:

What is the SMR host?
What is the SMR port?
What is the SMR username?

认证方式:

Select SMTP authentication mode:
1. Password
2. Client Secret
Enter 1 or 2 [Default: 1]:

然后,它会要求输入 SMR 密码或 SMR 客户机密钥,然后询问以下问题:

Does the SMR operate over SSL/TLS. If yes, a certificate is required to be present in certs/smtp folder (y/n)?

Docker 注册表配置

定制模式支持工具包管理的本地 Docker 专用注册表或外部注册表。

选择工具包是否应在本地安装和管理 DPR:

Do you want the kit to install and manage a local Docker Private Registry (DPR) on this VM? (y/n) [Default: n]:

如果您选择 n,则安装程序将要求提供外部注册表详细信息:

What is the external Docker Private Registry (DPR) address (FQDN:PORT)?
What is the external Docker Private Registry (DPR) username?
What is the external Docker Private Registry (DPR) password?
What is the docker registry context/repository name [Default: as360-k8s-docker-images]:
What is the helm repository context/repository name [Default: as360-k8s-helm-packages]:

要使用注册表根路径而不是上下文路径,请在出现上下文提示时输入 EMPTY。

如果您选择 y,则工具包会自动准备本地 DPR。

代理服务(可选)

Do you want to use a proxy service? (y/n) [Default: n]:

如果启用了该选项,安装程序将询问以下问题:

What is the proxy host?
What is the proxy port?
Does the proxy require user/password credentials? (y/n):
What is the proxy username?:
What is the proxy password?:

最终确认

在安装开始之前,脚本会显示您所选选项的摘要并要求您进行确认:

Continue with installation? (y/n) [Default: y]:

安装程序配置的内容

确认后,安装程序将配置:
  • Kubernetes 集群 (K0S)
  • AppScan 360° Central Platform (ASCP) 和支持组件。
  • AppScan Remediation Advisories (ASRA)
  • 软件组成分析 (SCA)(如果已选择)
  • 外部数据库连接
  • Docker 注册表连接

安装时间取决于系统容量和网络性能。

完成后,安装程序将输出:
  • 要添加的 Hosts 文件条目
  • 最终 AppScan 360° 访问 URL
使用所生成的 IP 和主机名映射来更新您的 Hosts 文件。
操作系统 Hosts 文件路径
Linux、MacOS /etc/hosts
Windows C:\Windows\System32\drivers\etc\hosts
例如:
192.168.1.100 appscan.appscan-test.local

登录并激活 AppScan 360°

要登录并激活 AppScan 360°,请执行以下操作:
  1. 打开安装完成时显示的 URL:https://<host>.<domain>
  2. 使用缺省凭证登录:
    • 用户名:Admin
    • 密码:Admin12!
  3. 上载您的 AppScan 360° 许可证文件以激活产品。

备份建议

定期备份以下项目:

  • 数据库
  • 安装目录中的配置文件
  • 许可证信息

更改安装方法

对于分布式部署,请参考 AppScan 360° 的分布式安装。

常见安装问题

问题 解决方案
数据库连接失败 验证数据库凭证和网络连接
磁盘空间不足 确保 VM 有足够的存储空间来满足您所选配置的需求
证书错误 验证证书文件格式、文件名以及在 certs 文件夹中的位置
Docker 注册表连接 验证注册表凭证、地址和网络连接
任何其他问题 故障诊断指南