https://github.com/vmware/vmware-go-kcl-v2

vmware-go-kcl is a vmware originated open-source project for AWS Kinesis Client Library in Go. It has been widely used by many external companies and internally by Carbon Black. vmware-go-kcl-v2 is its companion project by utilizing AWS Go SDK V2 which introduces lots of breaking changes. To keep the repo clean, it is better to have a separated repo vmware-go-kcl-v2 with better golang project structure improvement.
https://github.com/vmware/vmware-go-kcl-v2

Last synced: 5 months ago
JSON representation

vmware-go-kcl is a vmware originated open-source project for AWS Kinesis Client Library in Go. It has been widely used by many external companies and internally by Carbon Black. vmware-go-kcl-v2 is its companion project by utilizing AWS Go SDK V2 which introduces lots of breaking changes. To keep the repo clean, it is better to have a separated repo vmware-go-kcl-v2 with better golang project structure improvement.

• Host: GitHub
• URL: https://github.com/vmware/vmware-go-kcl-v2
• Owner: vmware
• License: mit
• Created: 2021-11-30T15:05:11.000Z (about 4 years ago)
• Default Branch: main
• Last Pushed: 2024-08-15T19:02:07.000Z (over 1 year ago)
• Last Synced: 2025-03-24T00:07:01.308Z (11 months ago)
• Language: Go
• Size: 324 KB
• Stars: 24
• Watchers: 2
• Forks: 17
• Open Issues: 18
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

          
# VMWare Go KCL v2

![technology Go](https://img.shields.io/badge/technology-go-blue.svg)

[![Go Report Card](https://goreportcard.com/badge/github.com/vmware/vmware-go-kcl-v2)](https://goreportcard.com/report/github.com/vmware/vmware-go-kcl-v2)

[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)

[![vmware-go-kcl-v2](https://github.com/vmware/vmware-go-kcl-v2/actions/workflows/vmware-go-kcl-v2-ci.yml/badge.svg)](https://github.com/vmware/vmware-go-kcl-v2/actions/workflows/vmware-go-kcl-v2-ci.yml)

## Overview

VMware-Go-KCL-V2 is a native open-source Go library for Amazon Kinesis Data Stream (KDS) consumption. It allows developers

to program KDS consumers in lightweight Go language and still take advantage of the features presented by the native

KDS Java API libraries.

[vmware-go-kcl-v2](https://github.com/vmware/vmware-go-kcl-v2) is a VMWare originated open-source project for AWS Kinesis

Client Library in Go. Within VMware, we have seen adoption in vSecureState and Carbon Black. In addition, Carbon Black

has contributed to the vmware-go-kcl codebase and heavily used it in the product. Besides,

[vmware-go-kcl-v2](https://github.com/vmware/vmware-go-kcl-v2) has got

[recognition](https://www.linkedin.com/posts/adityakrish_vmware-go-kcl-a-native-open-source-go-programming-activity-6810626798133616640-B6W8/),

and [contributions](https://github.com/vmware/vmware-go-kcl-v2/graphs/contributors) from the industry.

`vmware-go-kcl-v2` is the v2 version of VMWare KCL for the Go programming language by utilizing [AWS Go SDK V2](https://github.com/aws/aws-sdk-go-v2).

## Try it out

### Prerequisites

* [aws-sdk-go-v2](https://github.com/aws/aws-sdk-go-v2)

* The v2 SDK requires a minimum version of `Go 1.17`.

* [gosec](https://github.com/securego/gosec)

### Build & Run

1. Initialize Project

2. Build

    > `make build`

3. Test

    > `make test`

## Documentation

VMware-Go-KCL matches exactly the same interface and programming model from original Amazon KCL, the best place for getting reference, tutorial is from Amazon itself:

* [Developing Consumers Using the Kinesis Client Library](https://docs.aws.amazon.com/streams/latest/dev/developing-consumers-with-kcl.html)

* [Troubleshooting](https://docs.aws.amazon.com/streams/latest/dev/troubleshooting-consumers.html)

* [Advanced Topics](https://docs.aws.amazon.com/streams/latest/dev/advanced-consumers.html)

## Contributing

The vmware-go-kcl-v2 project team welcomes contributions from the community. Before you start working with vmware-go-kcl-v2, please

read our [Developer Certificate of Origin](https://cla.vmware.com/dco). All contributions to this repository must be

signed as described on that page. Your signature certifies that you wrote the patch or have the right to pass it on

as an open-source patch. For more detailed information, refer to [CONTRIBUTING.md](CONTRIBUTING.md).

## License

MIT License