v1alpha1

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

	// Desired state of the IP allocation.
	Spec IPAllocationSpec `json:"spec,omitempty"`

	// Observed state of the IP allocation.
	Status IPAllocationStatus `json:"status,omitempty"`
}

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

type IPAllocationPhase string

type IPAllocationSpec struct {
	// Desired IP family of the address to allocate. Must be either "IPv4" or "IPv6".
	// +kubebuilder:validation:Enum=IPv4;IPv6
	// +optional
	IPFamily corev1.IPFamily `json:"ipFamily,omitempty"`

	// Name of the desired IP pool to allocate an address from.
	// +kubebuilder:validation:MaxLength=253
	// +kubebuilder:validation:Pattern=`^[a-z0-9]([a-z0-9\-\.]*[a-z0-9])?$`
	// +optional
	PoolName string `json:"poolName,omitempty"`

	// Specific IP address to allocate. Must be a valid IPv4 or IPv6 address.
	// +optional
	Address string `json:"address,omitempty"`
}

type IPAllocationStatus struct {
	// Phase is the current status phase of the allocation.
	// +optional
	// +kubebuilder:default=Pending
	Phase IPAllocationPhase `json:"phase,omitempty"`

	// Address is the allocated IP address. This is only set if Phase is "Allocated"
	// or "Programmed".
	// +optional
	Address string `json:"address,omitempty"`

	// Whether the allocated address is configured for advertisement via ARP/NDP on
	// the router. This is only set if Phase is "Allocated" or "Programmed".
	// +optional
	Advertised bool `json:"advertised,omitempty"`

	// InterfaceName is the name of the network interface the allocated address is
	// advertised on. This is only definitly set in phase "Programmed" and might be
	// set in phase "Allocated".
	// +optional
	InterfaceName string `json:"interfaceName,omitempty"`

	// Conditions hold the latest available observations of the IPAllocation's state.
	// +optional
	// +patchMergeKey=type
	// +patchStrategy=merge
	// +listType=map
	// +listMapKey=type
	Conditions []metav1.Condition `json:"conditions,omitempty" patchStrategy:"merge" patchMergeKey:"type"`

	// ObservedGeneration is the most recent generation observed by the controller for
	// this IPAllocation. It is used to detect if the spec has been updated since the
	// last reconciliation.
	// +optional
	ObservedGeneration int64 `json:"observedGeneration,omitempty"`
}

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

	// Desired state of the IP pool.
	Spec IPPoolSpec `json:"spec,omitempty"`

	// Observed state of the IP pool.
	Status IPPoolStatus `json:"status,omitempty"`
}

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

type IPPoolSpec struct {
	// IP family of the addresses in this pool. Must be either "IPv4" or "IPv6".
	// +kubebuilder:validation:Required
	// +kubebuilder:validation:Enum=IPv4;IPv6
	IPFamily corev1.IPFamily `json:"ipFamily"`

	// List of CIDRs, ranges or individual IPs, e.g. "192.168.1.0/24", "10.0.0.5",
	// "172.16.10.7-172.16.10.10" or "fd37:274a:df59::/64". You can use the prefix "!"
	// to exclude specific addresses or ranges from the pool, e.g. "!10.1.2.3" or
	// "!10.1.0.0/24". Exclusions take precedence over inclusions, so if an IP matches
	// both an inclusion and an exclusion, it will be excluded.
	// +kubebuilder:validation:Required
	// +kubebuilder:validation:MinItems=1
	// +listType=set
	Addresses []string `json:"addresses"`

	// If `false`, IPs from this pool will not be auto-assigned to services. Services
	// must explicitly request this pool via annotation.
	// +kubebuilder:default=true
	AutoAssign bool `json:"autoAssign,omitempty"`

	// If `true`, IPs from this pool will be allocated in a way that avoids
	// known buggy addresses (e.g. .0, .1, .255 in IPv4 subnets). This only has
	// an effect if the pool contains CIDR blocks, and is ignored for explicitly
	// listed IPs or ranges. Enabling this may reduce the number of usable
	// addresses in small subnets.
	// +kubebuilder:default=true
	AvoidBuggyIPs bool `json:"avoidBuggyIPs,omitempty"`

	// Whether IPs from this pool should be advertised via ARP/NDP on the
	// router. If `false`, addresses are allocated, load balancers and SNAT are
	// configured, but the address will NOT be configured on an interface in
	// RouterOS.
	// +kubebuilder:default=true
	Advertise bool `json:"advertise,omitempty"`

	// Network interface the router will use for ARP/NDP advertisement. If
	// empty, no interface hint is passed and the most suitable interface is
	// determined by the router's routing table.
	// +kubebuilder:validation:Pattern=`^(|[a-zA-Z0-9][a-zA-Z0-9\-\.]*[a-zA-Z0-9])$`
	// +optional
	InterfaceName string `json:"interfaceName,omitempty"`
}

type IPPoolStatus struct {
	// Total number of allocatable addresses in this pool in a human-readable format,
	// e.g. "256", "1K" or "1M".
	// +optional
	TotalAddresses string `json:"totalAddresses,omitempty"`

	// Number of currently allocated addresses in a human-readable format, e.g.
	// "256", "1K" or "1M".
	// +optional
	AllocatedAddresses string `json:"allocatedAddresses,omitempty"`

	// Number of currently unallocated addresses in a human-readable format, e.g.
	// "256", "1K" or "1M".
	// +optional
	FreeAddresses string `json:"freeAddresses,omitempty"`

	// Conditions represent the latest available observations of the IP pool's state.
	// +optional
	// +listType=map
	// +listMapKey=type
	// +patchStrategy=merge
	// +patchMergeKey=type
	Conditions []metav1.Condition `json:"conditions,omitempty" patchStrategy:"merge" patchMergeKey:"type"`

	// ObservedGeneration is the most recent generation observed by the controller for this IPPool.
	// It is used to detect if the spec has been updated since the last reconciliation.
	// +optional
	ObservedGeneration int64 `json:"observedGeneration,omitempty"`
}