kube

Documentation

Index

• Constants
• Variables
• func ConfigWithPrincipal(user *auth.UserPrincipal, config *rest.Config, userPrefixes UserPrefixes) *rest.Config
• func CreateScheme() (*apiruntime.Scheme, error)
• 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 ImpersonatingConfigGetter
  • func NewImpersonatingConfigGetter(cfg *rest.Config, insecure bool, userPrefixes UserPrefixes) *ImpersonatingConfigGetter
  • func (r *ImpersonatingConfigGetter) Config(ctx context.Context) *rest.Config
• type KubeHTTP
  • func NewKubeHTTPClient() (*KubeHTTP, error)
  • func NewKubeHTTPClientWithConfig(config *rest.Config, contextName string, ...) (*KubeHTTP, error)
• type Resource
• type UserPrefixes
• type WegoConfig

Constants

const FluxNamespace = "flux-system"

const WeGOCRDName = "apps.wego.weave.works"

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) = rest.InClusterConfig

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

Functions

func ConfigWithPrincipal

func ConfigWithPrincipal(user *auth.UserPrincipal, config *rest.Config, userPrefixes UserPrefixes) *rest.Config

ConfigWithPrincipal returns a new config with the principal set as the impersonated user or bearer token.

func CreateScheme

func CreateScheme() (*apiruntime.Scheme, error)

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 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, userPrefixes UserPrefixes) *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 KubeHTTP

type KubeHTTP struct {
	client.Client
	ClusterName string
}

This is a wrapper around the client.Client to provide extra information specifically designed to query the K8s API directly instead of relying on `kubectl` to be present in the PATH.

func NewKubeHTTPClient

func NewKubeHTTPClient() (*KubeHTTP, error)

func NewKubeHTTPClientWithConfig

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

type Resource

type Resource interface {
	client.Object
}

type UserPrefixes

type UserPrefixes struct {
	UsernamePrefix string
	GroupsPrefix   string
}

UserPrefixes contains the prefixes for the user and groups that will be used when impersonating a user.

type WegoConfig

type WegoConfig struct {
	FluxNamespace string
	WegoNamespace string
	ConfigRepo    string
}