The Brigade 2 SDK for Go provides Go language bindings for the new Brigade 2 API.

This SDK remains under development, but has been made publicly available sooner rather than later in order to unblock Brigade contributors who wish to work on Brigade 2 compatible gateways (or other tools). It should be relatively stable, but please do expect occasional, minor breakages at this juncture.

Brigade's own non-API components, including its scheduler and CLI, are consumers of this SDK.

$ go get github.com/brigadecore/brigade/sdk/v3

In your gateway code:

import (
	"github.com/brigadecore/brigade/sdk/v3"
	"github.com/brigadecore/brigade/sdk/v3/restmachinery"
)

// ...

client, err := sdk.NewAPIClient(
	apiAddress, // The address of the Brigade 2 API server, beginning with http:https:// or https//
	apiToken, // An API token obtained using the Brigade 2 CLI
	&restmachinery.APIClientOptions {
		AllowInsecureConnections: false, // Do not ignore SSL errors
	},
)
if err != nil {
	// ...
}

client is an entrypoint into a tree of specialized clients. At its highest level, it's broken into:

Each of these, in turn, provides access to even more specialized clients.

When developing code that integrates with a specific aspect of the Brigade API, it makes sense to directly create the specific client you need, avoiding the things you do not need. For instance, instantiating a core.EventClient only would make sense for gateways (whose job is simply to broker events from upstream systems):

import (
	"github.com/brigadecore/brigade/sdk/v3"
	"github.com/brigadecore/brigade/sdk/v3/restmachinery"
)

// ...

client, err := core.NewEventsClient(
	apiAddress, // The address of the Brigade 2 API server, beginning with http:https:// or https://
	apiToken, // An API token obtained using the Brigade 2 CLI
	&restmachinery.APIClientOptions {
		AllowInsecureConnections: false, // Do not ignore SSL errors
	},
)
if err != nil {
	// ...
}

The SDK's godoc are quite thorough. Please explore those for further details.

Visit the main README for instructions on standing up your own instance of the Brigade 2 server, installing the Brigade 2 CLI (brig), and authenticating.

Once you are set up and have authenticated, you may create a service account whose token can be used in testing your new gateway (or other tool).

$ brig service-account create --id <name> --description <description>

The command will return the token.

The Brigade 2 SDK for Go accepts contributions via GitHub pull requests. The Contributing document outlines the process to help get your contribution accepted.

We have a slack channel! Kubernetes/#brigade Feel free to join for any support questions or feedback, we are happy to help. To report an issue or to request a feature open an issue here