v1alpha1

type AlgorithmGranularity string

type AlgorithmPolicy struct {
	// Recommenders of the Algorithm used to this Pod;
	// if end-user wants to define their own recommendation algorithms,
	// they should manage this field to match their recommend implementations.
	// +optional
	Recommender string `json:"recommender,omitempty"`

	// Granularity of the Algorithm server recommendation result
	// The default is 'Default'.
	// +kubebuilder:default:=Default
	Granularity AlgorithmGranularity `json:"granularity"`

	// Extensions config by key-value format.
	// +optional
	// +kubebuilder:pruning:PreserveUnknownFields
	Extensions *runtime.RawExtension `json:"extensions,omitempty"`
}

type ContainerControlledValues string

type ContainerResourceList struct {
	// Current indicates the real resource configuration from the view of CRI interface.
	// +optional
	Current v1.ResourceList `json:"current,omitempty"`
	// Recommended amount of resources. Observes ContainerResourcePolicy.
	// +optional
	Target v1.ResourceList `json:"target,omitempty"`
	// The most recent recommended resources target computed by the autoscaler
	// for the controlled pods, based only on actual resource usage, not taking
	// into account the ContainerResourcePolicy.
	// May differ from the Recommendation if the actual resource usage causes
	// the target to violate the ContainerResourcePolicy (lower than MinAllowed
	// or higher that MaxAllowed).
	// Used only as status indication, will not affect actual resource assignment.
	// +optional
	UncappedTarget v1.ResourceList `json:"uncappedTarget,omitempty"`
	// Minimum recommended amount of resources. Observes ContainerResourcePolicy.
	// This amount is not guaranteed to be sufficient for the application to operate in a stable way, however
	// running with less resources is likely to have significant impact on performance/availability.
	// +optional
	LowerBound v1.ResourceList `json:"lowerBound,omitempty"`
	// Maximum recommended amount of resources. Observes ContainerResourcePolicy.
	// Any resources allocated beyond this value are likely wasted. This value may be larger than the maximum
	// amount of application is actually capable of consuming.
	// +optional
	UpperBound v1.ResourceList `json:"upperBound,omitempty"`
}

type ContainerResourcePolicy struct {
	// Name of the container or DefaultContainerResourcePolicy, in which
	// case the policy is used by the containers that don't have their own
	// policy specified.
	ContainerName *string `json:"containerName"`

	// Specifies the minimal amount of resources that will be recommended
	// for the container. The default is no minimum.
	// +optional
	MinAllowed v1.ResourceList `json:"minAllowed,omitempty"`

	// Specifies the maximum amount of resources that will be recommended
	// for the container. The default is no maximum.
	// +optional
	MaxAllowed v1.ResourceList `json:"maxAllowed,omitempty"`

	// Specifies the type of recommendations that will be computed
	// (and possibly applied) by VPA.
	// If not specified, the default of [ResourceCPU] will be used.
	// +kubebuilder:default:={cpu}
	ControlledResources []v1.ResourceName `json:"controlledResources,omitempty" patchStrategy:"merge"`

	// Specifies which resource values should be controlled.
	// The default is "RequestsAndLimits".
	// +kubebuilder:default:=RequestsAndLimits
	ControlledValues ContainerControlledValues `json:"controlledValues"`

	// ResourceResizePolicy specifies how Kubernetes should handle resource resize.
	// The default is "None"
	// +kubebuilder:default:=None
	ResourceResizePolicy ResourceResizePolicy `json:"resourceResizePolicy"`
}

type ContainerResources struct {
	// Name of the container.
	ContainerName *string `json:"containerName,omitempty"`
	// Requests indicates the recommendation resources for requests of this container
	// +optional
	Requests *ContainerResourceList `json:"requests,omitempty"`
	// Limits indicates the recommendation resources for limits of this container
	// +optional
	Limits *ContainerResourceList `json:"limits,omitempty"`
}

type CrossVersionObjectReference struct {
	// Kind of the referent
	Kind string `json:"kind"`
	// Name of the referent
	Name string `json:"name"`
	// API version of the referent
	// +optional
	APIVersion string `json:"apiVersion,omitempty"`
}

type KatalystVerticalPodAutoscaler struct {
	metav1.TypeMeta `json:",inline"`
	// +optional
	metav1.ObjectMeta `json:"metadata,omitempty"`

	// Spec defines the behavior of a KatalystVerticalPodAutoscaler.
	// +optional
	Spec KatalystVerticalPodAutoscalerSpec `json:"spec,omitempty"`

	// Status represents the current information about a KatalystVerticalPodAutoscaler.
	// +optional
	Status KatalystVerticalPodAutoscalerStatus `json:"status,omitempty"`
}

type KatalystVerticalPodAutoscalerList struct {
	metav1.TypeMeta `json:",inline"`

	// Standard list metadata
	// More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata
	// +optional
	metav1.ListMeta `json:"metadata,omitempty"`

	// items is the list of CNRs
	Items []KatalystVerticalPodAutoscaler `json:"items"`
}

type KatalystVerticalPodAutoscalerSpec struct {
	// TargetRef points to the controller managing the set of pods for the
	// autoscaler to control - e.g. Deployment, StatefulSet.
	TargetRef CrossVersionObjectReference `json:"targetRef"`

	// Describes the rules on how changes are applied to the pods.
	// If not specified, all fields in the `PodUpdatePolicy` are set to their default values.
	// +optional
	UpdatePolicy PodUpdatePolicy `json:"updatePolicy,omitempty"`

	// Controls how the autoscaler computes recommended resources.
	// The resource policy may be used to set constraints on the recommendations
	// for individual containers. If not specified, the autoscaler computes recommended
	// resources for all containers in the pod, without additional constraints.
	// +optional
	ResourcePolicy PodResourcePolicy `json:"resourcePolicy,omitempty"`
}

type KatalystVerticalPodAutoscalerStatus struct {
	// The most recently computed amount of resources provided by the
	// autoscaler for the controlled pods.
	// +optional
	PodResources []PodResources `json:"podResources,omitempty"`

	// ContainerResources is the most recently computed amount of resources for the controlled containers
	// it will be overwritten by PodResources
	// +optional
	ContainerResources []ContainerResources `json:"containerResources,omitempty"`

	// Conditions is the set of conditions required for this autoscaler to scale its target,
	// and indicates whether those conditions are met.
	// +optional
	// +patchMergeKey=type
	// +patchStrategy=merge
	Conditions []VerticalPodAutoscalerCondition `json:"conditions,omitempty" patchStrategy:"merge" patchMergeKey:"type"`
}

type PodApplyStrategy string

type PodMatchingStrategy string

type PodResourcePolicy struct {
	// policy of algorithm, if no algorithm is provided, using default
	// in-tree recommendation logic instead.
	// +optional
	AlgorithmPolicy AlgorithmPolicy `json:"algorithmPolicy,omitempty"`

	// Per-container resource policies.
	// +optional
	// +patchMergeKey=containerName
	// +patchStrategy=merge
	ContainerPolicies []ContainerResourcePolicy `json:"containerPolicies,omitempty" patchStrategy:"merge" patchMergeKey:"containerName"`
}

type PodResources struct {
	// Name of the pod.
	PodName *string `json:"podName,omitempty"`
	// Resources recommended by the autoscaler for each container.
	ContainerResources []ContainerResources `json:"containerRecommendations,omitempty"`
}

type PodUpdatePolicy struct {
	// PodUpdatingStrategy controls the method autoscaler applies changes to the pod resources.
	// The default is 'Off'.
	// +kubebuilder:default:=Off
	PodUpdatingStrategy PodUpdatingStrategy `json:"podUpdatingStrategy,omitempty"`

	// PodMatchingStrategy controls the timing autoscaler applies changes to the pod resources.
	// The default is 'All'.
	// +kubebuilder:default:=All
	PodMatchingStrategy PodMatchingStrategy `json:"podMatchingStrategy,omitempty"`

	// PodApplyStrategy controls the applying scope autoscaler should obey to.
	// The default is 'Group'.
	// +kubebuilder:default:=Group
	PodApplyStrategy PodApplyStrategy `json:"podApplyStrategy,omitempty"`
}

type PodUpdatingStrategy string

type RecommendedContainerResources struct {
	// Name of the container.
	ContainerName *string `json:"containerName"`
	// Requests indicates the recommendation resources for requests of this container
	// +optional
	Requests *RecommendedRequestResources `json:"requests,omitempty"`
	// Limits indicates the recommendation resources for limits of this container
	// +optional
	Limits *RecommendedRequestResources `json:"limits,omitempty"`
}

type RecommendedPodResources struct {
	// Name of the pod.
	PodName *string `json:"podName"`
	// Resources recommended by the autoscaler for each container.
	// +optional
	ContainerRecommendations []RecommendedContainerResources `json:"containerRecommendations,omitempty"`
}

type RecommendedRequestResources struct {
	// Resources indicates the recommended resources in quantity format.
	Resources v1.ResourceList `json:"resources,omitempty"`
}

type ResourceResizePolicy string

type VerticalPodAutoscalerCondition struct {
	// type describes the current condition
	Type VerticalPodAutoscalerConditionType `json:"type"`
	// status is the status of the condition (True, False, Unknown)
	Status v1.ConditionStatus `json:"status"`
	// lastTransitionTime is the last time the condition transitioned from
	// one status to another
	// +optional
	LastTransitionTime metav1.Time `json:"lastTransitionTime,omitempty"`
	// reason is the reason for the condition's last transition.
	// +optional
	Reason string `json:"reason,omitempty"`
	// message is a human-readable explanation containing details about
	// the transition
	// +optional
	Message string `json:"message,omitempty"`
}

type VerticalPodAutoscalerConditionType string

type VerticalPodAutoscalerRecommendation struct {
	metav1.TypeMeta `json:",inline"`
	// +optional
	metav1.ObjectMeta `json:"metadata,omitempty"`

	// Spec defines the behavior of a VerticalPodAutoscalerRecommendation.
	// +optional
	Spec VerticalPodAutoscalerRecommendationSpec `json:"spec,omitempty"`

	// Status represents the current information about a VerticalPodAutoscalerRecommendation.
	// +optional
	Status VerticalPodAutoscalerRecommendationStatus `json:"status,omitempty"`
}

type VerticalPodAutoscalerRecommendationCondition struct {
	// type describes the current condition
	Type VerticalPodAutoscalerRecommendationConditionType `json:"type"`
	// status is the status of the condition (True, False, Unknown)
	Status v1.ConditionStatus `json:"status"`
	// lastTransitionTime is the last time the condition transitioned from
	// one status to another
	// +optional
	LastTransitionTime metav1.Time `json:"lastTransitionTime,omitempty"`
	// reason is the reason for the condition's last transition.
	// +optional
	Reason string `json:"reason,omitempty"`
	// message is a human-readable explanation containing details about
	// the transition
	// +optional
	Message string `json:"message,omitempty"`
}

type VerticalPodAutoscalerRecommendationConditionType string

type VerticalPodAutoscalerRecommendationList struct {
	metav1.TypeMeta `json:",inline"`

	// Standard list metadata
	// More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata
	// +optional
	metav1.ListMeta `json:"metadata,omitempty"`

	// items is the list of CNRs
	Items []VerticalPodAutoscalerRecommendation `json:"items"`
}

type VerticalPodAutoscalerRecommendationSpec struct {
	// The most recently computed amount of resources recommended by the
	// autoscaler for the controlled pods.
	// +optional
	PodRecommendations []RecommendedPodResources `json:"podRecommendations,omitempty"`
	// default container resources recommended by the
	// autoscaler for the controlled containers.
	// It will be overwritten by PodRecommendations
	// +optional
	ContainerRecommendations []RecommendedContainerResources `json:"containerRecommendations,omitempty"`
}

type VerticalPodAutoscalerRecommendationStatus struct {
	// PodRecommendations is the most recently recommendation handled by the controller.
	// +optional
	PodRecommendations []RecommendedPodResources `json:"podRecommendations,omitempty"`

	// ContainerRecommendations is the most recently defaultRecommendation handled by the controller
	// +optional
	ContainerRecommendations []RecommendedContainerResources `json:"containerRecommendations,omitempty"`

	// Conditions is the set of conditions required for this vparec to scale its target,
	// and indicates whether those conditions are met.
	// +optional
	// +patchMergeKey=type
	// +patchStrategy=merge
	Conditions []VerticalPodAutoscalerRecommendationCondition `json:"conditions,omitempty" patchStrategy:"merge" patchMergeKey:"type"`
}