clusters

Documentation

Index

• func NewRouter(clustersClient Client) chi.Router
• type Client
  • func NewClient(config Config) (Client, error)
• type Config
• type MockClient
  • func (_m *MockClient) GetCluster(name string) cluster.Client
  • func (_m *MockClient) GetClusters() []cluster.Client
• type Router

Functions

func NewRouter

func NewRouter(clustersClient Client) chi.Router

NewRouter return a new router with all the cluster routes.

Types

type Client

type Client interface {
	GetClusters() []cluster.Client
	GetCluster(name string) cluster.Client
}

Client is the interface with all the methods to interact with all loaded Kubernetes clusters.

func NewClient

func NewClient(config Config) (Client, error)

NewClient 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.

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 MockClient

type MockClient struct {
	mock.Mock
}

MockClient is an autogenerated mock type for the Client type

func (*MockClient) GetCluster

func (_m *MockClient) GetCluster(name string) cluster.Client

GetCluster provides a mock function with given fields: name

func (*MockClient) GetClusters

func (_m *MockClient) GetClusters() []cluster.Client

GetClusters provides a mock function with given fields:

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.