v1alpha1

type CommandArgsOverrider struct {
	// The name of container
	// +required
	ContainerName string `json:"containerName"`

	// Operator represents the operator which will apply on the command/args.
	// +kubebuilder:validation:Enum=add;remove
	// +required
	Operator OverriderOperator `json:"operator"`

	// Value to be applied to command/args.
	// Items in Value which will be appended after command/args when Operator is 'add'.
	// Items in Value which match in command/args will be deleted when Operator is 'remove'.
	// If Value is empty, then the command/args will remain the same.
	// +optional
	Value []string `json:"value,omitempty"`
}

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

	// Spec represents the desired behavior of EdgeApplication.
	// +required
	Spec EdgeApplicationSpec `json:"spec,omitempty"`
	// Status represents the status of PropagationStatus.
	// +optional
	Status EdgeApplicationStatus `json:"status,omitempty"`
}

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

type EdgeApplicationSpec struct {
	// WorkloadTemplate contains original templates of resources to be deployed
	// as an EdgeApplication.
	WorkloadTemplate ResourceTemplate `json:"workloadTemplate,omitempty"`
	// WorkloadScope represents which node groups the workload will be deployed in.
	WorkloadScope WorkloadScope `json:"workloadScope"`
}

type EdgeApplicationStatus struct {
	// WorkloadStatus contains running statuses of generated resources.
	// +optional
	WorkloadStatus []ManifestStatus `json:"workloadStatus,omitempty"`
}

type EnvOverrider struct {
	// The name of container
	// +required
	ContainerName string `json:"containerName"`

	// Operator represents the operator which will apply on the env.
	// +kubebuilder:validation:Enum=add;remove;replace
	// +required
	Operator OverriderOperator `json:"operator"`

	// Value to be applied to env.
	// Must not be empty when operator is 'add' or 'replace'.
	// When the operator is 'remove', the matched value in env will be deleted
	// and only the name of the value will be matched.
	// If Value is empty, then the env will remain the same.
	// +optional
	Value []corev1.EnvVar `json:"value,omitempty"`
}

type ImageComponent string

type ImageOverrider struct {
	// Predicate filters images before applying the rule.
	//
	// Defaults to nil, in that case, the system will automatically detect image fields if the resource type is
	// Pod, ReplicaSet, Deployment or StatefulSet by following rule:
	//   - Pod: /spec/containers/<N>/image
	//   - ReplicaSet: /spec/template/spec/containers/<N>/image
	//   - Deployment: /spec/template/spec/containers/<N>/image
	//   - StatefulSet: /spec/template/spec/containers/<N>/image
	// In addition, all images will be processed if the resource object has more than one containers.
	//
	// If not nil, only images matches the filters will be processed.
	// +optional
	Predicate *ImagePredicate `json:"predicate,omitempty"`

	// Component is part of image name.
	// Basically we presume an image can be made of '[registry/]repository[:tag]'.
	// The registry could be:
	// - k8s.gcr.io
	// - fictional.registry.example:10443
	// The repository could be:
	// - kube-apiserver
	// - fictional/nginx
	// The tag cloud be:
	// - latest
	// - v1.19.1
	// - @sha256:dbcc1c35ac38df41fd2f5e4130b32ffdb93ebae8b3dbe638c23575912276fc9c
	//
	// +kubebuilder:validation:Enum=Registry;Repository;Tag
	// +required
	Component ImageComponent `json:"component"`

	// Operator represents the operator which will apply on the image.
	// +kubebuilder:validation:Enum=add;remove;replace
	// +required
	Operator OverriderOperator `json:"operator"`

	// Value to be applied to image.
	// Must not be empty when operator is 'add' or 'replace'.
	// Defaults to empty and ignored when operator is 'remove'.
	// +optional
	Value string `json:"value,omitempty"`
}

type ImagePredicate struct {
	// Path indicates the path of target field
	// +required
	Path string `json:"path"`
}

type Manifest struct {
	// +kubebuilder:pruning:PreserveUnknownFields
	runtime.RawExtension `json:",inline"`
}

type ManifestCondition string

type ManifestStatus struct {
	// Identifier represents the identity of a resource linking to manifests in spec.
	// +required
	Identifier ResourceIdentifier `json:"identifier"`

	// Conditions contain the different condition statuses for this manifest.
	// Valid condition types are:
	// 1. Processing: this workload is under processing and the current state of manifest does not match the desired.
	// 2. Available: the current status of this workload matches the desired.
	// +kubebuilder:validation:Enum=Processing;Available
	// +optional
	Condition ManifestCondition `json:"conditions,omitempty"`
}

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

	// Spec represents the specification of the desired behavior of member nodegroup.
	// +required
	Spec NodeGroupSpec `json:"spec,omitempty"`

	// Status represents the status of member nodegroup.
	// +optional
	Status NodeGroupStatus `json:"status,omitempty"`
}

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

type NodeGroupSpec struct {
	// Nodes contains names of all the nodes in the nodegroup.
	// +optional
	Nodes []string `json:"nodes,omitempty"`

	// MatchLabels are used to select nodes that have these labels.
	// +optional
	MatchLabels map[string]string `json:"matchLabels,omitempty"`
}

type NodeGroupStatus struct {
	// NodeStatuses is a status list of all selected nodes.
	// +optional
	NodeStatuses []NodeStatus `json:"nodeStatuses,omitempty"`
}

type NodeStatus struct {
	// NodeName contains name of this node.
	// +required
	NodeName string `json:"nodeName"`
	// ReadyStatus contains ready status of this node.
	// +required
	ReadyStatus ReadyStatus `json:"readyStatus"`
	// SelectionStatus contains status of the selection result for this node.
	// +required
	SelectionStatus SelectionStatus `json:"selectionStatus"`
	// SelectionStatusReason contains human-readable reason for this SelectionStatus.
	// +optional
	SelectionStatusReason string `json:"selectionStatusReason,omitempty"`
}

type OverriderOperator string

type Overriders struct {
	// Replicas will override the replicas field of deployment
	// +optional
	Replicas *int `json:"replicas,omitempty"`
	// ImageOverriders represents the rules dedicated to handling image overrides.
	// +optional
	ImageOverriders []ImageOverrider `json:"imageOverriders,omitempty"`
	// EnvOverriders will override the env field of the container
	// +optional
	EnvOverriders []EnvOverrider `json:"envOverriders,omitempty"`
	// CommandOverriders represents the rules dedicated to handling container command
	// +optional
	CommandOverriders []CommandArgsOverrider `json:"commandOverriders,omitempty"`
	// ArgsOverriders represents the rules dedicated to handling container args
	// +optional
	ArgsOverriders []CommandArgsOverrider `json:"argsOverriders,omitempty"`
	// ResourcesOverriders will override the resources field of the container
	// +optional
	ResourcesOverriders []ResourcesOverrider `json:"resourcesOverriders,omitempty"`
}

type ReadyStatus string

type ResourceIdentifier struct {
	// Ordinal represents an index in manifests list, so the condition can still be linked
	// to a manifest even though manifest cannot be parsed successfully.
	// +kubebuilder:validation:Minimum=0
	// +required
	Ordinal int `json:"ordinal"`

	// Group is the group of the resource.
	// +optional
	Group string `json:"group,omitempty"`

	// Version is the version of the resource.
	// +optional
	Version string `json:"version,omitempty"`

	// Kind is the kind of the resource.
	// +optional
	Kind string `json:"kind,omitempty"`

	// Resource is the resource type of the resource
	// +optional
	Resource string `json:"resource,omitempty"`

	// Namespace is the namespace of the resource
	// +optional
	Namespace string `json:"namespace,omitempty"`

	// Name is the name of the resource
	// +optional
	Name string `json:"name,omitempty"`
}

type ResourceTemplate struct {
	// Manifests represent a list of Kubernetes resources to be deployed on the managed node groups.
	// +optional
	Manifests []Manifest `json:"manifests,omitempty"`
}

type ResourcesOverrider struct {
	// The name of container
	// +required
	ContainerName string `json:"containerName"`

	// Value to be applied to resources.
	// Must not be empty
	// +required
	Value corev1.ResourceRequirements `json:"value,omitempty"`
}

type SelectionStatus string

type TargetNodeGroup struct {
	// Name represents the name of target node group
	Name string `json:"name"`
	// Overriders represents the override rules that would apply on workload.
	Overriders Overriders `json:"overriders,omitempty"`
}

type TargetNodeLabel struct {
	// LabelSelector represents the label selectors used to match nodes for workload deployment.
	// It defines the criteria for selecting the target nodes based on their labels.
	// +optional
	LabelSelector metav1.LabelSelector `json:"labelSelector,omitempty"`

	// Overriders represents the override rules that would apply to the workload for the nodes
	// selected by the label selector.
	Overriders Overriders `json:"overriders,omitempty"`
}

type WorkloadScope struct {
	// TargetNodeGroups represents the target node groups of workload to be deployed.
	// +optional
	TargetNodeGroups []TargetNodeGroup `json:"targetNodeGroups,omitempty"`
	// TargetNodeLabels represents the target nodes with specified labels of workload to be deployed
	// +optional
	TargetNodeLabels []TargetNodeLabel `json:"targetNodeLabels,omitempty"`
}