Configuring Network Interfaces in Ubuntu with Netplan

Introduction

Configuring network interfaces is a fundamental task for system administrators and developers alike, as it directly impacts connectivity and communication within networks. With the introduction of Netplan in Ubuntu, managing these configurations has become more streamlined and efficient. This article will guide you through the process of setting up and configuring network interfaces using Netplan, ensuring that you can effectively manage your network settings.

What Is Netplan?

Netplan is a utility designed for configuring networking on Linux systems, particularly in Ubuntu environments. It utilizes a YAML-based configuration format, allowing users to define network interfaces, IP addresses, routes, and other networking parameters in a clear and structured manner. This approach enhances readability and simplifies management compared to traditional methods like ifupdown.

How It Works

Netplan functions by translating YAML configuration files into specific configuration files for various backends, such as NetworkManager or systemd-networkd. You create your network settings in a YAML file, usually located in the /etc/netplan/ directory, and apply the changes using the Netplan command line. Think of it as a translator that takes your human-readable instructions and converts them into a format that the system can understand and implement.

Key Concepts

YAML: A human-readable data serialization format that is intuitive to write and comprehend.
Network Interfaces: Physical or virtual connections through which the system communicates with other devices.
Backends: The underlying services that process the configurations, such as NetworkManager or systemd-networkd.
Apply Changes: After editing your configuration file, you must apply the changes for them to take effect.

Prerequisites

Before you start configuring network interfaces with Netplan, ensure you have the following:

An Ubuntu system (18.04 or later).
Root or sudo privileges to edit configuration files.
Basic familiarity with command-line operations.

Installation & Setup

Netplan is included by default in Ubuntu versions 17.10 and later. If you are using an older version, consider upgrading. To verify that Netplan is installed, you can check its version:

netplan --version

If you need to install it, use the following command:

sudo apt update && sudo apt install netplan.io

Step-by-Step Guide

Example: Configuring a Static IP Address for a Wired Interface

In this example, we will configure a wired interface (let’s assume it's named ens33) with a static IP address.

Identify Your Network Interface
Run the following command to list all available network interfaces:
```
ip addr
```
Identify the interface you wish to configure, e.g., ens33.
Create or Edit a Netplan Configuration File
Navigate to the /etc/netplan/ directory:
```
cd /etc/netplan/
```
You will typically find a .yaml file there. You can edit it or create a new one. For this example, let’s create a file named 01-netcfg.yaml:
```
sudo nano 01-netcfg.yaml
```

Define the Network Configuration
Add the following configuration to the YAML file, replacing the IP address, gateway, and DNS with your requirements:

network:
  version: 2
  renderer: networkd
  ethernets:
    ens33:
      dhcp4: no
      addresses:
        - 192.168.1.100/24
      gateway4: 192.168.1.1
      nameservers:
        addresses:
          - 8.8.8.8
          - 8.8.4.4

Apply the Configuration
After saving your changes, apply the configuration with the following command:
```
sudo netplan apply
```
Verify the Configuration
Check if the new IP address has been assigned:
```
ip addr show ens33
```

Real-World Examples

Example 1: Configuring Multiple Interfaces

If you have multiple interfaces, you can configure them in the same YAML file. For instance, to configure ens33 and ens34:

network:
  version: 2
  renderer: networkd
  ethernets:
    ens33:
      dhcp4: no
      addresses:
        - 192.168.1.100/24
      gateway4: 192.168.1.1
      nameservers:
        addresses:
          - 8.8.8.8
    ens34:
      dhcp4: yes

Example 2: Configuring VLANs

You can also configure VLANs using Netplan. Here’s how to set up a VLAN on ens33:

network:
  version: 2
  renderer: networkd
  ethernets:
    ens33:
      dhcp4: no
      addresses:
        - 192.168.1.100/24
      gateway4: 192.168.1.1
      nameservers:
        addresses:
          - 8.8.8.8
  vlans:
    vlan10:
      id: 10
      link: ens33
      addresses:
        - 192.168.2.100/24

Best Practices

Always back up existing configuration files before making changes.
Use descriptive names for your YAML files to indicate their purpose.
Validate your YAML syntax using tools like yamllint to avoid errors.
Keep your configurations organized and well-commented for future reference.
Test configurations in a staging environment before deploying to production.
Regularly review and update network configurations as your infrastructure evolves.
Monitor network performance and connectivity after applying changes.

Common Issues & Fixes

Issue	Cause	Fix
Network not coming up	Incorrect YAML syntax	Validate YAML file using `yamllint`.
Changes not applied	Missing `sudo` when running `netplan`	Ensure you use `sudo` to apply changes.
Interface not found	Typo in interface name	Double-check the interface name with `ip addr`.
DHCP not working	DHCP server issues	Verify DHCP server functionality and logs.

Key Takeaways

Netplan simplifies network configuration in Ubuntu using a YAML-based format.
You can configure various networking settings, including static IPs and VLANs.
Always validate your YAML syntax to prevent configuration errors.
Use sudo netplan apply to apply changes after editing configuration files.
Regularly review and update your network configurations for optimal performance and security.