clusters

Documentation

Index

• func NewRouter(clusters *Clusters) chi.Router
• type Clusters
  • func Load(config Config) (*Clusters, error)
  • func (c *Clusters) GetCluster(name string) *cluster.Cluster
• type Config
• type Router

Functions

func NewRouter

func NewRouter(clusters *Clusters) chi.Router

NewRouter return a new router with all the cluster routes.

Types

type Clusters

type Clusters struct {
	Clusters []*cluster.Cluster
}

TODO Clusters contains all fields and methods to interact with the configured Kubernetes clusters. It must implement the Clusters service from the protocol buffers definition.

func Load

func Load(config Config) (*Clusters, error)

Load loads all clusters for the given configuration. The clusters can be retrieved from different providers. Currently we are supporting incluster configuration and kubeconfig files. In the future it is planning to directly support GKE, EKS, AKS, etc.

func (*Clusters) GetCluster

func (c *Clusters) GetCluster(name string) *cluster.Cluster

type Config

type Config struct {
	Providers []provider.Config `json:"providers"`
}

Config is the configuration required to load all clusters. It takes an array of providers, which are defined in the providers package.

type Router

type Router struct {
	*chi.Mux
	// contains filtered or unexported fields
}

Router implements the router for the clusters package. The router provides all standard methods to interact with the Kubernetes API of a cluster.