Installation on Unity Catalog

This article explains how Xonai can be installed on a Unity Catalog volume and activated on a cluster via an init script.

Create a Volume

To create a volume to store Xonai files:

  1. Navigate to Catalog from the left navigation panel.

  2. Click Create > Create Volume within the schema you want to create the volume (e.g. /Volumes/main/default/).

  3. The Create a new volume dialog appears. Type xonai as the volume name and select Managed volume in Volume type.

Create an Init Script

After the volume is created:

  1. Create a file with the following content and change the placeholders as described after:

    1
2
    %sh
cp <volume-path>/xonai/xonai-spark-plugin-dbx-<release>-<version>-stable-linux-<arch>.jar /databricks/jars/

  2. Change <volume-path>, <runtime>, <release> and <arch> placeholders with:

    1. The path for the the managed volume you created (e.g. /Volumes/main/default/xonai).

    2. The Databricks runtime version you are using (e.g. 14.3).

    3. The Xonai JAR release version you want to use.

    4. The Worker processor architecture: amd64 for Intel/AMD or arm64 for Graviton/ARM.

  3. Copy xonai-init.sh to the managed volume you created for Xonai (e.g. /Volumes/main/default/xonai)

Info

You may want to create multiple configuration scripts with distinct names if you are using multiple Databricks runtime versions and processor architectures in your workspace.

Copy Xonai JARs

After the init script is created:

  1. Click Upload to this volume at the top right corner.

  2. The Upload files to volume dialog appears. Drag and drop or browse to the JAR(s) you want to upload, and click Upload.

Next Steps

Please refer to our activation guides to learn how to activate the Xonai Accelerator for the different types of Databricks compute with the init script created in this page.