Configuring an ipvlan network

    The Cluster Network Operator (CNO) manages additional network definitions. When you specify an additional network to create, the CNO creates the object automatically.

    Prerequisites

    • Install the OpenShift CLI (oc).

    • Log in as a user with cluster-admin privileges.

    Procedure

    To create an additional network for your cluster, complete the following steps:

    1. Edit the CNO CR by running the following command:

    2. Modify the CR that you are creating by adding the configuration for the additional network you are creating, as in the following example CR.

      The following YAML configures the ipvlan CNI plug-in:

      1. apiVersion: operator.openshift.io/v1
      2. kind: Network
      3. metadata:
      4. name: cluster
      5. spec:
      6. additionalNetworks: (1)
      7. - name: test-network-1
      8. namespace: test-1
      9. type: Raw
      10. rawCNIConfig: '{
      11. "cniVersion": "0.3.1",
      12. "name": "test-network-1",
      13. "type": "ipvlan",
      14. "master": "eth1",
      15. "mode": "l2",
      16. "ipam": {
      17. "type": "static",
      18. "addresses": [
      19. {
      20. "address": "192.168.1.23/24"
      21. }
      22. ]
      23. }
      24. }'
      1Specify the configuration for the additional network attachment definition.
    3. Save your changes and quit the text editor to commit your changes.

    4. Confirm that the CNO created the NetworkAttachmentDefinition object by running the following command. Replace <namespace> with the namespace that you specified when configuring the network attachment. There might be a delay before the CNO creates the object.

      1. $ oc get network-attachment-definitions -n <namespace>
      1. test-network-1 14m

    The configuration for an additional network attachment that uses the ipvlan Container Network Interface (CNI) plug-in is provided in two parts:

    • Cluster Network Operator (CNO) configuration

    • CNI plug-in configuration

    The CNO configuration specifies the name for the additional network attachment and the namespace to create the attachment in. The plug-in is configured by a JSON object specified by the rawCNIConfig parameter in the CNO configuration.

    The following YAML describes the configuration parameters for the CNO:

    Cluster Network Operator YAML configuration

    The following object describes the configuration parameters for the ipvlan CNI plug-in:

    ipvlan CNI plug-in JSON configuration object

    1. {
    2. "cniVersion": "0.3.1",
    3. "name": "<name>", (1)
    4. "type": "ipvlan",
    5. "mode": "<mode>", (2)
    6. "master": "<master>", (3)
    7. "mtu": <mtu>, (4)
    8. "ipam": { (5)
    9. }
    10. }
    1Specify the value for the name parameter you provided previously for the CNO configuration.
    2Specify the operating mode for the virtual network. The value must be l2, l3, or l3s. The default value is l2.
    3Specify the ethernet interface to associate with the network attachment. If a master is not specified, the interface for the default network route is used.
    4Set the maximum transmission unit (MTU) to the specified value. The default value is automatically set by the kernel.
    5Specify a configuration object for the ipam CNI plug-in. The plug-in manages IP address assignment for the attachment definition.

    ipvlan configuration example

    The following example configures an additional network named ipvlan-net:

    1. name: ipvlan-net
    2. namespace: work-network
    3. type: Raw
    4. rawCNIConfig: '{ (1)
    5. "cniVersion": "0.3.1",
    6. "name": "work-network",
    7. "type": "ipvlan",
    8. "master": "eth1",
    9. "mode": "l3",
    10. "ipam": {
    11. "type": "dhcp"
    12. }
    13. }'

    Configuration for ipam CNI plug-in

    The ipam Container Network Interface (CNI) plug-in provides IP address management (IPAM) for other CNI plug-ins.

    You can use the following methods for IP address assignment:

    • Static assignment.

    • Dynamic assignment through the Whereabouts IPAM CNI plug-in.

    Static IP address assignment configuration

    The following JSON describes the configuration for static IP address assignment:

    Static assignment configuration

    1. {
    2. "ipam": {
    3. "type": "static",
    4. "addresses": [ (1)
    5. {
    6. "address": "<address>", (2)
    7. "gateway": "<gateway>" (3)
    8. }
    9. ],
    10. "routes": [ (4)
    11. {
    12. "dst": "<dst>", (5)
    13. }
    14. ],
    15. "dns": { (7)
    16. "nameservers": ["<nameserver>"], (8)
    17. "domain": "<domain>", (9)
    18. "search": ["<search_domain>"] (10)
    19. }
    20. }
    1An array describing IP addresses to assign to the virtual interface. Both IPv4 and IPv6 IP addresses are supported.
    2An IP address and network prefix that you specify. For example, if you specify 10.10.21.10/24, then the additional network is assigned an IP address of 10.10.21.10 and the netmask is 255.255.255.0.
    3The default gateway to route egress network traffic to.
    4An array describing routes to configure inside the pod.
    5The IP address range in CIDR format, such as 192.168.17.0/24, or 0.0.0.0/0 for the default route.
    6The gateway where network traffic is routed.
    7Optional: DNS configuration.
    8An of array of one or more IP addresses for to send DNS queries to.
    9The default domain to append to a hostname. For example, if the domain is set to example.com, a DNS lookup query for example-host is rewritten as example-host.example.com.
    10An array of domain names to append to an unqualified hostname, such as example-host, during a DNS lookup query.

    Dynamic IP address assignment configuration

    The following JSON describes the configuration for dynamic IP address address assignment with DHCP.

    DHCP assignment configuration

    1. {
    2. "ipam": {
    3. "type": "dhcp"
    4. }
    5. }

    Dynamic IP address assignment configuration with Whereabouts

    The Whereabouts CNI plug-in allows the dynamic assignment of an IP address to an additional network without the use of a DHCP server.

    The following JSON describes the configuration for dynamic IP address assignment with Whereabouts:

    Whereabouts assignment configuration

    1. {
    2. "ipam": {
    3. "type": "whereabouts",
    4. "range": "<range>", (1)
    5. "exclude": ["<exclude_part>, ..."], (2)
    6. }
    7. }
    1Specify an IP address and range in CIDR notation. IP addresses are assigned from within this range of addresses.
    2Optional: Specify a list of IP addresses and ranges in CIDR notation. IP addresses within an excluded address range are not assigned.

    Static IP address assignment configuration example

    You can configure ipam for static IP address assignment:

    1. {
    2. "ipam": {
    3. "type": "static",
    4. "addresses": [
    5. {
    6. "address": "191.168.1.7"
    7. }
    8. ]
    9. }
    10. }

    Dynamic IP address assignment configuration example using DHCP

    You can configure ipam for DHCP:

    Dynamic IP address assignment configuration example using Whereabouts

    1. {
    2. "ipam": {
    3. "type": "whereabouts",
    4. "range": "192.0.2.192/27",
    5. "exclude": [
    6. "192.0.2.192/30",
    7. "192.0.2.196/32"
    8. ]
    9. }
    10. }

    Next steps

    • .