api

Documentation

Index

• type AggregateData
  • func (a *AggregateData) Merge(b *AggregateData)
• type Container
  • func NewContainer() *Container
• type ExternalNode
• type ExternalNodeList
• type Pod
• type Source

Types

type AggregateData

type AggregateData struct {
	Pods       []Pod
	Containers []Container
	Machine    []Container
	Events     []kubeapi.Event
}

func (*AggregateData) Merge

func (a *AggregateData) Merge(b *AggregateData)

type Container

type Container struct {
	Hostname string
	Name     string
	// TODO(vishh): Consider defining an internal Spec and Stats API to guard against
	// changes to cadvisor API.
	Spec  cadvisor.ContainerSpec
	Stats []*cadvisor.ContainerStats
}

func NewContainer

func NewContainer() *Container

type ExternalNode

type ExternalNode struct {
	Name string `json:"name,omitempty"`
	IP   string `json:"ip,omitempty"`
}

An external node represents a host which is running cadvisor. Heapster will expect data in this format via its external files API.

type ExternalNodeList

type ExternalNodeList struct {
	Items []ExternalNode `json:"items,omitempty"`
}

ExternalNodeList represents a list of all hosts that are running cadvisor which heapster will monitor.

type Pod

type Pod struct {
	Name      string `json:"name,omitempty"`
	Namespace string `json:"namespace,omitempty"`
	// TODO(vishh): Rename to UID.
	ID             string            `json:"id,omitempty"`
	Hostname       string            `json:"hostname,omitempty"`
	Containers     []Container       `json:"containers"`
	Status         string            `json:"status,omitempty"`
	PodIP          string            `json:"pod_ip,omitempty"`
	Labels         map[string]string `json:"labels,omitempty"`
	HostPublicIP   string            `json:"host_public_ip,omitempty"`
	HostInternalIP string            `json:"host_internal_ip,omitempty"`
}

PodState is the state of a pod, used as either input (desired state) or output (current state)

type Source

type Source interface {
	// GetInfo Fetches information about pods or containers.
	// start, end: Represents the time range for stats
	// resolution: Represents the intervals at which samples are collected.
	// Returns:
	// AggregateData
	GetInfo(start, end time.Time, resolution time.Duration) (AggregateData, error)
	// Returns debug information for the source.
	DebugInfo() string
	// Returns a user friendly string that describes the source.
	Name() string
}

Source represents a plugin that generates data. Each Source needs to implement a Register