v1alpha1

Documentation

Index

• Constants
• Variables
• func Resource(resource string) schema.GroupResource
• type ContainerMetrics
• type NodeMetrics
• type NodeMetricsList
• type PodMetrics
• type PodMetricsList

Constants

const GroupName = "metrics"

GroupName is the group name use in this package

Variables

var (
	SchemeBuilder = runtime.NewSchemeBuilder(addKnownTypes)
	AddToScheme   = SchemeBuilder.AddToScheme
)

var SchemeGroupVersion = schema.GroupVersion{Group: GroupName, Version: "v1alpha1"}

SchemeGroupVersion is group version used to register these objects

Functions

func Resource

func Resource(resource string) schema.GroupResource

Resource takes an unqualified resource and returns a Group qualified GroupResource

Types

type ContainerMetrics

type ContainerMetrics struct {
	// Container name corresponding to the one from pod.spec.containers.
	Name string `json:"name"`
	// The memory usage is the memory working set.
	Usage v1.ResourceList `json:"usage"`
}

resource usage metrics of a container.

type NodeMetrics

type NodeMetrics struct {
	metav1.TypeMeta `json:",inline"`
	v1.ObjectMeta   `json:"metadata,omitempty"`

	// The following fields define time interval from which metrics were
	// collected from the interval [Timestamp-Window, Timestamp].
	Timestamp metav1.Time     `json:"timestamp"`
	Window    metav1.Duration `json:"window"`

	// The memory usage is the memory working set.
	Usage v1.ResourceList `json:"usage"`
}

resource usage metrics of a node.

type NodeMetricsList

type NodeMetricsList struct {
	metav1.TypeMeta `json:",inline"`
	// Standard list metadata.
	// More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds
	metav1.ListMeta `json:"metadata,omitempty"`

	// List of node metrics.
	Items []NodeMetrics `json:"items"`
}

NodeMetricsList is a list of NodeMetrics.

type PodMetrics

type PodMetrics struct {
	metav1.TypeMeta `json:",inline"`
	v1.ObjectMeta   `json:"metadata,omitempty"`

	// The following fields define time interval from which metrics were
	// collected from the interval [Timestamp-Window, Timestamp].
	Timestamp metav1.Time     `json:"timestamp"`
	Window    metav1.Duration `json:"window"`

	// Metrics for all containers are collected within the same time window.
	Containers []ContainerMetrics `json:"containers"`
}

resource usage metrics of a pod.

type PodMetricsList

type PodMetricsList struct {
	metav1.TypeMeta `json:",inline"`
	// Standard list metadata.
	// More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds
	metav1.ListMeta `json:"metadata,omitempty"`

	// List of pod metrics.
	Items []PodMetrics `json:"items"`
}

PodMetricsList is a list of PodMetrics.