Prerequisites

Prerequisites#

Setup and installation for the ibm-watsonx-data-integration SDK for Python is lightweight and straight-forward, with only a few dependencies required by the package itself.

For a smooth install and optimal user experience, please be sure to carefully review the prerequisites below prior to installing the SDK and make sure that all requirements have been met.

In order to begin using the SDK, there are a few prerequisites that must be fulfilled:

  • A Python 3.10+ interpreter and the pip package manager must both be installed on the machine where the SDK will be used. For additional details on the pip package manager as well as installation instructions, please refer to the pip documentation.

  • The ibm-watsonx-data-integration package must be installed on the machine where you plan to execute SDK code.

  • You must have an account with access to the watsonx.data integration platform and an IAM API key created on that account to be used to authenticate from the SDK. For additional information on API keys, including how to create and use them, please refer to the IBM Cloud API Key documentation.

  • (Optional but strongly encouraged) For the vast majority of operations on the watsonx.data integration platform, like executing a flow, you will need to generate a User API Key within the watsonx.data integration service. For additional information on User API keys, including how to create and use them, please refer to the IBM Cloud User API Key documentation. Please note that the User API key is different from the IAM API key that you use to authenticate in the SDK, mentioned above. The User API key only exists within the watsonx.data integration platform.

    Note

    Running StreamSets jobs requires a User API key for secure authorization. To verify if your account has an active User API key, click your avatar and select Profile and settings to open your account profile. Select User API key to view the Active keys. If you do not have an active API key, create a key by clicking Create a key.

  • If you are using the SDK against an on-prem OpenShift/CPD cluster, you must export the cluster’s SSL certificate so that the SDK can successfully establish secure HTTPS connections. If you are logged in to your cluster using oc, you can extract the default ingress certificate with the following command:

    oc -n openshift-config-managed get cm default-ingress-cert \
-o jsonpath='{.data.ca-bundle\.crt}' > /tmp/ocp-router-ca.crt

Once extracted, set the REQUESTS_CA_BUNDLE environment variable to point to the certificate:

export REQUESTS_CA_BUNDLE=/tmp/ocp-router-ca.crt

This step is not required if your on-prem cluster is not SSL-enabled or does not use a custom certificate.