Skip to content

How to Deploy a UDA

Introduction

Deploying a UDA involves transferring the packaged UDA to a production environment and ensuring that it operates as intended. This section covers the deployment process.

How to Deploy a UDA package to kdb Insights

This page explains how to deploy a User-Defined Application (UDA) package to a kdb Insights instance. You can deploy the package using the kxi command-line interface (CLI) or other available methods.

Prerequisites

Before deploying a UDA package, ensure the following prerequisites are met:

  • You have access to a kdb Insights instance

  • The kxi CLI is installed and configured on your system

  • The UDA package is packaged according to kdb Insights packaging guidelines

Deploying a UDA package

1. Prepare the package

Prepare the UDA package by following the kdb Insights packaging process. Ensure that your package includes all necessary components:

  • UDA code files

  • Configuration files

  • Dependency files

To created a package, use the kxi package create command to package the components.

2. Deploy using kxi CLI

Deploy the UDA package using the kxi package deploy command.

Command syntax

kxi package deploy --url INSIGHTS_URL --client-id CLIENT_ID --client-secret CLIENT_SECRET SOURCE

  • INSIGHTS_URL - The URL of the kdb Insights instance.

  • CLIENT_ID - The client ID for authentication.

  • CLIENT_SECRET - The client secret for authentication.

  • SOURCE - The package name, with an optional version. For example, my-package/1.0.0.

Example deploy

To deploy a UDA package named my-package run:

kxi package deploy --url https://insights.example.com --client-id my-client-id --client-secret my-client-secret my-package
To deploy a specific version of the package run:

kxi package deploy --url https://insights.example.com --client-id my-client-id --client-secret my-client-secret my-package/1.2.3

3. Verify deployment

After deployment, verify that your UDA package is running correctly:

  • 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.

Additional information

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