k8s

Documentation

Overview

Package k8s reports the status of various Kubernetes objects.

Index

• func Provide(cfg hcl.Body, cfgCtx *hcl.EvalContext, nsProbe NamespaceProbe) (model.Prober, error)
• type Config
• type NamespaceProbe

Functions

func Provide

func Provide(cfg hcl.Body, cfgCtx *hcl.EvalContext, nsProbe NamespaceProbe) (model.Prober, error)

Provide creates a Probe from the given configuration and NamespaceProbe

Types

type Config

type Config struct {
	// Kubeconfig is a file path to a kubernetes client configurations file. Defaults to $HOME/.kube/config.
	Kubeconfig string `hcl:"kubeconfig,optional"`
	// Context is the name of the context to probe. Defaults to the current contexxt.
	Context string `hcl:"context,optional"`
	// Namespaces is a list of namespaces to watch. Defaults to all namespaces.
	Namespaces []string `hcl:"namespaces,optional"`
}

Config for the k8s probe that reports on the status of various Kubernetes objects.

type NamespaceProbe

type NamespaceProbe func(context.Context, *kubernetes.Clientset, string) model.Statuses

A NamespaceProbe implements a probe for a given k8s object kind within the provided namespace