IBM Event Streams for IBM Cloud™ is a high-throughput message bus built with Apache Kafka. It is optimized for event ingestion into IBM Cloud and event stream distribution between your services and applications.
Event Streams provides a REST API to help connect your existing systems to your Event Streams Kafka cluster. Using the API, you can integrate Event Streams with any system that supports RESTful APIs.
Documentation IBM Cloud Eventstreams Service APIs.
This is the Eventstreams Software Development Kit for Go
It includes a library of functions used to access a Eventstreams cluster.
- Overview
- Prerequisites
- Installation
- Using the SDK
- Questions
- Issues
- Open source @ IBM
- Contributing
- License
The IBM Cloud Eventstreams Go SDK allows developers to programmatically interact with the following IBM Cloud services:
| Service Name | Package name |
|---|---|
| Admin Rest | pkg/adminrestv1 |
| Schema Registry | pkg/schemaregistryv1 |
- An IBM Cloud account.
- The IBM Cloud CLI.
- An IAM API key to allow the SDK to access your account. Create one here.
- A IBM Cloud Eventstreams Instance Create one here
- Go version 1.14 or above.
The current version of this SDK: 1.1.0
There are a few different ways to download and install the Eventstreams Go SDK project for use by your Go application:
Use this command to download and install the SDK to allow your Go application to use it:
go get -u github.ibm.com/IBM/eventstreams-go-sdk
If your application is using Go modules, you can add a suitable import to your Go application, like this:
import (
"github.ibm.com/IBM/eventstreams-go-sdk/pkg/adminrestv1"
)then run go mod tidy to download and install the new dependency and update your Go application's
go.mod file.
If your application is using the dep dependency management tool, you can add a dependency
to your Gopkg.toml file. Here is an example:
[[constraint]]
name = "github.ibm.com/IBM/eventstreams-go-sdk"
version = "1.1.0"
then run dep ensure.
For general SDK usage information, please see this link.
For details on using the SDK for administering Kafka topics, please see kafka_topic_operations.md.
For details on using the SDK for schema operations, please see schema_operations.md
See examples for examples on using adminrest and schema SDKs.
If you are having difficulties using this SDK or have a question about the IBM Cloud services, please ask a question at Stack Overflow.
If you encounter an issue with the project, you are welcome to submit a bug report. Before that, please search for similar issues. It's possible that someone has already reported the problem.
Find more open source projects on the IBM Github Page
See CONTRIBUTING.
This SDK project is released under the Apache 2.0 license. The license's full text can be found in LICENSE.