Elastic Cloud Go SDK

Go SDK for Elastic Cloud. Its goal is to provide common ground for all Elastic Cloud programmatic code in Go.

Installation

Run the following go get command to install the SDK in your module dependencies directory:

go get -u github.com/elastic/cloud-sdk-go

High level package overview

The project's structure is based off the standard Go project layout. Therefore, all of our library code that we expect other projects to import is placed in the pkg/ directory.

The main packages for interacting directly with our public API endpoints are client and models. The source code for these is generated off the public API swagger specification.

The rest are a series of packages that can be leveraged in many ways. For a detailed package description visit the SDK's packages documentation at godoc.org. Alternatively you can use the godoc command on the root level of this project.

Getting started

Take a look at our sample code, which retrieves information about the active platform, to get an idea on how to use the SDK.

ecctl (the Elastic Cloud CLI tool) depends heavily on cloud-sdk-go. You can use ecctl packages as a reference on how to leverage the SDK. One good example is the code used to list elasticsearch clusters.

We always welcome contributions! Take a look at our contributing guide if this is something that interests you.

Updating the swagger specification

When a new version of the API specification is released, the local copy of that specification found in api/apidocs.json needs to be updated and committed as well.

The swagger specification is then used to generate a client and models Go packages and sub-packages. To update the Go auto-generated codebase, make swagger or make docker-swagger can be used.

Additionally, a full markdown declaration of API commands will be generated in api/version/$(ECE_VERSION).md, and pkg/api/version.go will be generated with the version matching the ECE_VERSION variable.

The Makefile global variable ECE_VERSION should be modified before running make swagger.