Everblack Go SDK

The official Go SDK for Everblack services. Also, package authn is the reference implementation of authentication mechanism, which is used internally in Everblack Cloud to verify signatures.

Installing

Use go get to install the latest version of the library.

go get -u github.com/evrblk/evrblk-go@latest

Example

import (
    evrblk "github.com/evrblk/evrblk-go"
    moab "github.com/evrblk/evrblk-go/moab/v0"
)

apiKeyId := "key_alfa_z141pKeFzfmGGyYlUyPsbF"
privatePem := "-----BEGIN EC PRIVATE KEY-----\nMHcCAQEEIN33cCNGxsuxwMaJ2jWvWcgxBSVr8HV7WUUSKGc71/BtoAoGCCqGSM49\nAwEHoUQDQgAE0m8+ZVijytLp01dsupG7QF8ZpjX5UmP20wj/sluPdoHW3BgiiyCn\n/pMwYptUs0yJUtUZ/0wzEyp8PgAWWhxglw==\n-----END EC PRIVATE KEY-----"

signer := evrblk.NewAlfaRequestSigner(apiKeyId, privatePem)

moabClient := moab.NewMoabGrpcClient("moab.us-east-2.api.evrblk.com", signer)

createQueueResp, err := moabClient.CreateQueue(context.Background(), &moab.CreateQueueRequest{
    Name:                      "my_queue_1",
    Description:               "Some description",
    KeepaliveTimeoutInSeconds: 15,
    ExpiresInSeconds:          86400,
})

How it works

Everblack services communicate over gRPC. All Proto definitions live in proto directory.

SDK is fully generated. First, it generates standard gRPC client with protoc. Then it takes gRPC service descriptors and generates wrappers for them with go run ./cmd/codegen. Wrapper has authentication (request signing), basic Prometheus metrics, and error type casting. planetscale/vtprotobuf plugin is used for performance.

The full built is done with:

make

To learn more about how it generates SDKs see cmd/codegen/main.go and Makefile.

API Versioning

Each service is versioned independently of each other. Packages are organized by major versions. For example, V0 version of Moab API is available with import moab "github.com/evrblk/evrblk-go/moab/v0", V1 version will be available with import moab "github.com/evrblk/evrblk-go/moab/v1", and so forth. V0 is experimental and breaking changes are expected. Starting with V1, it is guaranteed that all minor changes are backward compatible.

Currently available versions:

• Grackle
  • v1beta
• Moab
  • v0
• IAM
  • v0
• My Account
  • v0

License

Everblack Go SDK is released under the MIT License.