v1

type ConfigMapKeySelector struct {
	// Name of the ConfigMap.
	Name string `json:"name"`
	// Key within the ConfigMap that contains the script (e.g., "measure.sh").
	Key string `json:"key"`
}

type ConnectivityStatus string

type ExportMetricSpec struct {
	// Method to export the metrics. Reserved names include: "codeco-swm", which includes an interface for the
	// codeco swm crd. Interface must be implemented
	// for the method, so this must be designed beforehand.
	//+kubebuilder:default="default"
	Method string `json:"method,omitempty"`

	//+kubebuilder:default:="default"
	ServiceAccount string `json:"serviceAccount,omitempty"`

	// Additional configuration parameters that may be set by developer to implement different kinds
	// of flexible key-value pairs. In the case of the codeco-swm, "namespace" is included.
	Config map[string]string `json:"config,omitempty"`
}

type IDSRuleSource struct {
	// Name is a friendly identifier for this rule set
	Name string `json:"name"`

	// URL allows fetching a remote ruleset (e.g., specific version of ET Open).
	// The controller will need logic to download and cache this.
	// +optional
	URL string `json:"url,omitempty"`

	// Inline allows the user to paste a raw Suricata rule directly in the YAML.
	// Example: "alert tcp any any -> any 80 (msg:\"test rule\"; sid:100001; rev:1;)"
	// +optional
	Inline string `json:"inline,omitempty"`

	// ConfigMapRef allows loading rules from a Kubernetes ConfigMap.
	// Useful for large, organization-specific rule sets managed separately.
	// +optional
	ConfigMapRef *corev1.LocalObjectReference `json:"configMapRef,omitempty"`
}

type IdsRules struct {
	// Enabled allows toggling the IDS on/off without deleting the config.
	// +kubebuilder:default:=true
	Enabled bool `json:"enabled"`

	// HomeNetCIDR overrides the SURICATA $HOME_NET variable.
	// If empty, the controller should default this to the L2Network's NetworkCIDR.
	// +optional
	HomeNetCIDR []string `json:"homeNetCidr,omitempty"`

	// UseEmergingThreatsOpen is a high-level boolean to automatically enable
	// the standard "ET Open" ruleset without needing to manually configure URLs.
	// +kubebuilder:default:=true
	UseEmergingThreatsOpen bool `json:"useEmergingThreatsOpen"`

	// CustomRuleSources allows adding specific rule files or inline rules.
	// +optional
	CustomRuleSources []IDSRuleSource `json:"customRuleSources,omitempty"`

	// IgnorePorts allows whitelisting specific traffic flow from inspection
	// to improve performance or reduce false positives (BPF Filter generation).
	// +optional
	IgnorePorts []int32 `json:"ignorePorts,omitempty"`
}

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

	Spec   L2NetworkSpec   `json:"spec,omitempty"`
	Status L2NetworkStatus `json:"status,omitempty"`
}

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

type L2NetworkSpec struct {

	// NetworkType represents the type of network being configured.
	Type NetworkType `json:"type"`

	// Config is an optional field that is meant to be used as additional configuration depending on the type of network. Check each type of network for specific configuration definitions.
	Config *string `json:"config,omitempty"`

	// Provider is an optional field representing a provider spec. Check the provider spec definition for more details
	Provider *ProviderSpec `json:"provider,omitempty"`

	// NetworkCIDR defines the overall network CIDR used for routing pod interfaces.
	// This value represents the broader network segment that encompasses all pod IPs,
	// e.g. 10.101.0.0/16.
	NetworkCIDR string `json:"networkCIDR,omitempty"`

	// PodAddressRange specifies the specific pool of IP addresses that can be assigned to pods.
	// This range should be a subset of the overall network CIDR, e.g. 10.101.2.0/24.
	PodAddressRange string `json:"podAddressRange,omitempty"`

	// Ids configures the intrusion detection system.
	// +optional
	Ids *IdsRules `json:"ids,omitempty"`
}

type L2NetworkStatus struct {

	// +kubebuilder:validation:Optional
	// +kubebuilder:default=0
	ConnectedPodCount int `json:"connectedPodCount,omitempty"`
	// Last assigned IP, used for sequential allocation
	LastAssignedIP string `json:"lastAssignedIP,omitempty"`

	// Existing Pods in the network
	AssignedIPs map[string]string `json:"assignedIPs,omitempty"`

	// Status of the connectivity to the internal SDN Controller. If there is no connection, internal l2sm-switches won't forward traffic
	// +kubebuilder:default=Unavailable
	InternalConnectivity *ConnectivityStatus `json:"internalConnectivity"`

	// Status of the connectivity to the external provider SDN Controller. If there is no connectivity, the exisitng l2sm-ned in the cluster won't forward packages to the external clusters.
	ProviderConnectivity *ConnectivityStatus `json:"providerConnectivity,omitempty"`
}

type Link struct {
	// EndpointA is the name of the first node in the link.
	EndpointA string `json:"endpointA"`
	// EndpointB is the name of the second node in the link.
	EndpointB string `json:"endpointB"`
}

type LinkStatus struct {
	// SourceNode is the name of the node where the measurement originated.
	SourceNode string `json:"sourceNode"`

	// TargetNode is the name of the neighbor node being measured.
	TargetNode string `json:"targetNode"`

	// Status indicates if the link is "Up", "Down", or "Degraded".
	Status string `json:"status"`

	// Metrics contains the list of latest measurements for this link.
	Metrics []MetricValue `json:"metrics,omitempty"`
}

type MetricSpec struct {
	// Name identifies the metric.
	// Reserved names: "rtt", "jitter", "throughput".
	// If a reserved name is used, the internal Go implementation is used by default.
	// If a custom name is used, 'scriptSource' is required.
	Name string `json:"name"`

	// Interval specifies the time in minutes between measurements.
	// If not set (nil), the metric runs in "continuous mode", consuming the live stream of the measurement tool.
	// +optional
	Interval *int `json:"interval,omitempty"`

	// ScriptSource points to a ConfigMap containing a shell script to execute for this metric.
	// If provided, this script overrides the internal implementation (even for reserved names).
	// The script must print the measurement value to stdout.
	// +optional
	ScriptSource *ConfigMapKeySelector `json:"scriptSource,omitempty"`
}

type MetricValue struct {
	// Name of the metric (e.g., "rtt", "jitter", "custom-loss").
	Name string `json:"name"`

	// Value is the latest measurement as a float (e.g., 12.5).
	Value string `json:"value"`
}

type MonitorSpec struct {
	// Metrics is the list of measurements to perform on the overlay network.
	// Supports built-in metrics (rtt, jitter, throughput) and custom script-based metrics.
	Metrics []MetricSpec `json:"metrics"`

	// SpreadFactor determines how metric execution is distributed over time to avoid congestion.
	// A higher value spreads execution more widely.
	// +kubebuilder:default:="0.2"
	SpreadFactor string `json:"spreadFactor,omitempty"`

	ExportMetrics *ExportMetricSpec `json:"exportMetric,omitempty"`

	NetworkCIDR *string `json:"networkCIDR,omitempty"`
	IpCIDR      *string `json:"ipCIDR,omitempty"`
}

type NeighborSpec struct {

	// Name of the cluster the link is going to be made upon.
	Node string `json:"node"`

	// Domain where the neighbor's NED switch can be reached at. Must be a valid IP Address or Domain name, reachable from the node the NED
	// is going to be deployed at.
	Domain string `json:"domain"`

	// only used in monitoring mode. Ip address for network edge device probing interface
	LpmIp *string `json:"lpmIp,omitempty"`
}

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

	Spec   NetworkEdgeDeviceSpec   `json:"spec,omitempty"`
	Status NetworkEdgeDeviceStatus `json:"status,omitempty"`
}

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

type NetworkEdgeDeviceSpec struct {

	// The SDN Controller that manages the overlay network. Must specify a domain and a name.
	Provider *ProviderSpec `json:"provider"`

	// Node Configuration
	NodeConfig *NodeConfigSpec `json:"nodeConfig,omitempty"`

	// Field exclusive to the multi-domain overlay type. If specified in other  types of overlays, the reosurce will launch an error and won't be created.
	Neighbors []NeighborSpec `json:"neighbors,omitempty"`

	// Template describes the virtual switch pod that will be created.
	SwitchTemplate *SwitchTemplateSpec `json:"switchTemplate,omitempty"`

	// Monitor enables the performance measurement probing mechanism.
	// If omitted, no metrics are collected.
	// +optional
	Monitor *MonitorSpec `json:"monitor,omitempty"`
}

type NetworkEdgeDeviceStatus struct {

	// Status of the overlay. Is available when switches are connected between them and with the network Controller.
	// +kubebuilder:default=Unavailable
	Availability *ConnectivityStatus `json:"availability"`

	ConnectedNeighbors []NeighborSpec `json:"connectedNeighbors,omitempty"`

	OpenflowId string `json:"openflowId,omitempty"`

	// LinkMetrics holds the performance data for every monitored link.
	// +optional
	LinkMetrics *[]LinkStatus `json:"linkMetrics,omitempty"`
}

type NetworkType string

type NodeConfigSpec struct {
	NodeName string `json:"nodeName"`

	IPAddress string `json:"ipAddress"`
}

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

	Spec   OverlaySpec   `json:"spec,omitempty"`
	Status OverlayStatus `json:"status,omitempty"`
}

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

type OverlaySpec struct {

	// The SDN Controller that manages the overlay network. Must specify a domain and a name.
	Provider *ProviderSpec `json:"provider"`

	// Topology represents the desired topology, it's represented by the 'Nodes' field, a list of nodes where the switches are going to be deployed and a list of bidirectional links,
	// selecting the nodes that are going to be linked.
	Topology *TopologySpec `json:"topology,omitempty"`

	// Template describes the virtual switch pod that will be created.
	SwitchTemplate *SwitchTemplateSpec `json:"switchTemplate,omitempty"`

	// Interface number specifies how many interfaces the switch should have predefined (if used with multus)
	//+kubebuilder:default:value=10
	InterfaceNumber int `json:"interfaceNumber,omitempty"`

	// Monitor enables the performance measurement probing mechanism.
	// If omitted, no metrics are collected.
	// +optional
	Monitor *MonitorSpec `json:"monitor,omitempty"`
}

type OverlayStatus struct {
	// LinkMetrics holds the performance data for every monitored link.
	// +optional
	LinkMetrics *[]LinkStatus `json:"linkMetrics,omitempty"`
}

type ProviderSpec struct {
	Name   string   `json:"name"`
	Domain []string `json:"domain"`

	//+kubebuilder:default:value="30808"
	SDNPort string `json:"sdnPort,omitempty"`

	// DNS service configuration
	//+kubebuilder:default:="30053"
	// DNS protocol port (used for DNS queries via tools like dig)
	DNSPort string `json:"dnsPort,omitempty"`

	//+kubebuilder:default:="30818"
	// gRPC management port for DNS service (used for adding/modifying DNS entries)
	DNSGRPCPort string `json:"dnsGrpcPort,omitempty"`

	//+kubebuilder:default:value="6633"
	OFPort string `json:"ofPort,omitempty"`
}

type SwitchPodSpec struct {
	// List of volumes that can be mounted by containers belonging to the pod.
	// More info: https://kubernetes.io/docs/concepts/storage/volumes
	// +optional
	// +patchMergeKey=name
	// +patchStrategy=merge,retainKeys
	// +listType=map
	// +listMapKey=name
	Volumes []corev1.Volume `json:"volumes,omitempty" patchStrategy:"merge,retainKeys" patchMergeKey:"name" protobuf:"bytes,1,rep,name=volumes"`
	// List of initialization containers belonging to the pod.
	// Init containers are executed in order prior to containers being started. If any
	// init container fails, the pod is considered to have failed and is handled according
	// to its restartPolicy. The name for an init container or normal container must be
	// unique among all containers.
	// Init containers may not have Lifecycle actions, Readiness probes, Liveness probes, or Startup probes.
	// The resourceRequirements of an init container are taken into account during scheduling
	// by finding the highest request/limit for each resource type, and then using the max of
	// of that value or the sum of the normal containers. Limits are applied to init containers
	// in a similar fashion.
	// Init containers cannot currently be added or removed.
	// Cannot be updated.
	// More info: https://kubernetes.io/docs/concepts/workloads/pods/init-containers/
	// +patchMergeKey=name
	// +patchStrategy=merge
	// +listType=map
	// +listMapKey=name
	InitContainers []corev1.Container `json:"initContainers,omitempty" patchStrategy:"merge" patchMergeKey:"name" protobuf:"bytes,20,rep,name=initContainers"`
	// List of containers belonging to the pod.
	// Containers cannot currently be added or removed.
	// There must be at least one container in a Pod.
	// Cannot be updated.
	// +patchMergeKey=name
	// +patchStrategy=merge
	// +listType=map
	// +listMapKey=name
	Containers []corev1.Container `json:"containers" patchStrategy:"merge" patchMergeKey:"name" protobuf:"bytes,2,rep,name=containers"`
	// Host networking requested for this pod. Use the host's network namespace.
	// If this option is set, the ports that will be used must be specified.
	// Default to false.
	// +k8s:conversion-gen=false
	// +optional
	HostNetwork bool `json:"hostNetwork,omitempty" protobuf:"varint,11,opt,name=hostNetwork"`
}

type SwitchTemplateSpec struct {
	// Standard object's metadata.
	// More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
	// +optional
	metav1.ObjectMeta `json:"metadata,omitempty"`

	// Specification of the desired behavior of the pod.
	// More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
	// +optional
	Spec SwitchPodSpec `json:"spec,omitempty"`
}

type TopologySpec struct {
	// Nodes is a list of node names where switches will be deployed.
	Nodes []string `json:"nodes"`
	// Links is a list of connections between the defined nodes.
	Links []Link `json:"links,omitempty"`
}