Database requirements

2 minute readReference

You cannot log into CloudBees CD/RO until a database is configured. During the CloudBees CD/RO server installation, you can select the built-in (default) CloudBees CD/RO database (MariaDB) or an alternate database.

If you are using two different CloudBees CD/RO servers in a non-HA configuration, they cannot point to the same database.

Built-in database

CloudBees CD/RO ships with a demo license, which limits the software to two concurrent job steps and the CloudBees CD/RO-provided built-in database. Running CloudBees CD/RO on a single machine with the demo license is not recommended for a production environment. Additionally, the built-in database is not supported in a clustered CloudBees CD/RO configuration.

In a production configuration, connect CloudBees CD/RO to a database. If CloudBees CD/RO is installed with the built-in database, you can reconfigure it to use an external database at any time. For a list of alternate databases supported by CloudBees CD/RO, see Supported Alternate Databases. For more information and configuration instructions, see External Database Configuration.

Using an external database requires a CloudBees CD/RO enterprise license. You must configure an external database at the same time as you install your enterprise license to prevent error messages about an unsupported configuration or a license requirement.

Supported databases

For a complete list of officially supported databases for CloudBees CD/RO, see Supported databases.

Database requirements

General requirements

Configuring UTF-8 encoding

Databases must be configured to use UTF-8 encoding.

CloudBees does not require exact UTF-8 support in Microsoft SQL Server.

Setting the Open Connections Allowance

Databases must be configured to allow up to 200 open connections.

Oracle Database requirements

Setting the Oracle Database open cursors parameter

In an Oracle database, set the OPEN_CURSORS parameter to at least 1000 to prevent CloudBees CD/RO from running out of open cursors. But depending on your CloudBees CD/RO server usage, the OPEN_CURSORS value of 1000 might not be sufficient, and you might see java.sql.SQLException: ORA-01000: maximum open cursors exceeded " in the <DATA_DIR>/logs/commander.log file. In this case, you must increase the value of OPEN_CURSORS to one that is optimal depending on your usage.

Microsoft SQL Server requirements

Disabling SQL Server database audit for the first-time database connection

When using Microsoft SQL Server as the alternate database, turn off SQL Server Database Audit before CloudBees CD/RO connects to the database for the first time to create the user schema. Failing to do so can cause the server startup to be stuck in the “Making any necessary pre-schema-creation database setting changes” step while the CloudBees CD/RO server attempts to enable snapshot isolation to create the schema. This is a know issue with SQL Server as documented in https://support.microsoft.com/en-us/help/4090966/sql-server-session-hangs-when-you-try-to-enable-snapshot-isolation .

After CloudBees CD/RO finishes creating the schema and you have verified that you can log in to CloudBees CD/RO, turn on the SQL Server Database Audit as per your company policy.

Configure National Language Character Set support

MS SQL Server databases must be configured with both nchar (fixed length) and nvarchar (variable-length) Unicode string data support. For more information, refer to the Microsoft SQL Server documentation.