clustersmngr

Documentation

Index

• Constants
• func WithClustersClient(clustersFetcher ClusterFetcher, next http.Handler) http.Handler
• type Client
  • func ClientFromCtx(ctx context.Context) Client
  • func NewClient(clientsPool ClientsPool) Client
• type ClientsPool
  • func NewClustersClientsPool() ClientsPool
• type Cluster
• type ClusterClient
• type ClusterClientConfig
  • func ClientConfigWithUser(user *auth.UserPrincipal) ClusterClientConfig
• type ClusterFetcher
• type ClusterNotFoundError
  • func (e ClusterNotFoundError) Error() string
• type ClusteredList
  • func (cl *ClusteredList) Lists() map[string]client.ObjectList
  • func (cl *ClusteredList) ObjectList(cluster string) client.ObjectList
• type ClusteredObjectList
  • func NewClusteredList(listFactory func() client.ObjectList) ClusteredObjectList

Constants

const (
	// Clusters Client context key
	ClustersClientCtxKey key = iota
	DefaultCluster           = "Default"
)

Functions

func WithClustersClient

func WithClustersClient(clustersFetcher ClusterFetcher, next http.Handler) http.Handler

WithClustersClient creates clusters client for provided user in the context

Types

type Client

type Client interface {
	// Get retrieves an obj for the given object key.
	Get(ctx context.Context, cluster string, key client.ObjectKey, obj client.Object) error
	// List retrieves list of objects for a given namespace and list options.
	List(ctx context.Context, cluster string, list client.ObjectList, opts ...client.ListOption) error

	// Create saves the object obj.
	Create(ctx context.Context, cluster string, obj client.Object, opts ...client.CreateOption) error
	// Delete deletes the given obj
	Delete(ctx context.Context, cluster string, obj client.Object, opts ...client.DeleteOption) error
	// Update updates the given obj.
	Update(ctx context.Context, cluster string, obj client.Object, opts ...client.UpdateOption) error
	// Patch patches the given obj
	Patch(ctx context.Context, cluster string, obj client.Object, patch client.Patch, opts ...client.PatchOption) error

	// ClusteredList retrieves list of objects for all clusters.
	ClusteredList(ctx context.Context, clist ClusteredObjectList, opts ...client.ListOption) error

	// ClientsPool returns the clients pool.
	ClientsPool() ClientsPool

	// RestConfig returns a rest.Config for a given cluster
	RestConfig(cluster string) (*rest.Config, error)

	// Scoped returns a client that is scoped to a single cluster
	Scoped(cluster string) (client.Client, error)
}

Client thin wrapper to controller-runtime/client adding multi clusters context.

func ClientFromCtx

func ClientFromCtx(ctx context.Context) Client

ClientFromCtx returns the ClusterClient stored in the context

func NewClient

func NewClient(clientsPool ClientsPool) Client

type ClientsPool

type ClientsPool interface {
	Add(cfg ClusterClientConfig, cluster Cluster) error
	Clients() map[string]ClusterClient
	Client(cluster string) (ClusterClient, error)
}

ClientsPool stores all clients to the leaf clusters

func NewClustersClientsPool

func NewClustersClientsPool() ClientsPool

NewClustersClientsPool initializes a new ClientsPool

type Cluster

type Cluster struct {
	// Name defines the cluster name
	Name string `yaml:"name"`
	// Server defines cluster api address
	Server string `yaml:"server"`

	// SecretRef defines secret name that holds the cluster Bearer Token
	SecretRef string `yaml:"secretRef"`
	// BearerToken cluster access token read from SecretRef
	BearerToken string

	// TLSConfig holds configuration for TLS connection with the cluster values read from SecretRef
	TLSConfig rest.TLSClientConfig
}

Cluster defines a leaf cluster

type ClusterClient

type ClusterClient interface {
	client.Client
	RestConfig() *rest.Config
}

type ClusterClientConfig

type ClusterClientConfig func(Cluster) *rest.Config

func ClientConfigWithUser

func ClientConfigWithUser(user *auth.UserPrincipal) ClusterClientConfig

type ClusterFetcher

type ClusterFetcher interface {
	Fetch(ctx context.Context) ([]Cluster, error)
}

ClusterFetcher fetches all leaf clusters

type ClusterNotFoundError

type ClusterNotFoundError struct {
	Cluster string
}

ClusterNotFoundError cluster client can be found in the pool

func (ClusterNotFoundError) Error

func (e ClusterNotFoundError) Error() string

type ClusteredList

type ClusteredList struct {
	sync.Mutex
	// contains filtered or unexported fields
}

func (*ClusteredList) Lists

func (cl *ClusteredList) Lists() map[string]client.ObjectList

func (*ClusteredList) ObjectList

func (cl *ClusteredList) ObjectList(cluster string) client.ObjectList

type ClusteredObjectList

type ClusteredObjectList interface {
	ObjectList(cluster string) client.ObjectList
	Lists() map[string]client.ObjectList
}

func NewClusteredList

func NewClusteredList(listFactory func() client.ObjectList) ClusteredObjectList