Preparing to Migrate TrueNAS CORE to SCALE

TrueNAS Enterprise

High Availability (HA) systems cannot migrate directly from CORE to SCALE.

Enterprise customers with HA systems should contact iXsystems Support before attempting any migration.

iXsystems Support

Customers who purchase iXsystems hardware or that want additional support must have a support contract to use iXsystems Support Services. The TrueNAS Community forums provides free support for users without an iXsystems Support contract.

Contact MethodContact Options
Webhttps://support.ixsystems.com
Emailsupport@ixsystems.com
TelephoneMonday - Friday, 6:00AM to 6:00PM Pacific Standard Time:

US-only toll-free: 1-855-473-7449 option 2
Local and international: 1-408-943-4100 option 2
TelephoneAfter Hours (24x7 Gold Level Support only):

US-only toll-free: 1-855-499-5131
International: 1-408-878-3140 (international calling
rates apply)

Migrating TrueNAS from CORE to SCALE is a one-way operation. Attempting to activate or roll back to a CORE boot environment can break the system.

Upgrade your CORE system to the latest publicly-available 13.0-Ux release before attempting to migrate from CORE to SCALE.

SCALE Bluefin deprecates and Cobia removes the built-in DDNS, OpenVPN server and client, rsync, S3, and TFTP service. The WebDAV service and share feature are also deprecated in Bluefin and removed in Cobia. New applications are available in Bluefin to serve as replacements for the functions these services provided.

To migrate from CORE to SCALE Cobia, first upgrade to and migrate from the latest CORE release to the latest release of SCALE 22.12 (Bluefin). While running SCALE Bluefin, take the necessary steps to transition from these deprecated services to the applications that replace them, then upgrade to SCALE 23.10 (Cobia). The replacement applications are available in SCALE 22.12 and 23.10.

What can or cannot migrate?

Although TrueNAS attempts to keep most of your CORE configuration data when upgrading to SCALE, some CORE-specific items do not transfer. These are the items that don’t migrate from CORE:

  • FreeBSD GELI encryption. If you have GELI-encrypted pools on your system that you plan to import into SCALE, you must migrate your data from the GELI pool to a non-GELI encrypted pool before migrating to SCALE.
  • Malformed certificates. TrueNAS SCALE validates the system certificates when a CORE system migrates to SCALE. When a malformed certificate is found, SCALE generates a new self-signed certificate to ensure system accessibility.
  • CORE plugins and jails. Save the configuration information for your plugin and back up any stored data. After completing the SCALE install, add the equivalent SCALE application using the Apps option. If your CORE plugin is not listed as an available application in SCALE, use the Launch Docker Image option to add it as an application and import data from the backup into a new SCALE dataset for the application.
  • NIS data.
  • System tunables.
  • ZFS boot environments.
  • AFP shares also do not transfer, but migrate into an SMB share with AFP compatibility enabled.
  • CORE netcli utility. A new CLI utility is used for the Console Setup Menu and other commands issued in a CLI. By default, any TrueNAS user account with netcli as the chosen Shell updates to use the nologin option instead. See the Users Screens reference article for descriptions of all Shell options.
  • SAS multipath is not supported in TrueNAS SCALE.
  • TrueNAS CORE account names beginning with a number are not supported in TrueNAS SCALE. Usernames in SCALE must begin with a letter or an underscore. Before attempting a CORE to SCALE migration, review the local user accounts and rename or replace any accounts that begin with a numeric character (0-9).

VM storage and its basic configuration transfer over during a migration, but you need to double-check the VM configuration and the network interface settings specifically before starting the VM.

Init/shutdown scripts transfer, but can break. Review them before use.

Preparing for Migration

Before you attempt to migrate your CORE system to the latest release of SCALE Bluefin (22.12.3.4):

  1. Upgrade your CORE system to the most recent publicly-available CORE version. TrueNAS systems on 12.0x or earlier should upgrade to the latest CORE 13.0 release (e.g 13.0-U4 or newer) prior to migrating to SCALE. CORE systems at the latest 13.0 release can use the iso upgrade method to migrate to SCALE.

  2. Verify the root user is not locked. Go to Accounts > Users, use Edit for the root user to view current settings and confirm Lock User is not selected.

  3. After updating to the latest publicly-available release of CORE, download your system configuration file and a debug file. Keep these files in a safe place in case you need to revert back to CORE with a clean install of the CORE iso file.

  4. Back up your stored data files. If you need to do a clean install with the SCALE iso file, you can import your data pools into SCALE.

  5. Write down your network configuration information to use if you do a clean install of SCALE from an iso file.

    TrueNAS uses DHCP to assign the IP address to the primary system network interface. DHCP only provisions one IP address. You can use this DHCP-provided address or you can assign a static IP address. You must assign each network interface cards (NICs) installed in your system and wired to your network an IP address if you want to communicate over your network using the interfaces. To configure your TrueNAS server to work with your network, you need:

    • DHCP broadcast messages enabled on the network or the subnet(s) in your network where TrueNAS is installed
    • DNS name sever IP addresses in your network (SCALE can accommodate up to three name server IP addresses)
    • IP address for the Network Time Protocol (NTP) server you use to synchronize time across your servers and network
    • Main domain name or the domain name for the portion of your network where the TrueNAS SCALE server is deployed
    • Host name you want to use if not using the default-assigned host name in SCALE (truenas is the default host name in SCALE)
    • IP address for each additional network interface added in your system and connected to your network (static IP not provided by DHCP)
    • IP address assigned to the controller. Either allow DHCP to assign the IP address or assign a static IP.

  6. Back up any critical data!

  7. Record the settings for any service deprecated in SCALE Bluefin to use when you install the application that replaces the functionality of the service.

Download the SCALE ISO file or the SCALE upgrade file and save it to your computer or a USB drive (see the Physical Hardware tab in Installing SCALE) to use if you upgrade from the physical system.

Migrating from Deprecated Services

Migrating from deprecated services requires disabling active services and could result in service outages. Schedule the migration time accordingly.

After installing or updating to the latest SCALE 22.12 (Bluefin) release, disable the service and the Start Automatically option. This prevents the service from re-enabling after a system restart. Click Edit and take note of the settings configured for the service.

Click on the service below for details on transitioning from that service to an application that provides the functionality of the deprecated service. You can install an application replacing the service in either Bluefin or Cobia.

Migrating from DDNS Service

Review your Dynamic DNS service provider, domain, IP address, port number, URL, and credential (username and password) settings. Take a screenshot or record the settings. If establishing a new provider, create the user account before proceeding. Otherwise, use the existing provider details.

To grant access to a specific user (and group) other than using the default admin user UID and GID, add the new non-root administrative user. Note the UID and GID for this new user to enter in the application configuration screen.

Install the application using the CORE service settings from your notes. Cobia suggests other applications to consider other than DDNS-Updater application.

Migrating from OpenVPN Service

Review your OpenVPN client and server service settings. Take note of all certificate, device type, port, protocol, TLS crypt authentication, and additional parameter settings.

A certificate configured on CORE should migrate to SCALE, but as a precaution, record the certificate authority (CA) and certificate settings, especially any private and public keys the certificate uses.

Install the application using the CORE service settings from your notes. Cobia suggests other applications to consider other than the WG Easy VPN application.

Migrating from Rsync Service

Review your rsync and module service settings. Take note of all host path, access mode type, number of simultaneous connections, user and group IDs, allow and deny host addresses, and any auxiliary parameter settings.

Before you configure a new rsync application like Rsync-Daemon (Rsync-d),validate that it is needed. When rsync is configured externally with SSH or using an rsync task in Data Protection > Rsync Tasks, and when Rsync Mode is set to SSH, the deprecated rsync service is not used or necessary for rsync to function.

Install the application using the CORE service settings from your notes. Cobia suggests other applications to consider other than the Rsync-Daemon application.

Migrating from S3 MinIO

Review your S3 service settings. Take note of the credentials (Access Key and Secret Key), and data storage volume and host path.

If a certificate other than the default freenas_default is used, take note. A certificate configured on CORE should migrate to SCALE, but as a precaution, record the certificate authority (CA) and certificate settings, especially any private and public keys the certificate uses.

Follow the migration instructions provided in Migrating from MinIO S3.

Migrating from TFTP Service

Review your TFTP service settings. Take note of all directory, host, auxiliary parameter, permission, and credential (username and password) settings.

To grant access to a specific user (and group) other than using the default admin user UID and GID, add the new non-root administrative user. Note the UID and GID for this new user to enter in the application configuration screen.

To use a specific dataset or volume for files, Create any new dataset in Bluefin before installing the application. Install the application using the CORE service settings from your notes. Cobia suggests other applications to consider other than the TFTP Server (TFTP-HPA) application.

Migrating from WebDAV Service and Shares

Disable both the WebDAV share and service. Also disable the Start Automatically option to prevent the service from re-enabling after a system restart.

Review any existing WebDAV service authentication settings. Take note of all IP addresses, port numbers, URLs and credentials (username and password).

Remove any existing WebDAV shares. Go to Shares > WebDAV and edit any existing configurations. Take note of the share name, path, and read only settings, then delete the WebDAV share configuration.

To grant access to a specific user (and group) other than using the default admin user UID and GID, add the new non-root administrative user. Note the UID and GID for this new user to enter in the application configuration screen. To recreate any existing shares created with the webdav user and group in control, use the UID and GID (666) in the application.

After disabling the WebDAV service and clearing any existing share configurations from the Shares > WebDAV screen in Bluefin, install the WebDAV application using the CORE service settings from your notes.