The module lifecycle stage: Preview

The Deckhouse Kubernetes Platform installs CRDs but does not remove them when a module is disabled. If you no longer need the created CRDs, delete them.

ClusterIPAddress

Scope: Cluster
Version: v1alpha1

A request for an IPv4 address for a pod's additional network interface attached to a cluster network.
  • spec
    object
    Desired state of resource.
    • spec.networkRef
      object

      Required value

      Reference network used as the source of IPAM configuration.
      • spec.networkRef.kind
        string

        Required value

        Kind of the referenced network.

        Allowed values: ClusterNetwork

      • spec.networkRef.name
        string

        Required value

        Name of the referenced network.
    • spec.static
      object
      Parameters for Static allocation type.
      • spec.static.ip
        string

        Required value

        Requested IPv4 address.

        Example: 


        ip: 192.168.1.1
    • spec.type
      string

      Required value

      Requested allocation type.

      • Auto: allocate a free address from the pool.
      • Static: allocate the address specified in .spec.static.ip.

      Allowed values: Static, Auto

ClusterIPAddressPool

Scope: Cluster
Version: v1alpha1

Defines a cluster-scoped pool of IPv4 addresses used for IPAM on cluster networks.
  • spec
    object
    Desired state of resource.
    • spec.leaseTTL
      string
      Time to live for orphaned IPAddressLease objects created for addresses from this pool.

      Default: 1h

      Examples: 


      leaseTTL: 30s

      leaseTTL: 1m

      leaseTTL: 24h
    • spec.pools
      array of objects

      Required value

      List of pool entries served by this resource.
      • spec.pools.network
        string
        IPv4 network CIDR served by this pool entry.

        Example: 


        network: 192.168.1.0/24
      • spec.pools.ranges
        array of strings
        Optional list of allocatable IP ranges within network. If omitted, the entire network CIDR is considered allocatable.

        Example: 


        ranges:
- 192.168.1.50
- 192.168.1.51
- 192.168.1.0/24
- 192.168.1.100-192.168.1.110
        • spec.pools.ranges.Element of the array
          string
          Allocatable IPv4 range expression ("startIP-endIP", "CIDR", or single IPv4).

          Pattern: ^(?:(?:25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)\.){3}(?:25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(?:-(?:(?:25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)\.){3}(?:25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)|\/(?:3[0-2]|[12]?\d))?$

          Examples: 


          "": 192.168.1.50

          "": 192.168.1.0/24

          "": 192.168.1.100-192.168.1.110
      • spec.pools.routes
        array of objects
        Optional list of static routes associated with addresses allocated from this pool entry.
        • spec.pools.routes.destination
          string
          Destination network CIDR for the route.

          Examples: 


          destination: 192.168.10.0/24

          destination: 8.8.8.8/32
        • spec.pools.routes.via
          string
          Next-hop (gateway) IPv4 address.

          Example: 


          via: 192.168.1.1

ClusterNetwork

Scope: Cluster
Version: v1alpha1

Defines the ClusterNetwork resource for configuring cluster-wide networks.
  • spec
    object
    Specification of the ClusterNetwork resource, defining network parameters.
    • spec.ipam
      object
      IPAM configuration for the network.
      • spec.ipam.ipAddressPoolRef
        object
        Reference to the IP address pool used by this network.
        • spec.ipam.ipAddressPoolRef.kind
          string

          Required value

          Kind of the referenced pool.

          Allowed values: ClusterIPAddressPool

        • spec.ipam.ipAddressPoolRef.name
          string

          Required value

          Name of the referenced pool object.
    • spec.parentNodeNetworkInterfaces
      object

      Required value

      Selector for choosing NodeNetworkInterfaces representing NICs to which the network is bound.
      • spec.parentNodeNetworkInterfaces.labelSelector
        object

        Required value

        Label selector for filtering network interfaces of nodes.
        • spec.parentNodeNetworkInterfaces.labelSelector.matchLabels
          object

          Required value

          A set of labels that must match the labels of NodeNetworkInterface resources.
    • spec.type
      string

      Required value

      The type of network. Supported values:

      • VLAN — a tagged VLAN will be configured on node's corresponding NICs (i.e. eth0.100) to provide connectivity.
      • Access — corresponding NICs on nodes will be used directly to provide connectivity.

      Allowed values: Vlan, VLAN, Access

    • spec.vlan
      object
      VLAN parameters for the network. Required for "Vlan" type.
      • spec.vlan.id
        integer

        Required value

        VLAN ID. Must be between 1 and 4094.

        Allowed values: 1 <= X <= 4094

IPAddress

Scope: Namespaced
Version: v1alpha1

A namespaced resource that represents a request for an IPv4 address for a pod's additional network interface attached to a project network.
  • spec
    object
    Desired state of resource.
    • spec.networkRef
      object

      Required value

      Reference network used as the source of IPAM configuration.
      • spec.networkRef.kind
        string

        Required value

        Kind of the referenced network.

        Allowed values: Network, ClusterNetwork

      • spec.networkRef.name
        string

        Required value

        Name of the referenced network.
    • spec.static
      object
      Parameters for Static allocation type.
      • spec.static.ignoreLeaseTTLOnAllocation
        boolean
        If true, allows allocating the requested static IP when the only conflict is an orphaned IPAddressLease.
      • spec.static.ip
        string

        Required value

        Requested IPv4 address.

        Example: 


        ip: 192.168.1.1
    • spec.type
      string

      Required value

      Requested allocation type.

      • Auto: allocate a free address from the pool.
      • Static: allocate the address specified in .spec.static.ip.

      Allowed values: Static, Auto

IPAddressLease

Scope: Cluster
Version: v1alpha1

A cluster-scoped reservation record that holds an allocated IP and prevents it from being assigned to another IPAddress or ClusterIPAddress.
  • spec
    object
    Desired state of resource.
    • spec.ip
      string
      Reserved IPv4 address.

      Example: 


      ip: 192.168.1.10
    • spec.ipAddressRef
      object

      Required value

      Reference to the IPAddress or ClusterIPAddress that owns this lease.
      • spec.ipAddressRef.kind
        string

        Required value

        Kind of the referenced IP address resource.

        Allowed values: IPAddress, ClusterIPAddress

      • spec.ipAddressRef.name
        string

        Required value

        Name of the referenced IPAddress or ClusterIPAddress.
      • spec.ipAddressRef.namespace
        string

        Required value

        Namespace of the referenced IPAddress.
    • spec.networkRef
      object

      Required value

      Reference to the Network or ClusterNetwork associated with this lease.
      • spec.networkRef.kind
        string

        Required value

        Kind of the referenced network resource.

        Allowed values: Network, ClusterNetwork

      • spec.networkRef.name
        string

        Required value

        Name of the referenced network resource.
      • spec.networkRef.namespace
        string

        Required value

        Namespace of the referenced Network.
    • spec.ttl
      string
      Time-to-live applied after the lease is marked orphaned.

      Examples: 


      ttl: 30s

      ttl: 1h

IPAddressPool

Scope: Namespaced
Version: v1alpha1

Defines a namespaced pool of IPv4 addresses used for IPAM on project networks.
  • spec
    object
    Desired state of resource.
    • spec.leaseTTL
      string
      Time to live for orphaned IPAddressLease objects created for addresses from this pool.

      Default: 1h

      Examples: 


      leaseTTL: 30s

      leaseTTL: 1m

      leaseTTL: 24h
    • spec.pools
      array of objects

      Required value

      List of pool entries served by this resource.
      • spec.pools.network
        string
        IPv4 network CIDR served by this pool entry.

        Example: 


        network: 192.168.1.0/24
      • spec.pools.ranges
        array of strings
        Optional list of allocatable IP ranges within network. If omitted, the entire network CIDR is considered allocatable.

        Example: 


        ranges:
- 192.168.1.50
- 192.168.1.51
- 192.168.1.0/24
- 192.168.1.100-192.168.1.110
        • spec.pools.ranges.Element of the array
          string
          Allocatable IPv4 range expression ("startIP-endIP", "CIDR", or single IPv4).

          Pattern: ^(?:(?:25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)\.){3}(?:25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(?:-(?:(?:25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)\.){3}(?:25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)|\/(?:3[0-2]|[12]?\d))?$

          Examples: 


          "": 192.168.1.50

          "": 192.168.1.0/24

          "": 192.168.1.100-192.168.1.110
      • spec.pools.routes
        array of objects
        Optional list of static routes associated with addresses allocated from this pool entry.
        • spec.pools.routes.destination
          string
          Destination network CIDR for the route.

          Examples: 


          destination: 192.168.10.0/24

          destination: 8.8.8.8/32
        • spec.pools.routes.via
          string
          Next-hop (gateway) IPv4 address.

          Example: 


          via: 192.168.1.1

Network

Scope: Namespaced
Version: v1alpha1

Defines the Network resource for configuring the user network in the cluster. It is used to manage VLAN and network parameters such as network class and VLAN ID.
  • spec
    object
    Network resource specification that defines the network parameters.
    • spec.ipam
      object
      IPAM configuration for the network.
      • spec.ipam.ipAddressPoolRef
        object
        Reference to the IP address pool used by this network.
        • spec.ipam.ipAddressPoolRef.kind
          string

          Required value

          Kind of the referenced pool.

          Allowed values: IPAddressPool

        • spec.ipam.ipAddressPoolRef.name
          string

          Required value

          Name of the referenced pool object.
    • spec.networkClass
      string

      Required value

      The network class to be used for this network.

      Minimal length: 1

      Pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$

    • spec.type
      string

      Required value

      The type of network.

      Default: VLAN

      Allowed values: VLAN

    • spec.vlan
      object
      VLAN-specific parameters for the network.
      • spec.vlan.id
        integer
        VLAN ID from the available pool defined in corresponding NetworkClass.

        Allowed values: 1 <= X <= 4094

NetworkClass

Scope: Cluster
Version: v1alpha1

Defines the NetworkClass resource for pre-configuring user networks. The resource is referred in Network resource.
  • spec
    object
    • spec.vlan
      object

      Required value

      Specific options for VLAN-based networks.
      • spec.vlan.idPool
        array of strings

        Required value

        The array of allowed VLAN ID ranges.
        • spec.vlan.idPool.Element of the array
          string

          Pattern: ^\d+(-\d+)?$

      • spec.vlan.parentNodeNetworkInterfaces
        object

        Required value

        Selector for choosing NodeNetworkInterfaces representing NICs to which the network is bound.
        • spec.vlan.parentNodeNetworkInterfaces.labelSelector
          object

          Required value

          Label selector for filtering NodeNetworkInterface resources.
          • spec.vlan.parentNodeNetworkInterfaces.labelSelector.matchLabels
            object
            A set of labels that must match the labels of NodeNetworkInterface resources.

NodeNetworkInterface

Scope: Cluster
Version: v1alpha1

This resource describes and defines a network interface presented on Node. Used for discovering NICs and creating new interfaces like VLAN or Bond.
  • spec
    object
    • spec.bond
      object
      The bond interface parameters.
      • spec.bond.bondName
        string

        Required value

        The bond interface name.
      • spec.bond.memberNetworkInterfaces
        array of objects

        Required value

        The list of label selectors to match interfaces to bond.
        • spec.bond.memberNetworkInterfaces.labelSelector
          object
          Label selector for defining interfaces on top of which the bond interface will be created.
          • spec.bond.memberNetworkInterfaces.labelSelector.matchLabels
            object

            Required value

            A set of labels that must match the labels of NodeNetworkInterface resources.
    • spec.bridge
      object
      The bridge interface parameters.
      • spec.bridge.bridgeName
        string

        Required value

        The bridge interface name.
      • spec.bridge.memberNetworkInterfaces
        array of objects

        Required value

        The list of label selectors to match interfaces to bridge.
        • spec.bridge.memberNetworkInterfaces.labelSelector
          object
          Label selector for identifying interfaces that are part of the bridge.
          • spec.bridge.memberNetworkInterfaces.labelSelector.matchLabels
            object

            Required value

            A set of labels that must match the labels of NodeNetworkInterface resources.
    • spec.heritage
      Deprecated
      string
      The way the node network interface was created. Service option for controllers.

      Allowed values: SDNDiscovered, NetworkController, Manual

    • spec.nic
      object
      Parameters applicable to physical interfaces when spec.type is NIC.
      • spec.nic.bindingMode
        string
        Desired binding mode for the NIC.

        Allowed values: NetDev, VFIO-PCI, DPDK

      • spec.nic.pf
        object
        PF-specific settings for the NIC.
        • spec.nic.pf.sriov
          object
          SR-IOV configuration for the physical function.
          • spec.nic.pf.sriov.enabled
            boolean
            Enables SR-IOV on the physical function.

            Default: false

          • spec.nic.pf.sriov.numVFs
            integer

            Required value

            The number of Virtual Functions to expose when SR-IOV is enabled.

            Allowed values: 1 <= X

      • spec.nic.pfNodeNetworkInterfaceName
        string
        The name of the NodeNetworkInterface for the parent PF.
      • spec.nic.vf
        object
        Virtual Function specific configuration.
        • spec.nic.vf.linkState
          string

          Sets the link state for the VF.

          • Auto: The link state is determined by the PF's link state.
          • Enable: The link is always up.
          • Disable: The link is always down.

          Allowed values: Auto, Enable, Disable

        • spec.nic.vf.mac
          string
          MAC address assigned to the VF.

          Pattern: ^([0-9a-f]{2}:){5}[0-9a-f]{2}$

        • spec.nic.vf.mtu
          integer
          MTU configured on the VF.

          Allowed values: 68 <= X <= 9978

        • spec.nic.vf.queryRSS
          boolean
          Enables or disables querying RSS configuration for the VF.
        • spec.nic.vf.spoofCheck
          boolean
          Enables or disables MAC address spoofing check for the VF.
        • spec.nic.vf.trust
          boolean
          Enables or disables trust mode for the VF.
        • spec.nic.vf.vlan
          integer
          VLAN tag assigned to the VF.

          Allowed values: 0 <= X <= 4094

    • spec.nodeName
      string

      Required value

      The name of the Node the interface belongs to.
    • spec.type
      string

      Required value

      The type of the interface. Options:

      • NIC — the physical interface.
      • VLAN — a VLAN configured on some other interface.
      • Bond — an aggregated interface.
      • Bridge — a bridge interface.

      Allowed values: NIC, VLAN, Bond, Bridge

    • spec.vlan
      object
      The vlan interface parameters.
      • spec.vlan.id
        integer

        Required value

        The VLAN ID.
      • spec.vlan.parentNetworkInterface
        object

        Required value

        The selector to match the parent interface.
        • spec.vlan.parentNetworkInterface.labelSelector
          object

          Required value

          Label selector for determining the parent resource NodeNetworkInterface, on top of which the VLAN interface is enabled.
          • spec.vlan.parentNetworkInterface.labelSelector.matchLabels
            object

            Required value

            A set of labels that must match the labels of NodeNetworkInterface resources.

UnderlayNetwork

Scope: Cluster
Version: v1alpha1

UnderlayNetwork defines physical network interfaces (PF and VF) available for direct attachment to pods via Dynamic Resource Allocation (DRA). This resource enables hardware device passthrough for high-performance workloads such as DPDK applications. Selected interfaces are published as DRA devices that can be claimed by pods using ResourceClaim templates.
  • spec
    object
    • spec.autoBonding
      boolean
      Enable automatic grouping of interfaces when multiple PFs on a single node match the selector. Immutable. In Shared mode: When enabled, the controller groups one VF from each matched PF into a single DRA device. Each such device contains multiple VFs (one per matched PF) that are exposed to the pod as separate network interfaces. The number of grouped devices equals the smallest VF count among all matched PFs. If grouping cannot be assembled (e.g., some PF has no VFs), a warning is logged and device publication is skipped until grouping becomes possible. When disabled, each VF is published as a separate DRA device. In Dedicated mode: When enabled, all matched PFs on a node are grouped into a single DRA device, exposing all PFs to the pod as separate interfaces. When disabled, each PF is published as a separate DRA device. Note: This does not create kernel-level bonding interfaces inside the pod. The interfaces are simply passed through as individual interfaces, allowing applications (e.g., DPDK) to handle bonding/aggregation at the application level.

      Default: true

    • spec.memberNodeNetworkInterfaces
      array of objects

      Required value

      Label selectors for NodeNetworkInterface resources representing NIC's Physical Functions (PF) that will be used for device allocation. Only PF interfaces (not VF) should be selected. The controller will automatically configure and use VFs when operating in Shared mode.
      • spec.memberNodeNetworkInterfaces.labelSelector
        object
        Label selector for defining interfaces on which virtual and physical SR IOV functions will be configured.
        • spec.memberNodeNetworkInterfaces.labelSelector.matchLabels
          object

          Required value

          A set of labels that must match the labels of NodeNetworkInterface resources.
    • spec.mode
      string
      Device allocation mode that determines how physical interfaces are exposed to pods. Shared (default): Creates Virtual Functions (VF) from selected Physical Functions (PF) using SR-IOV, allowing multiple pods to share the same hardware. Each pod receives one or more VFs. When autoBonding is enabled, one VF from each matched PF is grouped into a single DRA device, exposing multiple interfaces to the pod (one per PF). Dedicated: Exposes each matching PF as an exclusive device without SR-IOV. When autoBonding is enabled, all matched PFs on a node are grouped into a single DRA device, exposing all PFs to the pod as separate interfaces. When autoBonding is disabled, each PF is published as a separate DRA device. Suitable for workloads requiring maximum performance or when SR-IOV is not available.

      Default: Shared

      Allowed values: Dedicated, Shared

    • spec.shared
      object
      Configuration parameters for Shared mode. Required when mode is set to "Shared". In Shared mode, SR-IOV is used to create Virtual Functions from Physical Functions, enabling multiple pods to share the same network hardware.
      • spec.shared.sriov
        object
        SR-IOV configuration for creating Virtual Functions from selected Physical Functions. When enabled, the controller configures SR-IOV on matching PF interfaces and creates the specified number of VFs per PF. These VFs are then published as DRA devices that can be allocated to pods.
        • spec.shared.sriov.enabled
          boolean

          Required value

          Enable SR-IOV on selected Physical Functions. When true, VFs will be created according to numVFs setting.
        • spec.shared.sriov.numVFs
          integer
          Number of Virtual Functions to create per Physical Function. Must be greater than 0 when enabled is true. The actual number of VFs created may be limited by the hardware's maximum supported VF count.

          Allowed values: 0 <= X