kubernetes

Documentation

Index

• Constants
• type Client
  • func NewClient(addr string, resyncPeriod time.Duration) (Client, error)
• type Pod
  • func NewPod(p *api.Pod) Pod
• type Reporter
  • func NewReporter(client Client) *Reporter
  • func (Reporter) Name() string
  • func (r *Reporter) Report() (report.Report, error)
• type Service
  • func NewService(s *api.Service) Service

Constants

const (
	PodID           = "kubernetes_pod_id"
	PodName         = "kubernetes_pod_name"
	PodCreated      = "kubernetes_pod_created"
	PodContainerIDs = "kubernetes_pod_container_ids"
	ServiceIDs      = "kubernetes_service_ids"
)

These constants are keys used in node metadata

const (
	ServiceID      = "kubernetes_service_id"
	ServiceName    = "kubernetes_service_name"
	ServiceCreated = "kubernetes_service_created"
)

These constants are keys used in node metadata

const (
	Namespace = "kubernetes_namespace"
)

These constants are keys used in node metadata

Types

type Client

type Client interface {
	Stop()
	WalkPods(f func(Pod) error) error
	WalkServices(f func(Service) error) error
}

Client keeps track of running kubernetes pods and services

func NewClient

func NewClient(addr string, resyncPeriod time.Duration) (Client, error)

NewClient returns a usable Client. Don't forget to Stop it.

type Pod

type Pod interface {
	ID() string
	Name() string
	Namespace() string
	ContainerIDs() []string
	Created() string
	AddServiceID(id string)
	Labels() labels.Labels
	GetNode() report.Node
}

Pod represents a Kubernetes pod

func NewPod

func NewPod(p *api.Pod) Pod

NewPod creates a new Pod

type Reporter

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

Reporter generate Reports containing Container and ContainerImage topologies

func NewReporter

func NewReporter(client Client) *Reporter

NewReporter makes a new Reporter

func (Reporter) Name

func (Reporter) Name() string

Name of this reporter, for metrics gathering

func (*Reporter) Report

func (r *Reporter) Report() (report.Report, error)

Report generates a Report containing Container and ContainerImage topologies

type Service

type Service interface {
	ID() string
	Name() string
	Namespace() string
	GetNode() report.Node
	Selector() labels.Selector
}

Service represents a Kubernetes service

func NewService

func NewService(s *api.Service) Service

NewService creates a new Service