k8s

Documentation

Index

• Variables
• type Client
  • func NewClient(s *ClientSetup, o *ClientOptions, logger logging.Logger) (c *Client, err error)
• type ClientOptions
• type ClientSetup

Variables

var ErrKubeconfigNotSet = errors.New("kubeconfig is not set")

ErrKubeconfigNotSet represents error when kubeconfig is empty string

Types

type Client

type Client struct {

	// Services that K8S provides
	ConfigMap      *configmap.Client
	Ingress        *ingress.Client
	Namespace      *namespace.Client
	Pods           *pod.Client
	PVC            *persistentvolumeclaim.Client
	Secret         *secret.Client
	ServiceAccount *serviceaccount.Client
	Service        *service.Client
	StatefulSet    *statefulset.Client
	IngressRoute   *ingressroute.Client
	// contains filtered or unexported fields
}

Client manages communication with the Kubernetes

func NewClient

func NewClient(s *ClientSetup, o *ClientOptions, logger logging.Logger) (c *Client, err error)

NewClient returns Kubernetes clientset

type ClientOptions

type ClientOptions struct {
	InCluster      bool
	KubeconfigPath string
}

ClientOptions holds optional parameters for the Client.

type ClientSetup

type ClientSetup struct {
	NewForConfig         func(c *rest.Config) (*kubernetes.Clientset, error)
	InClusterConfig      func() (*rest.Config, error)
	BuildConfigFromFlags func(masterUrl string, kubeconfigPath string) (*rest.Config, error)
	FlagString           func(name string, value string, usage string) *string
	FlagParse            func()
	OsUserHomeDir        func() (string, error)
}

ClientSetup holds functions for configuration of the Client. Functions are extracted for being able to mock them for unit tests.