Contribute in GitHub:

Installing and configuring the DBB server on Linux

The DBB server is packaged in two ways, a .tar.gz file for native Linux® environments or an IBM Cloud Pak® Packaging (CASE) bundle for a Red Hat® OpenShift® Container Platform (OCP). To install the CASE bundle to an OCP environment, see Installing and Configuring DBB server in a Red Hat OpenShift cluster; otherwise, continue reading this topic.

Downloading DBB server

The DBB server .tar file can be downloaded from Mainframe DEV.

Installing DBB server

Procedure

Expand the server .tar file on your Linux machine with the tar command. The result is a wlp directory that contains the Liberty runtime and DBB server configuration.
```
tar -xzvf dbb-server-1.1.2.tar.gz
```
Update the server configuration.
- For running a POC or trial, the basic configuration provides all that you need for a quick setup and start.
- For running a production server, you need to configure both the User Registry and an instance of Db2®.
Verify that the default Java™ runtime meets the minimum requirements or modify wlp/usr/servers/dbb/server.env to point to a Java runtime that meets the minimum requirements.
Start the server with the following commands.
```
wlp/bin/server start dbb
```

Configuring DBB server

If you are installing for the first time, continue with the configuration steps below. If you are upgrading from a previous release, review and follow the instructions in Migrating a Dependency Based Build server.

If you want to configure the DBB server to use Lightweight Directory Access Protocol (LDAP) SDBM on z/OS®, refer to Configuring IBM Dependency Based Build (DBB) server to use RACF based authentication via z/OS LDAP SDBM in the IBM Support website.

The configuration is located in wlp/usr/servers/dbb.

Server configuration properties

The dbb.properties file contains a few properties that the DBB server needs to customize the database schema and also allow the DBB server to obtain user team membership.

com.ibm.dbb.persistence.dbSchema (optional)

Use this property to set the database schema. The default schema is DBBZ. When you create the database tables, you must set this schema in the DDL.

com.ibm.dbb.persistence.dbSchemaPrefix (optional)

Use this property to supply a prefix to the database schema. For example, if com.ibm.dbb.persistence.dbSchema is not set and com.ibm.dbb.persistence.dbSchemaPrefix is set to B_, the schema is B_DBBZ.

com.ibm.dbb.web.admin (required)

A userid that is assigned to the administrator-role in the server.xml. This is used to obtain user team membership when processing requests.

com.ibm.dbb.web.admin.password (required)

The password for the userid supplied for com.ibm.dbb.web.admin. Use the Liberty securityUtility to obfuscate the password.

com.ibm.dbb.web.baseDN (required if LDAP is used)

Use this property to specify the base distinguished name for LDAP users (ex. ou=people,dc=dbb,o=ibm).

com.ibm.dbb.web.userNameProperty (required if LDAP is used)

Use this to specify the user name part of the LDAP distinguished name (ex. uid).

Port numbers (optional)

You can update server.xml to modify the port numbers used by the server. By default, the server uses port 9080 and secured port 9443. The ports can be changed by modifying the httpEndpoint configuration with the ports of choice. Objects in the database are not dependent on the port numbers or host names so the port numbers can be changed. You can change the port numbers even after creating DBB objects, and the operation of the DBB server is not affected.

User Registry (optional)

For a production configuration, you should connect the liberty app server to your existing LDAP configuration.

The DBB server has a default user registry that has one user, "ADMIN" with the default password "ADMIN". Edit basicUserRegistry.xml to add, remove, or change passwords for users in the registry.

The sample LDAP registry configurations in ldapUserRegistry.xml can be used as a starting point to configure the server to use your LDAP registry. For more details, see Configuring LDAP user registries in Liberty. If you choose to use LDAP, you need to edit the server.xml to include ldapUserRegistry.xml and comment out the include for basicUserRegistry.xml.

Database (optional)

See Setting up the DBB server database

Enabling logging to gather debug information

To enable logging for DBB server, update these two entries in the bootstrap.properties file as shown below.

com.ibm.ws.logging.trace.file.name=dbb.log
com.ibm.ws.logging.trace.specification=*.info:com.ibm.dbb.*=debug

Validating DBB server setup

Procedure

Navigate to https://localhost:9443/dbb/rest/collection.
Log in with default credentials or any credentials you have configured.

You should see a heading of "DBB Collections" with no collections listed.
Create sample collections.
1. Navigate to https://localhost:9443/dbb/rest/collection/setup. Expected result is "OK - Setup completed."
2. Navigate to https://localhost:9443/dbb/rest/collection. Expect to see a list of collections ("Collection1", "Collection2", and "Collection3").
3. Navigate to each collection to see the logical files and logical dependencies.

Troubleshooting

Review the log files that are generated at wlp/usr/servers/dbb/logs to identify issues with the server.