sherlock

Documentation

Index

• type Client
  • func New(config config.Config, iapToken string) (*Client, error)
  • func NewWithHostnameOverride(addr, iapToken string) (*Client, error)
  • func (c *Client) ClusterReleases(clusterName string) (Releases, error)
  • func (c *Client) Clusters() (Clusters, error)
  • func (c *Client) EnvironmentReleases(environmentName string) (Releases, error)
  • func (c *Client) Environments() (Environments, error)
  • func (s *Client) WriteClusters(cls []terra.Cluster) error
  • func (s *Client) WriteEnvironments(envs []terra.Environment) error
• type Cluster
• type Clusters
• type Environment
• type Environments
• type Release
  • func (r *Release) HelmfileRefOrDefault(def string) string
• type Releases
• type StateLoader

Types

type Client

type Client struct {
	// contains filtered or unexported fields
}

Client contains an API client for a remote sherlock server

func New

func New(config config.Config, iapToken string) (*Client, error)

New configures a new Client instance which confers the ability to issue requests against the API of a sherlock server

func NewWithHostnameOverride

func NewWithHostnameOverride(addr, iapToken string) (*Client, error)

NewWithHostNameOverride enables thelma commands to utilize a sherlock client that targets a different sherlock instance from the one used for state loading

func (*Client) ClusterReleases

func (c *Client) ClusterReleases(clusterName string) (Releases, error)

func (*Client) Clusters

func (c *Client) Clusters() (Clusters, error)

func (*Client) EnvironmentReleases

func (c *Client) EnvironmentReleases(environmentName string) (Releases, error)

func (*Client) Environments

func (c *Client) Environments() (Environments, error)

func (*Client) WriteClusters

func (s *Client) WriteClusters(cls []terra.Cluster) error

WriteClusters will take a list of terra.Cluster interfaces them and issue POST requests to create both the cluster and any releases within that cluster. 409 Conflict responses are ignored

func (*Client) WriteEnvironments

func (s *Client) WriteEnvironments(envs []terra.Environment) error

WriteEnvironments will take a list of terra.Environment interfaces them and issue POST requests to write both the environment and any releases within that environment. 409 Conflict responses are ignored

type Cluster

type Cluster struct {
	*models.V2controllersCluster
}

type Clusters

type Clusters []Cluster

type Environment

type Environment struct {
	*models.V2controllersEnvironment
}

type Environments

type Environments []Environment

type Release

type Release struct {
	*models.V2controllersChartRelease
}

func (*Release) HelmfileRefOrDefault

func (r *Release) HelmfileRefOrDefault(def string) string

type Releases

type Releases []Release

type StateLoader

type StateLoader interface {
	Environments() (Environments, error)
	Clusters() (Clusters, error)
	ClusterReleases(clusterName string) (Releases, error)
	EnvironmentReleases(environmentName string) (Releases, error)
}