Command line support for single virtual machine installation
AppScan 360° supports command line options and parameters for single virtual machine installation, including fresh installation, modular recovery, upgrade preparation, backup, or post-upgrade maintenance.
Command format
Base
syntax:
sudo ./AppScan360_SingleVMsetup_v<version>.run -- <kits_location> [option]orsudo ./AppScan360_SingleVMsetup_v<version>.run -- <kits_location> [parameter]<kits_location>points to the directory that contains the setup kit and affiliated AppScan kits. Required.[option]is a supported flag such as--modular,--upgrade, or--backup.[parameter]is a supported standalone operation such asprepareCertsFoldersorprepareUpgrade.
Note: All options/parameters are mutually exclusive. Use only one
option or one parameter per command.
Standard installation
Supported command line options
--modular
To run the
installation in smaller controlled steps because:
- a previous installation failed and you want to recover in steps.
- you want to install only one component.
- you want to resume installation from a selected component.
sudo ./AppScan360_SingleVMsetup_v<version>.run -- $PWD --modular--upgrade
To
run the supported upgrade path when an AppScan 360° deployment already
exists:
sudo ./AppScan360_SingleVMsetup_v<version>.run -- $PWD --upgradeThis is the preferred command when the installer detects an existing deployment.
--upgraderoutes to the modular upgrade flow.- the upgrade flow resumes from
ascp.
Note: If you run the normal full flow on an existing
deployment, the installer stops and asks you to rerun with
--upgrade or
--modular.--backup
To
export persistent volume data before upgrade or
maintenance:
This
command:sudo ./AppScan360_SingleVMsetup_v<version>.run -- $PWD --backup- writes backup files under
<kits_location>/backup. - backs up ASCP and SCA PV content.
Typical backup files are
ascp-pv-<timestamp>.tar.gz and
sca-pv-<timestamp>.tar.gz.Note:
kubectl is required.Supported standalone parameters
Standalone parameters perform a specific operation and then exit.
Base
format:
sudo ./AppScan360_SingleVMsetup_v<version>.run -- $PWD <parameter>prepareCertsFolders
To create the certificate folder structure under
<kits_location>/certs when you plan to provide custom or
self-signed certificates before
installation:sudo ./AppScan360_SingleVMsetup_v<version>.run -- $PWD prepareCertsFoldersThe command creates folders for:
- Docker registry certificates
- LDAP certificates
- SMTP certificates
- OIDC certificates
- OpenTelemetry certificates I
- ngress/Application domain certificates
updateStorageOwnership
To update storage ownership for the
1.6.x to 2.x.x
upgrade path when following the documented upgrade
steps.sudo ./AppScan360_SingleVMsetup_v<version>.run -- $PWD updateStorageOwnershipprepareUpgrade
To prepare an existing deployment for the Gateway API and Istio based upgrade path
when you need to remove older
ingress-nginx and
cert-manager components before continuing the
upgrade.sudo ./AppScan360_SingleVMsetup_v<version>.run -- $PWD prepareUpgradeThis
command:- removes
ingress-nginx. - removes old
cert-manager. - deletes existing Ingress resources in
hcl-appscan-ascp. - cleans up older cert-manager CRDs.
remediateStorageIssues
To run a targeted remediation for known post-upgrade storage issues when the
ascp-mr-tasks-manager pod does not recover after upgrade
because of the known storage
issue:sudo ./AppScan360_SingleVMsetup_v<version>.run -- $PWD remediateStorageIssuesThis command:
- corrects storage permissions.
- clears the affected storage content under the SAST tools path.
- restarts the tasks manager pod.
Automatic installer behavior
Existing deployment detection
If the installer detects an existing ASCP deployment and you start the normal
fresh-install flow, it stops and tells you to rerun with:
--upgradefor upgrade flow.--modularfor controlled component-wise flow.
Previous installation attempt detection
If a previous engage log is found and you start the regular flow, the installer asks
whether to continue from the last successful step.
- If you choose Yes, it switches to modular mode.
- If you choose No, it continues with the regular installation flow.
- In non-interactive mode, it defaults to modular mode.
Quick reference
| Use case | Command |
|---|---|
| Fresh installation in a new environment |
|
| Staged recovery or component-wise installation |
|
| Upgrade of an existing deployment |
|
| Backup PV data before upgrade or maintenance |
|
| Create certificate folders before installation |
|
Update storage ownership for 1.6.x
to 2.0.0 upgrade preparation |
|
Remove old ingress-nginx and
cert-manager before continuing
upgrade |
|
| Remediate the known post-upgrade tasks manager storage issue |
|