Black Duck Alert Quickstart (Docker Swarm - standalone)

• The Alert deployment files.

• An server with enough free resources to start the containers.

• If the cluster is a multi-node swarm deployment, the containers need to be node locked, or backed by persistent storage.

See Installation Requirements for more information.

Unzip the blackduck-alert-<RELEASE>-deployment.zip archive downloaded from the link above into a location on your Black Duck SCA server.

To get started, we need 4 secrets:

• ALERT_ENCRYPTION_PASSWORD

• ALERT_ENCRYPTION_GLOBAL_SALT

• ALERT_DB_USERNAME

• ALERT_DB_PASSWORD

To create secrets, follow the normal docker commands - We recommend storing the values in a file which can be kept safe

docker secret create <STACK_NAME>_<SECRET_NAME> <FILE_CONTAINING_VALUE>

example:

docker secret create hub_ALERT_ENCRYPTION_PASSWORD ALERT_ENCRYPTION_PASSWORD

For the purposes of this quickstart, we will use the following values:

Once the secrets are created, check that all four exist by running docker secret ls

For the purposes of this quickstart guide, create a new file called docker-compose.local-overrides.yml inside your standalone directory.

---
version: "3.6"
services:
  alert:
    environment:
      - PUBLIC_ALERT_WEBSERVER_PORT=443
      - ALERT_DB_NAME=alertdb
    secrets:
      - ALERT_ENCRYPTION_PASSWORD
      - ALERT_ENCRYPTION_GLOBAL_SALT
      - ALERT_DB_USERNAME
      - ALERT_DB_PASSWORD
  alertdb:
    environment:
      - POSTGRES_DB=alertdb
      - POSTGRES_PASSWORD_FILE=/run/secrets/ALERT_DB_PASSWORD
      - POSTGRES_USER_FILE=/run/secrets/ALERT_DB_USERNAME
    secrets:
      - ALERT_DB_USERNAME
      - ALERT_DB_PASSWORD
secrets:
  ALERT_ENCRYPTION_PASSWORD:
    external: true
    name: hub_ALERT_ENCRYPTION_PASSWORD
  ALERT_ENCRYPTION_GLOBAL_SALT:
    external: true
    name: hub_ALERT_ENCRYPTION_GLOBAL_SALT
  ALERT_DB_USERNAME:
    external: true
    name: hub_ALERT_DB_USERNAME
  ALERT_DB_PASSWORD:
    external: true
    name: hub_ALERT_DB_PASSWORD

Configuration of the Alert application such as authentication, database, providers, and channels can be performed using environment variables. Environment variable values are only used if there is no configuration data for the corresponding component already in the database. These will be read in at startup and configured by editing the docker-compose.local-overrides.yml file to include the environment variables you wish to set. The blackduck-alert.env file found under blackduck-alert-<VERSION>-deployment\docker-swarm\standalone provides a look at the various parameters that can be set. See Environment Variables for more information. There are a number of different configuration options which can be statically set. For the purpose of this quick start guide, we will configure these within the UI.

At this stage, we are ready to deploy. Run the following command within your terminal:

docker stack deploy -c docker-compose.yaml -c docker-compose.local-overrides.yaml alert

Execute watch docker service ls within terminal to ensure that all services report a state of 1/1. Once everything is started, navigate to https://HOST_NAME:8443/alert

At this point, you will be presented with a login screen.

Figure 1. Alert login screen