Alert Installation

Table of Contents


This page describes how to install Synopsys Alert using Synopsysctl. The following instructions apply only to Kubernetes and Red Hat OpenShift. 
You can install or upgrade Alert versions using synopsysctl.

Installation procedure

The procedure for installing Synopsys Alert using synopsysctl depends on whether Alert is a standalone instance, or if Alert leverages a Black Duck instance cfssl for secure communications.

Standalone Alert

To install Synopsys Alert in standalone mode, use the following command:

  • You must configure an encryption password and an encryption global salt. 
  • You can configure ALERT_ENCRYPTION_PASSWORD and ALERT_ENCRYPTION_GLOBAL_SALT by using environment variables, at the command line, or in the user interface. 
  • Use the --standalone=true flag to create a standalone Alert instance.

Here's an example at the command line:

Black-Duck integrated Alert

If you are installing Synopsys Alert so that it leverages the same cfssl as a Black Duck instance, then the syntax for installing Alert depends on whether Alert and Black Duck are in the same namespace or separate namespaces. As these instances depend on Black Duck, use the --standalone=false flag.

  • If Alert and Black Duck are in the same namespace:
    In the following command, the HUB_CFSSL_HOST variable must contain the name of the Black Duck instance in the same namespace.

  • If Alert and Black Duck are in different namespaces:

    In the following command, the HUB_CFSSL_HOST variable must contain both the name of the Black Duck instance and the name of the Black Duck instance namespace.

Environment variables for Alert host name

Use the following environment variables for the Alert host name:

  • ALERT_HOSTNAME: The variable used to specify the host name of the Alert server. Provide the host name as the value, and don’t set this value as the URL for the Alert server.

  • ALERT_SERVER_PORT: The variable used to set the port for Alert.

Customizing deployment resources

In synopsysctl 1.0.0 and later, --alert-memory and  --cfssl-memory options are replaced by the --deployment-resources-file-path option which is an absolute path to a JSON file containing a list of deployment resources that you can customize.

Use the --deployment-resources-file-path option to define custom settings where you can specify settings such as custom Kubernetes resource sizes, replicas count and the heap max memory for each container. 

./synopsysctl create alert --deployment-resources-file deployment-resources.json <parameters>

Use a similar format in the partial example from Black Duck to configure the alert and cffsl containers for Alert.