Core

Packages:

core.apinet.ironcore.dev/v1alpha1

Package v1alpha1 is the v1alpha1 version of the API.

Resource Types:

DaemonSet

DaemonSet is the schema for the daemonsets API.

Field Description
apiVersion
string		 core.apinet.ironcore.dev/v1alpha1
kind
string 		DaemonSet
metadata
Kubernetes meta/v1.ObjectMeta 		Refer to the Kubernetes API documentation for the fields of the metadata field.
spec
DaemonSetSpec

nodeSelector
Kubernetes meta/v1.LabelSelector

Selector selects all Instance that are managed by this daemon set.
template
InstanceTemplate

Template is the instance template.
status
DaemonSetStatus

IP

IP is the schema for the ips API.

Field Description
apiVersion
string		 core.apinet.ironcore.dev/v1alpha1
kind
string 		IP
metadata
Kubernetes meta/v1.ObjectMeta 		Refer to the Kubernetes API documentation for the fields of the metadata field.
spec
IPSpec

type
IPType
ipFamily
Kubernetes core/v1.IPFamily
ip
github.com/ironcore-dev/ironcore-net/apimachinery/api/net.IP
claimRef
IPClaimRef
status
IPStatus

IPAddress

IPAddress is the schema for the ipaddresses API.

Field Description
apiVersion
string		 core.apinet.ironcore.dev/v1alpha1
kind
string 		IPAddress
metadata
Kubernetes meta/v1.ObjectMeta 		Refer to the Kubernetes API documentation for the fields of the metadata field.
spec
IPAddressSpec

ip
github.com/ironcore-dev/ironcore-net/apimachinery/api/net.IP
claimRef
IPAddressClaimRef

Instance

Instance is the schema for the instances API.

Field Description
apiVersion
string		 core.apinet.ironcore.dev/v1alpha1
kind
string 		Instance
metadata
Kubernetes meta/v1.ObjectMeta 		Refer to the Kubernetes API documentation for the fields of the metadata field.
spec
InstanceSpec

type
InstanceType

Type specifies the InstanceType to deploy.
loadBalancerType
LoadBalancerType

LoadBalancerType is the load balancer type this instance is for.
networkRef
Kubernetes core/v1.LocalObjectReference

NetworkRef references the network the instance is on.
ips
[]github.com/ironcore-dev/ironcore-net/apimachinery/api/net.IP

IPs are the IPs of the instance.
loadBalancerPorts
[]LoadBalancerPort

LoadBalancerPorts are the load balancer ports of this instance.
affinity
Affinity

Affinity are affinity constraints.
topologySpreadConstraints
[]TopologySpreadConstraint

TopologySpreadConstraints describes how a group of instances ought to spread across topology domains. Scheduler will schedule instances in a way which abides by the constraints. All topologySpreadConstraints are ANDed.
nodeRef
Kubernetes core/v1.LocalObjectReference

NodeRef references the node hosting the load balancer instance. Will be set by the scheduler if empty.
status
InstanceStatus

LoadBalancer

LoadBalancer is the schema for the loadbalancers API.

Field Description
apiVersion
string		 core.apinet.ironcore.dev/v1alpha1
kind
string 		LoadBalancer
metadata
Kubernetes meta/v1.ObjectMeta 		Refer to the Kubernetes API documentation for the fields of the metadata field.
spec
LoadBalancerSpec

type
LoadBalancerType

Type specifies the type of load balancer.
networkRef
Kubernetes core/v1.LocalObjectReference

NetworkRef references the network the load balancer is part of.
ips
[]LoadBalancerIP 		(Optional)

IPs specifies the IPs of the load balancer.
ports
[]LoadBalancerPort

Ports are the ports the load balancer should allow. If empty, the load balancer allows all ports.
selector
Kubernetes meta/v1.LabelSelector

Selector selects all Instance that are managed by this daemon set.
template
InstanceTemplate

Template is the instance template.
status
LoadBalancerStatus

LoadBalancerRouting

LoadBalancerRouting is the schema for the loadbalancerroutings API.

Field Description
apiVersion
string		 core.apinet.ironcore.dev/v1alpha1
kind
string 		LoadBalancerRouting
metadata
Kubernetes meta/v1.ObjectMeta 		Refer to the Kubernetes API documentation for the fields of the metadata field.
destinations
[]LoadBalancerDestination

NATGateway

NATGateway is the schema for the natgateways API.

Field Description
apiVersion
string		 core.apinet.ironcore.dev/v1alpha1
kind
string 		NATGateway
metadata
Kubernetes meta/v1.ObjectMeta 		Refer to the Kubernetes API documentation for the fields of the metadata field.
spec
NATGatewaySpec

ipFamily
Kubernetes core/v1.IPFamily

IPFamily is the IP family of the NAT gateway.
networkRef
Kubernetes core/v1.LocalObjectReference

NetworkRef references the network the NAT gateway is part of.
ips
[]NATGatewayIP 		(Optional)

IPs specifies the IPs of the NAT gateway.
portsPerNetworkInterface
int32

PortsPerNetworkInterface specifies how many ports to allocate per network interface.
status
NATGatewayStatus

NATGatewayAutoscaler

NATGatewayAutoscaler is the schema for the natgatewayautoscalers API.

Field Description
apiVersion
string		 core.apinet.ironcore.dev/v1alpha1
kind
string 		NATGatewayAutoscaler
metadata
Kubernetes meta/v1.ObjectMeta 		Refer to the Kubernetes API documentation for the fields of the metadata field.
spec
NATGatewayAutoscalerSpec

natGatewayRef
Kubernetes core/v1.LocalObjectReference

NATGatewayRef points to the target NATGateway to scale.
minPublicIPs
int32

MinPublicIPs is the minimum number of public IPs to allocate for a NAT Gateway.
maxPublicIPs
int32

MaxPublicIPs is the maximum number of public IPs to allocate for a NAT Gateway.
status
NATGatewayAutoscalerStatus

NATTable

NATTable is the schema for the nattables API.

Field Description
apiVersion
string		 core.apinet.ironcore.dev/v1alpha1
kind
string 		NATTable
metadata
Kubernetes meta/v1.ObjectMeta 		Refer to the Kubernetes API documentation for the fields of the metadata field.
ips
[]NATIP

IPs specifies how to NAT the IPs for the NAT gateway.

Network

Network is the schema for the networks API.

Field Description
apiVersion
string		 core.apinet.ironcore.dev/v1alpha1
kind
string 		Network
metadata
Kubernetes meta/v1.ObjectMeta 		Refer to the Kubernetes API documentation for the fields of the metadata field.
spec
NetworkSpec

id
string

ID is the ID of the network.
peerings
[]NetworkPeering

Peerings are the network peerings with this network
status
NetworkStatus

NetworkID

NetworkID is the schema for the networkids API.

Field Description
apiVersion
string		 core.apinet.ironcore.dev/v1alpha1
kind
string 		NetworkID
metadata
Kubernetes meta/v1.ObjectMeta 		Refer to the Kubernetes API documentation for the fields of the metadata field.
spec
NetworkIDSpec

claimRef
NetworkIDClaimRef

NetworkInterface

NetworkInterface is the schema for the networkinterfaces API.

Field Description
apiVersion
string		 core.apinet.ironcore.dev/v1alpha1
kind
string 		NetworkInterface
metadata
Kubernetes meta/v1.ObjectMeta 		Refer to the Kubernetes API documentation for the fields of the metadata field.
spec
NetworkInterfaceSpec

nodeRef
Kubernetes core/v1.LocalObjectReference

NodeRef is the node the network interface is hosted on.
networkRef
Kubernetes core/v1.LocalObjectReference

NetworkRef references the network that the network interface is in.
ips
[]github.com/ironcore-dev/ironcore-net/apimachinery/api/net.IP

IPs are the internal IPs of the network interface.
prefixes
[]github.com/ironcore-dev/ironcore-net/apimachinery/api/net.IPPrefix

Prefixes are additional prefixes to route to the network interface.
natGateways
[]NetworkInterfaceNAT

NATs specify the NAT of the network interface IP family. Can only be set if there is no matching IP family in PublicIPs.
publicIPs
[]NetworkInterfacePublicIP 		(Optional)

PublicIPs are the public IPs the network interface should have.
status
NetworkInterfaceStatus

NetworkPolicy

NetworkPolicy is the Schema for the networkpolicies API.

Field Description
apiVersion
string		 core.apinet.ironcore.dev/v1alpha1
kind
string 		NetworkPolicy
metadata
Kubernetes meta/v1.ObjectMeta 		Refer to the Kubernetes API documentation for the fields of the metadata field.
spec
NetworkPolicySpec

networkRef
Kubernetes core/v1.LocalObjectReference

NetworkRef is the network to regulate using this policy.
networkInterfaceSelector
Kubernetes meta/v1.LabelSelector

NetworkInterfaceSelector selects the network interfaces that are subject to this policy.
priority
int32

Priority is an optional field that specifies the order in which the policy is applied. Policies with higher “order” are applied after those with lower order. If the order is omitted, it may be considered to be “infinite” - i.e. the policy will be applied last. Policies with identical order will be applied in alphanumerical order based on the Policy “Name”.
ingress
[]NetworkPolicyIngressRule

Ingress specifies rules for ingress traffic.
egress
[]NetworkPolicyEgressRule

Egress specifies rules for egress traffic.
policyTypes
[]PolicyType

PolicyTypes specifies the types of policies this network policy contains.

NetworkPolicyRule

NetworkPolicyRule is the schema for the networkpolicyrules API.

Field Description
apiVersion
string		 core.apinet.ironcore.dev/v1alpha1
kind
string 		NetworkPolicyRule
metadata
Kubernetes meta/v1.ObjectMeta 		Refer to the Kubernetes API documentation for the fields of the metadata field.
networkRef
LocalUIDReference

NetworkRef is the network to which network policy is applied.
targets
[]TargetNetworkInterface

Targets are the targets of the network policy.
priority
int32

Priority is an optional field that specifies the order in which the policy is applied.
ingressRule
[]Rule

IngressRules are the ingress rules.
egressRule
[]Rule

EgressRules are the egress rules.

Node

Node is the schema for the nodes API.

Field Description
apiVersion
string		 core.apinet.ironcore.dev/v1alpha1
kind
string 		Node
metadata
Kubernetes meta/v1.ObjectMeta 		Refer to the Kubernetes API documentation for the fields of the metadata field.
spec
NodeSpec

status
NodeStatus

Affinity

(Appears on:InstanceSpec)

Field Description
nodeAffinity
NodeAffinity
instanceAntiAffinity
InstanceAntiAffinity

DaemonSetSpec

(Appears on:DaemonSet)

Field Description
nodeSelector
Kubernetes meta/v1.LabelSelector

Selector selects all Instance that are managed by this daemon set.
template
InstanceTemplate

Template is the instance template.

DaemonSetStatus

(Appears on:DaemonSet)

Field Description
collisionCount
int32

IPAddressClaimRef

(Appears on:IPAddressSpec)

Field Description
group
string
resource
string
namespace
string
name
string
uid
k8s.io/apimachinery/pkg/types.UID

IPAddressSpec

(Appears on:IPAddress)

Field Description
ip
github.com/ironcore-dev/ironcore-net/apimachinery/api/net.IP
claimRef
IPAddressClaimRef

IPBlock

(Appears on:NetworkPolicyPeer, Rule)

IPBlock specifies an ip block with optional exceptions.

Field Description
cidr
github.com/ironcore-dev/ironcore-net/apimachinery/api/net.IPPrefix

CIDR is a string representing the ip block.
except
[]github.com/ironcore-dev/ironcore-net/apimachinery/api/net.IPPrefix

Except is a slice of CIDRs that should not be included within the specified CIDR. Values will be rejected if they are outside CIDR.

IPClaimRef

(Appears on:IPSpec)

Field Description
group
string
resource
string
name
string
uid
k8s.io/apimachinery/pkg/types.UID

IPSpec

(Appears on:IP)

Field Description
type
IPType
ipFamily
Kubernetes core/v1.IPFamily
ip
github.com/ironcore-dev/ironcore-net/apimachinery/api/net.IP
claimRef
IPClaimRef

IPStatus

(Appears on:IP)

IPType (string alias)

(Appears on:IPSpec)

Value Description

"Public"

InstanceAffinityTerm

(Appears on:InstanceAntiAffinity)

InstanceAffinityTerm defines a set of instances (namely those matching the labelSelector that this instance should be co-located (affinity) or not co-located (anti-affinity) with, where co-located is defined as running on a node whose value of the label with key matches that of any node on which a instance of the set of instances is running.

Field Description
labelSelector
Kubernetes meta/v1.LabelSelector

LabelSelector over a set of resources, in this case instances.
topologyKey
string

TopologyKey indicates that this instance should be co-located (affinity) or not co-located (anti-affinity) with the instances matching the labelSelector, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected instances is running. Empty topologyKey is not allowed.

InstanceAntiAffinity

(Appears on:Affinity)

Field Description
requiredDuringSchedulingIgnoredDuringExecution
[]InstanceAffinityTerm

RequiredDuringSchedulingIgnoredDuringExecution specifies anti-affinity requirements at scheduling time, that, if not met, will cause the instance not be scheduled onto the node. When there are multiple elements, the lists of nodes corresponding to each instanceAffinityTerm are intersected, i.e. all terms must be satisfied.

InstanceSpec

(Appears on:Instance, InstanceTemplate)

Field Description
type
InstanceType

Type specifies the InstanceType to deploy.
loadBalancerType
LoadBalancerType

LoadBalancerType is the load balancer type this instance is for.
networkRef
Kubernetes core/v1.LocalObjectReference

NetworkRef references the network the instance is on.
ips
[]github.com/ironcore-dev/ironcore-net/apimachinery/api/net.IP

IPs are the IPs of the instance.
loadBalancerPorts
[]LoadBalancerPort

LoadBalancerPorts are the load balancer ports of this instance.
affinity
Affinity

Affinity are affinity constraints.
topologySpreadConstraints
[]TopologySpreadConstraint

TopologySpreadConstraints describes how a group of instances ought to spread across topology domains. Scheduler will schedule instances in a way which abides by the constraints. All topologySpreadConstraints are ANDed.
nodeRef
Kubernetes core/v1.LocalObjectReference

NodeRef references the node hosting the load balancer instance. Will be set by the scheduler if empty.

InstanceStatus

(Appears on:Instance)

Field Description
ips
[]github.com/ironcore-dev/ironcore-net/apimachinery/api/net.IP
collisionCount
int32

InstanceTemplate

(Appears on:DaemonSetSpec, LoadBalancerSpec)

Field Description
metadata
Kubernetes meta/v1.ObjectMeta 		Refer to the Kubernetes API documentation for the fields of the metadata field.
spec
InstanceSpec

type
InstanceType

Type specifies the InstanceType to deploy.
loadBalancerType
LoadBalancerType

LoadBalancerType is the load balancer type this instance is for.
networkRef
Kubernetes core/v1.LocalObjectReference

NetworkRef references the network the instance is on.
ips
[]github.com/ironcore-dev/ironcore-net/apimachinery/api/net.IP

IPs are the IPs of the instance.
loadBalancerPorts
[]LoadBalancerPort

LoadBalancerPorts are the load balancer ports of this instance.
affinity
Affinity

Affinity are affinity constraints.
topologySpreadConstraints
[]TopologySpreadConstraint

TopologySpreadConstraints describes how a group of instances ought to spread across topology domains. Scheduler will schedule instances in a way which abides by the constraints. All topologySpreadConstraints are ANDed.
nodeRef
Kubernetes core/v1.LocalObjectReference

NodeRef references the node hosting the load balancer instance. Will be set by the scheduler if empty.

InstanceType (string alias)

(Appears on:InstanceSpec)

Value Description

"LoadBalancer"

LoadBalancerDestination

(Appears on:LoadBalancerRouting)

LoadBalancerDestination is the destination of the load balancer.

Field Description
ip
github.com/ironcore-dev/ironcore-net/apimachinery/api/net.IP

IP is the target IP.
targetRef
LoadBalancerTargetRef

TargetRef is the target providing the destination.

LoadBalancerIP

(Appears on:LoadBalancerSpec)

Field Description
name
string

Name is the name of the load balancer IP.
ipFamily
Kubernetes core/v1.IPFamily

IPFamily is the IP family of the IP. Has to match IP if specified. If unspecified and IP is specified, will be defaulted by using the IP family of IP. If only IPFamily is specified, a random IP of that family will be allocated if possible.
ip
github.com/ironcore-dev/ironcore-net/apimachinery/api/net.IP

IP specifies a specific IP to allocate. If empty, a random IP will be allocated if possible.

LoadBalancerPort

(Appears on:InstanceSpec, LoadBalancerSpec)

Field Description
protocol
Kubernetes core/v1.Protocol

Protocol is the protocol the load balancer should allow. If not specified, defaults to TCP.
port
int32

Port is the port to allow.
endPort
int32

EndPort marks the end of the port range to allow. If unspecified, only a single port, Port, will be allowed.

LoadBalancerSpec

(Appears on:LoadBalancer)

Field Description
type
LoadBalancerType

Type specifies the type of load balancer.
networkRef
Kubernetes core/v1.LocalObjectReference

NetworkRef references the network the load balancer is part of.
ips
[]LoadBalancerIP 		(Optional)

IPs specifies the IPs of the load balancer.
ports
[]LoadBalancerPort

Ports are the ports the load balancer should allow. If empty, the load balancer allows all ports.
selector
Kubernetes meta/v1.LabelSelector

Selector selects all Instance that are managed by this daemon set.
template
InstanceTemplate

Template is the instance template.

LoadBalancerStatus

(Appears on:LoadBalancer)

Field Description
collisionCount
int32

CollisionCount is used to construct names for IP addresses for the load balancer.

LoadBalancerTargetRef

(Appears on:LoadBalancerDestination)

LoadBalancerTargetRef is a load balancer target.

Field Description
uid
k8s.io/apimachinery/pkg/types.UID

UID is the UID of the target.
name
string

Name is the name of the target.
nodeRef
Kubernetes core/v1.LocalObjectReference

NodeRef references the node the destination network interface is on.

LoadBalancerType (string alias)

(Appears on:InstanceSpec, LoadBalancerSpec)

Value Description

"Internal"

"Public"

LocalUIDReference

(Appears on:NetworkPolicyRule, TargetNetworkInterface)

LocalUIDReference is a reference to another entity including its UID

Field Description
name
string

Name is the name of the referenced entity.
uid
k8s.io/apimachinery/pkg/types.UID

UID is the UID of the referenced entity.

NATGatewayAutoscalerSpec

(Appears on:NATGatewayAutoscaler)

Field Description
natGatewayRef
Kubernetes core/v1.LocalObjectReference

NATGatewayRef points to the target NATGateway to scale.
minPublicIPs
int32

MinPublicIPs is the minimum number of public IPs to allocate for a NAT Gateway.
maxPublicIPs
int32

MaxPublicIPs is the maximum number of public IPs to allocate for a NAT Gateway.

NATGatewayAutoscalerStatus

(Appears on:NATGatewayAutoscaler)

NATGatewayIP

(Appears on:NATGatewaySpec)

Field Description
name
string

Name is the semantic name of the NAT gateway IP.
ip
github.com/ironcore-dev/ironcore-net/apimachinery/api/net.IP

IP specifies a specific IP to allocate. If empty, a random IP will be allocated if possible.

NATGatewaySpec

(Appears on:NATGateway)

Field Description
ipFamily
Kubernetes core/v1.IPFamily

IPFamily is the IP family of the NAT gateway.
networkRef
Kubernetes core/v1.LocalObjectReference

NetworkRef references the network the NAT gateway is part of.
ips
[]NATGatewayIP 		(Optional)

IPs specifies the IPs of the NAT gateway.
portsPerNetworkInterface
int32

PortsPerNetworkInterface specifies how many ports to allocate per network interface.

NATGatewayStatus

(Appears on:NATGateway)

Field Description
usedNATIPs
int64

UsedNATIPs is the number of NAT IPs in-use.
requestedNATIPs
int64

RequestedNATIPs is the number of requested NAT IPs.

NATIP

(Appears on:NATTable)

Field Description
ip
github.com/ironcore-dev/ironcore-net/apimachinery/api/net.IP

IP is the IP to NAT.
sections
[]NATIPSection

Sections are the sections of the NATIP.

NATIPSection

(Appears on:NATIP)

Field Description
ip
github.com/ironcore-dev/ironcore-net/apimachinery/api/net.IP

IP is the source IP.
port
int32

Port is the start port of the section.
endPort
int32

EndPort is the end port of the section
targetRef
NATTableIPTargetRef

TargetRef references the entity having the IP.

NATTableIPTargetRef

(Appears on:NATIPSection)

Field Description
uid
k8s.io/apimachinery/pkg/types.UID

UID is the UID of the target.
name
string

Name is the name of the target.
nodeRef
Kubernetes core/v1.LocalObjectReference

NodeRef references the node the destination network interface is on.

NetworkIDClaimRef

(Appears on:NetworkIDSpec)

Field Description
group
string
resource
string
namespace
string
name
string
uid
k8s.io/apimachinery/pkg/types.UID

NetworkIDSpec

(Appears on:NetworkID)

Field Description
claimRef
NetworkIDClaimRef

NetworkInterfaceNAT

(Appears on:NetworkInterfaceSpec)

Field Description
ipFamily
Kubernetes core/v1.IPFamily

IPFamily is the IP family of the handling NAT gateway.
claimRef
NetworkInterfaceNATClaimRef

ClaimRef references the NAT claim handling the network interface’s NAT.

NetworkInterfaceNATClaimRef

(Appears on:NetworkInterfaceNAT)

Field Description
name
string

Name is the name of the claiming NAT gateway.
uid
k8s.io/apimachinery/pkg/types.UID

UID is the uid of the claiming NAT gateway.

NetworkInterfacePublicIP

(Appears on:NetworkInterfaceSpec)

Field Description
name
string

Name is the semantic name of the network interface public IP.
ipFamily
Kubernetes core/v1.IPFamily

IPFamily is the IP family of the IP. Has to match IP if specified. If unspecified and IP is specified, will be defaulted by using the IP family of IP. If only IPFamily is specified, a random IP of that family will be allocated if possible.
ip
github.com/ironcore-dev/ironcore-net/apimachinery/api/net.IP

IP specifies a specific IP to allocate. If empty, a random ephemeral IP will be allocated.

NetworkInterfaceSpec

(Appears on:NetworkInterface)

Field Description
nodeRef
Kubernetes core/v1.LocalObjectReference

NodeRef is the node the network interface is hosted on.
networkRef
Kubernetes core/v1.LocalObjectReference

NetworkRef references the network that the network interface is in.
ips
[]github.com/ironcore-dev/ironcore-net/apimachinery/api/net.IP

IPs are the internal IPs of the network interface.
prefixes
[]github.com/ironcore-dev/ironcore-net/apimachinery/api/net.IPPrefix

Prefixes are additional prefixes to route to the network interface.
natGateways
[]NetworkInterfaceNAT

NATs specify the NAT of the network interface IP family. Can only be set if there is no matching IP family in PublicIPs.
publicIPs
[]NetworkInterfacePublicIP 		(Optional)

PublicIPs are the public IPs the network interface should have.

NetworkInterfaceState (string alias)

(Appears on:NetworkInterfaceStatus)

Value Description

"Error"

NetworkInterfaceStateError is used for any NetworkInterface that is some error occurred.

"Pending"

NetworkInterfaceStatePending is used for any NetworkInterface that is in an intermediate state.

"Ready"

NetworkInterfaceStateReady is used for any NetworkInterface that is ready.

NetworkInterfaceStatus

(Appears on:NetworkInterface)

NetworkInterfaceStatus defines the observed state of NetworkInterface.

Field Description
state
NetworkInterfaceState

State is the state of the network interface.
pciAddress
PCIAddress

PCIAddress is the PCI address of the network interface.
tapDevice
TAPDevice

TAPDevice is the TAP device of the network interface.
prefixes
[]github.com/ironcore-dev/ironcore-net/apimachinery/api/net.IPPrefix

Prefixes are the prefixes of the network interface.
publicIPs
[]github.com/ironcore-dev/ironcore-net/apimachinery/api/net.IP

PublicIPs are the public IPs of the network interface.
natIPs
[]github.com/ironcore-dev/ironcore-net/apimachinery/api/net.IP

NATIPs are the NAT IPs of the network interface.

NetworkPeering

(Appears on:NetworkSpec)

NetworkPeering defines a network peering with another network.

Field Description
name
string

Name is the semantical name of the network peering.
id
string

ID is the ID of the network to peer with.
prefixes
[]PeeringPrefix

Prefixes is a list of prefixes that we want only to be exposed to the peered network, if no prefixes are specified no filtering will be done.

NetworkPeeringState (string alias)

(Appears on:NetworkPeeringStatus)

NetworkPeeringState is the state a NetworkPeering can be in

Value Description

"Error"

NetworkPeeringStateError signals that the network peering is in error state.

"Pending"

NetworkPeeringStatePending signals that the network peering is not applied.

"Ready"

NetworkPeeringStateReady signals that the network peering is ready.

NetworkPeeringStatus

NetworkPeeringStatus is the status of a network peering.

Field Description
id
int32

ID is the ID of network
state
NetworkPeeringState

State represents the network peering state

NetworkPolicyEgressRule

(Appears on:NetworkPolicySpec)

NetworkPolicyEgressRule describes a rule to regulate egress traffic with.

Field Description
ports
[]NetworkPolicyPort

Ports specifies the list of destination ports that can be called with this rule. Each item in this list is combined using a logical OR. Empty matches all ports. As soon as a single item is present, only these ports are allowed.
to
[]NetworkPolicyPeer

To specifies the list of destinations which the selected network interfaces should be able to send traffic to. Fields are combined using a logical OR. Empty matches all destinations. As soon as a single item is present, only these peers are allowed.

NetworkPolicyIngressRule

(Appears on:NetworkPolicySpec)

NetworkPolicyIngressRule describes a rule to regulate ingress traffic with.

Field Description
from
[]NetworkPolicyPeer

From specifies the list of sources which should be able to send traffic to the selected network interfaces. Fields are combined using a logical OR. Empty matches all sources. As soon as a single item is present, only these peers are allowed.
ports
[]NetworkPolicyPort

Ports specifies the list of ports which should be made accessible for this rule. Each item in this list is combined using a logical OR. Empty matches all ports. As soon as a single item is present, only these ports are allowed.

NetworkPolicyPeer

(Appears on:NetworkPolicyEgressRule, NetworkPolicyIngressRule)

NetworkPolicyPeer describes a peer to allow traffic to / from.

Field Description
objectSelector
ObjectSelector

ObjectSelector selects peers with the given kind matching the label selector. Exclusive with other peer specifiers.
ipBlock
IPBlock

IPBlock specifies the ip block from or to which network traffic may come.

NetworkPolicyPort

(Appears on:NetworkPolicyEgressRule, NetworkPolicyIngressRule, Rule)

NetworkPolicyPort describes a port to allow traffic on

Field Description
protocol
Kubernetes core/v1.Protocol

Protocol (TCP, UDP, or SCTP) which traffic must match. If not specified, this field defaults to TCP.
port
int32

The port on the given protocol. If this field is not provided, this matches all port names and numbers. If present, only traffic on the specified protocol AND port will be matched.
endPort
int32

EndPort indicates that the range of ports from Port to EndPort, inclusive, should be allowed by the policy. This field cannot be defined if the port field is not defined. The endPort must be equal or greater than port.

NetworkPolicySpec

(Appears on:NetworkPolicy)

Field Description
networkRef
Kubernetes core/v1.LocalObjectReference

NetworkRef is the network to regulate using this policy.
networkInterfaceSelector
Kubernetes meta/v1.LabelSelector

NetworkInterfaceSelector selects the network interfaces that are subject to this policy.
priority
int32

Priority is an optional field that specifies the order in which the policy is applied. Policies with higher “order” are applied after those with lower order. If the order is omitted, it may be considered to be “infinite” - i.e. the policy will be applied last. Policies with identical order will be applied in alphanumerical order based on the Policy “Name”.
ingress
[]NetworkPolicyIngressRule

Ingress specifies rules for ingress traffic.
egress
[]NetworkPolicyEgressRule

Egress specifies rules for egress traffic.
policyTypes
[]PolicyType

PolicyTypes specifies the types of policies this network policy contains.

NetworkSpec

(Appears on:Network)

Field Description
id
string

ID is the ID of the network.
peerings
[]NetworkPeering

Peerings are the network peerings with this network

NetworkState (string alias)

NetworkState is the state of a network.

NetworkStatus

(Appears on:Network)

Field Description
peerings
map[string][]./api/core/v1alpha1.NetworkPeeringStatus

Peerings contains the states of the network peerings for the network.

NodeAffinity

(Appears on:Affinity)

Field Description
requiredDuringSchedulingIgnoredDuringExecution
NodeSelector

NodeSelector

(Appears on:NodeAffinity)

NodeSelector represents the union of the results of one or more queries over a set of nodes; that is, it represents the OR of the selectors represented by the node selector terms.

Field Description
nodeSelectorTerms
[]NodeSelectorTerm

Required. A list of node selector terms. The terms are ORed.

NodeSelectorOperator (string alias)

(Appears on:NodeSelectorRequirement)

NodeSelectorOperator is the set of operators that can be used in a node selector requirement.

Value Description

"DoesNotExist"

"Exists"

"Gt"

"In"

"Lt"

"NotIn"

NodeSelectorRequirement

(Appears on:NodeSelectorTerm)

NodeSelectorRequirement is a requirement for a selector. It’s a combination of the key to match, the operator to match with, and zero to n values, depending on the operator.

Field Description
key
string

Key is the key the selector applies to.
operator
NodeSelectorOperator

Operator represents the key’s relationship to the values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt.
values
[]string

Values are the values to relate the key to via the operator.

NodeSelectorTerm

(Appears on:NodeSelector)

NodeSelectorTerm matches no objects if it’s empty. The requirements of the selector are ANDed.

Field Description
matchExpressions
[]NodeSelectorRequirement

MatchExpressions matches nodes by the label selector requirements.
matchFields
[]NodeSelectorRequirement

MatchFields matches the nodes by their fields.

NodeSpec

(Appears on:Node)

NodeStatus

(Appears on:Node)

ObjectIP

(Appears on:Rule)

Field Description
ipFamily
Kubernetes core/v1.IPFamily

IPFamily is the IPFamily of the prefix. If unset but Prefix is set, this can be inferred.
prefix
github.com/ironcore-dev/ironcore-net/apimachinery/api/net.IPPrefix

Prefix is the prefix of the IP.

ObjectSelector

(Appears on:NetworkPolicyPeer)

ObjectSelector specifies how to select objects of a certain kind.

Field Description
kind
string

Kind is the kind of object to select.
LabelSelector
Kubernetes meta/v1.LabelSelector

(Members of LabelSelector are embedded into this type.)

LabelSelector is the label selector to select objects of the specified Kind by.

PCIAddress

(Appears on:NetworkInterfaceStatus)

PCIAddress is a PCI address.

Field Description
domain
string
bus
string
slot
string
function
string

PeeringPrefix

(Appears on:NetworkPeering)

PeeringPrefix defines prefixes to be exposed to the peered network

Field Description
name
string

Name is the semantical name of the peering prefixes
prefix
github.com/ironcore-dev/ironcore-net/apimachinery/api/net.IPPrefix

CIDR to be exposed to the peered network

PolicyType (string alias)

(Appears on:NetworkPolicySpec)

PolicyType is a type of policy.

Value Description

"Egress"

PolicyTypeEgress is a policy that describes egress traffic.

"Ingress"

PolicyTypeIngress is a policy that describes ingress traffic.

Rule

(Appears on:NetworkPolicyRule)

Field Description
ipBlock
[]IPBlock

CIDRBlock specifies the CIDR block from which network traffic may come or go.
ips
[]ObjectIP

ObjectIPs are the object IPs the rule applies to.
networkPolicyPorts
[]NetworkPolicyPort

NetworkPolicyPorts are the protocol type and ports.

TAPDevice

(Appears on:NetworkInterfaceStatus)

TAPDevice is a TAP device.

Field Description
name
string

Name is the name of the TAP device.

TargetNetworkInterface

(Appears on:NetworkPolicyRule)

TargetNetworkInterface is the target of the network policy.

Field Description
ip
github.com/ironcore-dev/ironcore-net/apimachinery/api/net.IP

IP is the IP address of the target network interface.
targetRef
LocalUIDReference

TargetRef is the target providing the destination.

TopologySpreadConstraint

(Appears on:InstanceSpec)

TopologySpreadConstraint specifies how to spread matching instances among the given topology.

Field Description
maxSkew
int32

MaxSkew describes the degree to which instances may be unevenly distributed. When whenUnsatisfiable=DoNotSchedule, it is the maximum permitted difference between the number of matching instances in the target topology and the global minimum. The global minimum is the minimum number of matching instances in an eligible domain or zero if the number of eligible domains is less than MinDomains.
topologyKey
string

TopologyKey is the key of node labels. Nodes that have a label with this key and identical values are considered to be in the same topology. We consider each as a “bucket”, and try to put balanced number of instances into each bucket. We define a domain as a particular instance of a topology. Also, we define an eligible domain as a domain whose nodes meet the requirements of nodeAffinityPolicy and nodeTaintsPolicy.
whenUnsatisfiable
UnsatisfiableConstraintAction

WhenUnsatisfiable indicates how to deal with a instance if it doesn’t satisfy the spread constraint. - DoNotSchedule (default) tells the scheduler not to schedule it. - ScheduleAnyway tells the scheduler to schedule the instance in any location, but giving higher precedence to topologies that would help reduce the skew.
labelSelector
Kubernetes meta/v1.LabelSelector

LabelSelector is used to find matching instances. Instances that match this label selector are counted to determine the number of instances in their corresponding topology domain.

UnsatisfiableConstraintAction (string alias)

(Appears on:TopologySpreadConstraint)

Value Description

"DoNotSchedule"

DoNotSchedule instructs the scheduler not to schedule the instance when constraints are not satisfied.

Generated with gen-crd-api-reference-docs