Getting Started

During the development of this custom connector, DryvIQ recommends building the project using dotnet build. This will build using the Debug configuration and copy the connector into the appropriate directory on your machine for DryvIQ to pick up (if you have a local copy that you can use to test live within the product). However, once you are ready to deploy this connector to customers, you will want to package it as a NuGet package (.nupkg file) using dotnet pack --configuration Release and deploy it to a DryvIQ instance. This page assumes you have a NuGet package that you wish to deploy to customers.

Deploying the Extension with DryvIQ

The DryvIQ installer supports deploying custom extensions alongside the normal DryvIQ installation process. To do this, an extension developer would create an extensions.zip file containing all NuGet packages (.nupkg files) that should be deployed with the DryvIQ Platform.

Deploying the Extension to an Existing DryvIQ Instance

DryvIQ also supports installing custom extensions into an existing DryvIQ Platform instance. This process is the same regardless of whether you are dealing with a single-node or a multi-node cluster. Once DryvIQ is installed and the database configured, you can install the extension using a few different methods. To deploy an extension to an offline instance (the DryvIQ instance is not actively running), you can use the following:

skysync extensions deploy MyCustomExtension.nupkg

This command will install the extension into the DryvIQ database so it can be installed and deployed on each node in the cluster once the instances are brought online.

You can also deploy an extension into a running DryvIQ instance using the skysync-cli or the REST interface. To use the CLI, ensure that you have the CLI installed and configured before continuing.

skysync-cli extensions add MyCustomExtension.nupkg