v1alpha1

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

	// Specifies MaintenanceWindow reference for ApprovalPolicy.
	// Recommendation will be executed in this MaintenanceWindow without manual approval.
	MaintenanceWindowRef kmapi.TypedObjectReference `json:"maintenanceWindowRef"`

	// Specifies the list of TargetRef for which the ApprovalPolicy will be effective for.
	// +optional
	Targets []TargetRef `json:"targets"`
}

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

type ApprovalStatus string

type ApprovedWindow struct {
	// Window defines the ApprovedWindow type
	// Possible values are:
	// Immediate: Recommendation will be executed immediately
	// NextAvailable: Recommendation will be executed in the next Available window
	// SpecificDates: Recommendation will be executed in the given dates.
	Window WindowType `json:"window,omitempty"`

	// MaintenanceWindow holds the reference of the MaintenanceWindow resource
	// +optional
	MaintenanceWindow *kmapi.TypedObjectReference `json:"maintenanceWindow,omitempty"`

	// Dates holds a list of DateWindow when Recommendation is permitted to execute
	// +optional
	Dates []DateWindow `json:"dates,omitempty"`
}

type CVEReport struct {
	Count           map[string]int  `json:"count,omitempty"`
	Vulnerabilities []Vulnerability `json:"vulnerabilities,omitempty"`
}

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

	Spec   MaintenanceWindowSpec   `json:"spec,omitempty"`
	Status MaintenanceWindowStatus `json:"status,omitempty"`
}

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

type DateWindow struct {
	Start metav1.Time `json:"start"`
	End   metav1.Time `json:"end"`
}

type DayOfWeek string

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

	Spec   MaintenanceWindowSpec   `json:"spec,omitempty"`
	Status MaintenanceWindowStatus `json:"status,omitempty"`
}

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

type MaintenanceWindowSpec struct {
	// +optional
	IsDefault bool `json:"isDefault,omitempty"`
	// If the Timezone is not set or "" or "UTC", the given times and dates are considered as UTC.
	// If the name is "Local", the given times and dates are considered as server local timezone.
	//
	// Otherwise, the Timezone should specify a location name corresponding to a file
	// in the IANA Time Zone database, such as "Asia/Dhaka", "America/New_York", .
	// Ref: https://www.iana.org/time-zones
	//      https://en.wikipedia.org/wiki/List_of_tz_database_time_zones
	// +optional
	Timezone *string `json:"timezone,omitempty"`
	// Days consists of a map of DayOfWeek and corresponding list of TimeWindow.
	// There is `Logical OR` relationship between Days and Dates.
	// Example:
	//  days:
	//    Monday:
	//     - start: 10:40AM
	//       end: 7:00PM
	// +optional
	Days map[DayOfWeek][]TimeWindow `json:"days,omitempty"`
	// Dates consists of a list of Dates as Maintenance time.
	// Dates are always needed to be given in UTC format.
	// Format: yyyy-mm-ddThh.mm.ssZ [Here Z stands for Zero time zone / UTC time zone / GMT (+0000)]
	// Example:
	//  dates:
	//   - start: 2022-01-24T00:00:18Z
	//     end: 2022-01-24T23:41:18Z
	// +optional
	Dates []DateWindow `json:"dates,omitempty"`
}

type MaintenanceWindowStatus struct {
	// Specifies the current phase of the database
	// +optional
	// +kubebuilder:default=Pending
	Status ApprovalStatus `json:"status,omitempty"`
	// observedGeneration is the most recent generation observed for this resource. It corresponds to the
	// resource's generation, which is updated on mutation by the API Server.
	// +optional
	ObservedGeneration int64 `json:"observedGeneration,omitempty"`
	// Conditions applied to the database, such as approval or denial.
	// +optional
	Conditions []kmapi.Condition `json:"conditions,omitempty"`
}

type Operation struct {
	metav1.GroupKind `json:",inline"`
}

type OperationPhaseRules struct {
	// Success defines a rule to identify the successful execution of the operation.
	// Example:
	//   success: `has(self.status.phase) && self.status.phase == 'Successful'`
	// Here self.status.phase is pointing to .status.phase field of the Operation object.
	// When .status.phase field presents and becomes `Successful`, the Success rule will satisfy.
	Success string `json:"success"`

	// InProgress defines a rule to identify that applied operation is progressing.
	// Example:
	//   inProgress: `has(self.status.phase) && self.status.phase == 'Progressing'`
	// Here self.status.phase is pointing to .status.phase field of the Operation object.
	// When .status.phase field presents and becomes `Progressing`, the InProgress rule will satisfy.
	InProgress string `json:"inProgress"`

	// Failed defines a rule to identify that applied operation is failed.
	// Example:
	//   inProgress: `has(self.status.phase) && self.status.phase == 'Failed'`
	// Here self.status.phase is pointing to .status.phase field of the Operation object.
	// When .status.phase field presents and becomes `Failed`, the Failed rule will satisfy.
	Failed string `json:"failed"`
}

type Parallelism string

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

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

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

type RecommendationPhase string

type RecommendationSpec struct {
	// Description specifies the reason why this recommendation is generated.
	// +optional
	Description string `json:"description,omitempty"`

	// VulnerabilityReport specifies any kind vulnerability report like cve fixed information
	VulnerabilityReport *VulnerabilityReport `json:"vulnerabilityReport,omitempty"`

	// Target specifies the APIGroup, Kind & Name of the target resource for which the recommendation is generated
	Target core.TypedLocalObjectReference `json:"target"`

	// Operation holds a kubernetes object yaml which will be applied when this recommendation will be executed.
	// It should be a valid kubernetes resource yaml containing apiVersion, kind and metadata fields.
	// +kubebuilder:pruning:PreserveUnknownFields
	// +kubebuilder:validation:EmbeddedResource
	Operation runtime.RawExtension `json:"operation"`

	// Recommender holds the name and namespace of the component which generate this recommendation.
	Recommender kmapi.ObjectReference `json:"recommender"`

	// The recommendation will be executed within the given Deadline.
	// To maintain deadline, Parallelism can be compromised.
	// +optional
	Deadline *metav1.Time `json:"deadline,omitempty"`

	// If RequireExplicitApproval is set to `true` then the Recommendation must be Approved manually.
	// Recommendation won't be executed without manual approval and any kind of ApprovalPolicy will be ignored.
	// +optional
	RequireExplicitApproval bool `json:"requireExplicitApproval,omitempty"`

	// Rules defines OperationPhaseRules. It contains three identification rules of successful execution of the operation,
	// progressing execution of the operation & failed execution of the operation.
	// Example:
	// rules:
	//   success:    `has(self.status.phase) && self.status.phase == 'Successful'`
	//   inProgress: `has(self.status.phase) && self.status.phase == 'Progressing'`
	//   failed:     `has(self.status.phase) && self.status.phase == 'Failed'`
	Rules OperationPhaseRules `json:"rules"`

	// BackoffLimit specifies the number of retries before marking this recommendation failed.
	// By default set as five(5).
	// If BackoffLimit is zero(0), the operation will be tried to executed only once.
	// +optional
	// +kubebuilder:validation:Minimum=0
	// +kubebuilder:validation:Maximum=10
	BackoffLimit *int32 `json:"backoffLimit,omitempty"`
}

type RecommendationStatus struct {
	// Specifies the Approval Status of the Recommendation.
	// Possible values are `Pending`, `Approved`, `Rejected`
	// Pending: Recommendation is yet to Approved or Rejected
	// Approved: Recommendation is permitted to execute.
	// Rejected: Recommendation is rejected and never be executed.
	// +optional
	// +kubebuilder:default=Pending
	ApprovalStatus ApprovalStatus `json:"approvalStatus"`

	// Specifies the Recommendation current phase.
	// Possible values are:
	// Pending : Recommendation misses at least one pre-requisite for executing the operation.
	//           It also tells that some user action is needed.
	// Skipped : Operation is skipped because of Rejection ApprovalStatus.
	// Waiting : Recommendation is waiting for the MaintenanceWindow to execute the operation
	//           or waiting for others Recommendation to complete far maintaining Parallelism.
	// InProgress : The operation execution is successfully started and waiting for its final status.
	// Succeeded : Operation has been successfully executed.
	// Failed : Operation execution has not completed successfully i.e. encountered an error
	// +optional
	Phase RecommendationPhase `json:"phase,omitempty"`

	// A message indicating details about Recommendation current phase.
	// +optional
	// +kubebuilder:default=WaitingForApproval
	Reason string `json:"reason"`

	// Specifies Reviewer's details.
	// +optional
	Reviewer *Subject `json:"reviewer,omitempty"`

	// Specifies Reviewer's comment.
	// +optional
	Comments string `json:"comments,omitempty"`

	// Contains review timestamp
	// +optional
	ReviewTimestamp *metav1.Time `json:"reviewTimestamp,omitempty"`

	// ApprovedWindow specifies the time window configuration for the Recommendation execution.
	// +optional
	ApprovedWindow *ApprovedWindow `json:"approvedWindow,omitempty"`

	// Parallelism imposes some restriction to Recommendation execution.
	// Possible values are:
	// Namespace: Only one Recommendation can be executed at a time in a namespace.
	// Target: Only one Recommendation for a given target can be executed at a time.
	// TargetAndNamespace: Only one Recommendation for a given target can be executed at a time in a namespace.
	// +optional
	// +kubebuilder:default=Namespace
	Parallelism Parallelism `json:"parallelism,omitempty"`

	// observedGeneration is the most recent generation observed for this resource. It corresponds to the
	// resource's generation, which is updated on mutation by the API Server.
	// +optional
	ObservedGeneration int64 `json:"observedGeneration,omitempty"`

	// Conditions applied to the Recommendation.
	// +optional
	Conditions []kmapi.Condition `json:"conditions,omitempty"`

	// Outdated is indicating details whether the Recommendation is outdated or not.
	// If the value is `true`, then Recommendation will not be executed. This indicates that after generating the Recommendation,
	// the targeted resource is changed in such a way that the generated Recommendation has become outdated & can't be executed anymore.
	//
	// +optional
	// +kubebuilder:default=false
	Outdated bool `json:"outdated"`

	// CreatedOperationRef holds the created operation name.
	// +optional
	CreatedOperationRef *core.LocalObjectReference `json:"createdOperationRef,omitempty"`

	// FailedAttempt holds the number of times the operation is failed.
	// +optional
	// +kubebuilder:default=0
	FailedAttempt int32 `json:"failedAttempt"`
}

type ReportGenerationStatus string

type Subject struct {
	// Kind of object being referenced. Values defined by this API group are "User", "Group", and "ServiceAccount".
	// If the Authorizer does not recognized the kind value, the Authorizer should report an error.
	Kind string `json:"kind"`
	// APIGroup holds the API group of the referenced subject.
	// Defaults to "" for ServiceAccount subjects.
	// Defaults to "rbac.authorization.k8s.io" for User and Group subjects.
	// +optional
	APIGroup string `json:"apiGroup,omitempty" protobuf:"bytes,2,opt.name=apiGroup"`
	// Name of the object being referenced.
	Name string `json:"name" protobuf:"bytes,3,opt,name=name"`
	// Namespace of the referenced object.  If the object kind is non-namespace, such as "User" or "Group", and this value is not empty
	// the Authorizer should report an error.
	// +optional
	Namespace string `json:"namespace,omitempty" protobuf:"bytes,4,opt,name=namespace"`
}

type TargetRef struct {
	metav1.GroupKind `json:",inline"`
	// +optional
	Operations []Operation `json:"operations,omitempty"`
}

type TimeWindow struct {
	Start kmapi.TimeOfDay `json:"start"`
	End   kmapi.TimeOfDay `json:"end"`
}

type Vulnerability struct {
	VulnerabilityID string `json:"vulnerabilityID,omitempty"`
	PrimaryURL      string `json:"primaryURL,omitempty"`
	Severity        string `json:"severity,omitempty"`
}

type VulnerabilityReport struct {
	Status  ReportGenerationStatus `json:"status,omitempty"`
	Message string                 `json:"message,omitempty"`
	// Fixed represents the list of CVEs fixed if the recommendation is applied
	Fixed *CVEReport `json:"fixed,omitempty"`
	// Known represents the list of CVEs known to exist after the recommendation is applied
	Known *CVEReport `json:"known,omitempty"`
}

type WindowType string