Configuring Data Gate table metadata publishing to IBM Knowledge Catalog

To set up publishing to IBM Knowledge Catalog, you need the IBM Knowledge Catalog service on Cloud Pak for Data.

Before you begin

You can deploy or use a IBM Knowledge Catalog service in one of the following locations:
  • A IBM Knowledge Catalog service in the same Cloud Pak for Data instance as Data Gate.
  • A remote IBM Knowledge Catalog service in a Cloud Pak for Data instance other than your Data Gate instance, but in the same network on premises.
  • A service in a remote Red Hat® OpenShift® cluster on IBM Cloud.
  • A IBM Knowledge Catalog service provided by IBM Cloud Pak for Data as a Service on IBM Cloud.

Complete the following steps before you integrate IBM Knowledge Catalog into your Data Gate setup.

  1. Prepare a catalog.

    You can create a catalog or select an existing catalog as the target for metadata publishing.

  2. Prepare a user ID and a corresponding API key authorized to access and edit the catalog.

    The user ID requires at least the Editor role to access the target catalog.

    If your IBM Knowledge Catalog service is run by a remote Cloud Pak for Data service on premises, or in a Red Hat OpenShift cluster on IBM Cloud, you need the user ID (name) and the corresponding API key. To this end, retrieve the platform API key. You find the instructions here: Generating API keys for authentication.

    If your IBM Knowledge Catalog service is run by IBM Cloud Pak for Data as a Service on IBM Cloud, you need only the API key. For information on how to create such a key, see Creating an API key.

  3. Prepare the connection details and the access information for the target database.

    To add connection assets for source and target databases to the catalog, your IBM Knowledge Catalog must be able to access the Db2 for z/OS source database and the Db2 target database on Cloud Pak for Data.

    If your IBM Knowledge Catalog does not run in the same Cloud Pak for Data instance as Data Gate, configure the Db2 NodePort with an Ingress Controller.

    Prepare a user ID with Admin access to the target database. You can reuse the ID that was used to provision the Db2 and Data Gate instances.

Procedure

  1. On the dashboard of your Data Gate instance, on the tile that is labeled Watson Knowledge Catalog integration, click Configuration icon on dashboard.
  2. Under the heading Access to IBM Knowledge Catalog, select one of the following choices:
    Local
    If your IBM Knowledge Catalog service and your Data Gate service that is run in the same Cloud Pak for Data instance.
    Remote
    If your IBM Knowledge Catalog runs in a different location.
  3. In the URL field, type the web address (URL) of the IBM Knowledge Catalog service.

    Data Gate needs just the hostname part of the URL, such as:

    • https://cpd-zen.apps.dgcxb91.fire.ibm.com
    • https://dataplatforms.cld.ibm.com

    However, if you type in an entire URL string, Data Gate shortens (trims) it for you automatically.

  4. In the username field, type the ID of a user with editor access to the catalog. For more information, revisit step 2 at the beginning of this article.
    This step is not required if the IBM Knowledge Catalog service is provided by IBM Cloud Pak for Data as a Service on IBM Cloud.
  5. In the API key field, type the API key that you generated for the user in step 4. See also step 2 at the beginning of this article.
  6. Click Drop-down icon, which reveals selectable catalogs to expand the list of selectable catalogs.
    The list shows all the catalogs that the user you chose in step 4 can access in order to create metadata assets.
  7. Select the catalog that you want to publish the metadata to.
  8. In the username field under the heading Access to target database, type the ID of a user with Admin access to the Db2 or Db2 Warehouse target database of your Data Gate instance.
  9. In the Password field, type the password of the Admin user who is specified in step 8.
  10. Click Configure to save the information.