Creating Custom Connectors
Learn how to create a custom connector to use in the DryvIQ Platform.
Table of Contents
Prerequisites
- .NET Core SDK
- .NET IDE of choice
- Access to the DryvIQ SDK packages
- DryvIQ SDK custom project template
- Basic understanding of creating a DryvIQ Platform extension
Getting Started
The DryvIQ Platform allows users to connect to on-premise and cloud storage platforms and orchestrate the content contained within those platforms. To orchestrate the content, DryvIQ first needs to be able to talk to the storage platforms on both the source and the destination. This is accomplished by implementing an IConnectorProvider interface. DryvIQ provides supported implementations for several storage platforms out-of-the-box. However, when a customer has a platform we do not support, a custom connector must be provided to bridge the native storage platform APIs and DryvIQ.
Creating a Custom Connector
When creating a platform extension, the --extension can be used to specify the exact type of extension you would like to create. One of the available options is --extension=connector, which customizes the project as a custom connector:
dotnet new skysynclib --name MyCustomConnector --extension connector
As with creating an extension, you need to create a solution and add the new projects.
cd MyCustomConnector
dotnet new solution
dotnet sln add src\MyCustomConnector\MyCustomConnector.csproj
dotnet sln add test\MyCustomConnector.Tests\MyCustomConnector.Tests.csproj
Deployment
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.