AppScan 360° のシングル仮想マシンへのカスタム・インストール

カスタム・モードは、完全なシングル VM 構成と実働重視のデプロイメントを目的としています。このモードでは、express モードよりも多くのデプロイメントの選択肢がサポートされており、外部データベース構成、Docker レジストリーの選択、オプションのプロキシー設定、OpenTelemetry 統合などが含まれます。

注: ターゲット・システムで、すべてのインストールおよび構成手順を管理者として実行します。

開始する前に

  1. シングル VM 環境のセットアップを確認し、セットアップ中に必要な値を収集します。
  2. MyHCLSoftware ポータルから必要なキットをすべて 1 つのディレクトリーにダウンロードします。例えば、/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/ 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]:

カスタム・アンケートに回答する

実働フローでは、Express モードよりも幅広い一連の質問を尋ねます。

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° 中央プラットフォーム (ASCP) とサポートされているコンポーネント。
  • AppScan 修復アドバイザリー (ASRA)
  • ソフトウェア・コンポジション分析 (SCA)、選択した場合
  • 外部データベース接続
  • Docker レジストリー接続

インストールにかかる時間は、システム容量とネットワーク・パフォーマンスに依存します。

完了すると、インストーラーは次を出力します。
  • 追加する hosts ファイル・エントリー
  • 最終的な AppScan 360° アクセス URL
生成された IP およびホスト名マッピングを使用して、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 レジストリー接続 レジストリーの認証情報、アドレス、ネットワーク接続を確認します
その他の問題 トラブルシューティング・ガイド