v1

type Checkpoint struct {
	// PathIndex is the index of current path in operation set status.
	PathIndex int `json:"pathIndex"`
	// NodeIndex is the index of current node in path.
	NodeIndex int `json:"nodeIndex"`
}

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

	Spec   CommonEventSpec   `json:"spec,omitempty"`
	Status CommonEventStatus `json:"status,omitempty"`
}

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

type CommonEventSpec struct {
	Summary       string            `json:"summary"`
	Source        string            `json:"source"`
	Severity      string            `json:"severity"`
	Timestamp     string            `json:"timestamp,omitempty"`
	Class         string            `json:"class,omitempty"`
	Component     string            `json:"component,omitempty"`
	Group         string            `json:"group,omitempty"`
	CustomDetails map[string]string `json:"customDetails,omitempty"`
}

type CommonEventStatus struct {
	Count          int          `json:"count,omitempty"`
	Resolved       bool         `json:"resolved,omitempty"`
	Diagnosed      bool         `json:"diagnosed,omitempty"`
	LastUpdateTime *metav1.Time `json:"lastUpdateTime,omitempty"`
}

type CommonEventTemplate struct {
	Regexp CommonEventTemplateRegexp `json:"regexp,omitempty"`
}

type CommonEventTemplateRegexp struct {
	// Source is the regular expression for matching "Source" of common event.
	// +optional
	Source string `json:"source,omitempty"`
	// Severity is the regular expression for matching "Severity" of common event.
	// +optional
	Severity string `json:"severity,omitempty"`
	// Class is the regular expression for matching "Class" of common event.
	// +optional
	Class string `json:"class,omitempty"`
	// Component is the regular expression for matching "Component" of common event.
	// +optional
	Component string `json:"component,omitempty"`
	// Group is the regular expression for matching "Group" of common event.
	// +optional
	Group string `json:"group,omitempty"`
}

type CronTemplate struct {
	// Schedule is the schedule in cron format.
	// See https://en.wikipedia.org/wiki/Cron for more details.
	Schedule string `json:"schedule"`
}

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

	Spec   DiagnosisSpec   `json:"spec,omitempty"`
	Status DiagnosisStatus `json:"status,omitempty"`
}

type DiagnosisCondition struct {
	// Type is the type of the condition.
	Type DiagnosisConditionType `json:"type"`
	// Status is the status of the condition.
	// Can be True, False, Unknown.
	Status corev1.ConditionStatus `json:"status"`
	// LastTransitionTime specifies last time the condition transitioned from one status
	// to another.
	// +optional
	LastTransitionTime metav1.Time `json:"lastTransitionTime,omitempty"`
	// Reason is a unique, one-word, CamelCase reason for the condition's last transition.
	// +optional
	Reason string `json:"reason,omitempty"`
	// Message is a human readable message indicating details about last transition.
	// +optional
	Message string `json:"message,omitempty"`
}

type DiagnosisConditionType string

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

type DiagnosisPhase string

type DiagnosisSpec struct {
	// OperationSet is the name of operation set which represents diagnosis pipeline to be executed.
	OperationSet string `json:"operationSet"`
	// One of NodeName and PodReference must be specified.
	// NodeName is a specific node which the diagnosis is on.
	// +optional
	NodeName string `json:"nodeName,omitempty"`
	// PodReference contains details of the target pod.
	// +optional
	PodReference *PodReference `json:"podReference,omitempty"`
	// Parameters is a set of the parameters to be passed to opreations.
	// Parameters and OperationResults are encoded into a json object and sent to operation processor when
	// running diagnosis.
	// +optional
	Parameters map[string]string `json:"parameters,omitempty"`
}

type DiagnosisStatus struct {
	// Phase is a simple, high-level summary of where the diagnosis is in its lifecycle.
	// The conditions array, the reason and message fields contain more detail about the
	// pod's status.
	// There are five possible phase values:
	//
	// DiagnosisPending: The diagnosis has been accepted by the system, but no operation has been started.
	// DiagnosisRunning: The diagnosis has been bound to a node and one of the operations have been started.
	// At least one operation is still running.
	// DiagnosisSucceeded: All operations in some path have voluntarily terminated with a response code
	// of 200, and the system is not going to execute rest operations.
	// DiagnosisFailed: All paths in the graph have terminated, and at least one operation in each path
	// terminated in a failure.
	// DiagnosisUnknown: For some reason the state of the diagnosis could not be obtained, typically due
	// to an error in communicating with the host of the diagnosis.
	// +optional
	Phase DiagnosisPhase `json:"phase,omitempty"`
	// Conditions contains current service state of diagnosis.
	// +optional
	Conditions []DiagnosisCondition `json:"conditions,omitempty"`
	// StartTime is RFC 3339 date and time at which the object was acknowledged by the system.
	// +optional
	StartTime metav1.Time `json:"startTime,omitempty"`
	// FailedPaths contains all failed paths in diagnosis pipeline.
	// The last node in the path is the one which fails to execute operation.
	// +optional
	FailedPaths []Path `json:"failedPaths,omitempty"`
	// SucceededPath is the succeeded paths in diagnosis pipeline.
	// +optional
	SucceededPath Path `json:"succeededPath,omitempty"`
	// OperationResults contains results of operations.
	// Parameters and OperationResults are encoded into a json object and sent to operation processor when
	// running diagnosis.
	// +optional
	OperationResults map[string]string `json:"operationResults,omitempty"`
	// Checkpoint is the checkpoint for resuming unfinished diagnosis.
	// +optional
	Checkpoint *Checkpoint `json:"checkpoint,omitempty"`
}

type Function struct {
	// CodeSource contains the code source files.
	CodeSource map[string]string `json:"codeSource"`
	// Runtime is the language to use for writing a function.
	Runtime FunctionRuntime `json:"runtime"`
}

type FunctionRuntime string

type HTTPServer struct {
	// Address is the serving address of the processor. It must be either an ip or a dns address.
	// Defaults to kubediag agent advertised address if not specified.
	// +optional
	Address *string `json:"address,omitempty"`
	// Port is the serving port of the processor.
	// Defaults to kubediag agent serving port if not specified.
	// +optional
	Port *int32 `json:"port,omitempty"`
	// Path is the serving http path of processor.
	// +optional
	Path *string `json:"path,omitempty"`
	// Scheme is the serving scheme of processor. It must be either http or https.
	// +optional
	Scheme *string `json:"scheme,omitempty"`
}

type HostPath struct {
	// Path of the directory on the host.
	// Defaults to kubediag agent data root if not specified.
	Path string `json:"path"`
}

type KubernetesEventTemplate struct {
	// Regexp is the regular expression for matching kubernetes event template.
	Regexp KubernetesEventTemplateRegexp `json:"regexp"`
}

type KubernetesEventTemplateRegexp struct {
	// Name is the regular expression for matching "Name" of kubernetes event.
	// +optional
	Name string `json:"name,omitempty"`
	// Namespace is the regular expression for matching "Namespace" of kubernetes event.
	// +optional
	Namespace string `json:"namespace,omitempty"`
	// Reason is the regular expression for matching "Reason" of kubernetes event.
	// +optional
	Reason string `json:"reason,omitempty"`
	// Message is the regular expression for matching "Message" of kubernetes event.
	// +optional
	Message string `json:"message,omitempty"`
	// Source is the regular expression for matching "Source" of kubernetes event.
	// All fields of "Source" are regular expressions.
	// +optional
	Source corev1.EventSource `json:"source,omitempty"`
}

type NamespacedName struct {
	// Namespace specifies the namespace of a kubernetes api resource.
	Namespace string `json:"namespace"`
	// Name specifies the name of a kubernetes api resource.
	Name string `json:"name"`
}

type Node struct {
	// ID is the unique identifier of the node.
	// It is identical to node index in adjacency list and set by admission webhook server.
	// +optional
	ID int `json:"id,omitempty"`
	// To is the list of node ids this node links to.
	// +optional
	To NodeSet `json:"to,omitempty"`
	// Operation is the name of operation running on the node.
	// It is empty if the node is the first in the list.
	// +optional
	Operation string `json:"operation,omitempty"`
	// Dependences is the list of depended node ids.
	// +optional
	Dependences NodeSet `json:"dependences,omitempty"`
}

type NodeSet []int

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

	Spec OperationSpec `json:"spec,omitempty"`
}

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

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

	Spec   OperationSetSpec   `json:"spec,omitempty"`
	Status OperationSetStatus `json:"status,omitempty"`
}

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

type OperationSetSpec struct {
	// AdjacencyList contains all nodes in the directed acyclic graph. The first node in the list represents the
	// start of a diagnosis.
	AdjacencyList []Node `json:"adjacencyList"`
}

type OperationSetStatus struct {
	// Paths is the collection of all directed paths of the directed acyclic graph.
	// +optional
	Paths []Path `json:"paths,omitempty"`
	// Specifies whether a valid directed acyclic graph can be generated via provided nodes.
	Ready bool `json:"ready"`
}

type OperationSpec struct {
	// Processor describes how to register a operation processor into kubediag.
	Processor Processor `json:"processor"`
	// Dependences is the list of all depended operations required to be precedently executed.
	// +optional
	Dependences []string `json:"dependences,omitempty"`
	// Storage represents the type of storage for operation results.
	// Operation results will not be stored if nil.
	// +optional
	Storage *Storage `json:"storage,omitempty"`
}

type Path []Node

type PodReference struct {
	NamespacedName `json:",inline"`
	// Container specifies name of the target container.
	// +optional
	Container string `json:"container,omitempty"`
}

type Processor struct {
	// One and only one of the following processor should be specified.
	// HTTPServer specifies the http server to do operations.
	// +optional
	HTTPServer *HTTPServer `json:"httpServer,omitempty"`
	// ScriptRunner contains the information to run a script.
	// +optional
	ScriptRunner *ScriptRunner `json:"scriptRunner,omitempty"`
	// Function contains the details to run a function as an operation.
	// +optional
	Function *Function `json:"function,omitempty"`
	// Number of seconds after which the processor times out.
	// Defaults to 30 seconds. Minimum value is 1.
	// +optional
	TimeoutSeconds *int32 `json:"timeoutSeconds,omitempty"`
}

type PrometheusAlertTemplate struct {
	// Regexp is the regular expression for matching prometheus alert template.
	Regexp PrometheusAlertTemplateRegexp `json:"regexp"`
	// NodeNameReferenceLabel specifies the label for setting ".spec.nodeName" of generated diagnosis.
	// The label value will be set as ".spec.nodeName" field.
	// +optional
	NodeNameReferenceLabel model.LabelName `json:"nodeNameReferenceLabel,omitempty"`
	// PodNamespaceReferenceLabel specifies the label for setting ".spec.podReference.namespace" of generated diagnosis.
	// The label value will be set as ".spec.podReference.namespace" field.
	// +optional
	PodNamespaceReferenceLabel model.LabelName `json:"podNamespaceReferenceLabel,omitempty"`
	// PodNameReferenceLabel specifies the label for setting ".spec.podReference.name" of generated diagnosis.
	// The label value will be set as ".spec.podReference.name" field.
	// +optional
	PodNameReferenceLabel model.LabelName `json:"podNameReferenceLabel,omitempty"`
	// ContainerReferenceLabel specifies the label for setting ".spec.podReference.container" of generated diagnosis.
	// The label value will be set as ".spec.podReference.container" field.
	// +optional
	ContainerReferenceLabel model.LabelName `json:"containerReferenceLabel,omitempty"`
	// ParameterInjectionLabels specifies the labels for setting ".spec.parameters" of generated diagnosis.
	// All label names and values will be set as key value pairs in ".spec.parameters" field.
	// +optional
	ParameterInjectionLabels []model.LabelName `json:"parameterInjectionLabels,omitempty"`
}

type PrometheusAlertTemplateRegexp struct {
	// AlertName is the regular expression for matching "AlertName" of prometheus alert.
	// +optional
	AlertName string `json:"alertName,omitempty"`
	// Labels is the regular expression for matching "Labels" of prometheus alert.
	// Only label values are regular expressions while all label names must be identical to the
	// prometheus alert label names.
	// +optional
	Labels model.LabelSet `json:"labels,omitempty"`
	// Annotations is the regular expression for matching "Annotations" of prometheus alert.
	// Only annotation values are regular expressions while all annotation names must be identical to the
	// prometheus alert annotation names.
	// +optional
	Annotations model.LabelSet `json:"annotations,omitempty"`
	// StartsAt is the regular expression for matching "StartsAt" of prometheus alert.
	// +optional
	StartsAt string `json:"startsAt,omitempty"`
	// EndsAt is the regular expression for matching "EndsAt" of prometheus alert.
	// +optional
	EndsAt string `json:"endsAt,omitempty"`
	// GeneratorURL is the regular expression for matching "GeneratorURL" of prometheus alert.
	// +optional
	GeneratorURL string `json:"generatorURL,omitempty"`
}

type ScriptRunner struct {
	// Script is the content of shell script.
	Script string `json:"script"`
	// ArgKeys contains a slice of keys in parameters or operationResults. The script arguments are generated
	// from specified key value pairs.
	// No argument will be passed to the script if not specified.
	// +optional
	ArgKeys []string `json:"argKeys,omitempty"`
	// OperationResultKey is the prefix of keys to store script stdout, stderr or error message in operationResults.
	// Execution results will not be updated if not specified.
	// +optional
	OperationResultKey *string `json:"operationResultKey,omitempty"`
}

type SourceTemplate struct {
	// One and only one of the following source should be specified.
	// PrometheusAlertTemplate specifies the template to create a diagnosis from a prometheus alert.
	// +optional
	PrometheusAlertTemplate *PrometheusAlertTemplate `json:"prometheusAlertTemplate,omitempty"`
	// KubernetesEventTemplate specifies the template to create a diagnosis from a kubernetes event.
	// +optional
	KubernetesEventTemplate *KubernetesEventTemplate `json:"kubernetesEventTemplate,omitempty"`
	// CommonEventTemplate specifies the template to create a diagnosis from a common event.
	// +optional
	CommonEventTemplate *CommonEventTemplate `json:"commonEventTemplate,omitempty"`
	// CronTemplate specifies the template to create a diagnosis periodically at fixed times.
	// +optional
	CronTemplate *CronTemplate `json:"cronTemplate,omitempty"`
}

type Storage struct {
	// HostPath represents a directory on the host.
	// +optional
	HostPath *HostPath `json:"hostPath,omitempty"`
}

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

	Spec   TriggerSpec   `json:"spec,omitempty"`
	Status TriggerStatus `json:"status,omitempty"`
}

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

type TriggerSpec struct {
	// OperationSet is the name of referenced operation set in the generated diagnosis.
	OperationSet string `json:"operationSet"`
	// Parameters is a set of the parameters to be passed to diagnosis.
	// +optional
	Parameters map[string]string `json:"parameters,omitempty"`
	// NodeName is the default node which the diagnosis is on.
	// +optional
	NodeName string `json:"nodeName,omitempty"`
	// SourceTemplate is the template of trigger.
	SourceTemplate SourceTemplate `json:"sourceTemplate"`
}

type TriggerStatus struct {
	// LastScheduleTime is the last time the cron was successfully scheduled.
	// +optional
	LastScheduleTime *metav1.Time `json:"lastScheduleTime,omitempty"`
}