kube

Documentation

Index

• Constants
• Variables
• func CreateScheme() *apiruntime.Scheme
• func IsClusterReady(l logger.Logger, k Kube) error
• func RestConfig() (*rest.Config, string, error)
• type ClusterStatus
  • func (cs ClusterStatus) String() string
• type Kube
  • func NewKubeHTTPClient() (Kube, client.Client, error)
  • func NewKubeHTTPClientWithConfig(config *rest.Config, contextName string) (Kube, client.Client, error)
• type KubeHTTP
  • func (k *KubeHTTP) Apply(ctx context.Context, manifest []byte, namespace string) error
  • func (k *KubeHTTP) Delete(ctx context.Context, manifest []byte) error
  • func (c *KubeHTTP) DeleteByName(ctx context.Context, name string, gvr schema.GroupVersionResource, ...) error
  • func (k *KubeHTTP) FetchNamespaceWithLabel(ctx context.Context, key string, value string) (*corev1.Namespace, error)
  • func (k *KubeHTTP) FluxPresent(ctx context.Context) (bool, error)
  • func (k *KubeHTTP) GetApplication(ctx context.Context, name types.NamespacedName) (*wego.Application, error)
  • func (k *KubeHTTP) GetApplications(ctx context.Context, namespace string) ([]wego.Application, error)
  • func (k *KubeHTTP) GetClusterName(ctx context.Context) (string, error)
  • func (k *KubeHTTP) GetClusterStatus(ctx context.Context) ClusterStatus
  • func (k *KubeHTTP) GetResource(ctx context.Context, name types.NamespacedName, resource Resource) error
  • func (k KubeHTTP) GetSecret(ctx context.Context, name types.NamespacedName) (*corev1.Secret, error)
  • func (k *KubeHTTP) GetWegoConfig(ctx context.Context, namespace string) (*WegoConfig, error)
  • func (k *KubeHTTP) NamespacePresent(ctx context.Context, namespace string) (bool, error)
  • func (k *KubeHTTP) Raw() client.Client
  • func (k *KubeHTTP) SecretPresent(ctx context.Context, secretName string, namespace string) (bool, error)
  • func (k *KubeHTTP) SetResource(ctx context.Context, resource Resource) error
  • func (k *KubeHTTP) SetWegoConfig(ctx context.Context, config WegoConfig, namespace string) (*corev1.ConfigMap, error)
• type Resource
• type WegoConfig

Constants

const FluxNamespace = "flux-system"

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

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

Variables

var (
	GVRSecret         schema.GroupVersionResource = corev1.SchemeGroupVersion.WithResource("secrets")
	GVRApp            schema.GroupVersionResource = wego.GroupVersion.WithResource("apps")
	GVRKustomization  schema.GroupVersionResource = kustomizev2.GroupVersion.WithResource("kustomizations")
	GVRGitRepository  schema.GroupVersionResource = sourcev1.GroupVersion.WithResource("gitrepositories")
	GVRHelmRepository schema.GroupVersionResource = sourcev1.GroupVersion.WithResource("helmrepositories")
	GVRHelmRelease    schema.GroupVersionResource = helmv2.GroupVersion.WithResource("helmreleases")
)

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 IsClusterReady

func IsClusterReady(l logger.Logger, k Kube) error

func RestConfig

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

Types

type ClusterStatus

type ClusterStatus int

const (
	Unknown ClusterStatus = iota
	Unmodified
	FluxInstalled
	GitOpsInstalled
)

func (ClusterStatus) String

func (cs ClusterStatus) String() string

Function to translate ClusterStatus to a string

type Kube

type Kube interface {
	Apply(ctx context.Context, manifest []byte, namespace string) error
	Delete(ctx context.Context, manifest []byte) error
	DeleteByName(ctx context.Context, name string, gvr schema.GroupVersionResource, namespace string) error
	SecretPresent(ctx context.Context, string, namespace string) (bool, error)
	GetApplications(ctx context.Context, namespace string) ([]wego.Application, error)
	FluxPresent(ctx context.Context) (bool, error)
	NamespacePresent(ctx context.Context, namespace string) (bool, error)
	GetClusterName(ctx context.Context) (string, error)
	GetClusterStatus(ctx context.Context) ClusterStatus
	GetApplication(ctx context.Context, name types.NamespacedName) (*wego.Application, error)
	GetResource(ctx context.Context, name types.NamespacedName, resource Resource) error
	SetResource(ctx context.Context, resource Resource) error
	GetSecret(ctx context.Context, name types.NamespacedName) (*corev1.Secret, error)
	FetchNamespaceWithLabel(ctx context.Context, key string, value string) (*corev1.Namespace, error)
	SetWegoConfig(ctx context.Context, config WegoConfig, namespace string) (*corev1.ConfigMap, 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) (Kube, client.Client, error)

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) Delete

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

func (*KubeHTTP) DeleteByName

func (c *KubeHTTP) DeleteByName(ctx context.Context, name string, gvr schema.GroupVersionResource, namespace string) error

func (*KubeHTTP) FetchNamespaceWithLabel

func (k *KubeHTTP) FetchNamespaceWithLabel(ctx context.Context, key string, value string) (*corev1.Namespace, error)

FetchNamespaceWithLabel fetches a namespace where a label follows key=value

func (*KubeHTTP) FluxPresent

func (k *KubeHTTP) FluxPresent(ctx context.Context) (bool, error)

func (*KubeHTTP) GetApplication

func (k *KubeHTTP) GetApplication(ctx context.Context, name types.NamespacedName) (*wego.Application, error)

func (*KubeHTTP) GetApplications

func (k *KubeHTTP) GetApplications(ctx context.Context, namespace string) ([]wego.Application, error)

func (*KubeHTTP) GetClusterName

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

func (*KubeHTTP) GetClusterStatus

func (k *KubeHTTP) GetClusterStatus(ctx context.Context) ClusterStatus

func (*KubeHTTP) GetResource

func (k *KubeHTTP) GetResource(ctx context.Context, name types.NamespacedName, resource Resource) error

func (KubeHTTP) GetSecret

func (k KubeHTTP) GetSecret(ctx context.Context, name types.NamespacedName) (*corev1.Secret, 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) NamespacePresent

func (k *KubeHTTP) NamespacePresent(ctx context.Context, namespace string) (bool, error)

func (*KubeHTTP) Raw

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

func (*KubeHTTP) SecretPresent

func (k *KubeHTTP) SecretPresent(ctx context.Context, secretName string, namespace string) (bool, error)

func (*KubeHTTP) SetResource

func (k *KubeHTTP) SetResource(ctx context.Context, resource Resource) error

func (*KubeHTTP) SetWegoConfig

func (k *KubeHTTP) SetWegoConfig(ctx context.Context, config WegoConfig, namespace string) (*corev1.ConfigMap, error)

type Resource

type Resource interface {
	client.Object
}

type WegoConfig

type WegoConfig struct {
	FluxNamespace string
	WegoNamespace string
}