Skip to main content

Network

Netplan​

Since OSISM 6.1.0, the default network type is a netplan and no longer needs to be set explicitly
network_type: netplan

The configuration is written to /etc/netplan/01-osism.yaml by default. Can be changed via the network_netplan_path and network_netplan_file parameters. The file permissions are 0600 by default (cane be changed via the network_netplan_permissions parameter). By default, all other files in /etc/netplan are removed. If you do not want this, you can set network_netplan_remove_unmanaged_files to false. It is also possible to explicitly list individual files that should not be deleted in network_netplan_managed_files_extra.

An existing /etc/intefaces file is replaced with a placeholder file. It is not possible to use /etc/interfaces and Netplan in parallel.

This template is used as the base for the configuration
# This file describes the network interfaces available on your system
# For more information, see netplan(5).
---
network:
  version: {{ network_version }}
  renderer: {{ network_renderer }}

  bonds:
    {{ network_bonds|to_nice_yaml(indent=4)|indent(4) }}

  bridges:
    {{ network_bridges|to_nice_yaml(indent=4)|indent(4) }}

  ethernets:
    {{ network_ethernets|to_nice_yaml(indent=4)|indent(4) }}

  tunnels:
    {{ network_tunnels|to_nice_yaml(indent=4)|indent(4) }}

  vlans:
    {{ network_vlans|to_nice_yaml(indent=4)|indent(4) }}

  vrfs:
    {{ network_vrfs|to_nice_yaml(indent=4)|indent(4) }}

The parameters listed in the following table can be used in the template.

ParameterDefaultDescription
network_version2Defines what version of the configuration format is used. The only value supported at the moment is 2.
network_renderernetworkdDefines what network configuration tool will be used to set up your configuration.
network_bonds{}https://netplan.readthedocs.io/en/stable/netplan-yaml/#properties-for-device-type-bonds
network_bridges{}https://netplan.readthedocs.io/en/stable/netplan-yaml/#properties-for-device-type-bridges
network_ethernets{}https://netplan.readthedocs.io/en/stable/netplan-yaml/#properties-for-device-type-ethernets
network_tunnels{}https://netplan.readthedocs.io/en/stable/netplan-yaml/#properties-for-device-type-tunnels
network_vlans{}https://netplan.readthedocs.io/en/stable/netplan-yaml/#properties-for-device-type-vlans
network_vrfs{}https://netplan.readthedocs.io/en/stable/netplan-yaml/#properties-for-device-type-vrfs

By default changes to the network configuration are not applied automatically. This is done on purpose to allow a manual check in advance. Changes to the network configuration can be applied either by rebooting or by executing netplan apply.

$ osism console --type clush all
Enter 'quit' to leave this interactive mode
Working with nodes: testbed-manager.testbed.osism.xyz,testbed-node-[0-2].testbed.osism.xyz
clush> sudo netplan apply

It is possible to execute the netplan apply automatically via a handler when changes are made. The parameter network_allow_service_restart is used for this.

environments/configuration.yml
network_allow_service_restart: true

Example​

The Netplan documentation contains a large number of example configurations. The following example shows the use of How to create VLANs with the osism.commons.network role.

network_ethernets:
  mainif:
    match:
      macaddress: "de:ad:be:ef:ca:fe"
    set-name: mainif
    addresses: [ "10.3.0.5/23" ]
    nameservers:
      addresses: [ "8.8.8.8", "8.8.4.4" ]
      search: [ example.com ]
    routes:
      - to: default
        via: 10.3.0.1

network_vlans:
  vlan15:
    id: 15
    link: mainif
    addresses: [ "10.3.99.5/24" ]
  vlan10:
    id: 10
    link: mainif
    addresses: [ "10.3.98.5/24" ]
    nameservers:
      addresses: [ "127.0.0.1" ]
      search: [ domain1.example.com, domain2.example.com ]

Dispatcher scripts​

Dummy interfaces​

Dummy devices are created with the help of systemd.netdev and can then be used as a normal netowrk device in the Netplan configuration.

network_dummy_interfaces:
  - dummy0

The MTU is set to 9000 by default and can be set via network_dummy_interface_mtu.

/etc/interfaces​

If /etc/interfaces is to be used, the network_type must be explicitly set in environments/configuration.yml
network_type: interfaces

IPv6 fabric underlay​

Example configuration for a node. The configuration is stored in the host_vars file for the node in inventory directory in the configuration repository.

##########################################################
# ansible

ansible_host: 10.10.42.10
##########################################################
# generic

internal_interface: dummy0
##########################################################
# network

network_type: netplan
network_dummy_interfaces:
  - dummy0
network_ethernets:
  enp99s0f0np0:
    mtu: 9100
  enp99s0f1np1:
    mtu: 9100
  dummy0:
    addresses:
      - 10.10.42.10/32
      - 2001:db8::10:10:42:10/128
##########################################################
# frr

frr_local_as: 4210042010
frr_loopback_v4: 10.10.42.10
frr_loopback_v6: 2001:db8::10:10:42:10
frr_uplinks:
  - interface: enp99s0f0np0
    remote_as: 65401
  - interface: enp99s0f1np1
    remote_as: 65402
##########################################################
# kolla

network_interface: "{{ internal_interface }}"