Skip to content

Go client library for Elastic Cloud and Elastic Cloud Enterprise (ECE)

License

Notifications You must be signed in to change notification settings

evanfreed/cloud-sdk-go

 
 

Repository files navigation

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.

About

Go client library for Elastic Cloud and Elastic Cloud Enterprise (ECE)

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Go 100.0%