Enabling users to upload JDBC drivers

JDBC driver upload is disabled by default. If you want to enable users to create Generic JDBC connections, create custom JDBC connectors, or use predefined connectors that require JDBC drivers, you must enable users to upload JDBC driver files.

Who needs to complete this task?
To complete this task, you must be either:
  • A cluster administrator
  • An instance administrator
When do you need to complete this task?
Complete this task to enable users with the Manage configurations permission to complete one or more of the following tasks:
  • Upload drivers for Generic JDBC connections
  • Upload drivers for custom JDBC connectors
  • Upload drivers for the following predefined connectors:
    • Exasol
    • Hive via Execution Engine for Hadoop
    • IBM Db2 for i
    • IBM Db2 for z/OS
    • Impala via Execution Engine for Hadoop
    • SAP BAPI
    • SAP Bulk Extract
    • SAP Delta Extract
    • SAP HANA
    • SAP IDoc
  • Remove out-of-date, unused, or obsolete drivers

About this task

You can adjust the JDBC driver upload setting by editing the wdp_connect_connection_jdbc_drivers_repository_mode parameter in the common core services custom resource (ccs ccs-cr).

Value Description
enabled Users with the Manage configurations permission can:
  • Upload JDBC drivers from the web client or REST API.
  • Delete JDBC drivers from the web client or REST API.
Users without the Manage configurations permission can:
  • List available JDBC drivers from the web client or REST API.
  • Use available JDBC drivers to create connections from the web client or REST API.
sealed Users cannot upload or delete JDBC drivers from the web client or REST API. However, users can:
  • List available JDBC drivers from the web client or REST API.
  • Use available JDBC drivers to create connections from the web client or REST API.
disabled Users cannot:
  • Upload JDBC drivers from the web client or REST API.
  • Delete JDBC drivers from the web client or REST API.
  • List available JDBC drivers from the web client or REST API.
  • Use available JDBC drivers to create connections from the web client or REST API.
  • Use connections that require an uploaded JDBC driver.
To check the current setting, run:
oc get configmap config-wdp-connect-connection \
-n=${PROJECT_CPD_INST_OPERANDS} \
-o=yaml

The properties that are included in the response depend on whether Cloud Pak for Data was upgraded from an older release.

  • jdbc-drivers-repository-mode
  • disable-jar-tab

    This property applies only to upgraded environments. This property is equivalent to the wdp_connect_connection_disable_jar_tab parameter in the common core services custom resource.

    Note: This property is not used to control the behavior of JDBC driver uploads. The property is used only for debugging during upgrades.

Procedure

  1. Log in to Red Hat® OpenShift® Container Platform as a user with sufficient permissions to complete the task.
    ${OC_LOGIN}
  2. Run the appropriate command to enable users to upload JDBC drivers:
    oc patch ccs ccs-cr \
    --namespace=${PROJECT_CPD_INST_OPERANDS} \
    --type=merge \
    --patch '{"spec": {"wdp_connect_connection_jdbc_drivers_repository_mode": "enabled"}}'
  3. Wait for the common core services status to be Completed:
    oc get ccs ccs-cr \
    --namespace=${PROJECT_CPD_INST_OPERANDS}

Results

After you complete this task, users with the Manage configurations permission can upload JDBC drivers from the web client and through REST API calls.