Skyline.DataMiner.Core.ArtifactInstaller 2.0.0-alpha4

Skyline.DataMiner.Core.ArtifactInstaller

Skyline.DataMiner.Core.ArtifactInstaller is a .NET library that streamlines the process of installing various artifacts—such as Low-Code Apps and Dashboards—into DataMiner systems. It provides a simple and robust API for automating artifact deployment with built-in error handling and flexible configuration.

📦 Features

• Artifact Installation: Seamlessly install Low-Code Apps and Dashboards into DataMiner systems.
• Simple Integration: Minimal setup required with SLNet and HTTP client configuration.
• Asynchronous Operations: Non-blocking, efficient installation processes.
• Robust Error Handling: Comprehensive exception management for installation failures.

🚀 Getting Started

📥 Installation

Install the package via NuGet:

dotnet add package Skyline.DataMiner.Core.ArtifactInstaller

🔧 Usage

1. Connect to DataMiner

using System.Net.Http;
using Skyline.ArtifactInstaller;
using Skyline.DataMiner.Net;

var slnetConnection = ConnectionSettings.GetConnection("your-dataminer-host");
var httpClient = new HttpClient();

var dataMinerService = Installer.ToDataMiner(slnetConnection, httpClient);

2. Install a Low-Code App

using Skyline.ArtifactInstaller.Identifiers;

var appZip = new ZipIdentifier(@"C:\Artifacts\MyLowCodeApp.zip");

string result = await dataMinerService.InstallLowCodeAppAsync(appZip);
Console.WriteLine($"Low-Code App installation result: {result}");

3. Install a Dashboard

using Skyline.ArtifactInstaller.Identifiers;

var dashboardZip = new ZipIdentifier(@"C:\Artifacts\MyDashboard.zip");

string result = await dataMinerService.InstallDashboardAsync(dashboardZip);
Console.WriteLine($"Dashboard installation result: {result}");

🛠️ API Overview

Installer Factory

IDataMinerService Installer.ToDataMiner(IConnection slnetConnection, HttpClient httpClient)

• Initializes a connection to the DataMiner system for artifact installation.

IDataMinerService Interface

• InstallDashboardAsync:
  Installs a Dashboard from a .zip package.

• InstallLowCodeAppAsync:
  Installs a Low-Code App from a .zip package.

Task<string> InstallDashboardAsync(ZipIdentifier id);
Task<string> InstallLowCodeAppAsync(ZipIdentifier id);

⚠️ Error Handling

• InvalidOperationException: Triggered when installation fails after multiple retries.
• DataMinerException: Raised if there are issues retrieving system information during setup.

🤝 Contributing

Contributions are welcome! Please submit issues or pull requests to help improve the library.