v1beta1

type ActiveSchedule struct {
	// Name of the `SpannerAutoscaleSchedule`
	ScheduleName string `json:"name"`

	// The time until when this schedule will remain active
	EndTime metav1.Time `json:"endTime"`

	// The extra compute capacity which will be added because of this schedule
	AdditionalPU int `json:"additionalPU"`
}

type AuthType string

type Authentication struct {
	// Authentication method to be used for GCP authentication.
	// If `ImpersonateConfig` as well as `IAMKeySecret` is nil, this will be set to use ADC be default.
	Type AuthType `json:"type,omitempty"`

	// Details of the GCP service account which will be impersonated, for authentication to GCP.
	// This can used only on GKE clusters, when workload identity is enabled.
	// [[Ref](https://cloud.google.com/kubernetes-engine/docs/how-to/workload-identity)].
	// This is a pointer because structs with string slices can not be compared for zero values
	ImpersonateConfig *ImpersonateConfig `json:"impersonateConfig,omitempty"`

	// Details of the k8s secret which contains the GCP service account authentication key (in JSON).
	// [[Ref](https://cloud.google.com/kubernetes-engine/docs/tutorials/authenticating-to-cloud-platform)].
	// This is a pointer because structs with string slices can not be compared for zero values
	IAMKeySecret *IAMKeySecret `json:"iamKeySecret,omitempty"`
}

type CPUMetricType string

type ComputeType string

type IAMKeySecret struct {
	// Name of the secret which contains the authentication key
	Name string `json:"name"`

	// Namespace of the secret which contains the authentication key
	Namespace string `json:"namespace,omitempty"`

	// Name of the yaml 'key' under which the authentication value is stored
	Key string `json:"key"`
}

type ImpersonateConfig struct {
	// The service account which will be impersonated
	TargetServiceAccount string `json:"targetServiceAccount"`

	// Delegation chain for the service account impersonation.
	// [[Ref](https://pkg.go.dev/google.golang.org/api/impersonate#hdr-Required_IAM_roles)]
	Delegates []string `json:"delegates,omitempty"`
}

type InstanceState string

type ScaleConfig struct {
	// Whether to use `nodes` or `processing-units` for scaling.
	// This is only used at the time of CustomResource creation. If compute capacity is provided in `nodes`, then it is automatically converted to `processing-units` at the time of resource creation, and internally, only `ProcessingUnits` are used for computations and scaling.
	ComputeType ComputeType `json:"computeType,omitempty"`

	// If `nodes` are provided at the time of resource creation, then they are automatically converted to `processing-units`. So it is recommended to use only the processing units. Ref: [Spanner Compute Capacity](https://cloud.google.com/spanner/docs/compute-capacity#compute_capacity)
	Nodes ScaleConfigNodes `json:"nodes,omitempty"`

	// ProcessingUnits for scaling of the Spanner instance. Ref: [Spanner Compute Capacity](https://cloud.google.com/spanner/docs/compute-capacity#compute_capacity)
	ProcessingUnits ScaleConfigPUs `json:"processingUnits,omitempty"`

	// The maximum number of processing units which can be deleted in one scale-down operation. It can be a multiple of 100 for values < 1000, or a multiple of 1000 otherwise.
	// It can also be a percentage of the total number of processing units at the start of the scale-down operation.
	// +kubebuilder:default=2000
	ScaledownStepSize intstr.IntOrString `json:"scaledownStepSize,omitempty"`

	// How often autoscaler is reevaluated for scale down.
	// The cool down period between two consecutive scaledown operations. If this option is omitted, the value of the `--scale-down-interval` command line option is taken as the default value.
	ScaledownInterval *metav1.Duration `json:"scaledownInterval,omitempty"`

	// The maximum number of processing units which can be added in one scale-up operation. It can be a multiple of 100 for values < 1000, or a multiple of 1000 otherwise.
	// It can also be a percentage of the total number of processing units at the start of the scale-up operation.
	// +kubebuilder:default=0
	ScaleupStepSize intstr.IntOrString `json:"scaleupStepSize,omitempty"`

	// How often autoscaler is reevaluated for scale up.
	// The warm up period between two consecutive scaleup operations. If this option is omitted, the value of the `--scale-up-interval` command line option is taken as the default value.
	ScaleupInterval *metav1.Duration `json:"scaleupInterval,omitempty"`

	// The CPU utilization which the autoscaling will try to achieve. Ref: [Spanner CPU utilization](https://cloud.google.com/spanner/docs/cpu-utilization#task-priority)
	TargetCPUUtilization TargetCPUUtilization `json:"targetCPUUtilization"`
}

type ScaleConfigNodes struct {
	// Minimum number of Nodes for the autoscaling range
	Min int `json:"min,omitempty"`

	// Maximum number of Nodes for the autoscaling range
	Max int `json:"max,omitempty"`
}

type ScaleConfigPUs struct {
	// Minimum number of Processing Units for the autoscaling range
	// +kubebuilder:validation:MultipleOf=100
	Min int `json:"min"`

	// Maximum number of Processing Units for the autoscaling range
	// +kubebuilder:validation:MultipleOf=100
	Max int `json:"max"`
}

type Schedule struct {
	// The recurring frequency of the schedule in [standard cron](https://en.wikipedia.org/wiki/Cron) format. Examples and verification utility: https://crontab.guru
	Cron string `json:"cron"`

	// The length of time for which this schedule will remain active each time the cron is triggered.
	Duration string `json:"duration"`
}

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

	Spec   SpannerAutoscaleScheduleSpec   `json:"spec,omitempty"`
	Status SpannerAutoscaleScheduleStatus `json:"status,omitempty"`
}

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

type SpannerAutoscaleScheduleSpec struct {
	// The `SpannerAutoscaler` resource name with which this schedule will be registered.
	// Immutable after creation.
	TargetResource string `json:"targetResource"`

	// The extra compute capacity which will be added when this schedule is active.
	// This is the only field that can be updated after creation.
	AdditionalProcessingUnits int `json:"additionalProcessingUnits"`

	// The details of when and for how long this schedule will be active.
	// Immutable after creation.
	Schedule Schedule `json:"schedule"`
}

type SpannerAutoscaleScheduleStatus struct{}

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

	Spec   SpannerAutoscalerSpec   `json:"spec,omitempty"`
	Status SpannerAutoscalerStatus `json:"status,omitempty"`
}

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

type SpannerAutoscalerSpec struct {
	// The Spanner instance which will be managed for autoscaling
	TargetInstance TargetInstance `json:"targetInstance"`

	// Authentication details for the Spanner instance
	Authentication Authentication `json:"authentication,omitempty"`

	// Details of the autoscaling parameters for the Spanner instance
	ScaleConfig ScaleConfig `json:"scaleConfig"`
}

type SpannerAutoscalerStatus struct {
	// List of schedules which are registered with this spanner-autoscaler instance
	Schedules []string `json:"schedules,omitempty"`

	// List of all the schedules which are currently active and will be used in calculating compute capacity
	CurrentlyActiveSchedules []ActiveSchedule `json:"currentlyActiveSchedules,omitempty"`

	// Last time the `SpannerAutoscaler` scaled the number of Spanner nodes.
	// Used by the autoscaler to control how often the number of nodes are changed
	LastScaleTime metav1.Time `json:"lastScaleTime,omitempty"`

	// Last time the `SpannerAutoscaler` fetched and synced the metrics from Spanner
	LastSyncTime metav1.Time `json:"lastSyncTime,omitempty"`

	// Current number of processing-units in the Spanner instance
	CurrentProcessingUnits int `json:"currentProcessingUnits,omitempty"`

	// Desired number of processing-units in the Spanner instance
	DesiredProcessingUnits int `json:"desiredProcessingUnits,omitempty"`

	// Minimum number of processing units based on the currently active schedules
	DesiredMinPUs int `json:"desiredMinPUs,omitempty"`

	// Maximum number of processing units based on the currently active schedules
	DesiredMaxPUs int `json:"desiredMaxPUs,omitempty"`

	// State of the Cloud Spanner instance
	InstanceState InstanceState `json:"instanceState,omitempty"`

	// Current average CPU utilization for high priority task, represented as a percentage
	CurrentHighPriorityCPUUtilization int `json:"currentHighPriorityCPUUtilization,omitempty"`

	// Current total CPU utilization (all priorities), represented as a percentage.
	// This field is populated only when spec.scaleConfig.targetCPUUtilization.total is specified.
	CurrentTotalCPUUtilization int `json:"currentTotalCPUUtilization,omitempty"`

	// CurrentCPUMetricType is the CPU metric type that was used in the last sync cycle.
	// The controller uses this to detect metric-type switches and skip scaling until
	// the status reflects the newly configured metric type.
	CurrentCPUMetricType CPUMetricType `json:"currentCPUMetricType,omitempty"`
}

type TargetCPUUtilization struct {
	// Desired CPU utilization for 'High Priority' CPU consumption category. Ref: [Spanner CPU utilization](https://cloud.google.com/spanner/docs/cpu-utilization#task-priority)
	// Mutually exclusive with 'total'. Exactly one of 'highPriority' or 'total' must be specified.
	// +optional
	// +kubebuilder:validation:Minimum=0
	// +kubebuilder:validation:Maximum=100
	// +kubebuilder:validation:ExclusiveMinimum=true
	// +kubebuilder:validation:ExclusiveMaximum=true
	HighPriority *int `json:"highPriority,omitempty"`

	// Desired total CPU utilization (all priorities combined). Ref: [Spanner CPU utilization](https://cloud.google.com/spanner/docs/cpu-utilization)
	// Mutually exclusive with 'highPriority'. Exactly one of 'highPriority' or 'total' must be specified.
	// +optional
	// +kubebuilder:validation:Minimum=0
	// +kubebuilder:validation:Maximum=100
	// +kubebuilder:validation:ExclusiveMinimum=true
	// +kubebuilder:validation:ExclusiveMaximum=true
	Total *int `json:"total,omitempty"`
}

type TargetInstance struct {
	// The GCP Project id of the Spanner instance
	ProjectID string `json:"projectId"`

	// The instance id of the Spanner instance
	InstanceID string `json:"instanceId"`
}