Introduction

This page describes how to install Black Duck from the command line using synopsysctl.

The command that you use to install Black Duck with synopsysctl is as follows:

./synopsysctl create blackduck <customization parameters>

Use the following command to view all the configurable parameters:

./synopsysctl create blackduck --help

See the following examples about how you can use the configuration parameters to achieve your objectives.

Quick install

To create a basic Black Duck deployment, use the following command:

./synopsysctl create blackduck <name> \
--namespace <namespace> \
--expose-ui [LOADBALANCER|NODEPORT|OPENSHIFT] \
--admin-password <admin password> \
--user-password <user password> \
--seal-key <32 characters>
--certificate-file-path \
--certificate-key-file-path 

The following list describes the parameters used in the command:

• name: Name you to use to identify this Black Duck instance, which is a mandatory parameter. For example, when you want to update this Black Duck instance later, you reference the Black Duck instance with this name.
• namespace: The namespace into which you deploy Black Duck.
• expose-ui: To expose the Black Duck web user interface, you select a value for expose-ui. Refer to Exposing the Black Duck Web User Interface for guidance about which value to select.
• admin-password: admin password for PostgreSQL.

• user-password: User password for PostgreSQL.

• seal-key: Seal key is used to encrypt the master key and must consist of 32 characters.
• --certificate-file-path Absolute path to a file for the Black Duck NGINX certificate
• --certificate-key-file-path  Absolute path to a file for the Black Duck NGINX certificate key

This creates a Black Duck installation with the following characteristics:

• Black Duck version 2021.2.1
• Images pulled from Docker Hub.
• Small deployment.
• Persistent volume claims made (see following note).
• Uses a default (self-signed) certificate for the NGINX web server.
• No external databases, proxies or certificate authorities.
• Empty, initialized database (no cloned data).
• IPv6 support required.

The created Black Duck instance is fully functional and you can use it for tasks such as demonstrations, evaluations, and testing. For production implementations, more configuration might be necessary. 

Advanced installation options

Refer to Black Duck Installation Parameters for help specifying values for a custom Black Duck deployment.

For some customizations, you might be instructed to modify environment variables. In this case, use the --environs <data> parameter where data is one or more environment variables, expressed in key-value pairs, separated by a comma. Refer to the following example:

--environs PUBLIC_HUB_WEBSERVER_HOST:localhost,PUBLIC_HUB_WEBSERVER_PORT:443