builder_images.md

Builder Images

Driverkit supports multiple builder images.
A builder image is the docker image used to build the drivers.

Adding a builder image

Adding a builder image is just a matter of adding a new dockerfile under the build folder,
with a name matching: builder_$osname.Dockerfile (like: builder_stretch.Dockerfile).

The makefile will be then automatically able to collect the new docker images and pushing it as part of the CI.

Moreover, the new image $osname must also be added to the static map of images, kept in builders.go source file:

var images = map[string]Image{
	"buster": {
		GCCVersion: map[kernelrelease.Architecture][]string{
			kernelrelease.ArchitectureAmd64: {"4.8", "4.9", "5", "6", "8"},
			kernelrelease.ArchitectureArm64: {"4.8", "5", "6", "8"}, // 4.9 is not present on arm64
		},
	},
	"bullseye": {
		GCCVersion: map[kernelrelease.Architecture][]string{
			kernelrelease.ArchitectureAmd64: {"9", "10"},
			kernelrelease.ArchitectureArm64: {"9", "10"},
		},
	},
	"bookworm": {
		GCCVersion: map[kernelrelease.Architecture][]string{
			kernelrelease.ArchitectureAmd64: {"11", "12"},
			kernelrelease.ArchitectureArm64: {"11", "12"},
		},
	},
}

Then, the new image's shipped gcc is now available to various builder using the defaultGCC method's algorithm,
or chosen by each builder by implementing the builder.GCCVersionRequestor interface.

Finally, the builder doc file should be updated with the new available GCC (section 3.).