MASES.KNetConnect
3.1.0
dotnet tool install --global MASES.KNetConnect --version 3.1.0
dotnet new tool-manifest
dotnet tool install --local MASES.KNetConnect --version 3.1.0
#tool dotnet:?package=MASES.KNetConnect&version=3.1.0
nuke :add-package MASES.KNetConnect --version 3.1.0
title: Kafka™ Connect SDK of .NET suite for Apache Kafka™ _description: Describes how to use Kafka™ Connect SDK of .NET suite for Apache Kafka™
KNet: KNet Connect SDK
Create a new connector based on KNet Connect SDK
To start to use KNet Connect SDK and write a connector in C# the following steps can be used:
- Install the available templates following the template usage article
- Execute one the following commands:
- Sink connector:
dotnet new knetConnectSink
- Source connector:
dotnet new knetConnectSource
- Update the code to define the needed behavior.
Execution
The connector can be used from a JVM hosted runtime and from a .NET hosted runtime. For an overview of configuration see Connect SDK
JVM hosted runtime
To use the connector from a JVM hosted runtime follow the instructions available at https://kafka.apache.org/documentation/#connect and https://kafka.apache.org/quickstart#quickstart_kafkaconnect.
.NET hosted runtime
KNet Connect .NET hosted runtime is available in two different formats:
- dotnet tool hosted on NuGet: check https://www.nuget.org/packages/MASES.KNetConnect/ and https://docs.microsoft.com/en-us/dotnet/core/tools/global-tools for installation deep instructions.
- Docker image hosted on GitHub or Docker Hub: follow instruction within the page and general instruction on https://docs.docker.com
The dotnet tool needs a JRE/JDK installed within the system
Usage
To use the .NET hosted runtime Connect interface (KNetConnect) runs a command like the following:
- dotnet tool
knetconnect -s connect-standalone.properties specific-connector.properties
knetconnect -d connect-distributed.properties
If the previous commands raise the error described in Intel CET and KNet the only solution is to apply the following workaround (within an elevated shell) and disable CET:
reg add "HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows NT\CurrentVersion\Image File Execution Options\knetconnect.exe" /v MitigationOptions /t REG_BINARY /d "0000000000000000000000000000002000" /f
- Docker image
docker run ghcr.io/masesgroup/knetconnect -s connect-standalone.properties specific-connector.properties
docker run masesgroup/knetconnect -s connect-standalone.properties specific-connector.properties
docker run ghcr.io/masesgroup/knetconnect -d connect-distributed.properties
docker run masesgroup/knetconnect -d connect-distributed.properties
Command line switch available
knetconnect accepts the following command-line switch to identify its behavior:
- d: starts a distributed version of Connector defined in the file identified from the subsequent parameter
- s: starts a standalone version of Connector defined in the file identified from the subsequent parameter
- k: starts a KNet version (Distributed or Standalone) accepting environment variables names containing the data associated to the parameters expected from the stanard version
- other parameters in sequence are:
- Apache Kafka™ Connect configuration file
- KNet Connector configuration file
- or in case of k switch is used the parameters are the environemnt variables containing the configuration data in the following form:
- key and value separated with =
- key-value pair separated with ||
- an example is key1=value1||key2=value2||key3
Product | Versions Compatible and additional computed target framework versions. |
---|---|
.NET | net8.0 is compatible. net8.0-android was computed. net8.0-browser was computed. net8.0-ios was computed. net8.0-maccatalyst was computed. net8.0-macos was computed. net8.0-tvos was computed. net8.0-windows was computed. net9.0 was computed. net9.0-android was computed. net9.0-browser was computed. net9.0-ios was computed. net9.0-maccatalyst was computed. net9.0-macos was computed. net9.0-tvos was computed. net9.0-windows was computed. net10.0 was computed. net10.0-android was computed. net10.0-browser was computed. net10.0-ios was computed. net10.0-maccatalyst was computed. net10.0-macos was computed. net10.0-tvos was computed. net10.0-windows was computed. |
This package has no dependencies.
Version | Downloads | Last Updated |
---|---|---|
3.1.0 | 124 | 9/23/2025 |
3.0.4 | 148 | 9/23/2025 |
3.0.3 | 99 | 8/22/2025 |
3.0.2 | 232 | 8/5/2025 |
3.0.1 | 330 | 7/20/2025 |
3.0.0 | 84 | 7/19/2025 |
2.9.3 | 338 | 7/20/2025 |
2.9.2 | 162 | 7/17/2025 |
2.9.1 | 574 | 2/5/2025 |
2.9.0 | 529 | 12/23/2024 |
2.8.2 | 564 | 11/5/2024 |
2.8.1 | 517 | 9/20/2024 |
2.8.0 | 461 | 8/6/2024 |
2.7.10 | 363 | 11/5/2024 |
2.7.9 | 578 | 9/20/2024 |
2.7.8 | 330 | 7/31/2024 |
2.7.7 | 365 | 7/30/2024 |
2.7.6 | 361 | 7/29/2024 |
2.7.5 | 533 | 7/2/2024 |
2.7.4 | 529 | 6/27/2024 |
2.7.3 | 555 | 6/24/2024 |
2.7.2 | 427 | 5/25/2024 |
2.7.1 | 378 | 5/18/2024 |
2.7.0 | 403 | 5/16/2024 |
2.6.7 | 367 | 11/5/2024 |
2.6.6 | 484 | 9/20/2024 |
2.6.5 | 622 | 9/16/2024 |
2.6.4 | 399 | 6/14/2024 |
2.6.3 | 254 | 6/11/2024 |
2.6.2 | 353 | 5/17/2024 |
2.6.0 | 701 | 3/1/2024 |
2.5.0 | 593 | 2/28/2024 |
2.4.3 | 505 | 2/11/2024 |
2.4.2 | 412 | 1/27/2024 |
2.4.1 | 395 | 1/21/2024 |
2.4.0 | 508 | 1/20/2024 |
2.3.0 | 1,164 | 11/25/2023 |
2.2.0 | 717 | 10/19/2023 |
2.1.3 | 693 | 10/11/2023 |
2.1.2 | 883 | 10/6/2023 |
2.1.1 | 834 | 10/5/2023 |
2.1.0 | 941 | 9/27/2023 |
2.0.2 | 773 | 8/2/2023 |
2.0.1 | 799 | 7/11/2023 |
2.0.0 | 715 | 7/8/2023 |
1.5.5 | 769 | 7/1/2023 |
1.5.4 | 624 | 5/28/2023 |
1.5.3 | 822 | 4/16/2023 |
1.5.2 | 943 | 4/11/2023 |
1.5.1 | 877 | 3/15/2023 |
1.5.0 | 1,064 | 2/9/2023 |
1.4.8 | 819 | 11/28/2022 |
1.4.7 | 910 | 11/23/2022 |