v1alpha1

type ConfigMapPortraitAlgorithmResultSource struct{}

type CronHorizontalPortraitData struct {
	// Crons contains cron rule based replicas values.
	// +kubebuilder:validation:MinItems=1
	Crons []ReplicaCron `json:"crons"`
}

type CronHorizontalPortraitProvider struct {
	// Crons contains cron rule based replicas values.
	// +kubebuilder:validation:MinItems=1
	Crons []ReplicaCron `json:"crons"`
}

type CronJobPortraitAlgorithmJob struct {
	// Template is the template of the Kubernetes CronJob that runs algorithm.
	Template CronJobTemplateSpec `json:"template"`
}

type CronJobTemplateSpec struct {
	// ObjectMeta is standard object's metadata of the CronJob.
	// +optional
	metav1.ObjectMeta `json:"metadata,omitempty"`

	// Spec is specification of the desired behavior of the CronJob.
	// +optional
	Spec batchv1.CronJobSpec `json:"spec,omitempty"`
}

type DynamicHorizontalPortraitProvider struct {
	PortraitSpec `json:",inline"`
}

type ExternalJobPortraitAlgorithm struct {
	// Job is the external job that runs the algorithm.
	Job PortraitAlgorithmJob `json:"job"`

	// ResultSource is the source from where to fetch the result of the algorithm.
	ResultSource PortraitAlgorithmResultSource `json:"resultSource"`
}

type ExternalPodSorter struct {
	// Name is the name of the sorter.
	// It must be unique across all external pod sorters of the ReplicaProfile.
	Name string `json:"name"`

	// Config is used to pass arbitrary config data to the sorter.
	// +optional
	Config map[string]string `json:"config,omitempty"`
}

type ExternalPodTrafficController struct {
	// Name is the name of the controller.
	// It must be unique across all external pod traffic controllers of the ReplicaProfile.
	Name string `json:"name"`

	// Config is used to pass arbitrary config to the controller.
	// +optional
	Config map[string]string `json:"config,omitempty"`
}

type ExternalStabilityChecker struct {
	// Name is the name of the checker.
	// It must be unique across all external stability checkers of the autoscaler.
	Name string `json:"name"`

	// Config is used to pass arbitrary config to the checker.
	// +optional
	Config map[string]string `json:"config,omitempty"`
}

type GrayStatus struct {
	// GrayPercent is the current gray percentage of the total change.
	// +kubebuilder:validation:Minimum=0
	// +kubebuilder:validation:Maximum=100
	GrayPercent int32 `json:"grayPercent"`

	// LastUpdateTime is the last update time of GrayPercent.
	LastUpdateTime metav1.Time `json:"lastUpdateTime"`
}

type GrayStrategy struct {
	// GrayState is the desired state of pods that in gray stage.
	// For scaling up, it can only be set to "Online".
	// For scaling down, it can either be set to "Cutoff", "Standby" or "Deleted".
	// +kubebuilder:validation:Enum=Online;Cutoff;Standby;Deleted
	GrayState PodState `json:"grayState"`

	// ChangeIntervalSeconds is the interval time between each gray change.
	// +kubebuilder:validation:Minimum=1
	ChangeIntervalSeconds int32 `json:"changeIntervalSeconds"`

	// ChangePercent is the percentage of the total change of replica numbers which is used to
	// calculate the amount of pods to change in each gray change.
	// +kubebuilder:validation:Minimum=1
	// +kubebuilder:validation:Maximum=100
	ChangePercent int32 `json:"changePercent"`

	// ObservationSeconds is the additional observation time after the gray change reaching 100%.
	// During the observation time, all pods that in gray stage would be kept in GrayState
	// and the stability ensurance mechanism for the gray change would continue to take effect.
	// If not set, the gray change will not have observation time.
	// +optional
	// +kubebuilder:validation:Minimum=0
	ObservationSeconds int32 `json:"observationSeconds,omitempty"`
}

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

	Spec   HorizontalPortraitSpec   `json:"spec,omitempty"`
	Status HorizontalPortraitStatus `json:"status,omitempty"`
}

type HorizontalPortraitConditionType string

type HorizontalPortraitData struct {
	// Type is the type of this portrait data.
	// +kubebuilder:validation:Enum=Static;Cron;TimeSeries
	Type HorizontalPortraitDataType `json:"type"`

	// Static refers to static portrait data.
	// +optional
	Static *StaticHorizontalPortraitData `json:"static,omitempty"`

	// Cron refers to cron portrait data.
	// +optional
	Cron *CronHorizontalPortraitData `json:"cron,omitempty"`

	// TimeSeries refers to time series portrait data.
	// +optional
	TimeSeries *TimeSeriesHorizontalPortraitData `json:"timeSeries,omitempty"`

	// ExpireTime indicates when this portrait data will expire.
	// +optional
	ExpireTime *metav1.Time `json:"expireTime,omitempty"`
}

type HorizontalPortraitDataType string

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

type HorizontalPortraitProvider struct {
	// Type is the type of the horizontal portrait provider.
	// +kubebuilder:validation:Enum=Static;Cron;Dynamic
	Type HorizontalPortraitProviderType `json:"type"`

	// Priority is the priority of the horizontal portrait generated by this provider.
	// A valid portrait with higher priority overrides ones with lower priority.
	// The bigger the number, the higher the priority.
	// If multiple portraits have the same priority,
	// the one which desires most replicas at current time would override the other ones.
	Priority int32 `json:"priority"`

	// Static is the configuration for static horizontal portrait provider.
	// +optional
	Static *StaticHorizontalPortraitProvider `json:"static,omitempty"`

	// Cron is the configuration for cron horizontal portrait provider.
	// +optional
	Cron *CronHorizontalPortraitProvider `json:"cron,omitempty"`

	// Dynamic is the configuration for dynamic horizontal portrait provider.
	// Note that the PortraitType must be unique across all dynamic horizontal portrait providers of the autoscaler.
	// +optional
	Dynamic *DynamicHorizontalPortraitProvider `json:"dynamic,omitempty"`
}

type HorizontalPortraitProviderType string

type HorizontalPortraitSpec struct {
	// ScaleTargetRef points to the target resource to scale.
	ScaleTargetRef k8sautoscalingv2.CrossVersionObjectReference `json:"scaleTargetRef"`

	PortraitSpec `json:",inline"`
}

type HorizontalPortraitStatus struct {
	// PortraitData is the data of generated portrait.
	// +optional
	PortraitData *HorizontalPortraitData `json:"portraitData,omitempty"`

	// Conditions represents current conditions of the HorizontalPortrait.
	// +optional
	Conditions []metav1.Condition `json:"conditions,omitempty"`
}

type HorizontalPortraitValue struct {
	// Provider is the unique identification of the provider of the portrait from which this value is produced.
	Provider string `json:"provider"`

	// Replicas is the desired number of online replicas.
	// +kubebuilder:validation:Minimum=0
	Replicas int32 `json:"replicas"`

	// ExpireTime indicates when this portrait value will expire.
	// +optional
	ExpireTime *metav1.Time `json:"expireTime,omitempty"`
}

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

	Spec   IntelligentHorizontalPodAutoscalerSpec   `json:"spec,omitempty"`
	Status IntelligentHorizontalPodAutoscalerStatus `json:"status,omitempty"`
}

type IntelligentHorizontalPodAutoscalerBehavior struct {
	// ScaleUp is the behavior configuration for scaling up.
	// +optional
	ScaleUp ScalingBehavior `json:"scaleUp,omitempty"`

	// ScaleDown is the behavior configuration for scaling down.
	// +optional
	ScaleDown ScalingBehavior `json:"scaleDown,omitempty"`

	// ReplicaProfile is used to configure the behavior of the underlying ReplicaProfile.
	// +optional
	ReplicaProfile *ReplicaProfileBehavior `json:"replicaProfile,omitempty"`
}

type IntelligentHorizontalPodAutoscalerConditionType string

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

type IntelligentHorizontalPodAutoscalerSpec struct {
	// ScaleTargetRef points to the target resource to scale.
	ScaleTargetRef k8sautoscalingv2.CrossVersionObjectReference `json:"scaleTargetRef"`

	// Paused means if the autoscaler is paused.
	// +optional
	Paused bool `json:"paused,omitempty"`

	// MinReplicas is the lower limit for the number of replicas to which the autoscaler can scale down.
	// +kubebuilder:validation:Minimum=0
	MinReplicas int32 `json:"minReplicas"`

	// MaxReplicas is the upper limit for the number of replicas to which the autoscaler can scale up.
	// It cannot be less than MinReplicas.
	// +kubebuilder:validation:Minimum=0
	MaxReplicas int32 `json:"maxReplicas"`

	// ScaleMode is the scaling mode of the autoscaler.
	// +optional
	// +kubebuilder:validation:Enum=Auto;Preview
	// +kubebuilder:default=Auto
	ScaleMode ScaleMode `json:"scaleMode"`

	// PortraitProviders contains configurations of portrait providers
	// that are used to generate horizontal portraits for the scale target.
	PortraitProviders []HorizontalPortraitProvider `json:"portraitProviders"`

	// Behavior configures the scaling behavior of the autoscaler.
	// +optional
	Behavior IntelligentHorizontalPodAutoscalerBehavior `json:"behavior,omitempty"`

	// StabilityCheckers contains configurations of stability checkers
	// that are used to ensure stability during autoscaling.
	// TODO: reconsider the place of this field
	// +optional
	StabilityCheckers []StabilityChecker `json:"stabilityCheckers,omitempty"`
}

type IntelligentHorizontalPodAutoscalerStatus struct {
	// PreviousPortraitValue is the last valid portrait value produced by portrait providers.
	// +optional
	PreviousPortraitValue *HorizontalPortraitValue `json:"previousPortraitValue,omitempty"`

	// CurrentPortraitValue is the current valid portrait value produced by portrait providers.
	// +optional
	CurrentPortraitValue *HorizontalPortraitValue `json:"currentPortraitValue,omitempty"`

	// Gray represents the current gray status of replicas change.
	// +optional
	Gray *GrayStatus `json:"gray,omitempty"`

	// Conditions represents current conditions of the IntelligentHorizontalPodAutoscaler.
	// +optional
	Conditions []metav1.Condition `json:"conditions,omitempty"`
}

type KubeHPAPortraitAlgorithm struct {
	// SyncPeriod is the period for syncing the portrait.
	// +optional
	// +kubebuilder:default="15s"
	SyncPeriod metav1.Duration `json:"syncPeriod"`

	// Tolerance is the tolerance for when resource usage suggests upscaling/downscaling.
	// Should be a string formatted float64 number.
	// +optional
	// +kubebuilder:default="0.1"
	Tolerance string `json:"tolerance"`

	// CPUInitializationPeriod is the period after pod start when CPU samples might be skipped.
	// +optional
	// +kubebuilder:default="5m"
	CPUInitializationPeriod metav1.Duration `json:"cpuInitializationPeriod"`

	// InitialReadinessDelay is period after pod start during which readiness changes
	// are treated as readiness being set for the first time. The only effect of this is that
	// HPA will disregard CPU samples from unready pods that had last readiness change during that period.
	// +optional
	// +kubebuilder:default="30s"
	InitialReadinessDelay metav1.Duration `json:"initialReadinessDelay"`
}

type MetricSpec struct {
	k8sautoscalingv2.MetricSpec `json:",inline"`

	// Name is the unique identifier of this metric spec.
	// It must be unique across all metric specs if specified.
	// +optional
	Name string `json:"name,omitempty"`

	// Operator is an optional binary arithmetic operator which is used to specify
	// a custom comparison rule "<actual> <operator> <target>" for the metric.
	// Note that not all use cases support this.
	// +optional
	// +kubebuilder:validation:Enum===;>;<;>=;<=
	Operator Operator `json:"operator,omitempty"`
}

type MetricsStabilityChecker struct {
	// Metrics contains metrics rules of the checker.
	// +kubebuilder:validation:MinItems=1
	Metrics []MetricSpec `json:"metrics"`
}

type Operator string

type PodSorter struct {
	// Type is the type of pod sorter.
	// It defaults to WorkloadDefault.
	// +optional
	// +kubebuilder:validation:Enum=WorkloadDefault;External
	// +kubebuilder:default=WorkloadDefault
	Type PodSorterType `json:"type"`

	// External refers to a user specified external pod sorter.
	// +optional
	External *ExternalPodSorter `json:"external,omitempty"`
}

type PodSorterType string

type PodState string

type PodTrafficController struct {
	// Type is the type of pod traffic controller.
	// It defaults to ReadinessGate.
	// +optional
	// +kubebuilder:validation:Enum=ReadinessGate;External
	// +kubebuilder:default=ReadinessGate
	Type PodTrafficControllerType `json:"type"`

	// External refers to a user specified external pod traffic controller.
	// +optional
	External *ExternalPodTrafficController `json:"external,omitempty"`
}

type PodTrafficControllerType string

type PortraitAlgorithm struct {
	// Type is the type of algorithm.
	Type PortraitAlgorithmType `json:"type"`

	// ExternalJob is the configuration for ExternalJob algorithm.
	// +optional
	ExternalJob *ExternalJobPortraitAlgorithm `json:"externalJob,omitempty"`

	// KubeHPA is the configuration for KubeHPA algorithm.
	// +optional
	KubeHPA *KubeHPAPortraitAlgorithm `json:"kubeHPA,omitempty"`

	// Config is the general configuration data for arbitrary algorithm those
	// used by external portrait generators.
	// +optional
	// +kubebuilder:pruning:PreserveUnknownFields
	Config *runtime.RawExtension `json:"config,omitempty"`
}

type PortraitAlgorithmJob struct {
	// Type is the type of job.
	Type PortraitAlgorithmJobType `json:"type"`

	// CronJob is the configuration for CronJob job.
	// +optional
	CronJob *CronJobPortraitAlgorithmJob `json:"cronJob,omitempty"`
}

type PortraitAlgorithmJobType string

type PortraitAlgorithmResultSource struct {
	// Type is the type of result source.
	Type PortraitAlgorithmResultSourceType `json:"type"`

	// ConfigMap is the configuration for ConfigMap result source.
	// +optional
	ConfigMap *ConfigMapPortraitAlgorithmResultSource `json:"configMap,omitempty"`
}

type PortraitAlgorithmResultSourceType string

type PortraitAlgorithmType string

type PortraitSpec struct {
	// PortraitType is the type of portrait.
	// Different type has different semantics with different portrait generating logic.
	PortraitType PortraitType `json:"portraitType"`

	// ExternalGeneratorName is the identifier of external controller which shall generate this portrait.
	// External controllers should use this field to filter portraits to generate.
	// Kapacity's built-in portrait generators would ignore portraits with this field set.
	// +optional
	ExternalGeneratorName string `json:"externalGeneratorName,omitempty"`

	// Metrics contains the specifications for which to use to generate the portrait.
	// +optional
	Metrics []MetricSpec `json:"metrics,omitempty"`

	// Algorithm is the algorithm for which to use to generate the portrait.
	Algorithm PortraitAlgorithm `json:"algorithm"`
}

type PortraitType string

type ReplicaCron struct {
	// Name is the name of this cron rule.
	// It must be unique across all rules.
	Name string `json:"name"`

	// Description is an additional description of this cron rule.
	// +optional
	Description string `json:"description,omitempty"`

	// TimeZone is the time zone in which the cron would run.
	// Defaults to UTC.
	// +optional
	// +kubebuilder:default=UTC
	TimeZone string `json:"timeZone"`

	// Start is the cron of time from which the rule takes effect.
	// It must be a valid standard cron expression.
	Start string `json:"start"`

	// End is the cron of time to which the rule takes effect.
	// It must be a valid standard cron expression.
	End string `json:"end"`

	// Replicas is the desired number of online replicas within this cron rule.
	// +kubebuilder:validation:Minimum=0
	Replicas int32 `json:"replicas"`
}

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

	Spec   ReplicaProfileSpec   `json:"spec,omitempty"`
	Status ReplicaProfileStatus `json:"status,omitempty"`
}

type ReplicaProfileBehavior struct {
	// PodSorter is used to decide the priority of pods when scaling.
	// If not set, default pod sorter will be set to WorkloadDefault.
	// +optional
	// +kubebuilder:default={type:"WorkloadDefault"}
	PodSorter PodSorter `json:"podSorter"`

	// PodTrafficController is used to control pod traffic when scaling.
	// If not set, default pod traffic controller will be set to ReadinessGate.
	// +optional
	// +kubebuilder:default={type:"ReadinessGate"}
	PodTrafficController PodTrafficController `json:"podTrafficController"`
}

type ReplicaProfileConditionType string

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

type ReplicaProfileSpec struct {
	// ScaleTargetRef points to the target resource to scale.
	ScaleTargetRef k8sautoscalingv2.CrossVersionObjectReference `json:"scaleTargetRef"`

	// OnlineReplicas is the desired number of online replicas.
	// +optional
	// +kubebuilder:validation:Minimum=0
	OnlineReplicas int32 `json:"onlineReplicas,omitempty"`

	// CutoffReplicas is the desired number of cutoff replicas.
	// +optional
	// +kubebuilder:validation:Minimum=0
	CutoffReplicas int32 `json:"cutoffReplicas,omitempty"`

	// StandbyReplicas is the desired number of standby replicas.
	// +optional
	// +kubebuilder:validation:Minimum=0
	StandbyReplicas int32 `json:"standbyReplicas,omitempty"`

	// Paused means if the replica control is paused.
	// +optional
	Paused bool `json:"paused,omitempty"`

	// Behavior configures the behavior of ReplicaProfile.
	// If not set, default behavior will be set.
	// +optional
	// +kubebuilder:default={podSorter:{type:"WorkloadDefault"},podTrafficController:{type:"ReadinessGate"}}
	Behavior ReplicaProfileBehavior `json:"behavior"`
}

type ReplicaProfileStatus struct {
	// OnlineReplicas is the current number of online replicas.
	// +optional
	// +kubebuilder:validation:Minimum=0
	OnlineReplicas int32 `json:"onlineReplicas,omitempty"`

	// CutoffReplicas is the current number of cutoff replicas.
	// +optional
	// +kubebuilder:validation:Minimum=0
	CutoffReplicas int32 `json:"cutoffReplicas,omitempty"`

	// StandbyReplicas is the current number of standby replicas.
	// +optional
	// +kubebuilder:validation:Minimum=0
	StandbyReplicas int32 `json:"standbyReplicas,omitempty"`

	// Conditions represents current conditions of the ReplicaProfile.
	// +optional
	Conditions []metav1.Condition `json:"conditions,omitempty"`
}

type ReplicaTimeSeriesPoint struct {
	// Timestamp is the unix time stamp of this point.
	// +kubebuilder:validation:Minimum=0
	Timestamp int64 `json:"timestamp"`

	// Replicas is the desired number of online replicas from this point.
	// +kubebuilder:validation:Minimum=0
	Replicas int32 `json:"replicas"`
}

type ScaleMode string

type ScalingBehavior struct {
	// GrayStrategy is the configuration of the strategy for gray change of replicas.
	// If not set, gray change will be disabled.
	// +optional
	GrayStrategy *GrayStrategy `json:"grayStrategy,omitempty"`
}

type StabilityChecker struct {
	// Type is the type of stability checker.
	// +kubebuilder:validation:Enum=Metrics;External
	Type StabilityCheckerType `json:"type"`

	// StabilizationAction is the action to perform in order to ensure stability
	// when the checker detects anomalies.
	// +kubebuilder:validation:Enum=Pause;Rollback
	StabilizationAction StabilizationActionType `json:"stabilizationAction"`

	// CoolDownSeconds is the cooldown time after the checker no longer detects anomalies
	// after which the autoscaling process will resume normal.
	// +optional
	// +kubebuilder:validation:Minimum=0
	CoolDownSeconds int32 `json:"coolDownSeconds,omitempty"`

	// Metrics is the configuration for metrics stability checker.
	// +optional
	Metrics *MetricsStabilityChecker `json:"metrics,omitempty"`

	// External is the configuration for external stability checker.
	// +optional
	External *ExternalStabilityChecker `json:"external,omitempty"`
}

type StabilityCheckerType string

type StabilizationActionType string

type StaticHorizontalPortraitData struct {
	// Replicas is the desired number of online replicas.
	// +kubebuilder:validation:Minimum=0
	Replicas int32 `json:"replicas"`
}

type StaticHorizontalPortraitProvider struct {
	// Replicas is the desired number of online replicas.
	// +kubebuilder:validation:Minimum=0
	Replicas int32 `json:"replicas"`
}

type TimeSeriesHorizontalPortraitData struct {
	// TimeSeries is time series of replicas.
	// The points of the series MUST be ordered by time.
	// The specified replicas would take effect from that point to the next point.
	// Thus, the last point could last forever until the whole portrait data become expired.
	// +kubebuilder:validation:MinItems=1
	TimeSeries []ReplicaTimeSeriesPoint `json:"timeSeries"`
}