v1alpha1

type ConditionType string

type RemediationStrategyType string

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

	Spec   SelfNodeRemediationSpec   `json:"spec,omitempty"`
	Status SelfNodeRemediationStatus `json:"status,omitempty"`
}

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

	Spec   SelfNodeRemediationConfigSpec   `json:"spec,omitempty"`
	Status SelfNodeRemediationConfigStatus `json:"status,omitempty"`
}

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

type SelfNodeRemediationConfigSpec struct {

	// WatchdogFilePath is the watchdog file path that should be available on each node, e.g. /dev/watchdog.
	// +kubebuilder:default=/dev/watchdog
	// +optional
	WatchdogFilePath string `json:"watchdogFilePath,omitempty"`

	// SafeTimeToAssumeNodeRebootedSeconds is the time after which the healthy self node remediation
	// agents will assume the unhealthy node has been rebooted, and it is safe to recover affected workloads.
	// This is extremely important as starting replacement Pods while they are still running on the failed
	// node will likely lead to data corruption and violation of run-once semantics.
	// In an effort to prevent this, the operator ignores values lower than a minimum calculated from the
	// ApiCheckInterval, ApiServerTimeout, MaxApiErrorThreshold, PeerDialTimeout, and PeerRequestTimeout fields,
	// and the unhealthy node's individual watchdog timeout.
	// +optional
	SafeTimeToAssumeNodeRebootedSeconds *int `json:"safeTimeToAssumeNodeRebootedSeconds,omitempty"`

	// The timeout for api-server connectivity check.
	// Valid time units are "ms", "s", "m", "h".
	// +kubebuilder:default:="5s"
	// +kubebuilder:validation:Pattern="^([0-9]+(\\.[0-9]+)?(ns|us|µs|ms|s|m|h))+$"
	// +kubebuilder:validation:Type:=string
	// +optional
	PeerApiServerTimeout *metav1.Duration `json:"peerApiServerTimeout,omitempty"`

	// The frequency for api-server connectivity check.
	// Valid time units are "ms", "s", "m", "h".
	// +kubebuilder:default:="15s"
	// +kubebuilder:validation:Pattern="^([0-9]+(\\.[0-9]+)?(ns|us|µs|ms|s|m|h))+$"
	// +kubebuilder:validation:Type:=string
	// the frequency for api-server connectivity check
	// +optional
	ApiCheckInterval *metav1.Duration `json:"apiCheckInterval,omitempty"`

	// The frequency for updating peers.
	// Valid time units are "ms", "s", "m", "h".
	// +kubebuilder:default:="15m"
	// +kubebuilder:validation:Pattern="^([0-9]+(\\.[0-9]+)?(ns|us|µs|ms|s|m|h))+$"
	// +kubebuilder:validation:Type:=string
	// +optional
	PeerUpdateInterval *metav1.Duration `json:"peerUpdateInterval,omitempty"`

	// Timeout for each api-connectivity check.
	// Valid time units are "ms", "s", "m", "h".
	// +kubebuilder:default:="5s"
	// +kubebuilder:validation:Pattern="^([0-9]+(\\.[0-9]+)?(ns|us|µs|ms|s|m|h))+$"
	// +kubebuilder:validation:Type:=string
	// +optional
	ApiServerTimeout *metav1.Duration `json:"apiServerTimeout,omitempty"`

	// Timeout for establishing connection to peer.
	// Valid time units are "ms", "s", "m", "h".
	// +kubebuilder:default:="5s"
	// +kubebuilder:validation:Pattern="^([0-9]+(\\.[0-9]+)?(ns|us|µs|ms|s|m|h))+$"
	// +kubebuilder:validation:Type:=string
	// +optional
	PeerDialTimeout *metav1.Duration `json:"peerDialTimeout,omitempty"`

	// Timeout for each peer request.
	// Valid time units are "ms", "s", "m", "h".
	// +kubebuilder:default:="5s"
	// +kubebuilder:validation:Pattern="^([0-9]+(\\.[0-9]+)?(ns|us|µs|ms|s|m|h))+$"
	// +kubebuilder:validation:Type:=string
	// +optional
	PeerRequestTimeout *metav1.Duration `json:"peerRequestTimeout,omitempty"`

	// After this threshold, the node will start contacting its peers.
	// +kubebuilder:default:=3
	// +kubebuilder:validation:Minimum=1
	// +optional
	MaxApiErrorThreshold int `json:"maxApiErrorThreshold,omitempty"`

	// IsSoftwareRebootEnabled indicates whether self node remediation agent will do software reboot,
	// if the watchdog device can not be used or will use watchdog only,
	// without a fallback to software reboot.
	// +kubebuilder:default=true
	// +optional
	IsSoftwareRebootEnabled bool `json:"isSoftwareRebootEnabled,omitempty"`

	// EndpointHealthCheckUrl is an url that self node remediation agents which run on control-plane node will try to access when they can't contact their peers.
	// This is a part of self diagnostics which will decide whether the node should be remediated or not.
	// It will be ignored when empty (which is the default).
	// +optional
	EndpointHealthCheckUrl string `json:"endpointHealthCheckUrl,omitempty"`

	// HostPort is used for internal communication between SNR agents.
	// +kubebuilder:default:=30001
	// +kubebuilder:validation:Minimum=1
	// +optional
	HostPort int `json:"hostPort,omitempty"`

	// CustomDsTolerations allows to add custom tolerations snr agents that are running on the ds in order to support remediation for different types of nodes.
	// +optional
	CustomDsTolerations []v1.Toleration `json:"customDsTolerations,omitempty"`
}

type SelfNodeRemediationConfigStatus struct {
}

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

type SelfNodeRemediationSpec struct {
	//RemediationStrategy is the remediation method for unhealthy nodes.
	//Currently, it could be either "Automatic", "OutOfServiceTaint" or "ResourceDeletion".
	//ResourceDeletion will iterate over all pods and VolumeAttachment related to the unhealthy node and delete them.
	//OutOfServiceTaint will add the out-of-service taint which is a new well-known taint "node.kubernetes.io/out-of-service"
	//that enables automatic deletion of pv-attached pods on failed nodes, "out-of-service" taint is only supported on clusters with k8s version 1.26+ or OCP/OKD version 4.13+.
	// Automatic will choose the most appropriate strategy during runtime.
	// +kubebuilder:default:="Automatic"
	// +kubebuilder:validation:Enum=Automatic;ResourceDeletion;OutOfServiceTaint
	RemediationStrategy RemediationStrategyType `json:"remediationStrategy,omitempty"`
}

type SelfNodeRemediationStatus struct {
	//TimeAssumedRebooted is the time by then the unhealthy node assumed to be rebooted
	// +optional
	//+operator-sdk:csv:customresourcedefinitions:type=status
	TimeAssumedRebooted *metav1.Time `json:"timeAssumedRebooted,omitempty"`

	// Phase represents the current phase of remediation,
	// One of: TBD
	// +optional
	//+operator-sdk:csv:customresourcedefinitions:type=status
	Phase *string `json:"phase,omitempty"`

	// LastError captures the last error that occurred during remediation.
	// If no error occurred it would be empty
	//+operator-sdk:csv:customresourcedefinitions:type=status
	LastError string `json:"lastError,omitempty"`

	// +operator-sdk:csv:customresourcedefinitions:type=status,displayName="conditions",xDescriptors="urn:alm:descriptor:com.tectonic.ui:conditions"
	// Represents the observations of a SelfNodeRemediation's current state.
	// Known .status.conditions.type are: "Processing"
	// +listType=map
	// +listMapKey=type
	// +optional
	Conditions []metav1.Condition `json:"conditions,omitempty"`
}

type SelfNodeRemediationTemplate struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata,omitempty"`
	// +required
	Spec   SelfNodeRemediationTemplateSpec   `json:"spec"`
	Status SelfNodeRemediationTemplateStatus `json:"status,omitempty"`
}

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

type SelfNodeRemediationTemplateResource struct {
	Spec SelfNodeRemediationSpec `json:"spec"`
}

type SelfNodeRemediationTemplateSpec struct {
	// Template defines the desired state of SelfNodeRemediationTemplate
	//+operator-sdk:csv:customresourcedefinitions:type=spec
	Template SelfNodeRemediationTemplateResource `json:"template"`
}

type SelfNodeRemediationTemplateStatus struct {
}