Cloud Pak for Data

 View Only



LinkedIn Share on LinkedIn

How to configure an external Flight URL route to deliver data products with Data Product Hub

By Barbara Schramm posted Wed February 26, 2025 04:15 PM

  

By Raneeth S., Software Developer, and Barbara Schramm, Content Design Lead for Data Product Hub

Data Product Hub provides several options for delivering data products to subscribers. One popular option is to use the Flight service for real-time live access. Subscribers create a Flight client which can be included in a notebook or other applications. The Flight client accesses the data product using a Flight URL provided with the subscription.

The Flight URL is generated using an external route on the OpenShift cluster, which is required to deliver data products using the Flight Service. The external route is configured by either the cluster or instance administrator on the pod before installing Data Product Hub.

After the external route is configured, then the external Flight URL must be bound to Data Product Hub to deliver data products. You can bind the route by using the steps in this blog. Instructions are provided for both the OpenShift console and the command line. 

From the console


Prerequisite: The Flight URL requires an external route to deliver data products using the Flight Service. For instructions on configuring an external Flight service route, see Configuring an external route to the Flight service.

After the external route is configured, follow these steps in the OpenShift console to bind the Flight service external route with Data Product Hub:

  1. Log in as admin to the cluster where the Data Product Hub service was deployed.
  2. From the dashboard, select Projects>All Projects. Then select Workloads>Pods.
  3. Locate the pod for Data Product Hub by searching for data-product-operator. You receive two results similar to ibm-cpd-data-product-operator-xxxxx and ibm-cpd-data-product-operator-catalog-xxxxx.
    data-product-operator-pod
  4. Select the pod that doesn’t contain “catalog”. For example, select ibm-cpd-data-product-operator-xxxxx NOT ibm-cpd-data-product-operator-catalog-xxxxx.

    data-product-operator-pod

  5. From the pods page, select the Terminal menu. The Terminal provides the ability to execute scripts inside the pod.
    Terminal for the data product operator pod

  6. Open the /opt/ansible/<<installed-version>>/roles/data-product folder and locate the update_fcrouteurl.yaml file. This file contains the script for binding the external Flight service route to Data Product Hub.
    Locate update_fcrouteurl.yaml script
  7. Execute the script by entering: ansible-playbook update_fcrouteurl.yaml -e "fcservicens=wkc fcservicename=wdp-connect-flight".
    Ensure that fcservicens is the correct namespace for the wdp-connect-flight service. 

    Execute update_fcrouteurl.yaml script
  8. After the script execution completes, restart the dataproduct-api deployment. Open Deployments>Project>All Projects. Then select the dataproduct-api deployment to open the deployment details page.
    deployments
  9. From the dataproduct-api deployment details page, select Actions>Restart rollout to refresh the dataproduct-api deployment. Refreshing the deployment binds the new external routeURL value to the pod and makes it available to Data Product Hub for delivering data products.
    refresh dataproduct-api deployment
  10. Subscribers must refresh the subscription to update it with the Flight URL. Then, you can use the URL in your Flight client. For instructions on creating a Flight client, see Flight client example for accessing a data product.

From the command line

Prerequisite: The Flight URL requires an external route to deliver data products using the Flight Service. For instructions on configuring an external Flight service route, see Configuring an external route to the Flight service.

  1. Log into the cluster where the Data Product Hub service is deployed:
    sudo su -
  2.  Find the pod name:
    kubectl get pods -n <<operator-namespace>> | grep "data-product-operator"

    Two pod names are returned: ibm-cpd-data-product-operator-xxxxx and ibm-cpd-data-product-operator-catalog-xxxxx. You will access the pod that does NOT contain "catalog".

  3. Access the operator pod:
    kubectl exec -it <ibm-cpd-data-product-operator-xxxxx> -n <<operator-namespace>> /bin/bash
  4. Locate the update_fcrouteurl.yaml script in the /opt/ansible/installed-version/roles/data-product directory where "installed-version" is the Cloud Pak for Data version.
  5. Execute the update_fcrouteurl.yaml script:
    ansible-playbook update_fcrouteurl.yaml -e "fcservicens=wkc fcservicename=wdp-connect-flight"

    Ensure that fcservicens is the correct namespace for the wdp-connect-flight service.

  6. Restart the dataproduct-api service to bind the new external route URL:
    kubectl rollout restart deployment dataproduct-api -n wkc
  7. Subscribers must refresh the subscription to update it with the Flight URL. Then, you can use the URL in your Flight client. For instructions on creating a Flight client, see Flight client example for accessing a data product.



#Spotlight
#data-highlights-home

0 comments
98 views

Permalink