OpenBSD Upgrade Guide: 5.1 to 5.2

[FAQ Index] | [5.0 -> 5.1] | [5.2 -> 5.3]

Note: Upgrades are only supported from one release to the release immediately following it. Do not skip releases.

It is highly recommended that you read through and fully understand this process before attempting it. If you are doing it on a critical or physically remote machine, it is recommended that you test this process on an identical, local system to verify its success before attempting on a critical or remote computer.

Upgrading is a convenient way to bring your OpenBSD system up to the most recent version. However, the results are not intended to precisely match the results of a wipe-and-reload installation. Old library files in particular are not removed in the upgrade process, as they may be required by older applications that may or may not be upgraded at this time. If you REALLY wish to get rid of all these old files, you are probably better off reinstalling from scratch.

Table of Contents:

• Before upgrading
  • raid(4) and RAIDframe are no more
  • Radeon X driver changes
  • OpenSMTPd changes
  • Packet Filter changes
  • tftpd starts from rc.d now
  • Introducing nginx
• The upgrade process
• Final steps
  • Merging locally changed files via sysmerge(8)
  • Merging locally changed files via patch file
  • Files to delete
  • Checking the kernel
  • Upgrading packages

Before upgrading: things to think about and be aware of

• raid(4) and RAIDframe are no more: If you are using RAIDframe for a system currently, you will need to make plans to rebuild it using softraid(4) before you can upgrade it past 5.1.

• Radeon X driver changes: The radeon(4) driver has been updated to version 6.14.3, but it's not selected by auto-configuration code. The radeonold(4) driver is providing a frozen version of the last working driver, as there were some issues with the new driver. Users with cards needing the new driver should create an xorg.conf(5) file containing just

  Section "Device"
      Identifier "RadeonCard"
      Driver "radeon"
  EndSection
  

  Or merge this section in their existing /etc/X11/xorg.conf file.

  The radeonhd driver is now deprecated. Users of this driver should update their /etc/X11/xorg.conf file by replacing

        Driver "radeonhd"
  

  with

        Driver "radeon"
  

• OpenSMTPd changes:
  • smtpd.conf syntax changes:
    • relay via rules should now be expressed with a relay URL:

      	accept [...] relay via "mx1.example.org" smtps port 465

      becomes

      	accept [...] relay via "smtps://mx1.example.org"

    • makemap(8) virtual domains configuration:

      	accept for virtual vmap [...]

      becomes

      	accept for virtual map vmap [...]

    The new syntax is documented in smtpd.conf(5)

  • smtpd queue layout changed: A change to the queue layout was introduced, you will want to empty your queue before updating.

• pf.conf syntax changes:
  • prio to assign queueing priorities has changed to set prio.
  • set-tos to enforce a TOS has changed to set tos
  The new syntax is documented in pf.conf(5)

• tftpd starts from rc.d now: keeping with newer practices, tftpd(8) is no longer run from inetd(8) but is now started using an rc.d script. You will want to remove the tftpd lines from /etc/inetd and replace them with a tftpd_flags="[chroot directory]" line in /etc/rc.conf.local.

• Introducing nginx(8): nginx (see also nginx(8)) has been added to OpenBSD, ultimately to replace the Apache 1.3 derived httpd(8). For new installations, you are encouraged to utilize nginx rather than httpd, existing installations are encouraged to start planning replacing the stock httpd with nginx.

The upgrade process

Upgrading by install kernel

Afterwards, complete the upgrade by following the final steps as detailed below.

One easy way to boot from the install kernel is to place the 5.2 version of bsd.rd in the root of your boot drive, then instruct the boot loader to boot using this new bsd.rd file. On amd64 and i386, you do this by entering "boot bsd.rd" at the initial boot> prompt.

Upgrading without install kernel

Sometimes, one needs to do an upgrade of a machine when one can't easily use the normal upgrade process. The most common case is when the machine is in a remote location and you don't have easy access to the system console. One can usually do this by carefully following this process:

• Place install files in a "good" location. Make sure you have sufficient space!

• Become root with ksh(1): While using sudo(8) before each command is generally a good practice, the sudo(8) command will be broken by the last steps, so you should be root before starting this process. Also, the use of the OpenBSD ksh(1) shell is assumed.

• Stop any appropriate applications: During this process, all the userland applications will be replaced but may not be runnable, and strange things may happen as a result. If this is a concern to you, shut down any applications that may be impacted. There may be other applications which you wish to keep from running immediately after the upgrade, stop and disable them as well.

• Disable package daemons and local shutdown commands: The last steps in the upgrade process may result in various commands, especially those which are dynamically linked, being broken. In particular, this may prevent a normal shutdown of daemons listed in pkg_scripts, or additional commands in /etc/rc.shutdown, which may cause the machine to hang at shutdown. Before you proceed with the upgrade, edit /etc/rc.conf.local and comment-out any pkg_scripts lines. Also inspect /etc/rc.shutdown and comment-out any local shutdown commands. These can be reinstated post upgrade.

• Check the kernel: Although most people can skip this step, if you had a modified kernel in 5.1, it is likely you will need to modify the stock kernel of 5.2. Especially when you are performing the upgrade process remotely, now is the time to make sure the new kernel will work upon rebooting the machine. If any changes must be made to the kernel, the safest thing to do is to make those changes on a local 5.2 system. This can be as simple as modifying a specific device using config(8), or it can involve a recompilation if the option you need is not included in the GENERIC kernel. Please consult FAQ 5 - Building the system from source before deciding to recompile your kernel.

• Install new kernel(s):
  • If using a single processor kernel:

    export RELEASEPATH=/usr/rel   # where you put the files
    cd ${RELEASEPATH}
    rm /obsd ; ln /bsd /obsd && cp bsd /nbsd && mv /nbsd /bsd
    cp bsd.rd bsd.mp /
    

    (note: you will get a harmless error message if your platform doesn't have a bsd.mp):

  • If you are using the multiprocessor kernel:

    export RELEASEPATH=/usr/rel   # where you put the files
    cd ${RELEASEPATH}
    rm /obsd ; ln /bsd /obsd && cp bsd.mp /nbsd && mv /nbsd /bsd
    cp bsd.rd /
    cp bsd /bsd.sp
    

  Note the extra steps for copying over the primary kernel: those are done to ensure that there is always a valid copy of the kernel on the disk that the system can boot from should there be a really badly timed power outage or system crash.

• Save a copy of reboot(8), install new userland applications. You are still running the old kernel, it is possible the new reboot command will not run on the old kernel, so we will start by saving a copy of the old reboot command. Do NOT install etc52.tgz and xetc52.tgz now, because that will overwrite your current configuration files! Note that we are installing base52.tgz LAST, because it will include a new tar(1) utility, which may or may not run on the old kernel. We reboot immediately, as the system is probably barely runnable after the unpacking of all the new files.

  cp /sbin/reboot /sbin/oreboot
  tar -C / -xzphf xserv52.tgz
  tar -C / -xzphf xfont52.tgz
  tar -C / -xzphf xshare52.tgz
  tar -C / -xzphf xbase52.tgz
  tar -C / -xzphf game52.tgz
  tar -C / -xzphf comp52.tgz
  tar -C / -xzphf man52.tgz
  tar -C / -xzphf base52.tgz # Install last!
  /sbin/oreboot
  

  Not all file sets will need to be installed for all applications, however if you installed a file set originally, you should certainly upgrade it with the new file set now.

  Again, the files in /etc are handled separately below, so etc52.tgz and xetc52.tgz are NOT unpacked here.

• After reboot completes, upgrade /dev. The new MAKEDEV file was copied to /dev by the installation of base52.tgz, so you simply need to do the following:

  cd /dev
  ./MAKEDEV all
  

Final steps

1a. Merging locally changed files via sysmerge(8)

Who should use sysmerge(8):
People running highly modified systems or systems that didn't start out at the previous release (for example, a snapshot part way between releases), who are upgrading to a snapshot or who have not carefully upgraded their system in the past will find sysmerge vastly superior to using the patches, as it works with what is actually on your system, instead of what we expected was on your system. It will also give you much greater control over your upgrade process, and will involve you in it more closely.

Who may wish to NOT use sysmerge(8):
With recent improvements in sysmerge, we hope that relatively few people have reason not to use sysmerge(8)! However, people with a large quantity of similar machines to upgrade may find the "patch file" process faster, and perhaps the basis of a customized upgrade script.

Using sysmerge(8) for the first time:
If you have a system that's been upgraded in the past via the patch file process you will probably find the FIRST time you upgrade by sysmerge, you have a LOT of manual file changes to make. This is because the patch file process only attempted to achieve functional compatibility on the upgraded system, and did not respect the version control information sysmerge(8) uses to identify "unchanged" files. Rest assured, later runs of sysmerge will be far less painful, and often completely effortless.

The sysmerge(8) utility will compare the files that are actually on your system with those that would be installed in a fresh install, and assist you in merging the changes into your system. Note that unlike the patch file, there are no assumptions made about what is actually on your system, so you can use sysmerge(8) to move between more arbitrary points in the development process, such as from an earlier 5.1-current to 5.2-release or from one -current to a later one. Sysmerge(8) compares the current files on your system with the files that would have been installed with a new install, and what would have been there from the last run of sysmerge. Usually, it can figure out what to do to update your files, but if it has difficulty, it will give you the option of keeping the old file, installing the new file, or assisting you in the manual merging of the old and new files, using sdiff.

Please read the sysmerge(8) manual page before using it on your system. You are also advised to read the diff(1), sdiff(1) and even review more(1) manual pages before continuing.

Assuming the etc52.tgz and xetc52.tgz files exists in your ${RELEASEPATH}, run it with:

sysmerge -s ${RELEASEPATH}/etc52.tgz -x ${RELEASEPATH}/xetc52.tgz

For the files sysmerge(8) can't resolve on its own, it will show you a unified diff(1), run through your favorite $PAGER (i.e., more(1)) and ask you if you wish to:

  Use 'd' to delete the temporary ./var/www/htdocs/index.html
  Use 'i' to install the temporary ./var/www/htdocs/index.html
  Use 'm' to merge the temporary and installed versions
  Use 'v' to view the diff results again

  Default is to leave the temporary file to deal with by hand

If you wish to retain your existing file, delete the temporary file, if you wish to replace your existing file with the new version, install the temporary file. If you wish to merge the two together, choosing 'm' will put you into sdiff(1), where you can manually merge the file. The default is to come back and deal with the file later, manually.

Sysmerge(8) saves all your replaced files into a temporary directory, similar to /var/tmp/sysmerge.24959/backups, so if you accidentally clobber something that was probably not such a good idea, you have a chance to recover it. Note that daily(8) cleans old files from this directory, but it will survive a reboot.

1b. Merging locally changed files via a patch file

This process makes a lot of assumptions about what files you have and have not modified, and that you are upgrading from 5.1-release to 5.2-release. Before following this, make sure your system matches the assumptions, and alter the process accordingly if needed -- or just use the above sysmerge process.

No new users and groups need to be created for 5.2.

You will want to extract the etc52.tgz files to a temporary location:

export RELEASEPATH=/usr/rel
tar -C /tmp -xzphf ${RELEASEPATH}/etc52.tgz

Files that can probably be copied from etc52.tgz "as is":

etc/daily
etc/moduli
etc/rc
etc/rc.conf
etc/mail/localhost.cf
etc/mail/sendmail.cf
etc/mail/submit.cf
etc/rc.d/nfsd
etc/rc.d/nginx
etc/rc.d/sendmail
etc/rc.d/tftpd
etc/rc.d/rc.subr
var/www/conf/bgplg.head

Note that it IS possible to locally modify these files; if this has been done, do NOT simply copy over those files, and consider using the sysmerge(8) process instead. Pay special attention to mail/* if you are using something other than the default Sendmail(8) configuration.

Here are copy/paste lines for copying these files, assuming you unpacked etc52.tgz in the above recommended place:

cd /tmp/etc
cp daily moduli rc rc.conf /etc
mkdir /etc/nginx
cp nginx/* /etc/nginx/
cd /tmp/etc/rc.d
cp nfsd nginx sendmail tftpd rc.subr /etc/rc.d
cp /tmp/var/www/conf/bgplg.head /var/www/conf/
cp /tmp/etc/mail/*.cf /etc/mail  # Use with care!

These files likely have local changes, but should be updated for 5.2. IF you have not altered these files, you can copy over the new version, otherwise the changes should be merged with your files:

etc/inetd.conf
etc/login.conf
etc/services
etc/sysctl.conf
etc/mail/smtpd.conf
etc/mail/spamd.conf
etc/ssh/sshd_config

The changes to these files are in this patch file. Please test this process before relying on it for a machine you can not easily get to. You can attempt to use this by executing the following as root:

cd /
ftp /faq/upgrade52.patch
patch -C -p0 < upgrade52.patch

This will test the patch to see how well it will apply to YOUR system; to actually apply it, leave off the "-C" option. Note that it is likely that if you have customized files or not kept them closely updated, or are upgrading from a snapshot of 5.1, they may not accept the patch cleanly. Make sure all file changes are attempted; patch(1) may quit prematurely if it gets too confused in one file, which may happen if your machine was originally installed from a snapshot or otherwise has some interim changes. The last file to be changed here should be sysctl.conf. Deleting the file sections that fail from the patch file may permit the rest to be applied. You will need to manually apply the changes that are skipped.

The following files have had changes which should be looked at, but it is unlikely they should be directly copied or merged (i.e., if you are using nsd.conf, look at the suggested change of strategy, and decide if it is appropriate for your use).

etc/bgpd.conf
etc/iked.conf

Finally, use newaliases(8) to update the aliases database, mtree(8) create any new directories:

newaliases
mtree -qdef /etc/mtree/4.4BSD.dist -p / -u

All upgraders, whether merging via sysmerge(8) or patch file should continue the upgrade process with these steps:

2. Files to delete

rm /usr/bin/lint
rm /usr/libexec/lint[12]
rm -r /usr/libdata/lint
rm /usr/share/man/man1/lint.1
rm /etc/rc.d/btd
rm /usr/sbin/pkg
rm /sbin/raidctl
rm /usr/share/man/man4/raid.4
rm /usr/share/man/man8/raidctl.8
rm /usr/libexec/tftpd
rm -r /usr/lib/gcc-lib/*-unknown-openbsd5.1

3. Checking the kernel

If you followed the instructions for the upgrade process without install kernel, you have already completed this step. However, if you used the install kernel, and if you had a modified kernel in 5.1, it is likely you will need to modify the stock kernel of 5.2. This can be as simple as modifying a specific device using config(8), or it can involve a recompilation if the option you need is not included in the GENERIC kernel. Please consult FAQ 5 - Building the system from source before considering to recompile your kernel.

4. Upgrading packages

The following packages are known to have significant upgrade issues that will impact a large number of users. The fact that a package is not on this list doesn't mean it will have a trivial upgrade. You must do some homework on the applications YOU use.

• Subversion gnome-keyring is now a subpackage: gnome-keyring support in Subversion was previously a FLAVOR of the port, as it required the main program to link with libpthread causing some side-effects with the previous uthread library (notably, strange behavior with "svn diff | more" due to how I/O on file descriptors was handled).

  As this is no longer an issue with rthreads, the FLAVOR has been removed. To continue using gnome-keyring with Subversion, after updating packages you will need to "pkg_add gnome-keyring-subversion".

• xpdf-utils replaced with poppler-utils: The PDF-related tools from xpdf-utils (pdffonts, pdfimages, pdfinfo, pdftotext) have been replaced with equivalents in poppler-utils. Note that these no longer read xpdfrc files and are now only configured using command-line options.

• ser removed: The ser port has been removed. Users of ser are advised to migrate to kamailio for now.

• scrotwm renamed to spectrwm: The package update will be handled automatically but you will need to rename your configuration files: mv /etc/scrotwm.conf /etc/spectrwm.conf for the system configuration file, and any .scrotwm.conf files in user home directories will need to be renamed to .spectrwm.conf. You will also need to adapt any entries in .xsession, etc., to start the window manager.

• xxxterm renamed to xombrero: The package update will be handled automatically but you will need to rename your configuration files and directories. There is no system configuration file, but any .xxxterm.conf files in user home directories will need to be renamed to .xombrero.conf.

• dovecot: Dovecot was updated to 2.1 which may require minor changes to configuration. See the upgrade notes for details.

The package tools support in-place updating using pkg_add -u. For instance, to update all your packages, make sure PKG_PATH is pointing to the 5.2 packages directory on your CD or nearest FTP mirror, and use something like

pkg_add -u

[FAQ Index] | [5.0 -> 5.1] | [5.2 -> 5.3]