v1

type AutoConfigSpec struct {
	// AutoBonding indicate whether to do auto bonding on interfaces
	Autobonding *bool `json:"autoBonding"`
	// AutoVlan indicate whether to allocate vlans automatically  to interfaces
	AutoVlan *bool `json:"autoVlan"`
}

type BridgeOptions struct {
	Stp BridgeStpOptions `json:"stp,omitempty"`
}

type BridgePort struct {
	// TODO description
	// TODO: Mandatory?
	Name string `json:"name"`
	// TODO description
	// TODO: Mandatory?
	// TODO: possible values
	Type string `json:"type,omitempty"`
	// TODO description
	// TODO: Mandatory?
	// TODO: possible values?
	VlanMode string `json:"vlanMode,omitempty"`
	// TODO description
	// Mandatory?
	AccessTag string `json:"accessTag,omitempty"`
	// sets the port cost of the port <port> to <cost>.
	// This is a dimensionless metric.
	StpPathCost int `json:"stp-path-cost,omitempty"`
	// The priority value is an unsigned 8-bit quantity
	// (a number between 0 and 255), and has no dimension.
	// This metric is used in the designated port and root
	// port selection algorithms.
	StpPriority int `json:"stp-priority,omitempty"`
	// Controls whether traffic may be send back out of the port on
	// which it was received. By default, this flag is turned off and
	// the bridge will not forward traffic back out of the receiving
	// port.
	// NOTE: We don't add omitempty here, to ensure that this is present for
	//       'false' value too
	StpHairpinMode bool `json:"stp-hairpin-mode"`
}

type BridgeSpec struct {
	// Port configuration on the bridge
	Ports   []BridgePort  `json:"port"`
	Options BridgeOptions `json:"options,omitempty"`
}

type BridgeStpOptions struct {
	Enabled bool `json:"enabled"`
}

type CIDR struct {
	IP           string `json:"ip"`
	PrefixLength uint8  `json:"prefix-length"`
}

type ConfAndOperationalState struct {
	Capabilities []string `json:"capabilities"`
	// Current configuration as well as operational state of the interfaces
	Interfaces []InterfaceInfo `json:"interfaces"`
}

type ConfigurationState struct {
	Interfaces []InterfaceSpec `json:"interfaces"`
}

type DuplexType string

type EthernetSpec struct {
	// auto-negotiation setting of the interface
	AutoNegotiation bool `json:"auto-negotiation"`
	// duplex settings of the interface
	Duplex DuplexType `json:"duplex"`
	// Link speed in TODO: which units
	Speed uint `json:"speed"`
}

type IPv4Spec struct {
	// Indication whether IPv4 is enabled
	Enabled bool `json:"enabled"`
	// Whether IPv4 addresses are dynamically configured
	DHCP *bool `json:"dhcp,omitempty"`
	// List of IPv4 addresses
	Address []CIDR `json:"address,omitempty"`
	// TODO: description
	Neighbors []Neighbor `json:"neighbors,omitempty"`
	// TODO: description
	Forwarding *bool `json:"forwarding,omitempty"`
}

type IPv6Spec struct {
	// Indication whether IPv4 is enabled
	Enabled bool `json:"enabled"`
	// Whether IPv4 addresses are dynamically configured
	DHCP *bool `json:"dhcp,omitempty"`
	// IPv6 autoconf
	AutoConf *bool `json:"autoConf,omitempty"`
	// List of IPv4 addresses
	Address []CIDR `json:"address,omitempty"`
	// TODO: description
	Neighbors []CIDR `json:"neighbors,omitempty"`
	// TODO: description
	Forwarding *bool `json:"forwarding,omitempty"`
	// TODO: description?
	DupAddrDetectTransmit *int `json:"dupAddressDetectTransmit,omitempty"`
}

type InterfaceInfo struct {
	// Current configuration of the interface
	InterfaceSpec `json:",inline"`
	// Interface index
	IFIndex uint `json:"ifIndex"`
	// TODO: list of possible values
	AdminStatus string `json:"adminStatus,omitempty"`
	// TODO: list of possible values
	LinkStatus string `json:"linkStatus,omitempty"`
	// Physical address
	// TODO: do we need that on top of the MAC address from InterfaceSpec?
	PhysAddress string `json:"physAddress,omitempty"`
	// Name of the higher layer interface
	HigherLayerIF string `json:"higherLayerInterface,omitempty"`
	// Name of the lower layer interface
	LowerLayerIF string `json:"lowerLayerInterface,omitempty"`
	// Statistics of the interface
	Statistics *InterfaceStatistics `json:"statistics,omitempty"`
}

type InterfaceMatchRule struct {
	// Name of the interface to match
	Name string `json:"name,omitempty"`
	// Type of the interface to match
	Type InterfaceType `json:"type,omitempty"`
	// VLAN ID on the interface to match
	VlanID *uint `json:"vlanID"`
	// Information retrieved from LLDP on neighbors
	LLDP *LLDPInfo `json:"lldp"`
}

type InterfaceSpec struct {
	// Name of the interface
	Name string `json:"name"`
	// Description of the interface
	Description string `json:"description,omitempty"`
	// Type of interface
	Type InterfaceType `json:"type,omitempty"`
	// State of interface
	State InterfaceState `json:"state,omitempty"`
	// MAC address set on the interface
	MACAddress string `json:"macAddress,omitempty"`
	// MTU size in bytes set on the interface
	MTU *uint `json:"mtu,omitempty"`
	// Ethernet holds configuration of interface of type ethernet
	Ethernet *EthernetSpec `json:"ethernet,omitempty"`
	// Flow control setting of the interface
	FlowControl *bool `json:"flowControl,omitempty"`
	// VLAN ID set on the interface
	VlanID *uint `json:"vlanID,omitempty"`
	// The interface on which the VLAN was created
	VlanBase string `json:"vlanbase,omitempty"`
	// Link aggregation (bond) spec of the interface
	LinkAggregation *LinkAggregationSpec `json:"linkaggregation,omitempty"`
	// Configuration of a bridge connected to the interface
	Bridge *BridgeSpec `json:"bridge,omitempty"`
	// IPv4 configuration of the interface
	IPv4 *IPv4Spec `json:"ipv4,omitempty"`
	// IPv6 configuration of the interface
	IPv6 *IPv6Spec `json:"ipv6,omitempty"`
}

type InterfaceState string

type InterfaceStatistics struct {
	InBroadcastPackets  uint64 `json:"inBroadcastPackets"`
	InDiscards          uint64 `json:"inDiscards"`
	InErrors            uint64 `json:"inErrors"`
	InMulticastPackets  uint64 `json:"inMulticastPackets"`
	InOctets            uint64 `json:"inOctets"`
	InUnicastPackets    uint64 `json:"inUnicastPackets"`
	OutBroadcastPackets uint64 `json:"outBroadcastPackets"`
	OutDiscards         uint64 `json:"outDiscards"`
	OutErrors           uint64 `json:"outErrors"`
	OutMulticastPackets uint64 `json:"outMulticastPackets"`
	OutOctets           uint64 `json:"outOctets"`
	OutUnicastPackets   uint64 `json:"outUnicastPackets"`
}

type InterfaceType string

type LLDPInfo struct {
	VlanIDList []uint `json:"vlanIDList,omitempty"`
}

type LinkAggregationMode string

type LinkAggregationOptions struct {
	// TODO: description
	Stp *bool `json:"stp,omitempty"`
	// TODO: description
	Rstp *bool `json:"rstp,omitempty"`
	// TODO: description
	FailMode string `json:"failMode,omitempty"`
	// TODO: description
	McastSnoopingEnabled *bool `json:"mcastSnoopingEnabled,omitempty"`
}

type LinkAggregationSpec struct {
	// Link aggregation mode
	Mode LinkAggregationMode `json:"mode"`
	// List of slave interfaces aggregated by the interface
	Slaves []string `json:"slaves,omitempty"`
	// TODO: description
	Options *LinkAggregationOptions `json:"options,omitempty"`
}

type Neighbor struct {
	IP               string `json:"ip"`
	LinkLayerAddress string `json:"linkLayerAddress"`
}

type NodeNetConfPolicy struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata,omitempty"`
	Spec              NodeNetConfPolicySpec `json:"spec"`
}

type NodeNetConfPolicyList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata"`
	Items           []NodeNetConfPolicy `json:"items"`
}

type NodeNetConfPolicySpec struct {
	// Node affinity may be used to select on which nodes the state should be applied
	// More info: https://kubernetes.io/docs/concepts/configuration/assign-pod-node/
	Affinity *k8sv1.Affinity `json:"affinity,omitempty"`
	// Node tolerations may be used to select on which nodes the state should NOT be applied
	// More info: https://kubernetes.io/docs/concepts/configuration/taint-and-toleration/
	Tolerations []k8sv1.Toleration `json:"tolerations,omitempty"`
	// List of interfaces on which the configuration should be applied.
	// List must include at least one interface matching rule.
	MatchRules []InterfaceMatchRule `json:"matchRules"`
	// Specification for auto configuration of the matched interfaces.
	// Mutually exclusive with DesiredState.
	AutoConfig *AutoConfigSpec `json:"autoconfig"`
	// Specification of the desired state of the matched interfaces.
	// Mutually exclusive with AutoConfig.
	DesiredState *ConfigurationState `json:"desiredState"`
}

type NodeNetworkState struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata,omitempty"`
	Spec              NodeNetworkStateSpec   `json:"spec"`
	Status            NodeNetworkStateStatus `json:"status"`
}

type NodeNetworkStateList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata"`
	Items           []NodeNetworkState `json:"items"`
}

type NodeNetworkStateSpec struct {
	Managed bool `json:"managed"`
	// Name of the node reporting this state
	NodeName string `json:"nodeName"`
	// The desired configuration for the node derived from the NodeNetConfPolicy
	DesiredState ConfigurationState `json:"desiredState"`
}

type NodeNetworkStateStatus struct {
	CurrentState ConfAndOperationalState `json:"currentState"`
}