v1alpha2

Documentation

Overview

Package v1alpha2 is the v1alpha2 version of the API.

Index

• Variables
• func Kind(kind string) schema.GroupKind
• func Resource(resource string) schema.GroupResource
• type AttributeInfo
  • func (in *AttributeInfo) DeepCopy() *AttributeInfo
  • func (in *AttributeInfo) DeepCopyInto(out *AttributeInfo)
• type AttributeList
  • func (in AttributeList) DeepCopy() AttributeList
  • func (in AttributeList) DeepCopyInto(out *AttributeList)
• type CostInfo
  • func (in *CostInfo) DeepCopy() *CostInfo
  • func (in *CostInfo) DeepCopyInto(out *CostInfo)
• type CostList
  • func (in CostList) DeepCopy() CostList
  • func (in CostList) DeepCopyInto(out *CostList)
• type NodeResourceTopology
  • func (in *NodeResourceTopology) DeepCopy() *NodeResourceTopology
  • func (in *NodeResourceTopology) DeepCopyInto(out *NodeResourceTopology)
  • func (in *NodeResourceTopology) DeepCopyObject() runtime.Object
• type NodeResourceTopologyList
  • func (in *NodeResourceTopologyList) DeepCopy() *NodeResourceTopologyList
  • func (in *NodeResourceTopologyList) DeepCopyInto(out *NodeResourceTopologyList)
  • func (in *NodeResourceTopologyList) DeepCopyObject() runtime.Object
• type ResourceInfo
  • func (in *ResourceInfo) DeepCopy() *ResourceInfo
  • func (in *ResourceInfo) DeepCopyInto(out *ResourceInfo)
• type ResourceInfoList
  • func (in ResourceInfoList) DeepCopy() ResourceInfoList
  • func (in ResourceInfoList) DeepCopyInto(out *ResourceInfoList)
• type TopologyManagerPolicy
• type Zone
  • func (in *Zone) DeepCopy() *Zone
  • func (in *Zone) DeepCopyInto(out *Zone)
• type ZoneList
  • func (in ZoneList) DeepCopy() ZoneList
  • func (in ZoneList) DeepCopyInto(out *ZoneList)

Variables

var (
	// SchemeBuilder initializes a scheme builder
	SchemeBuilder = runtime.NewSchemeBuilder(addKnownTypes)
	// AddToScheme is a global function that registers this API group & version to a scheme
	AddToScheme = SchemeBuilder.AddToScheme
)

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

SchemeGroupVersion is group version used to register these objects

Functions

func Kind

func Kind(kind string) schema.GroupKind

Kind takes an unqualified kind and returns back a Group qualified GroupKind

func Resource

func Resource(resource string) schema.GroupResource

Resource takes an unqualified resource and returns a Group qualified GroupResource

Types

type AttributeInfo

type AttributeInfo struct {
	Name  string `json:"name" protobuf:"bytes,1,opt,name=name"`
	Value string `json:"value" protobuf:"bytes,2,opt,name=value"`
}

AttributeInfo contains one attribute of a Zone. +protobuf=true

func (*AttributeInfo) DeepCopy

func (in *AttributeInfo) DeepCopy() *AttributeInfo

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new AttributeInfo.

func (*AttributeInfo) DeepCopyInto

func (in *AttributeInfo) DeepCopyInto(out *AttributeInfo)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type AttributeList

type AttributeList []AttributeInfo

AttributeList contains an array of AttributeInfo objects. +protobuf=true

func (AttributeList) DeepCopy

func (in AttributeList) DeepCopy() AttributeList

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new AttributeList.

func (AttributeList) DeepCopyInto

func (in AttributeList) DeepCopyInto(out *AttributeList)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type CostInfo

type CostInfo struct {
	Name  string `json:"name" protobuf:"bytes,1,opt,name=name"`
	Value int64  `json:"value" protobuf:"varint,2,opt,name=value"`
}

CostInfo describes the cost (or distance) between two Zones. +protobuf=true

func (*CostInfo) DeepCopy

func (in *CostInfo) DeepCopy() *CostInfo

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new CostInfo.

func (*CostInfo) DeepCopyInto

func (in *CostInfo) DeepCopyInto(out *CostInfo)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type CostList

type CostList []CostInfo

CostList contains an array of CostInfo objects. +protobuf=true

func (CostList) DeepCopy

func (in CostList) DeepCopy() CostList

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new CostList.

func (CostList) DeepCopyInto

func (in CostList) DeepCopyInto(out *CostList)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type NodeResourceTopology

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

	// DEPRECATED (to be removed in v1beta1): use top level attributes if needed
	TopologyPolicies []string `json:"topologyPolicies,omitempty"`

	Zones      ZoneList      `json:"zones"`
	Attributes AttributeList `json:"attributes,omitempty"`
}

NodeResourceTopology describes node resources and their topology.

func (*NodeResourceTopology) DeepCopy

func (in *NodeResourceTopology) DeepCopy() *NodeResourceTopology

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new NodeResourceTopology.

func (*NodeResourceTopology) DeepCopyInto

func (in *NodeResourceTopology) DeepCopyInto(out *NodeResourceTopology)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*NodeResourceTopology) DeepCopyObject

func (in *NodeResourceTopology) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

type NodeResourceTopologyList

type NodeResourceTopologyList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata"`

	Items []NodeResourceTopology `json:"items"`
}

NodeResourceTopologyList is a list of NodeResourceTopology resources

func (*NodeResourceTopologyList) DeepCopy

func (in *NodeResourceTopologyList) DeepCopy() *NodeResourceTopologyList

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new NodeResourceTopologyList.

func (*NodeResourceTopologyList) DeepCopyInto

func (in *NodeResourceTopologyList) DeepCopyInto(out *NodeResourceTopologyList)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*NodeResourceTopologyList) DeepCopyObject

func (in *NodeResourceTopologyList) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

type ResourceInfo

type ResourceInfo struct {
	// Name of the resource.
	Name string `json:"name" protobuf:"bytes,1,opt,name=name"`
	// Capacity of the resource, corresponding to capacity in node status, i.e.
	// total amount of this resource that the node has.
	Capacity resource.Quantity `json:"capacity" protobuf:"bytes,2,opt,name=capacity"`
	// Allocatable quantity of the resource, corresponding to allocatable in
	// node status, i.e. total amount of this resource available to be used by
	// pods.
	Allocatable resource.Quantity `json:"allocatable" protobuf:"bytes,3,opt,name=allocatable"`
	// Available is the amount of this resource currently available for new (to
	// be scheduled) pods, i.e. Allocatable minus the resources reserved by
	// currently running pods.
	Available resource.Quantity `json:"available" protobuf:"bytes,4,opt,name=available"`
}

ResourceInfo contains information about one resource type. +protobuf=true

func (*ResourceInfo) DeepCopy

func (in *ResourceInfo) DeepCopy() *ResourceInfo

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ResourceInfo.

func (*ResourceInfo) DeepCopyInto

func (in *ResourceInfo) DeepCopyInto(out *ResourceInfo)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type ResourceInfoList

type ResourceInfoList []ResourceInfo

ResourceInfoList contains an array of ResourceInfo objects. +protobuf=true

func (ResourceInfoList) DeepCopy

func (in ResourceInfoList) DeepCopy() ResourceInfoList

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ResourceInfoList.

func (ResourceInfoList) DeepCopyInto

func (in ResourceInfoList) DeepCopyInto(out *ResourceInfoList)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type TopologyManagerPolicy

type TopologyManagerPolicy string

DEPRECATED (to be removed in v1beta1): use top level attributes if needed

const (
	// Constants of type TopologyManagerPolicy represent policy of the worker
	// node's resource management component. It's TopologyManager in kubelet.
	// DEPRECATED (to be removed in v1beta1): use top level attributes if needed
	// SingleNUMANodeContainerLevel represent single-numa-node policy of
	// the TopologyManager
	SingleNUMANodeContainerLevel TopologyManagerPolicy = "SingleNUMANodeContainerLevel"
	// SingleNUMANodePodLevel enables pod level resource counting, this policy assumes
	// TopologyManager policy single-numa-node also was set on the node
	SingleNUMANodePodLevel TopologyManagerPolicy = "SingleNUMANodePodLevel"
	// Restricted TopologyManager policy was set on the node
	Restricted TopologyManagerPolicy = "Restricted"
	// RestrictedContainerLevel TopologyManager policy was set on the node and TopologyManagerScope was set to pod
	RestrictedContainerLevel TopologyManagerPolicy = "RestrictedContainerLevel"
	// RestrictedPodLevel TopologyManager policy was set on the node and TopologyManagerScope was set to pod
	RestrictedPodLevel TopologyManagerPolicy = "RestrictedPodLevel"
	// BestEffort TopologyManager policy was set on the node
	BestEffort TopologyManagerPolicy = "BestEffort"
	// BestEffort TopologyManager policy was set on the node and TopologyManagerScope was set to container
	BestEffortContainerLevel TopologyManagerPolicy = "BestEffortContainerLevel"
	// BestEffort TopologyManager policy was set on the node and TopologyManagerScope was set to pod
	BestEffortPodLevel TopologyManagerPolicy = "BestEffortPodLevel"
	// None policy is the default policy and does not perform any topology alignment.
	None TopologyManagerPolicy = "None"
)

type Zone

type Zone struct {
	Name       string           `json:"name" protobuf:"bytes,1,opt,name=name"`
	Type       string           `json:"type" protobuf:"bytes,2,opt,name=type"`
	Parent     string           `json:"parent,omitempty" protobuf:"bytes,3,opt,name=parent"`
	Costs      CostList         `json:"costs,omitempty" protobuf:"bytes,4,rep,name=costs"`
	Attributes AttributeList    `json:"attributes,omitempty" protobuf:"bytes,5,rep,name=attributes"`
	Resources  ResourceInfoList `json:"resources,omitempty" protobuf:"bytes,6,rep,name=resources"`
}

Zone represents a resource topology zone, e.g. socket, node, die or core. +protobuf=true

func (*Zone) DeepCopy

func (in *Zone) DeepCopy() *Zone

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Zone.

func (*Zone) DeepCopyInto

func (in *Zone) DeepCopyInto(out *Zone)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type ZoneList

type ZoneList []Zone

ZoneList contains an array of Zone objects. +protobuf=true

func (ZoneList) DeepCopy

func (in ZoneList) DeepCopy() ZoneList

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ZoneList.

func (ZoneList) DeepCopyInto

func (in ZoneList) DeepCopyInto(out *ZoneList)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.