kubernetes

Documentation

Overview

Package kubernetes provides access to the Kubernetes API

Package kubernetes provides access to the Kubernetes API

Index

• type Client
  • func NewClient() Client
• type ClientConfig
  • func (c ClientConfig) GetEndpoints(service string, namespace string) (*v1.Endpoints, error)
• type EndpointsController
  • func NewEndpointsController(client Client) *EndpointsController
  • func (e EndpointsController) GetEndpoints(service string, namespace string) (*v1.Endpoints, error)

Types

type Client

type Client interface {
	GetEndpoints(service string, namespace string) (*v1.Endpoints, error)
}

Client interface that allows us to mock calls to the Kubernetes API

func NewClient

func NewClient() Client

NewClient initiates connection to the kubernetes API See https://github.com/kubernetes/client-go/blob/master/examples/in-cluster/main.go

type ClientConfig

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

ClientConfig holds the kubernetes session for when communicating with the kubernetes API

func (ClientConfig) GetEndpoints

func (c ClientConfig) GetEndpoints(service string, namespace string) (*v1.Endpoints, error)

GetEndpoints gets the endpoints from the kubernetes API See https://github.com/kubernetes/client-go

type EndpointsController

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

EndpointsController provides access to the kubernetes endpoints functions

func NewEndpointsController

func NewEndpointsController(client Client) *EndpointsController

NewEndpointsController stores our real or mocked kubernetes client object

func (EndpointsController) GetEndpoints

func (e EndpointsController) GetEndpoints(service string, namespace string) (*v1.Endpoints, error)

GetEndpoints is a wrapper function around the kubernetes client. If there is any manipulation or filtering of the kubernetes types or data, it should be done here.