kube

Documentation

Index

• Constants
• Variables
• func CreateScheme() *apiruntime.Scheme
• func InClusterConfigClusterName() string
• func RestConfig() (*rest.Config, string, error)
• type ClientGetter
  • func NewDefaultClientGetter(configGetter ConfigGetter, clusterName string, ...) ClientGetter
• type ClusterConfig
• type ConfigGetter
• type DefaultClientGetter
  • func (g *DefaultClientGetter) Client(ctx context.Context) (client.Client, error)
• type DefaultKubeGetter
  • func (g *DefaultKubeGetter) Kube(ctx context.Context) (Kube, error)
• type ImpersonatingConfigGetter
  • func NewImpersonatingConfigGetter(cfg *rest.Config, insecure bool) *ImpersonatingConfigGetter
  • func (r *ImpersonatingConfigGetter) Config(ctx context.Context) *rest.Config
• type Kube
  • func NewKubeHTTPClient() (Kube, client.Client, error)
  • func NewKubeHTTPClientWithConfig(config *rest.Config, contextName string, ...) (Kube, client.Client, error)
• type KubeGetter
  • func NewDefaultKubeGetter(configGetter ConfigGetter, clusterName string) KubeGetter
• type KubeHTTP
  • func (k *KubeHTTP) Apply(ctx context.Context, manifest []byte, namespace string) error
  • func (k *KubeHTTP) GetClusterName(ctx context.Context) (string, error)
  • func (k *KubeHTTP) GetWegoConfig(ctx context.Context, namespace string) (*WegoConfig, error)
  • func (k *KubeHTTP) Raw() client.Client
• type WegoConfig

Constants

const (
	WegoConfigMapName = "weave-gitops-config"
)

Variables

var ErrNamespaceNotFound = errors.New("namespace not found")

var (
	//ErrWegoConfigNotFound indicates weave gitops config could not be found
	ErrWegoConfigNotFound = errors.New("Wego Config not found")
)

var InClusterConfig func() (*rest.Config, error) = func() (*rest.Config, error) {
	return rest.InClusterConfig()
}

InClusterConfig defines a function for checking if this code is executing in kubernetes. This can be overriden if needed.

Functions

func CreateScheme

func CreateScheme() *apiruntime.Scheme

func InClusterConfigClusterName

func InClusterConfigClusterName() string

func RestConfig

func RestConfig() (*rest.Config, string, error)

Types

type ClientGetter

type ClientGetter interface {
	Client(ctx context.Context) (client.Client, error)
}

ClientGetter implementations should create a Kubernetes client from a context.

func NewDefaultClientGetter

func NewDefaultClientGetter(configGetter ConfigGetter, clusterName string, schemeBuilder ...func(*runtime.Scheme) error) ClientGetter

NewDefaultClientGetter creates a new DefaultClientGetter

type ClusterConfig

type ClusterConfig struct {
	DefaultConfig *rest.Config
	ClusterName   string
}

ClusterConfig is used to hold the default *rest.Config and the cluster name.

type ConfigGetter

type ConfigGetter interface {
	Config(ctx context.Context) *rest.Config
}

ConfigGetter implementations should extract the details from a context and create a *rest.Config for use in clients.

type DefaultClientGetter

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

DefaultClientGetter implements the ClientGetter interface and uses a ConfigGetter to get a *rest.Config and create a Kubernetes client.

func (*DefaultClientGetter) Client

func (g *DefaultClientGetter) Client(ctx context.Context) (client.Client, error)

Client creates a new Kubernetes client using the *rest.Config returned from its ConfigGetter.

type DefaultKubeGetter

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

DefaultKubeGetter implements the KubeGetter interface and uses a ConfigGetter to get a *rest.Config and create a Kube client.

func (*DefaultKubeGetter) Kube

func (g *DefaultKubeGetter) Kube(ctx context.Context) (Kube, error)

Kube creates a new Kube client using the *rest.Config returned from its ConfigGetter.

type ImpersonatingConfigGetter

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

ImpersonatingConfigGetter is an implementation of the ConfigGetter interface that returns configs based on a base one. It inspects the context for a principal and if it finds one, it configures the *rest.Config to impersonate that principal. Otherwise it returns a copy of the base config.

func NewImpersonatingConfigGetter

func NewImpersonatingConfigGetter(cfg *rest.Config, insecure bool) *ImpersonatingConfigGetter

NewImpersonatingConfigGetter creates and returns a ConfigGetter with a known config.

func (*ImpersonatingConfigGetter) Config

func (r *ImpersonatingConfigGetter) Config(ctx context.Context) *rest.Config

Config returns a *rest.Config configured to impersonate a user or use the default service account credentials.

type Kube

type Kube interface {
	Apply(ctx context.Context, manifest []byte, namespace string) error
	GetClusterName(ctx context.Context) (string, error)
	GetWegoConfig(ctx context.Context, namespace string) (*WegoConfig, error)
	Raw() client.Client
}

func NewKubeHTTPClient

func NewKubeHTTPClient() (Kube, client.Client, error)

func NewKubeHTTPClientWithConfig

func NewKubeHTTPClientWithConfig(config *rest.Config, contextName string, additionalSchemes ...func(*apiruntime.Scheme) error) (Kube, client.Client, error)

type KubeGetter

type KubeGetter interface {
	Kube(ctx context.Context) (Kube, error)
}

KubeGetter implementations should create a Kube client from a context.

func NewDefaultKubeGetter

func NewDefaultKubeGetter(configGetter ConfigGetter, clusterName string) KubeGetter

NewDefaultKubeGetter creates a new DefaultKubeGetter

type KubeHTTP

type KubeHTTP struct {
	Client      client.Client
	ClusterName string
	DynClient   dynamic.Interface
	RestMapper  meta.RESTMapper
}

This is an alternative implementation of the kube.Kube interface, specifically designed to query the K8s API directly instead of relying on `kubectl` to be present in the PATH.

func (*KubeHTTP) Apply

func (k *KubeHTTP) Apply(ctx context.Context, manifest []byte, namespace string) error

func (*KubeHTTP) GetClusterName

func (k *KubeHTTP) GetClusterName(ctx context.Context) (string, error)

func (*KubeHTTP) GetWegoConfig

func (k *KubeHTTP) GetWegoConfig(ctx context.Context, namespace string) (*WegoConfig, error)

GetWegoConfig fetches the wego config saved in the cluster in a given namespace. If an empty namespace is passed it will search in all namespaces and return the first one it finds.

func (*KubeHTTP) Raw

func (k *KubeHTTP) Raw() client.Client

type WegoConfig

type WegoConfig struct {
	FluxNamespace string
	WegoNamespace string
	ConfigRepo    string
}