How to Deploy a UDA

Introduction

Deploying a UDA in kdb Insights involves transferring the package containing the UDA to a target environment and verifying its functionality. This section outlines the deployment process.

Prerequisites

Ensure the following prerequisites are met before deploying a package containing a UDA:

You have access to a kdb Insights instance
The kxi CLI is installed and configured on your system.
Prepare the UDA package by following the UDA creation guide to create a UDA.
Add the UDA to a package by following the Adding a UDA to a package guide. For more information on package configuration, refer to the Packaging Overview.

Note

If you are unfamiliar with how packaging works in kdb Insights, it is recommended to review this topic before continuing. This foundational knowledge is essential for understanding how UDAs are packaged and deployed. Refer to the Packaging Overview for more information.

Deploying a package containing a UDA

To complete the deployment, load the UDA into the relevant processes as outlined in the following guides:

SDK

Refer to Installing UDAs on kdb Insights SDK for instructions on setting environment variables to locate and load the package.

Enterprise

Refer to Installing UDAs on kdb Insights Enterprise for instructions on setting environment variables in the database package to locate and load the UDA.

Verify the deployment

Verify that the deployment is running as expected:

Check the deployment status in the kdb Insights console.
Review logs or monitoring data to ensure the application components are functioning as expected.
Perform any necessary post-deployment testing or validation, including querying data using the UDA.

Additional information

For more information on packaging and deploying UDA packages in kdb Insights, refer to the kdb Insights Package deployment documentation.