NVIDIA Build-Kit

Forbidden Variables	Section	Value	Default	Use case
REQUIRED_VARIABLES	all	Comma separated variable names	-	Checks if the variables names in value are defined, exits the tool if it isn't.
QEMU_PATH	common, linux	Path to qemu-aarch64-static binary	/usr/bin/	This variable controls the path to qemu-aarch64-static binary used for chrooting into the Linux filesystem.
BUILD_KIT_DIR	all	Path to NVIDIA Build-Kit directory	/opt/nvidia/driveos/<RELEASE>/filesystems/build-kit	Helper scripts for installing packages inside chroot environment are copied from ${BUILD_KIT_DIR}/helpers Mirror setup scripts for setting up Nvidia repositories and downloading Nvidia Packages are copied from ${BUILD_KIT_DIR}/mirror-setup
COPYTARGET	all	Path to Copytarget binary	/opt/nvidia/driveos/<RELEASE>/filesystems/copytarget/copytarget.py	This variable specifies the copytarget binary to be executed for processing copytarget yaml files.
PYTHON3	all	Path to python3 binary	/usr/bin/python3	This variable specifies the python binary that should be used for invoking the copytarget.py tool.

Field	Acceptable Values	Required	Instructions
OS	"linux"	Yes	Specify "linux" for generating Linux target filesystem image.
Output	valid Unix filename	Yes	Specify the output file name. Recommended characters = a-zA-Z0-9_-. The outputs generated will be filename.img and filename.tar.bz2 (if create-tar option is provided).
Base	valid Unix filename with extension .img, .img.tar.<compression>, .tar, .tar.<compression>	Yes	Specify the input file name Input can be image, compressed image, or tarball (uncompressed archive), or compressed tarball
Mirrors	comma separated values of mirrors as written in /etc/apt/sources.list file. Value: Array of mirrors	Can be left empty	Specify the mirrors where the packages specified in DebianPackages will be obtained. Ensure these values adhere to the package manager's syntax of mirrors. E.g. "Mirrors": [ "deb http://ports.ubuntu.com/ubuntu-ports/ bionic main universe restricted", "deb http://ports.ubuntu.com/ubuntu-ports/ bionic-updates main universe restricted", "deb http://ports.ubuntu.com/ubuntu-ports/ bionic-security main universe restricted" ],
Users	dict of username to tuple of (UID, password) Key: username Value: Array of 2 items - UID and passwd	Can be left empty	Specify the users to be added to the target filesystem being created. Ensure username is a valid username as per ubuntu standards. UID recommended to be above 1000 . Ensure the UID is available in the Base, as conflicting UIDs will error the tool. E.g. "Users": { "nvidia": [ "1000", "nvidia" ], "test": [ "1001", "testpassword" ] },
Groups	dict of groupname to GID Key: groupname Value: GID	Can be left empty	Ensure groupname is a valid groupname as per ubuntu standards. GID recommended to be above 1000. Ensure the GID is available in the Base. as conflicting GIDs will error the tool. E.g. "Groups": { "weston-launch": "1010" }
Memberships	dict of username to array of groups Key: username Value: Array of groups Each item: group	Can be left empty	Ensure the username is available from the Base tarball / Created via NVIDIA Build-Kit, as absent username will error the tool. Ensure the groups are available from the Base tarball / Created via NVIDIA Build-Kit, as absent groups will error the tool. E.g. "Memberships": { "nvidia": [ "adm", "audio", "cdrom", "dialout", "dip", "floppy", "plugdev", "sudo", "video", "weston-launch" ] }
Preinstall	dict of file to value "" or "target" Key: Paths to files, can use env variables in this. Value: "" or "target"	Can be left empty	Provide bash scripts that need to be executed before debian packages are installed. E.g. conditional setting up of mirrors, updating DNS servers, Executing something on the host. "" empty value implies running on the host. "target" value implies running on FS chroot. FILESYSTEM_WORK_DIR variable is available for the bash script for getting Target Filesystem directory in the host. WORK_DIR variable is available for the bash script for getting the Build-Kit Work Directory E.g. "PreInstalls": { "${BUILD_KIT_DIR}/mirror-setup/setup-cuda-cudnn-tensorrt-mirror.sh": "" }, The above one is used to setup cuda, cudnn, trt mirrors for downloading their debian packages. It is executed on the host as the second field is empty.
CopyTargets	Array of Copytargets to be executed Each item: Paths to copytarget files, can use env variables in this.	Can be left empty	Provide the list of copytarget yaml files/scripts to be executed to copy files into the target filesystem. Note: If writing script $1 is target directory, Note: If writing yaml, in the export section $targetdir gives the target directory.
PostInstalls	dict of file to value "" or "target" Key: Paths to files, can use env variables in this. Value: "" or "target"	Can be left empty	Provide bash scripts that need to be executed after debian packages are installed and CopyTargets are executed. Example: running run-once scripts, running post install checks "" empty value implies running on the host "target" value implies running on FS chroot E.g., "PostInstalls": { "/root/run-once/X01-nv-run-once-add-user": "target", "/etc/systemd/scripts/nv_run_once_run_ldconfig": "target" }, The above section runs the run-once scripts on the target as they aren't dependent on running on a target board.
FilesystemCleanup	Array of files to remove Each item: Paths of files to be removed	Can be left empty	Itemized list of intermediate files generated which are to be removed once the postinstall scripts are done executing. E.g. "FilesystemCleanup": [ "/tmp/", "/var/tmp/", "/var/cache/apt/srcpkgcache.bin", "/var/cache/apt/pkgcache.bin", "/etc/apt/sources.list.d/cuda.list", "/etc/apt/sources.list.d/cudnn.list", "/etc/apt/sources.list.d/tensorrt.list", "/etc/apt/sources.list.d/local-apt-repos.list" ],
DebianPackages	Array of debian packages (same name as the ones used in apt-get install) Each item: Valid debian package names.	Can be left empty	List out the debian packages to be installed into the target filesystem E.g. "DebianPackages": [ "cuda-libraries-10-2", "cuda-gdb-10-2", "cuda-memcheck-10-2", "libcudnn7", "libnvinfer5" ]
ImageSize	Unsigned Number of bytes.	No	The size of the partition to which the current image will be expanded to (defaults to 8GB). E.g. "ImageSize":"4294967296"

OS	pre-build	build	post-build	process-output
Linux	Set up binfmt for executing different arch binaries. Extract base filesystem. Update mirrors in the filesystem with values provided in the CONFIG.json. Update resolv.conf of target filesystem with host's resolv.conf. Run preinstall scripts.	Generate manifest of packages to be installed Convert CONFIG.json into MANIFEST.json for version locking. Install packages using package manager (apt). Create users/groups and update user memberships. Execute copytarget scripts provided in the	Restore mirrors to original in the target filesystem. Restore resolv.conf to original in target filesystem. Run postinstall scripts.	Create EXT image file of the target filesystem.

Short Option	Long Option	Defaults	Required	Description
-h	--help	N/A	No	Show help message and exit.
-v	--version	N/A	No	Print version and exit.
-i JSON_PATH	--input=JSON_PATH	No defaults	Yes	Input NVIDIA Build-Kit CONFIG file.
-o OUTPUT_FOLDER	--output=OUTPUT_FOLDER	${PWD}	No	Output folder.
-m	--manifest-only	False	No	Generates manifest only. Do not install.
	--create-tar	False	No	Creates output tarball along with image file creation.
	--skip-image	False	No	Skip image file creation.