Get started with the Dockerized Black Duck installation. This post outlines workplace specifications, tools, and steps for installing 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 Black Duck. Think of this post as a quick way to get started with the Dockerized installation, outlining the workplace specifications and the tools and steps you’ll take to deploy Black Duck.
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.
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 hardware and software requirements before getting started:
|Hardware (min. specs)||
|Preferred operating systems||
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.
To learn how to install Black Duck using Kubernetes, see the guide.
Step 1: To begin setting up Docker, install the required packages and set up the stable repository.
sudo yum install -y yum-utils device-mapper-persistent-data lvm2
sudo yum-config-manager --add-repo https://download.docker.com/linux/centos/docker-ce.repo
Step 2: Update the yum package index and install the latest version of Docker.
sudo yum makecache fast
sudo yum install docker-ce docker-ce-cli containerd.io
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.
sudo systemctl start docker
sudo docker run hello-world
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.
usermod -aG docker $USER
docker run hello-world
Step 5: Configure Docker to automatically start when your system reboots:
systemctl enable docker
Starting from within the opt directory, create a new directory for Black Duck orchestration files and cd into it:
mkdir blackduck && cd "$_"
In the new directory, use the wget command to download the files. Black Duck orchestration files are at https://github.com/blackducksoftware/hub/releases. We recommend you always use the latest release, using the following command as an example:
sudo wget https://github.com/blackducksoftware/hub/archive/v2020.2.1.tar.gz
Unzip the downloaded file:
sudo tar xvzf v2020.2.1.tar.gz
Once the file is unzipped, it will create a directory named hub that includes the Black Duck version number. Navigate into that directory and into the docker-swarm folder within it:
sudo docker swarm init
The swarm will be initialized, and a message will print to the console. Next, create the services that constitute the Docker stack:
sudo docker stack deploy -c docker-compose.yml hub
Optional: Integrate Black Duck Binary Analysis with the install:
sudo -c docker-compose.bdba.yml
Monitor the stack to ensure that all services start. This may take some time:
sudo watch docker ps
Black Duck comprises 12 services. Once all of them display a status of healthy, Black Duck is running.
Once all services are healthy, you can visit your host URL and begin using Black Duck.
This post was originally published Jan. 17, 2018, and refreshed June 18, 2020.
As a Product Marketing/Business Rotational Program Associate at Synopsys, Charlie will rotate through the sales, marketing, sales operations, and finance departments four months at a time. He joined Black Duck Software in July, before Black Duck Software was acquired by Synopsys. During his time in sales and marketing, Charlie has researched and learned about the importance of open source risk management—especially pertaining to container security and secure DevOps practices. While in marketing, Charlie has been helping with the launch of OpsSight, a product designed for IT Operations and Infrastructure teams hoping to automate security practices in the production environment. He holds a B.A. in Political Economy from Bates College.