atlas

Documentation

Index

• Variables
• type Client
• type HTTPClient
  • func NewClient(baseURL string, groupID string, publicKey string, privateKey string) *HTTPClient
  • func (c *HTTPClient) GetProvider(name string) (*Provider, error)
• type InstanceSize
• type Provider

Variables

var (
	ErrUnauthorized = errors.New("invalid API key")
)

Different errors the api may return.

Types

type Client

type Client interface {
	GetProvider(name string) (*Provider, error)
}

Client is an interface for interacting with the Atlas API.

type HTTPClient

type HTTPClient struct {
	BaseURL string
	HTTP    *http.Client
}

HTTPClient is the main implementation of the Client interface which communicates with the Atlas API.

func NewClient

func NewClient(baseURL string, groupID string, publicKey string, privateKey string) *HTTPClient

NewClient will create a new HTTPClient with the specified connection details.

func (*HTTPClient) GetProvider

func (c *HTTPClient) GetProvider(name string) (*Provider, error)

GetProvider will find a provider by name using the private API. GET /cloudProviders/{NAME}/options

type InstanceSize

type InstanceSize struct {
	Name string `json:"name"`
}

InstanceSize represents an available cluster size.

type Provider

type Provider struct {
	Name          string `json:"@provider"`
	InstanceSizes map[string]InstanceSize
}

Provider represents a single cloud provider to which a cluster can be deployed.