-
Notifications
You must be signed in to change notification settings - Fork 93
_Black Duck Installation Guide
This page has been deprecated. Please see the official Kubernetes Black Duck Installation Guide here.
This page describes how to install a Black Duck server instance using Synopsys Operator. These instructions cover Black Duck installations on both Kubernetes and Red Hat OpenShift.
Black Duck requires a utility called Synopsys Operator for installation. Synopsys Operator vastly simplifies Black Duck deployments on Kubernetes and OpenShift by eliminating the need to edit error-prone YML files.
If you do not already have Synopsys Operator installed, go to the Synopsys Operator Installation Guide and follow the instructions to install it, then proceed with the Black Duck installation steps.
This version of Black Duck supports the following versions of Kubernetes and OpenShift:
- Kubernetes 1.9.1 - 1.13
- OpenShift 3.6 - 3.10
Generally, a Black Duck instance requires the following:
- The ability to provision a Linux cloud or compute infrastructure that runs Docker containers and has at least an allocatable 32GB of memory and 16 cores
- The ability to expose Black Duck services so that they can be reached from outside your cluster
- The ability to connect to the Black Duck KB (Knowledge Base) and registration servers (this may require an external internet proxy for air-gapped data centers)
Before you start the Black Duck installation, it is recommended you give some thought to the management of Black Duck data. Check out the Persistent Volume Considerations and Database Considerations pages for guidance.
There are two ways to install Black Duck using Synopsys Operator:
- Using the Synopsys Operator Console UI
- Invoking
kubectl create -fand passing in a Black Duck installation config file
Using the Console UI is easiest, and is the recommended approach. To learn how to install Black Duck using the Console UI, see Installing Black Duck with the Console UI.
If you'd prefer to create a config file and invoke kubectl/oc from the command line, see Installing Black Duck from the Command Line.
Note: If you wish to upgrade or delete an existing Black Duck server, see the Upgrading and Deleting Black Duck Servers page.
Once the Black Duck installation process is complete (it may take several minutes), you can then launch the Black Duck Web UI and make other configuration changes as necessary.
Your newly-installed Black Duck instance will be created with default credentials (username and password). Contact your authorized support representative if you do not know what those credentials are. It is highly recommended you change these default credentials after logging in the first time.
See the Viewing the Black Duck Web UI for instructions.
For guidance on optional configuration tasks after the Black Duck installation is complete, see the topics under "Configuration" in the sidebar on the right. Pay special attention to the Exposing Black Duck Services page.
For guidance on Troubleshooting, see the topics under "Troubleshooting" in the sidebar on the right.
Note: In highly-secured clusters, Synopsys Operator may not be able to initialize in the Black Duck database. See the Deploying Black Duck in Secured Clusters page for a solution.