v1alpha1

Documentation

Overview

Package v1alpha1 contains API Schema definitions for the analysis v1alpha1 API group +kubebuilder:object:generate=true +groupName=analysis.koordinator.sh

Index

• Constants
• Variables
• func Resource(resource string) schema.GroupResource
• type CrossVersionObjectReference
  • func (in *CrossVersionObjectReference) DeepCopy() *CrossVersionObjectReference
  • func (in *CrossVersionObjectReference) DeepCopyInto(out *CrossVersionObjectReference)
• type Recommendation
  • func (in *Recommendation) DeepCopy() *Recommendation
  • func (in *Recommendation) DeepCopyInto(out *Recommendation)
  • func (in *Recommendation) DeepCopyObject() runtime.Object
• type RecommendationList
  • func (in *RecommendationList) DeepCopy() *RecommendationList
  • func (in *RecommendationList) DeepCopyInto(out *RecommendationList)
  • func (in *RecommendationList) DeepCopyObject() runtime.Object
• type RecommendationSpec
  • func (in *RecommendationSpec) DeepCopy() *RecommendationSpec
  • func (in *RecommendationSpec) DeepCopyInto(out *RecommendationSpec)
• type RecommendationStatus
  • func (in *RecommendationStatus) DeepCopy() *RecommendationStatus
  • func (in *RecommendationStatus) DeepCopyInto(out *RecommendationStatus)
• type RecommendationTarget
  • func (in *RecommendationTarget) DeepCopy() *RecommendationTarget
  • func (in *RecommendationTarget) DeepCopyInto(out *RecommendationTarget)
• type RecommendationTargetType
• type RecommendedContainerStatus
  • func (in *RecommendedContainerStatus) DeepCopy() *RecommendedContainerStatus
  • func (in *RecommendedContainerStatus) DeepCopyInto(out *RecommendedContainerStatus)
• type RecommendedPodStatus
  • func (in *RecommendedPodStatus) DeepCopy() *RecommendedPodStatus
  • func (in *RecommendedPodStatus) DeepCopyInto(out *RecommendedPodStatus)

Constants

const (
	// LowConfidenceCondition indicates the low confidence for the current forecasting result.
	LowConfidenceCondition string = "LowConfidence"
	// NoObjectsMatchedCondition indicates that the current description didn't match any objects.
	NoObjectsMatchedCondition string = "NoObjectsMatched"
	// FetchingHistoryCondition indicates that forecaster is in the process of loading additional
	// history samples.
	FetchingHistoryCondition string = "FetchingHistory"
	// ConfigDeprecatedCondition indicates that this configuration is deprecated and will stop being
	// supported soon.
	ConfigDeprecatedCondition string = "ConfigDeprecated"
	// ConfigUnsupportedCondition indicates that this configuration is unsupported and will not be provided for it.
	ConfigUnsupportedCondition string = "ConfigUnsupported"
)

Variables

var (
	// GroupVersion is group version used to register these objects
	GroupVersion = schema.GroupVersion{Group: "analysis.koordinator.sh", Version: "v1alpha1"}

	SchemeGroupVersion = GroupVersion

	// SchemeBuilder is used to add go types to the GroupVersionKind scheme
	SchemeBuilder = &scheme.Builder{GroupVersion: GroupVersion}

	// AddToScheme adds the types in this group-version to the given scheme.
	AddToScheme = SchemeBuilder.AddToScheme
)

Functions

func Resource

func Resource(resource string) schema.GroupResource

Resource is required by pkg/client/listers/...

Types

type CrossVersionObjectReference

type CrossVersionObjectReference struct {
	// Kind of the referent; More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds"
	Kind string `json:"kind"`
	// Name of the referent; More info: http://kubernetes.io/docs/user-guide/identifiers#names
	Name string `json:"name"`
	// API version of the referent
	APIVersion string `json:"apiVersion,omitempty"`
}

CrossVersionObjectReference contains enough information to let you identify the referred resource.

func (*CrossVersionObjectReference) DeepCopy

func (in *CrossVersionObjectReference) DeepCopy() *CrossVersionObjectReference

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

func (*CrossVersionObjectReference) DeepCopyInto

func (in *CrossVersionObjectReference) DeepCopyInto(out *CrossVersionObjectReference)

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

type Recommendation

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

	Spec   RecommendationSpec   `json:"spec,omitempty"`
	Status RecommendationStatus `json:"status,omitempty"`
}

Recommendation is the Schema for the recommendations API

func (*Recommendation) DeepCopy

func (in *Recommendation) DeepCopy() *Recommendation

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

func (*Recommendation) DeepCopyInto

func (in *Recommendation) DeepCopyInto(out *Recommendation)

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

func (*Recommendation) DeepCopyObject

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

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

type RecommendationList

type RecommendationList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata,omitempty"`
	Items           []Recommendation `json:"items"`
}

RecommendationList contains a list of Recommendation

func (*RecommendationList) DeepCopy

func (in *RecommendationList) DeepCopy() *RecommendationList

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

func (*RecommendationList) DeepCopyInto

func (in *RecommendationList) DeepCopyInto(out *RecommendationList)

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

func (*RecommendationList) DeepCopyObject

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

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

type RecommendationSpec

type RecommendationSpec struct {
	// Target is the object to be analyzed, which can be a workload or a series of pods
	Target RecommendationTarget `json:"target"`
}

RecommendationSpec is the specification of the client object.

func (*RecommendationSpec) DeepCopy

func (in *RecommendationSpec) DeepCopy() *RecommendationSpec

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

func (*RecommendationSpec) DeepCopyInto

func (in *RecommendationSpec) DeepCopyInto(out *RecommendationSpec)

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

type RecommendationStatus

type RecommendationStatus struct {
	// PodStatus records the most recently computed amount of resources recommended
	PodStatus *RecommendedPodStatus `json:"podStatus,omitempty"`
	// UpdateTime is the update time of the distribution
	UpdateTime *metav1.Time `json:"updateTime,omitempty"`
	// Conditions is the list of conditions representing the status of the distribution
	Conditions []metav1.Condition `json:"conditions,omitempty"`
}

RecommendationStatus defines the observed state of Recommendation

func (*RecommendationStatus) DeepCopy

func (in *RecommendationStatus) DeepCopy() *RecommendationStatus

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

func (*RecommendationStatus) DeepCopyInto

func (in *RecommendationStatus) DeepCopyInto(out *RecommendationStatus)

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

type RecommendationTarget

type RecommendationTarget struct {
	// Type indicates the type of target
	Type RecommendationTargetType `json:"type"`
	// Workload indicates the target is a k8s workload, which is effective when Type is "workload"
	Workload *CrossVersionObjectReference `json:"workload,omitempty"`
	// PodSelector defines the reference of a series of pods, which is effective when Type is "podSelector"
	PodSelector *metav1.LabelSelector `json:"podSelector,omitempty"`
}

RecommendationTarget defines the target of analysis, which can be a k8s workload or a series of pods

func (*RecommendationTarget) DeepCopy

func (in *RecommendationTarget) DeepCopy() *RecommendationTarget

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

func (*RecommendationTarget) DeepCopyInto

func (in *RecommendationTarget) DeepCopyInto(out *RecommendationTarget)

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

type RecommendationTargetType

type RecommendationTargetType string

RecommendationTargetType defines the type of analysis target

const (
	// RecommendationTargetWorkload defines the k8s workload type
	RecommendationTargetWorkload RecommendationTargetType = "workload"
	// RecommendationPodSelector defines the pod selector type
	RecommendationPodSelector RecommendationTargetType = "podSelector"
)

type RecommendedContainerStatus

type RecommendedContainerStatus struct {
	// Name of the container.
	ContainerName string `json:"containerName,omitempty"`
	// Recommended resources of container
	Resources corev1.ResourceList `json:"resources,omitempty"`
}

RecommendedContainerStatus defines the observed state of container

func (*RecommendedContainerStatus) DeepCopy

func (in *RecommendedContainerStatus) DeepCopy() *RecommendedContainerStatus

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

func (*RecommendedContainerStatus) DeepCopyInto

func (in *RecommendedContainerStatus) DeepCopyInto(out *RecommendedContainerStatus)

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

type RecommendedPodStatus

type RecommendedPodStatus struct {
	// ContainerStatuses records the most recently computed amount of resources recommended
	ContainerStatuses []RecommendedContainerStatus `json:"containerStatuses,omitempty"`
}

RecommendedPodStatus defines the observed state of pod

func (*RecommendedPodStatus) DeepCopy

func (in *RecommendedPodStatus) DeepCopy() *RecommendedPodStatus

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

func (*RecommendedPodStatus) DeepCopyInto

func (in *RecommendedPodStatus) DeepCopyInto(out *RecommendedPodStatus)

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