_Viewing the Black Duck Web UI

This page has been deprecated. Please see the official Kubernetes Black Duck Installation Guide here.

Introduction

The page describes how to view the Black Duck Web UI in your browser once you have completed the Black Duck installation.

Finding the URL of the Black Duck Web UI

To launch the Black Duck Web UI, you must point your web browser to the IP address of the Black Duck webserver. The instructions below describe how to find that IP address.

On OpenShift

To find the Web UI address, use the following command:

oc get routes -n <BLACK DUCK NAMESPACE>

The Web UI's address will appear in the returned list in the HOST/PORT field.

On Kubernetes

By default, Synopsys Operator will create both a load balancer and a node port that can be leveraged to view your Black Duck UI outside the cluster.

Load Balancer

The preferred mechanism is to use the load balancer. You should be able to use the load-balancer approach if you are deploying in:

• a public cloud
• a private cloud managed with a cloud provider (e.g., OpenStack)

Consult your cluster administrator to determine whether you are able to leverage a load balancer. (Environments like MiniKube do not support load balancers.)

If you can use a load balancer, you can run the following command to get the external IP address of the Black Duck web server:

kubectl get service webserver-lb -n <BLACK DUCK NAMESPACE>

Alternatively, if you are using the Synopsys Operator console UI, the URL of the Black Duck webserver will be displayed in the console UI.

Node Port

If you cannot use a load balancer, you can leverage the Node Port to view the Black Duck web server outside the cluster.

A Node Port is a port opened on all nodes in your cluster; the node port for the Black Duck web server redirects to the web server all traffic sent to any node at that port. Because the port is opened on all nodes, the URL for the web server is simply:

https://<IP address of any node in your cluster>:<nodeport>

First, to get the port portion of the URL, type:

kubectl get -o jsonpath=“{.spec.ports[0].nodePort}” services webserver-np -n <BLACK DUCK NAMESPACE>

(Alternatively, you can get this port from the Synopsys Operator console UI.)

Next, you must get the IP address portion of the URL. How you do this depends on whether you are using minikube/minishift.

If not running minikube/minishift

If the cluster is externally exposed (for example, AWS, Google Cloud), then to get the external IP addresses of the nodes in your cluster, run:

kubectl get nodes -o jsonpath=‘{ $.items[*].status.addresses[?(@.type==“ExternalIP”)].address }’

If the cluster is not externally exposed, then to get the IP address that will be accessible only within your cluster network, run the following command:

kubectl describe pod <<WEBSERVER_POD_NAME>> -n <<BLACKDUCK_NAMESPACE>>

(The IP address will be provided in the "Node" value.

If running minikube/minishift

If you are running minikube or minishift, then the entire cluster exists on your local machine, and there are no IP addresses exposed outside your machine. Therefore, you need to use the following commands to grab the IP address that is valid/visible when used on your local machine:

minikube ip or minishift ip

Combine the IP address and the port to create the URL.

Important note: If you use the node-port approach, you must set PUBLIC_HUB_WEBSERVER_PORT to the node-port value using the instructions given in the Common Configuration Tasks page.

For More Information

For more information about exposing Black Duck services outside the cluster, see the Exposing Black Duck Services page.