Skip to main content

Your submission was sent successfully! Close

Thank you for signing up for our newsletter!
In these regular emails you will find the latest updates from Canonical and upcoming events where you can meet our team.Close

Thank you for contacting us. A member of our team will be in touch shortly. Close

  1. Blog
  2. Article

Joshua Powers
on 1 December 2017


Netplan

For this week’s Bionic test blitz I am looking at Netplan! Netplan enables easily configuring networking on a system via YAML files. Netplan processes the YAML and generates the required configurations for either NetworkManager or systemd-network the system’s renderer. Netplan replaced ifupdown as the default configuration utility starting with Ubuntu 17.10 Artful.

Configuration

Initial Setup in Bionic

When you install Bionic or use a cloud image of Bionic a file will appear in /etc/netplan depending on the renderer in use. Here is a breakdown of the various types:
Install Type Renderer File
Server ISO systemd-networkd /etc/netplan/01-netcfg.yaml
Cloud Image systemd-networkd /etc/netplan/50-cloud-init.yaml
Desktop ISO NetworkManager /etc/netplan/01-network-manager-all.yaml
Do note that configuration files can exist in three different locations with the precidence from most important to least as follows:
  • /run/netplan/*.yaml
  • /etc/netplan/*.yaml
  • /lib/netplan/*.yaml
Alphabetically later files, no matter what directory they are in, will amend keys if the key does not already exist and override previous keys if they do.

Examples

The best method for demonstrating what netplan can do is by showing some examples. Keep in mind that these are very simple examples that do not demonstrate complex situations that netplan can handle.

Static and DHCP Addressing

The following configures four devices:
  • enp3s0 setup with IPv4 DHCP
  • enp4s0 setup with IPv4 static with custom MTU
  • IPv6 static tied to a specific MAC address
  • IPv4 and IPv6 DHCP with jumbo frames tied to a specific MAC address
ethernets:
    enp3s0:
        dhcp4: true
    enp4s0:
        addresses:
            - 192.168.0.10/24
        gateway4: 192.168.0.1
        mtu: 1480
        nameservers:
            addresses:
                - 8.8.8.8
                - 9.9.9.9
    net1:
        addresses:
            - fe80::a00:10a/120
        gateway6: fe80::a00:101
        match:
            macaddress: 52:54:00:12:34:06
    net2:
        dhcp4: true
        dhcp6: true
        match:
            macaddress: 52:54:00:12:34:07
        mtu: 9000

Bonding

Bonding can easily be configured with the required interfaces list and by specifying the mode. The mode can be any of the valid types: balance-rr, active-backup, balance-xor, broadcast, 802.3ad, balance-tlb, balance-alb. See the bonding wiki page for more details.
bonds:
    bond0:
        dhcp4: yes
        interfaces:
            - enp3s0
            - enp4s0
        parameters:
            mode: active-backup
            primary: enp3s0

Bridges

Here is a very simple example of a bridge using DHCP:
bridges:
    br0:
        dhcp4: yes
        interfaces:
            - enp3s0
Additional parameters can be passed in to turn off STP for example or set priorities.

Vlans

Similarly, vlans only require a name as the key and then an id and link to use for the vlan:
vlans:
    vdev:
        id: 101
        link: net1
        addresses:
            - 10.0.1.10/24
    vprod:
        id: 102
        link: net2
        addresses:
            - 10.0.2.10/24
    vtest:
        id: 103
        link: net3
        addresses:
            - 10.0.3.10/24
    vmgmt:
        id: 104
        link: net4
        addresses:
            - 10.0.4.10/24

Next Steps

I was left with an overall very positive impression of netplan. Having the ability to write YAML configuration files and not have to worry about how the actual configuration was generated or what commands need to be used depending on the backend simplifies the process. I would like to continue to attempt some more complex configurations that I can find as well as attempt additional test cases with the ifupdown-migrate subcommand.

Links & Refrences

Related posts


Oliver Smith
17 May 2024

Migrating from CentOS to Ubuntu: a guide for system administrators and DevOps

Cloud and server Article

CentOS 7 is on track to reach its end-of-life (EoL) on June 30, 2024. Post this date, the CentOS Project will cease to provide updates or support, including vital security patches. Moving away from the RHEL-based ecosystem might appear daunting, but if you’re considering Ubuntu the switch can be both straightforward and economically viabl ...


Lukas Märdian
5 April 2024

Introducing Netplan v1.0 – stable, declarative network management

Cloud and server Article

After more than 7 years of development, Netplan v1.0 delivers improved stability and maintainability alongside a host of other new features. ...


Lukas Märdian
14 November 2023

Netplan brings consistent network configuration across Desktop, Server, Cloud and IoT

Cloud and server Article

Learn how Netplan has established itself as the proven network stack across all variants of Ubuntu – Server, Cloud, Embedded and now Desktop. ...