UnRAID OS version 6 Upgrade Notes

From unRAID
Revision as of 20:53, 3 February 2017 by Jonp (talk | contribs) (Created page with "= Prerequisites = Before upgrading to version 6.3, please ensure you have made a complete back up of your USB flash device. You can do this by copying the entire contents of...")
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search

Prerequisites

Before upgrading to version 6.3, please ensure you have made a complete back up of your USB flash device. You can do this by copying the entire contents of the "Flash" share to a separate computer.

From version 5.x or earlier

Please see this forum post for information on upgrading.

From version 6.0 or 6.1

Due to changes to both VM manager and Docker, there are special steps you must perform as part of the upgrade process. Note, these steps only apply if you are making use of Docker or VMs in your existing setup.

Docker Containers

There is a one-time update procedure that each container will need to go through in order to point it towards that new API going forward, even if the container itself truly isn't in need of an update (see here for more information from Docker on this). This process will happen automatically the first time your containers are started after upgrading.

If you run into any issues with your containers after this procedure completes (such as the "layers from manifest don't match image configuration" error), you will need to rebuild your docker image file. To do this:

  1. Stop Docker from the Settings > Docker page
  2. Click the checkbox and then click the button to delete the image
  3. Start Docker again and the image will be recreated
  4. Go to the Docker tab and click Add Container
  5. From the Template drop down, select one of your previous templates (prefixed with "my-") and then click Apply
  6. Repeat the previous step for each of your containers
  7. You will not need to reconfigure your apps after this is complete

Virtual Machines

NOTE: before upgrading, please be sure to backup any VMs you have AND set disable them from auto-starting. This will give you the opportunity to perform the post-upgrade procedures before starting them.

After upgrading, any edits you make to your VMs will not be present if you roll-back to 6.1.x at a later point in time. When you roll-back, your VM configurations (XML) will be in the state they were prior to the upgrade. This also means that new VMs you create in 6.2 will NOT show up under VM manager if you roll back to 6.1.x. This doesn't affect virtual disk image, only the VM configurations themselves.

Pre-upgrade instructions

A change that was made in version 6.2 eliminated the customization of the bridge name used for virtual machines. Users that have a custom bridge name set will need to revert it back to the default of 'br0' before upgrading. To see if you have a customized network bridge, open the Settings -> Network Settings page of the web interface. If the bridge name is anything other than 'br0', change it back to 'br0' and click apply.

If you found you have a custom-name for your network bridge and you also have VMs on the system, it is very likely that these VMs are also set to use the custom-named bridge and therefore they must be updated as well. To do this, you will need to perform the following steps after you have restored the default network bridge name:

  1. Shutdown all VMs running on the system.
  2. Edit each VM and turn on Advanced View mode.
  3. Locate the network section and from the dropdown, select br0 and then click apply.
  4. Once all VMs are set to use the 'br0' bridge, go to the Settings -> VM Manager page, turn on Advanced View, and set the default network bridge on this page to also be 'br0' and click apply.

Your VMs should now be ready for use under 6.2.

Post-upgrade instructions

To ensure that your VMs take advantage of all these changes and continue to function properly, the following one-time actions should be performed before starting your VMs for the first time but after you upgrade.

NOTE: Any custom XML edits you have made will be lost after performing this procedure.

  1. For each VM, go to the VMs tab, click the VM's icon, and select the Edit option
  2. Turn on "Advanced View" in the top right of the Edit VM page
  3. If you are using VNC for the primary graphics card, adjust the VNC Video Driver field to QXL
  4. Click Apply

OVMF VM Booting Issues

OVMF-based virtual machines that were created under version 6.1 or earlier will most likely require a one-time process to boot up properly on the new release. If you are presented with an EFI shell instead of your OS booting appropriately, type the following commands in order to boot your VM:

  • fs0:
  • cd efi/boot
  • bootx64.efi

If this doesn't work, try changing the first command from fs0: to fs1:. If that doesn't work, please post in the forums for further assistance. This procedure should only need to be performed the first time you boot OVMF VMs that were previously created using unRAID 6.1 or earlier.

From version 6.2

No special steps are necessary to upgrade from version 6.2 to 6.3.

Installing the update

  1. Boot your server up and login to the web interface
  2. Click the Plugins tab
  3. Click the Install Plugin tab
  4. Copy and paste the below link into the field and click install
  5. Once the upgrade plugin has been installed, reboot your server

LINK TO PLUGIN