History log of /freebsd-10-stable/release/scripts/mk-vmimage.sh
Revision Date Author Comments
# 282111 27-Apr-2015 gjb

MFC r280299, r280840, r280846, r280879, r280881, r280884, r280928,
r281783, r281809, r281832:

r280299 (cperciva):
When creating VM images, copy the contents of the created filesystem
into a new filesystem before packaging it into a disk image. This
prevents "remnants" of deleted files from showing up in the VM images,
and reduces their compressed size (by about 10% for the cloudware
images) as a result.

r280840 (cperciva):
Clean up filesystem unmounting in vmimage builds:
- Remove vm_umount_base function which is currently unused.
- Add umount_loop function which loops attempting to unmount one
filesystem.
- Replace calls to umount with calls to umount_loop.
- Don't attempt to unmount ${DESTDIR}/dev if it isn't mounted.

The looping is necessary because sometimes umount fails due to
filesystems being busy. The most common cause of such busyness is
periodic(8) jobs running `find / ...`.

r280846 (cperciva):
Improve check for whether ${DESTDIR}/dev is mounted.

r280879 (cperciva):
Add bits for building EC2 disk images.

r280881 (cperciva):
Partially revert r278118 now that the required logic for deciding
whether freebsd-update can be useful has moved into the
firstboot_freebsd_update script.

r280884 (cperciva):
Fix pkg(8) command line in vm_extra_pre_umount().

r280928 (cperciva):
Add code for creating an EC2 AMI.

r281783:
When building VM disk images, vm_copy_base() uses tar(1) to copy
the userland from one md(4)-mounted filesystem to a clean filesystem
to prevent remnants of files that were added and removed from
resulting in an unclean filesystem. When newfs(8) creates the first
filesystem with journaled soft-updates enabled, the /.sujournal file
in the new filesystem cannot be overwritten by the /.sujournal in the
original filesystem.

To avoid this particular error case, do not enable journaled
soft-updates when creating the md(4)-backed filesystems, and instead
use tunefs(8) to enable journaled soft-updates after the new
filesystem is populated in vm_copy_base().

While here, fix a long standing bug where the build environment /boot
files were used by mkimg(1) when creating the VM disk images by using
the files in .OBJDIR.

r281809:
Simplify variable expansion in attempt to fix the vm-image build.

r281832:
Fix locating the /boot files.

Sponsored by: The FreeBSD Foundation


# 278985 19-Feb-2015 gjb

MFC r277458, r277536, r277606, r277609, r277836, r277839,
r278118, r278119, r278206, r278502:

r277458:
Move virtual machine / cloud provider targets and
options from release/Makefile to their own Makefile.

Add glue to allow enabling building cloud provider VM images
by default.

Add a 'vm-cloudware' target, used to drive all targets in
CLOUDTARGETS.

Add examples for WITH_CLOUDWARE to release.conf.sample.
Add WITH_CLOUDWARE evaluation to RELEASE_RMAKEFLAGS.

Rewrite to consolidate VM image build scripts into one.

Fix duplicated mkimg(1) call in vm_create_disk().

Add primitive (untested) PowerPC/PowerPC64 VM image support.

Note: As it is currently written, the /boot/pmbr and
/boot/{gptboot,boot1.hfs} use the build host and not the
target build. Fixing this is likely going to be a hack in
itself.

mount(8) and umount(8) devfs(5) as needed.

Change path for mk-vmimage.sh from ${TARGET}/ to scripts/ now that
it is consolidated into one file.

Fix paths for the base image and output disk image files.

Set the boot partition type to 'apple-boot' for powerpc.

In vm_install_base(), copy the host resolv.conf into the build
chroot before attempting to do anything that requires working DNS
(i.e., pkg bootstrap).

In vm_extra_pre_umount(), remove the resolv.conf before the disk
image is unmounted from the backing md(4).

Silence errors when umounting the chroot's /dev, since it probably
doesn't exist when we're running this.

Unmount filesystems before attempting to destroy the md which
holds them.

Unmount filesystem and destroy md before we read the vnode from
disk and package it into a disk image. Otherwise we end up
packaging an unclean filesystem.

Merge duplicative vm-CLOUDTYPE targets before additional duplication
gets added by the impending arrival of ec2 and gcloud.

Add NOSWAP option which can be set by a vmimage.conf file to specify
that no swap space should be created in the image. This will be used
by EC2 builds, since FreeBSD/EC2 allocates swap space on "ephemeral"
disks which are physically attached to the Xen host node.

In vm_extra_install_packages(), only bootstrap pkg(8) if
VM_EXTRA_PACKAGES is empty.

In vm_extra_pre_umount(), cleanup downloaded packages if pkg(8) was
bootstrapped earlier.

In vm_extra_install_base(), do not install waagent in the openstack
image, because it is not used. This appears to be a copy mistake.

Remove vm_extra_install_base() from the openstack.conf entirely,
since it does not need to be overridden.

Enable password-less sudo for openstack images.

Update the VM_EXTRA_PACKAGES list for the openstack images.

Remove vm_extra_install_base() for the Azure image, now that the
waagent exists in the ports tree.

Add sysutils/azure-agent to the VM_EXTRA_PACKAGES list.

In vm_extra_pre_umount(), remove the explicit pkg(8) install
list, as dependencies are resolved by sysutils/azure-agent.

Add a 'list-cloudware' target to print the list of supported CLOUDWARE
values and a description.

Add the AZURE_DESC and OPENSTACK_DESC descriptions.

Update release(7)

Add 'list-vmtargets' target, which produces a list of all supported
VM and cloud provider images.

Add VHD_DESC, VMDK_DESC, QCOW2_DESC, RAW_DESC image descriptions.

Update release(7) to document the list-vmtargets target.

Add initial support for the GCE (Google Compute Engine) cloud hosting
provider image.

Remove the console setting from rc.conf(5), which is not used there.
While here, set console to include vidconsole in the loader.conf(5).

Remove the pkg-clean(8) call from vm_extra_pre_umount() since the
function is often overridden.

Add vm_extra_pkg_rmcache() to call pkg-clean(8) to avoid duplicated
code.

Move resolv.conf(5) removal back to vm_extra_pre_umount() where it
belongs.

The GCE image needs resolv.conf(5) to exist (created as part of the
image setup), so it cannot be removed.

Comment the line that configures ttys(5) to 'off', which makes it
impossible to test that the image boots.

Add a note explaining why the line is commented, and not (yet) removed
entirely.

Move the 'install' bits that are specific to virtual machine images
from the Makefile to Makefile.vm.

Rename the 'install' target to 'release-install', and add a new
'vm-install' target.

Add a new 'install' target that invokes the new targets.

Add WITH_CLOUDWARE to the list of make(1) variables for the release
build.

Remove hw.vga.textmode=1 from the VM image loader.conf, which was
included during test builds and not intended to be included when
merging this project branch back to head.

Remove mk-azure.sh, which is no longer needed.

r277536:
Rename the 'release' target to 'real-release', and add two targets,
'vm-release' and 'cloudware-release', that are invoked if
WITH_VMIMAGES and WITH_CLOUDWARE are not empty.

This fixes an issue where 'make release' would not build the cloud
provider targets because CLOUDWARE was not yet set.

Move the WITH_VMIMAGES and WITH_CLOUDWARE targets to Makefile.vm.

Note: There is no 'cloudware-install' target yet, since some of the
disk image names may need to be specific to the provider, so this is
probably best handled by the build scripts.

r277606:
Provide a recipe of "true" for building the "release" target once
its prerequisites are satisfied, in order to avoid having an implicit
rule triggered by the presence of release.sh.

r277609:
When iterating through VMFORMATS, the VMBASE file is not removed
or truncated to a zero-size file, which if used to create more
than one disk image format, can result in accidental pollution of
the target formatted disk image.

Instead of using a single VMBASE image (vm.img, by default), use
a single base file for each format, named as VMFORMAT.img, which
produces VMBASE.VMFORMAT as the final formatted image.

r277836:
Rename the 'system' target to 'disc1', which is specific to the
disc1.iso installer image.

Replace 'system' with 'release' in CLEANFILES, and add 'disc1'
to CLEANDIRS.

Ensure the 'dvd' target depends on 'packagesystem'.

Fix 'mini-memstick.img' prerequisite, which should be the 'bootonly'
target, not 'disc1' (previously 'system').

Use .TARGET as the target installation directory for the disc1.iso
and bootonly.iso images, which now expand to 'disc1' and 'bootonly'
respectively, mimicking the behavior of the 'dvd' target.

Remove '@true' from the 'release' target, and instead use
'touch ${.TARGET}' to prevent multiple iterations of
'make release' from clobbering previously-built installer
medium.

r277839:
Update release(7) to reflect renaming the 'system' target to 'disc1'.

r278118:
Move service_enable="YES" rc.conf(5) additions to VM_RC_LIST and
deduplicate.

Evaluate if firstboot_freebsd_update should be enabled based on
UNAME_r, because it is not supported for the -CURRENT or -STABLE
branches.

r278119:
Use ifconfig_DEFAULT="" instead of hard-coding vtnet(4)

r278206:
Bump copyright after r277458.

r278502:
In scripts/mk-vmimage.sh, prevent incorrect usage() by defaulting
VMCONFIG to /dev/null, and additionally ensuring VMCONFIG is not
a character device before it is sourced.

While here, be sure to exit if usage() is called.

This should effectively be no-op, but the usage() output was
discovered while investigating a larger issue.

* Several changes local to stable/10 were needed in order to handle
UEFI images that are specific to this branch.

Tested with: stable/10@r278906
Sponsored by: The FreeBSD Foundation


# 282111 27-Apr-2015 gjb

MFC r280299, r280840, r280846, r280879, r280881, r280884, r280928,
r281783, r281809, r281832:

r280299 (cperciva):
When creating VM images, copy the contents of the created filesystem
into a new filesystem before packaging it into a disk image. This
prevents "remnants" of deleted files from showing up in the VM images,
and reduces their compressed size (by about 10% for the cloudware
images) as a result.

r280840 (cperciva):
Clean up filesystem unmounting in vmimage builds:
- Remove vm_umount_base function which is currently unused.
- Add umount_loop function which loops attempting to unmount one
filesystem.
- Replace calls to umount with calls to umount_loop.
- Don't attempt to unmount ${DESTDIR}/dev if it isn't mounted.

The looping is necessary because sometimes umount fails due to
filesystems being busy. The most common cause of such busyness is
periodic(8) jobs running `find / ...`.

r280846 (cperciva):
Improve check for whether ${DESTDIR}/dev is mounted.

r280879 (cperciva):
Add bits for building EC2 disk images.

r280881 (cperciva):
Partially revert r278118 now that the required logic for deciding
whether freebsd-update can be useful has moved into the
firstboot_freebsd_update script.

r280884 (cperciva):
Fix pkg(8) command line in vm_extra_pre_umount().

r280928 (cperciva):
Add code for creating an EC2 AMI.

r281783:
When building VM disk images, vm_copy_base() uses tar(1) to copy
the userland from one md(4)-mounted filesystem to a clean filesystem
to prevent remnants of files that were added and removed from
resulting in an unclean filesystem. When newfs(8) creates the first
filesystem with journaled soft-updates enabled, the /.sujournal file
in the new filesystem cannot be overwritten by the /.sujournal in the
original filesystem.

To avoid this particular error case, do not enable journaled
soft-updates when creating the md(4)-backed filesystems, and instead
use tunefs(8) to enable journaled soft-updates after the new
filesystem is populated in vm_copy_base().

While here, fix a long standing bug where the build environment /boot
files were used by mkimg(1) when creating the VM disk images by using
the files in .OBJDIR.

r281809:
Simplify variable expansion in attempt to fix the vm-image build.

r281832:
Fix locating the /boot files.

Sponsored by: The FreeBSD Foundation


# 278985 19-Feb-2015 gjb

MFC r277458, r277536, r277606, r277609, r277836, r277839,
r278118, r278119, r278206, r278502:

r277458:
Move virtual machine / cloud provider targets and
options from release/Makefile to their own Makefile.

Add glue to allow enabling building cloud provider VM images
by default.

Add a 'vm-cloudware' target, used to drive all targets in
CLOUDTARGETS.

Add examples for WITH_CLOUDWARE to release.conf.sample.
Add WITH_CLOUDWARE evaluation to RELEASE_RMAKEFLAGS.

Rewrite to consolidate VM image build scripts into one.

Fix duplicated mkimg(1) call in vm_create_disk().

Add primitive (untested) PowerPC/PowerPC64 VM image support.

Note: As it is currently written, the /boot/pmbr and
/boot/{gptboot,boot1.hfs} use the build host and not the
target build. Fixing this is likely going to be a hack in
itself.

mount(8) and umount(8) devfs(5) as needed.

Change path for mk-vmimage.sh from ${TARGET}/ to scripts/ now that
it is consolidated into one file.

Fix paths for the base image and output disk image files.

Set the boot partition type to 'apple-boot' for powerpc.

In vm_install_base(), copy the host resolv.conf into the build
chroot before attempting to do anything that requires working DNS
(i.e., pkg bootstrap).

In vm_extra_pre_umount(), remove the resolv.conf before the disk
image is unmounted from the backing md(4).

Silence errors when umounting the chroot's /dev, since it probably
doesn't exist when we're running this.

Unmount filesystems before attempting to destroy the md which
holds them.

Unmount filesystem and destroy md before we read the vnode from
disk and package it into a disk image. Otherwise we end up
packaging an unclean filesystem.

Merge duplicative vm-CLOUDTYPE targets before additional duplication
gets added by the impending arrival of ec2 and gcloud.

Add NOSWAP option which can be set by a vmimage.conf file to specify
that no swap space should be created in the image. This will be used
by EC2 builds, since FreeBSD/EC2 allocates swap space on "ephemeral"
disks which are physically attached to the Xen host node.

In vm_extra_install_packages(), only bootstrap pkg(8) if
VM_EXTRA_PACKAGES is empty.

In vm_extra_pre_umount(), cleanup downloaded packages if pkg(8) was
bootstrapped earlier.

In vm_extra_install_base(), do not install waagent in the openstack
image, because it is not used. This appears to be a copy mistake.

Remove vm_extra_install_base() from the openstack.conf entirely,
since it does not need to be overridden.

Enable password-less sudo for openstack images.

Update the VM_EXTRA_PACKAGES list for the openstack images.

Remove vm_extra_install_base() for the Azure image, now that the
waagent exists in the ports tree.

Add sysutils/azure-agent to the VM_EXTRA_PACKAGES list.

In vm_extra_pre_umount(), remove the explicit pkg(8) install
list, as dependencies are resolved by sysutils/azure-agent.

Add a 'list-cloudware' target to print the list of supported CLOUDWARE
values and a description.

Add the AZURE_DESC and OPENSTACK_DESC descriptions.

Update release(7)

Add 'list-vmtargets' target, which produces a list of all supported
VM and cloud provider images.

Add VHD_DESC, VMDK_DESC, QCOW2_DESC, RAW_DESC image descriptions.

Update release(7) to document the list-vmtargets target.

Add initial support for the GCE (Google Compute Engine) cloud hosting
provider image.

Remove the console setting from rc.conf(5), which is not used there.
While here, set console to include vidconsole in the loader.conf(5).

Remove the pkg-clean(8) call from vm_extra_pre_umount() since the
function is often overridden.

Add vm_extra_pkg_rmcache() to call pkg-clean(8) to avoid duplicated
code.

Move resolv.conf(5) removal back to vm_extra_pre_umount() where it
belongs.

The GCE image needs resolv.conf(5) to exist (created as part of the
image setup), so it cannot be removed.

Comment the line that configures ttys(5) to 'off', which makes it
impossible to test that the image boots.

Add a note explaining why the line is commented, and not (yet) removed
entirely.

Move the 'install' bits that are specific to virtual machine images
from the Makefile to Makefile.vm.

Rename the 'install' target to 'release-install', and add a new
'vm-install' target.

Add a new 'install' target that invokes the new targets.

Add WITH_CLOUDWARE to the list of make(1) variables for the release
build.

Remove hw.vga.textmode=1 from the VM image loader.conf, which was
included during test builds and not intended to be included when
merging this project branch back to head.

Remove mk-azure.sh, which is no longer needed.

r277536:
Rename the 'release' target to 'real-release', and add two targets,
'vm-release' and 'cloudware-release', that are invoked if
WITH_VMIMAGES and WITH_CLOUDWARE are not empty.

This fixes an issue where 'make release' would not build the cloud
provider targets because CLOUDWARE was not yet set.

Move the WITH_VMIMAGES and WITH_CLOUDWARE targets to Makefile.vm.

Note: There is no 'cloudware-install' target yet, since some of the
disk image names may need to be specific to the provider, so this is
probably best handled by the build scripts.

r277606:
Provide a recipe of "true" for building the "release" target once
its prerequisites are satisfied, in order to avoid having an implicit
rule triggered by the presence of release.sh.

r277609:
When iterating through VMFORMATS, the VMBASE file is not removed
or truncated to a zero-size file, which if used to create more
than one disk image format, can result in accidental pollution of
the target formatted disk image.

Instead of using a single VMBASE image (vm.img, by default), use
a single base file for each format, named as VMFORMAT.img, which
produces VMBASE.VMFORMAT as the final formatted image.

r277836:
Rename the 'system' target to 'disc1', which is specific to the
disc1.iso installer image.

Replace 'system' with 'release' in CLEANFILES, and add 'disc1'
to CLEANDIRS.

Ensure the 'dvd' target depends on 'packagesystem'.

Fix 'mini-memstick.img' prerequisite, which should be the 'bootonly'
target, not 'disc1' (previously 'system').

Use .TARGET as the target installation directory for the disc1.iso
and bootonly.iso images, which now expand to 'disc1' and 'bootonly'
respectively, mimicking the behavior of the 'dvd' target.

Remove '@true' from the 'release' target, and instead use
'touch ${.TARGET}' to prevent multiple iterations of
'make release' from clobbering previously-built installer
medium.

r277839:
Update release(7) to reflect renaming the 'system' target to 'disc1'.

r278118:
Move service_enable="YES" rc.conf(5) additions to VM_RC_LIST and
deduplicate.

Evaluate if firstboot_freebsd_update should be enabled based on
UNAME_r, because it is not supported for the -CURRENT or -STABLE
branches.

r278119:
Use ifconfig_DEFAULT="" instead of hard-coding vtnet(4)

r278206:
Bump copyright after r277458.

r278502:
In scripts/mk-vmimage.sh, prevent incorrect usage() by defaulting
VMCONFIG to /dev/null, and additionally ensuring VMCONFIG is not
a character device before it is sourced.

While here, be sure to exit if usage() is called.

This should effectively be no-op, but the usage() output was
discovered while investigating a larger issue.

* Several changes local to stable/10 were needed in order to handle
UEFI images that are specific to this branch.

Tested with: stable/10@r278906
Sponsored by: The FreeBSD Foundation