Software Integrity Blog

An introduction to installing Black Duck

Get started with the Dockerized Black Duck installation. This post outlines workplace specifications, tools, and steps you’ll take to deploy Black Duck.

Black Duck Academy hosts a series of videos that help our customers deploy, manage, and use our products. To help our customers see value from Black Duck immediately after their purchase, this post supplements our video on installing the Hub. Think of this post as a quick way to get you started with the Dockerized Hub installation, outlining the workplace specifications as well as the tools and steps you’ll take to deploy the Hub.

Black Duck is deployed as a set of Docker images. Docker is a packaging technology that allows you to bundle your application with its software dependencies—eliminating the need to configure infrastructure before deployment. It is built once and can run anywhere as a single unit. Operational images are typically referred to as containers.

Why Docker architecture?

The Docker architecture brings a number of significant improvements to Black Duck:

Black Duck is deployed as a set of Docker containers, which together comprise the application. Each container fulfills a different role. For example, the Web App container processes UI requests while the Solr container acts as the enterprise search platform component. A detailed description of each container’s role is available in the Black Duck Docker Install Guide on the Synopsys Software Integrity Community.

Please ensure that you meet all of the hardware and software requirements before getting started:

Hardware (min. specs) Software Preferred operating system
64-bit 5 core processor Docker 17.03.x or Docker 17.06.x (CE or EE) CentOS 7.3
20 GB of RAM Orchestration tool such as Docker Swarm**, Docker Compose, Docker Run, or Kubernetes. Ubuntu 16.04.x
250 GB of free space for the database and other Hub containers For additional information on supported orchestration techniques, consult the Docker Installation Guide. Oracle Enterprise Linux 7.3
Free space for database backups Red Hat Enterprise Linux Server 7.3
  SUSE Linux Enterprise Server 12.x
  Linux Operating Systems that support Docker 17.03.x

Setting up the Docker repository on a new host machine

Note that the following steps depend on the operating system (OS). Also, while other methods are supported, this example uses the Docker Swarm tool to orchestrate the Black Duck container deployment and installation on a CentOS / Docker CE platform.

Step 1: To begin setting up Docker, install the required packages and set up the stable repository.

Step 2: Update the yum package index and install the latest version of Docker.

Step 3:  Verify installation with a hello-world image, which runs a test image in a container. When it runs, Docker prints an informational message and then exits.

Post-installation (optional)

Step 4: Manage Docker as a non-root user so you won’t have to issue a sudo command every time you want to run a docker command. Start by creating a group called Docker.

Step 5: Configure Docker to automatically start when your system reboots.

Here are links to more information on installing Docker and Docker Swarm. Now that the Docker architecture has been set up, let’s install Black Duck.

Installing Black Duck

The Black Duck installation process can be broken down into three major steps: (1) download the .tar file needed for orchestration and configuration files, (2) unpack the .tar file and configure web server and, if needed, the proxy server environment files, and (3) install Black Duck using an orchestration tool such as Docker Swarm

Step 1: Download the orchestration and configuration files. You need these files to install Black Duck and launch the Docker images.

Step 2: Unpack .tar file and configure Web server and, if needed, proxy server settings.

Step 3: Install the Dockerized Black Duck with the PostgreSQL database instance. Begin by initializing Docker swarm, creating a single node swarm.

We’re ready to install Black Duck; this deploys all of the containers that comprise Black Duck.

Certain Docker orchestration techniques allow scalability by allowing admins to choose the number of active job runner containers.

Verify installation completion

Confirm installation was successful by running the docker ps commands.

Watch the Black Duck installation video on the Synopsys Software Integrity Community