-
-
Notifications
You must be signed in to change notification settings - Fork 6
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Browse files
Browse the repository at this point in the history
* #92: update to JNet 1.5.3 and version upgrade * #93: documentation alignment * #92: code fix for JCOBridge 2.5.5
- Loading branch information
1 parent
702c123
commit 3463ef7
Showing
22 changed files
with
167 additions
and
89 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,14 +1,10 @@ | ||
| # KNet: .NET gateway for Apache Kafka APIs | ||
| # KNet: the Apache Kafka .NET suite | ||
|
|
||
| KNet is a .NET gateway for [Apache Kafka](https://kafka.apache.org/) [APIs](https://kafka.apache.org/documentation/#api) providing all features: Producer, Consumer, Admin, Streams, Connect, backends (ZooKeeper and Kafka). | ||
| KNet is a comprehensive .NET suite for [Apache Kafka](https://kafka.apache.org/) [APIs](https://kafka.apache.org/documentation/#api) providing all features: Producer, Consumer, Admin, Streams, Connect, backends (ZooKeeper and Kafka). | ||
|
|
||
| This project adheres to the Contributor [Covenant code of conduct](CODE_OF_CONDUCT.md). By participating, you are expected to uphold this code. Please report unacceptable behavior to [email protected]. | ||
|
|
||
| ## Status | ||
|
|
||
| Latest releases are: | ||
| ### Libraries and Tools | ||
|
|
||
| |KNet | KNetCLI | KNet.Templates | KNetPS<br/>(1.4.4+) | KNetConnect<br/>(1.4.7+) | | ||
| |KNet | KNetCLI | KNet.Templates | KNetPS | KNetConnect | | ||
| |:---: |:---: |:---: |:---: |:---: | | ||
| |[](https://www.nuget.org/packages/MASES.KNet) [](https://www.nuget.org/packages/MASES.KNet) | [](https://www.nuget.org/packages/MASES.KNetCLI) [](https://www.nuget.org/packages/MASES.KNetCLI) | [](https://www.nuget.org/packages/MASES.KNet.Templates) [](https://www.nuget.org/packages/MASES.KNet.Templates)| [](https://www.powershellgallery.com/packages/MASES.KNetPS/)| [](https://www.nuget.org/packages/MASES.KNetConnect) [](https://www.nuget.org/packages/MASES.KNetConnect) | | ||
|
|
||
|
|
@@ -18,9 +14,11 @@ Latest releases are: | |
| [](https://github.com/masesgroup/KNet/actions/workflows/codeql-analysis.yml) | ||
| [](https://github.com/masesgroup/KNet/actions/workflows/release.yaml) | ||
|
|
||
| --- | ||
|
|
||
| ## Scope of the project | ||
|
|
||
| This project aims to create a library to direct access, from .NET, all the features available in the [Apache Kafka binary distribution](https://kafka.apache.org/downloads). | ||
| This project aims to create a set of libraries and tools to direct access, from .NET, all the features available in the [Apache Kafka binary distribution](https://kafka.apache.org/downloads). | ||
|
|
||
| There are many client libraries written to manage communication with Apache Kafka. Conversely, this project use directly the Java packages released from The Apache Foundation giving more than one benefit: | ||
| * all implemented features are availables at no extra implementation costs, see [KNet usage](src/net/Documentation/articles/usage.md); | ||
|
|
@@ -39,11 +37,39 @@ The Apache Kafka packages are downloaded from: | |
| |:---: |:---: |:---: |:---: | | ||
| | [](https://search.maven.org/search?q=g:%22org.apache.kafka%22%20AND%20a:%22connect-runtime%22) | [](https://search.maven.org/search?q=g:%22org.apache.kafka%22%20AND%20a:%22connect-mirror%22) | [](https://search.maven.org/search?q=g:%22org.apache.kafka%22%20AND%20a:%22connect-file%22) | [](https://search.maven.org/search?q=g:%22org.apache.kafka%22%20AND%20a:%22connect-basic-auth-extension%22) | | ||
|
|
||
| ### Community and Contribution | ||
|
|
||
| Do you like the project? | ||
| - Request your free [community subscription](https://www.jcobridge.com/pricing-25/). | ||
|
|
||
| Do you want to help us? | ||
| - put a :star: on this project | ||
| - open [issues](https://github.com/masesgroup/KNet/issues) to request features or report bugs :bug: | ||
| - improves the project with Pull Requests | ||
|
|
||
| This project adheres to the Contributor [Covenant code of conduct](CODE_OF_CONDUCT.md). By participating, you are expected to uphold this code. Please report unacceptable behavior to [email protected]. | ||
|
|
||
| ## Summary | ||
|
|
||
| * [Roadmap](src/net/Documentation/articles/roadmap.md) | ||
| * [Actual state](src/net/Documentation/articles/actualstate.md) | ||
| * [Performance](src/net/Documentation/articles/performance.md) | ||
| * [Connect SDK](src/net/Documentation/articles/connectSDK.md) | ||
| * [KNet usage](src/net/Documentation/articles/usage.md) | ||
| * [KNet APIs extensibility](src/net/Documentation/articles/API_extensibility.md) | ||
| * [KNet CLI usage](src/net/Documentation/articles/usageCLI.md) | ||
| * [KNet Connect usage](src/net/Documentation/articles/usageConnect.md) | ||
| * [KNet PowerShell usage](src/net/Documentation/articles/usagePS.md) | ||
| * [KNet Template usage](src/net/Documentation/articles/usageTemplates.md) | ||
| * [How to build from scratch](src/net/Documentation/articles/howtobuild.md) | ||
|
|
||
| ### News | ||
|
|
||
| * V1.4.4+: From version 1.4.4 there is a new project, named KNetPS, which permits to write PowerShell client scripts for an Apache Kafka cluster and many other things, [here full usage](src/net/Documentation/articles/usagePS.md). | ||
| * V1.4.7+: From version 1.4.7 there is a new project, named KNetConnect, to execute Apache Kafka Connect related jobs, [here full usage](src/net/Documentation/articles/usageConnect.md). | ||
|
|
||
| --- | ||
|
|
||
| ## Runtime engine | ||
|
|
||
| KNet uses [JNet](https://github.com/masesgroup/JNet), and indeed [JCOBridge](https://www.jcobridge.com/) with its [features](https://www.jcobridge.com/features/), to obtain many benefits: | ||
|
|
@@ -69,21 +95,4 @@ Have a look at the following JCOBridge resources: | |
| - [Commercial Edition](https://www.jcobridge.com/pricing-25/) | ||
| - Latest release: [](https://www.nuget.org/packages/MASES.JCOBridge) | ||
|
|
||
| --- | ||
| ## Summary | ||
|
|
||
| * [Roadmap](src/net/Documentation/articles/roadmap.md) | ||
| * [Actual state](src/net/Documentation/articles/actualstate.md) | ||
| * [Performance](src/net/Documentation/articles/performance.md) | ||
| * [Connect SDK](src/net/Documentation/articles/connectSDK.md) | ||
| * [KNet usage](src/net/Documentation/articles/usage.md) | ||
| * [KNet APIs extensibility](src/net/Documentation/articles/API_extensibility.md) | ||
| * [KNet CLI usage](src/net/Documentation/articles/usageCLI.md) | ||
| * [KNet Connect usage](src/net/Documentation/articles/usageConnect.md) | ||
| * [KNet PowerShell usage](src/net/Documentation/articles/usagePS.md) | ||
| * [KNet Template usage](src/net/Documentation/articles/usageTemplates.md) | ||
| * [How to build from scratch](src/net/Documentation/articles/howtobuild.md) | ||
|
|
||
| --- | ||
|
|
||
| KAFKA is a registered trademark of The Apache Software Foundation. KNet has no affiliation with and is not endorsed by The Apache Software Foundation. | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,5 +1,50 @@ | ||
| # Welcome to KNet | ||
| # KNet: the Apache Kafka .NET suite | ||
|
|
||
| KNet is a .NET gateway for [Apache Kafka](https://kafka.apache.org/) [APIs](https://kafka.apache.org/documentation/#api) providing all features: Producer, Consumer, Admin, Streams, Connect, backends (ZooKeeper and Kafka). | ||
| KNet is a comprehensive .NET suite for [Apache Kafka](https://kafka.apache.org/) [APIs](https://kafka.apache.org/documentation/#api) providing all features: Producer, Consumer, Admin, Streams, Connect, backends (ZooKeeper and Kafka). | ||
|
|
||
| ### Libraries and Tools | ||
|
|
||
| |KNet | KNetCLI | KNet.Templates | KNetPS | KNetConnect | | ||
| |:---: |:---: |:---: |:---: |:---: | | ||
| |[](https://www.nuget.org/packages/MASES.KNet) [](https://www.nuget.org/packages/MASES.KNet) | [](https://www.nuget.org/packages/MASES.KNetCLI) [](https://www.nuget.org/packages/MASES.KNetCLI) | [](https://www.nuget.org/packages/MASES.KNet.Templates) [](https://www.nuget.org/packages/MASES.KNet.Templates)| [](https://www.powershellgallery.com/packages/MASES.KNetPS/)| [](https://www.nuget.org/packages/MASES.KNetConnect) [](https://www.nuget.org/packages/MASES.KNetConnect) | | ||
|
|
||
| ### Pipelines | ||
|
|
||
| [](https://github.com/masesgroup/KNet/actions/workflows/build.yaml) | ||
| [](https://github.com/masesgroup/KNet/actions/workflows/codeql-analysis.yml) | ||
| [](https://github.com/masesgroup/KNet/actions/workflows/release.yaml) | ||
|
|
||
| --- | ||
|
|
||
| ## Scope of the project | ||
|
|
||
| This project aims to create a set of libraries and tools to direct access, from .NET, all the features available in the [Apache Kafka binary distribution](https://kafka.apache.org/downloads). | ||
|
|
||
| There are many client libraries written to manage communication with Apache Kafka. Conversely, this project use directly the Java packages released from The Apache Foundation giving more than one benefit: | ||
| * all implemented features are availables at no extra implementation costs, see [KNet usage](src/net/Documentation/articles/usage.md); | ||
| * avoids any third party communication protocol implementation; | ||
| * access all features made available from Apache Kafka: the most important are Apache Kafka Streams and Apache Kafka Connect which does not have any C# implementation; | ||
| * measured high [performance](src/net/Documentation/articles/performance.md) in many operating conditions. | ||
|
|
||
| The Apache Kafka packages are downloaded from: | ||
|
|
||
| |kafka-clients | kafka-streams | kafka-tools | kafka_2.13 | | ||
| |:---: |:---: |:---: |:---: | | ||
| |[](https://search.maven.org/search?q=g:%22org.apache.kafka%22%20AND%20a:%22kafka-clients%22) | [](https://search.maven.org/search?q=g:%22org.apache.kafka%22%20AND%20a:%22kafka-streams%22) | [](https://search.maven.org/search?q=g:%22org.apache.kafka%22%20AND%20a:%22kafka-tools%22) | [](https://search.maven.org/search?q=g:%22org.apache.kafka%22%20AND%20a:%22kafka_2.13%22) | | ||
|
|
||
|
|
||
| |connect-runtime | connect-mirror | connect-file | connect-basic-auth-extension | | ||
| |:---: |:---: |:---: |:---: | | ||
| | [](https://search.maven.org/search?q=g:%22org.apache.kafka%22%20AND%20a:%22connect-runtime%22) | [](https://search.maven.org/search?q=g:%22org.apache.kafka%22%20AND%20a:%22connect-mirror%22) | [](https://search.maven.org/search?q=g:%22org.apache.kafka%22%20AND%20a:%22connect-file%22) | [](https://search.maven.org/search?q=g:%22org.apache.kafka%22%20AND%20a:%22connect-basic-auth-extension%22) | | ||
|
|
||
| ### Community and Contribution | ||
|
|
||
| Do you like the project? | ||
| - Request your free [community subscription](https://www.jcobridge.com/pricing-25/). | ||
|
|
||
| Do you want to help us? | ||
| - put a :star: on this project | ||
| - open [issues](https://github.com/masesgroup/KNet/issues) to request features or report bugs :bug: | ||
| - improves the project with Pull Requests | ||
|
|
||
| This project adheres to the Contributor [Covenant code of conduct](CODE_OF_CONDUCT.md). By participating, you are expected to uphold this code. Please report unacceptable behavior to [email protected]. |
Oops, something went wrong.