Add Netplan NIC support for Debian/Ubuntu #1463

Signed-off-by: Jonathon Anderson <janderson@ciq.com>

CHANGELOG.md

@@ -8,6 +8,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
 
 ### Added
 
+- Added Netplan NIC support for Debian/Ubuntu #1463
 - Added documentation on ensuring `systemctl restart warewulfd` is ran when editing `nodes.conf` or `warewulf.conf`
 - Add the ability to boot nodes with `wwid=[interface]`, which replaces
   `interface` with the interface MAC address

CONTRIBUTORS.md

@@ -42,5 +42,5 @@
 * Brandon Biggs <brandonsbiggs@gmail.com>
 * Howard Van Der Wal <howard.a.vanderwal@protonmail.com> [@metalllinux](https://github.com/metalllinux)
 * Nicholas Porter <nap23@unm.edu>
-* Ian Kaufman [@iankgt40](https://github.com/iankgt40)
+* Ian Kaufman <ikaufman@ucsd.edu> [@iankgt40](https://github.com/iankgt40)
 * Daniele Colombo [@dacolombo](https://github.com/dacolombo)

overlays/netplan/internal/netplan_test.go

@@ -0,0 +1,74 @@
+package netplan
+
+import (
+	"bytes"
+	"testing"
+
+	"github.com/stretchr/testify/assert"
+	"github.com/warewulf/warewulf/internal/app/wwctl/overlay/show"
+	"github.com/warewulf/warewulf/internal/pkg/testenv"
+	"github.com/warewulf/warewulf/internal/pkg/wwlog"
+)
+
+func Test_netplanOverlay(t *testing.T) {
+	env := testenv.New(t)
+	defer env.RemoveAll(t)
+	env.ImportFile(t, "etc/warewulf/nodes.conf", "nodes.conf")
+	env.ImportFile(t, "var/lib/warewulf/overlays/netplan/rootfs/etc/netplan/01-netcfg.yaml.ww", "../rootfs/etc/netplan/01-netcfg.yaml.ww")
+
+	tests := []struct {
+		name string
+		args []string
+		log  string
+	}{
+		{
+			name: "netplan",
+			args: []string{"--render", "node1", "netplan", "etc/netplan/01-netcfg.yaml.ww"},
+			log:  netplan,
+		},
+	}
+
+	for _, tt := range tests {
+		t.Run(tt.name, func(t *testing.T) {
+			cmd := show.GetCommand()
+			cmd.SetArgs(tt.args)
+			stdout := bytes.NewBufferString("")
+			stderr := bytes.NewBufferString("")
+			logbuf := bytes.NewBufferString("")
+			cmd.SetOut(stdout)
+			cmd.SetErr(stderr)
+			wwlog.SetLogWriter(logbuf)
+			err := cmd.Execute()
+			assert.NoError(t, err)
+			assert.Empty(t, stdout.String())
+			assert.Empty(t, stderr.String())
+			assert.Equal(t, tt.log, logbuf.String())
+		})
+	}
+}
+
+const netplan string = `backupFile: true
+writeFile: true
+Filename: 01-netcfg.yaml
+# This file is autogenerated by warewulf
+network:
+  version: 2
+  renderer: networkd
+  ethernets:
+     wwnet0:
+        addresses:
+           - 192.168.3.21/24
+        mtu: 1500
+backupFile: true
+writeFile: true
+Filename: 01-netcfg.yaml
+# This file is autogenerated by warewulf
+network:
+  version: 2
+  renderer: networkd
+  ethernets:
+     wwnet1:
+        addresses:
+           - 192.168.3.22/24
+        mtu: 9000
+`

overlays/netplan/internal/nodes.conf

@@ -0,0 +1,17 @@
+nodes:
+  node1:
+    network devices:
+      default:
+        device: wwnet0
+        hwaddr: e6:92:39:49:7b:03
+        ipaddr: 192.168.3.21
+        netmask: 255.255.255.0
+        gateway: 192.168.3.1
+        mtu: 1500
+      secondary:
+        device: wwnet1
+        hwaddr: 9a:77:29:73:14:f1
+        ipaddr: 192.168.3.22
+        netmask: 255.255.255.0
+        gateway: 192.168.3.1
+        mtu: 9000

overlays/netplan/rootfs/etc/netplan/01-netcfg.yaml.ww

@@ -0,0 +1,13 @@
+{{range $devname, $netdev := .NetDevs -}}
+{{- $filename := print "01-netcfg.yaml" }}
+{{- file $filename }}
+# This file is autogenerated by warewulf
+network:
+  version: 2
+  renderer: networkd
+  ethernets:
+     {{$netdev.Device}}:
+        addresses:
+           - {{$netdev.IpCIDR}}
+        mtu: {{$netdev.MTU}}
+{{end -}}