Experimental version. The functionality may undergo significant changes. Compatibility with future versions is not guaranteed.

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.parentNodeNetworkInterfaces
      object

      Required value

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

        Required value

        • spec.parentNodeNetworkInterfaces.labelSelector.matchLabels
          object

          Required value

    • 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

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.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.

      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

          • spec.vlan.parentNodeNetworkInterfaces.labelSelector.matchLabels
            object

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
          • spec.bond.memberNetworkInterfaces.labelSelector.matchLabels
            object

            Required value

    • 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
          • spec.bridge.memberNetworkInterfaces.labelSelector.matchLabels
            object

            Required value

    • spec.heritage
      string

      Required value

      The way the node network interface was created. Service option for controllers.

      Default: Manual

      Allowed values: SDNDiscovered, NetworkController, Manual

    • 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.

      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

          • spec.vlan.parentNetworkInterface.labelSelector.matchLabels
            object

            Required value