Helm を使用した AppScan 360° のインストール

Helm を使用した AppScan 360° のインストールには、AppScan 360° 環境のセットアップのほかに、永続的で信頼性の高いインターネット接続が必要です。システムは、HCL Harbor から定期的に Helm チャートをダウンロードできる必要があります。

Helm を使用して AppScan 360° をインストールする前に、次の手順を実行します。

helmfile のインストール

helmfile をインストールするには、次の手順を実行します。
  1. helmfile バイナリー・ファイルをダウンロードします。
    wget -O helmfile.tar.gz $(curl -s https://api.github.com/repos/helmfile/helmfile/releases/latest | grep browser_download_url | grep linux_amd64.tar.gz | cut -d '"' -f 4)
  2. アーカイブを抽出します。
    tar -xvzf helmfile_*_linux_amd64.tar.gz
  3. helmfile バイナリーを適切なローカル・ディレクトリーに移動します。
    例えば、usr/local/bin/ です。
    sudo mv helmfile /usr/local/bin/
  4. ファイルに実行可能権限を与えます。
    sudo chmod +x /usr/local/bin/
    sudo chmod +x /usr/local/bin/helmfile
  5. 次のようにして、インストールを確認します。
    helmfile --version
    注: デプロイメント全体で一貫性を保つために、目的のバージョンを使用していることを必ず確認してください。

Harbor 接続をセットアップする

Harborへの接続をセットアップするには、次の手順を実行します。
  • usernamepassword (cli-secret で定義されている) を使用して、Docker ログインを使用します。
    docker login hclcr.io
  • docker/config.json ファイルの環境変数を設定します。
    export HCLCR_USERNAME=<harbor-username>
    export HCLCR_PASSWORD=<harbor-password/cli-secret>
  • base64 エンコーディングの環境変数を設定します。
    export AS360_KNI_JSON_CONFIG_AS_BASE64="<base64-value-of-docker-config.json>"

GitHub リポジトリーをセットアップする

AppScan 360° Helm のリポジトリーは、プライベート GitHub サーバー上でホストされています。https://github.com/HCL-TECH-SOFTWARE/ で、適切なリポジトリーのクローンを作成して、ローカル・リポジトリーに適切に入力します。
git clone --branch main https://github.com/HCL-TECH-SOFTWARE/AppScan-360-Helm-Files.git
クローンの作成後、ローカル・リポジトリーの構造が次のとおりであることを検証します。
AppScan-360-Helm-Files
├── helm.d
│   ├── helmfile-ASCP.yaml.gotmpl
│   ├── helmfile-ASRA.yaml.gotmpl
│   ├── helmfile-SCA.yaml.gotmpl
│   └── helmFileCustomization
│       └── singular-singular.clusterKit-Sample.yaml
└── helmfile.yaml.gotmpl

インストール AppScan 360°

クローンが作成されたリポジトリー (AppScan-360-Helm-Files) から、次のように実行します。
helmfile sync

ソフトウェア・コンポジション分析 (SCA) を含める

ソフトウェア・コンポジション分析 (SCA) は、AppScan 360° をパラメーターと共にインストールする場合に含まれます。
注: ソフトウェア・コンポジション分析 (SCA) は、デフォルトでは AppScan 360° に含まれていません。有効にする必要があります。
SCA を含めるには:
includeSCA=true helmfile sync
SCA を無効にするには:
includeSCA=true helmfile destroy
ソフトウェア・コンポジション分析 (SCA) 脆弱性データベースの自動更新を有効にするには、正しい資格情報を使用して HCL Harbor レジストリーを示す次の環境変数を設定します。
export SCA_AUTOUPDATER_REGISTRY_USERNAME=<HCL_HARBOR_USERNAME>
export SCA_AUTOUPDATER_REGISTRY_PASSWORD=<HCL_HARBOR_PASSWORD>
重要: 自動更新を設定しない場合は、脆弱性データベースを手動で更新する必要があります。

Git タグとアーカイブを使用したバージョン・サポート

AppScan 360° は、Git タグとアーカイブを使用したバージョン管理インストールをサポートします。
Git を使用して AppScan 360° の最新バージョンを複製するには:
git clone 
https://github.com/HCL-TECH-SOFTWARE/AppScan-360-Helm-Files.git
Git を使用して AppScan 360° の特定のバージョンを複製するには (X.X.X は特定のバージョン番号):
git clone --branch vX.X.X 
https://github.com/HCL-TECH-SOFTWARE/AppScan-360-Helm-Files.git
アーカイブを直接ダウンロードするには (X.X.X は特定のバージョン番号):
wget https://github.com/HCL-TECH-SOFTWARE/AppScan-360-Helm-Files/archive/refs/tags/vX.X.X.zip
特定のアーカイブを抽出するには (X.X.X は特定のバージョン番号):
unzip AppScan-360-Helm-Files-vX.X.X.zip
または
tar -xvzf AppScan-360-Helm-Files-vX.X.X.tar.gz
注: アーカイブをダウンロードする場合は、新しいバージョンを再ダウンロードしてアップグレードを手動で実行する必要があります。Git Pull を使用したインプレース・アップグレードは使用できません。

Helm インストールのトラブルシューティング

  • リリース名:
    コンポーネント リリース名 名前空間
    AppScan 360° プラットフォーム (platform) appscan360-ascp hcl-appscan-ascp
    AppScan 修復アドバイザリー asra hcl-appscan-asra
    ソフトウェア・コンポジション分析 (SCA) (オプション) scaservices hcl-appscan-sca
  • No state file found

    状態ファイルには helmfile.d/* という名前を付ける必要があります。
    1. AppScan-360-Helm-Files -> helm.dに移動します。
    2. run helmfile sync を実行します
  • ./helmfile.yaml: in .helmfiles[0]: in helm.d/helmfile-ASCP.yaml: failed processing release appscan360-ascp: values file matching "helmFileCustomizations/singular-singular.clusterKit.yaml" does not exist in "."

    プロパティー・ファイル (singular-singular.clusterKit.yaml) がありません。ファイルが適切な場所にあることを検証し、再試行してください。

  • Failed to pull helm-packages or docker images

    Docker ログインがないか、HCLCR_USERNAME および HCLCR_PASSWORD 環境変数がありません。ログイン情報を検証して再試行してください。

  • Failed to get pull secret

    .docker/config.json ファイルがないか、適切な値を持った AS360_KNI_JSON_CONFIG_AS_BASE64 が定義されていません。ログイン情報を検証して再試行してください。