Installing AppScan 360° with Helm

A Helm installation of AppScan 360° requires a persistent, reliable Internet connection in addition the requirements for setting up the AppScan 360° environment. The system must be able in download Helm charts from HCL Harbor regularly.

Before installing AppScan 360° with Helm:
  • Verify that you have a stable and persistent Internet connection for downloading Helm charts from GitHub, and for fetching Docker images and Helm packages from HCL Harbor.
  • The configuration file is available and named properly.

Install helmfile

To install helmfile:
  1. Download the helmfile binary file:
    wget https://github.com/helmfile/helmfile/releases/download/v0.169.1/helmfile_0.169.1_linux_amd64.tar.gz
  2. Extract the downloadable file:
    tar -xvzf helmfile_0.169.1_linux_amd64.tar.gz
  3. Move the helmfile binary to an appropriate local directory.
    For example, usr/local/bin/.
    sudo mv helmfile /usr/local/bin/
  4. Give executable permission to the file:
    sudo chmod +x /usr/local/bin/helmfile
  5. Verify the installation:
    helmfile --version

Setup the Harbor connection

To setup the connection to Harbor, either:
  • Use the Docker login with your username and password as defined in cli-secret:
    docker login hclcr.io
  • Set environment variables for the docker/config.json file:
    export HCLCR_USERNAME=<harbor-username>
export HCLCR_PASSWORD=<harbor-password/cli-secret>
  • Set environment variables for base64 encoding:
    export AS360_KNI_JSON_CONFIG_AS_BASE64="<base64-value-of-docker-config.json>"

Setup the GitHub repository

The repository for AppScan 360° Helm is hosted on a private GitHub server. Clone the appropriate repository at https://github.com/HCL-TECH-SOFTWARE/ to populate the local repository properly:
git clone --branch main https://github.com/HCL-TECH-SOFTWARE/AppScan-360-Helm-Files.git
After cloning, verify the local repository has the following structure:
AppScan-360-Helm-Files
├── Helm.d
│   ├── helmfile-ASCP.yaml
│   ├── helmfile-ASRA.yaml
│   └── helmFileCustomization
│       ├── clusterKit.yaml
│       ├── singular-singular.clusterKit-Sample.yaml
│       └── siteKit.yaml
└── helmfile.yaml

Install AppScan 360°

From the cloned repository (AppScan-360-Helm-Files), run:
helmfile sync

Troubleshooting Helm installation

  • No state file found

    The state file must be named helmfile.d/*.
    1. Navigate to AppScan-360-Helm-Files -> helm.d
    2. Run 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 "."

    The properties file (singular-singular.clusterKit.yaml) is missing. Verify the file is in the correct location and try again.

  • Failed to pull helm-packages or docker images

    The Docker login is missing, or HCLCR_USERNAME and HCLCR_PASSWORD environment variable is missing. Verify the login information and try again.

  • Failed to get pull secret

    The .docker/config.json file is missing or AS360_KNI_JSON_CONFIG_AS_BASE64 with appropriate value is not defined. Verify the login information and try again.