api

package

v0.1.1 Latest Latest Go to latest Published: Oct 30, 2019 License: Apache-2.0 Imports: 15 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/lob/pharos

Documentation ¶

Index ¶

type Client
- func ClientFromConfig(configFile string) (*Client, error)
- func NewClient(config *config.Config, generator token.Generator) *Client
type Cluster

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type Client ¶

type Client struct {
	TokenGenerator token.Generator
	// contains filtered or unexported fields
}

Client is a struct containing information for an api client.

func ClientFromConfig ¶

func ClientFromConfig(configFile string) (*Client, error)

ClientFromConfig creates a new Client with its own http.Client using the config file provided and a new token generator that uses AWS's stsAPI.

func NewClient ¶

func NewClient(config *config.Config, generator token.Generator) *Client

NewClient creates a new Client with its own http.Client.

func (*Client) CreateCluster ¶

func (c *Client) CreateCluster(newCluster Cluster) (model.Cluster, error)

CreateCluster sends a POST request to the clusters endpoint of the Pharos API and returns the Cluster that was created.

func (*Client) DeleteCluster ¶

func (c *Client) DeleteCluster(clusterID string) (model.Cluster, error)

DeleteCluster sends a DELETE request to the clusters endpoint of the Pharos API and returns a Cluster containing the deleted cluster.

func (*Client) GetCluster ¶

func (c *Client) GetCluster(clusterID string) (model.Cluster, error)

GetCluster sends a GET request to the clusters/id endpoint of the Pharos API and returns a Cluster.

func (*Client) ListClusters ¶

func (c *Client) ListClusters(query map[string]string) ([]model.Cluster, error)

ListClusters sends a GET request to the clusters endpoint of the Pharos API and returns an array of Clusters. Can also be called with query to retrieve a certain subset of clusters.

func (*Client) UpdateCluster ¶

func (c *Client) UpdateCluster(clusterID string, active bool) (model.Cluster, error)

UpdateCluster sends a POST request to the clusters/id endpoint of the Pharos API and returns a Cluster containing the updated cluster.

type Cluster ¶

type Cluster struct {
	ID                   string `json:"id"`
	Environment          string `json:"environment"`
	ServerURL            string `json:"server_url"`
	ClusterAuthorityData string `json:"cluster_authority_data"`
}

Cluster describes a new cluster to be created in Pharos.

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL