Skip to content

Commit

Permalink
1430 24.10 migration article updates (#3145)
Browse files Browse the repository at this point in the history
* PD-1403 Remove 24.10 Migration Articles and Add MigrateCOREtoSCALE24_04.md Snippet to 24.10 Index

This PR deletes the migration articles from the 24.10 branch, adds a new snippet with instructions on the only migration path and replaces the text in the /gettingStarted/Migrate/_index.md file with the new snippet. This snippet also goes into the Master branch file.

* PD-1430 Fix broken links to deleted files

* PD-1430 Add Aliases in 24.10

This commit adds the aliases for the deleted migration files.

* PD-1430 Change Migration information in 24.10

This commit changes the content in the migration section of the 2410 getting started guide by adding back the deleted files, adds the new snippets MigrateCOREtoSCALE24_04.md and WhatDoesNotMigrate.md, and updates the content in the MigratePrep.md and MigrateCOREtoSCALE.md article.

* PD-1430 Fix snippets in 24.10

* Update MigrateCOREtoSCALE24_04.md

fix spelling

* Update FirstTimeLogin.md

revert to old links in to migration articles in the 24.10 branch

* Update FirstTimeLogin.md

revert line 97 to 24.10 migration links

* Update FirstTimeLogin.md

Revert changes in line 88 back to 24.10 article links instead of 24.04

* Update _index.md

Revert link in like 39 back to 24.10 article instead of 24.04

* Update AFPMigration.md

Revert reference in line 31 back to 24.10 instead of 24.04

* Update UpdateHASCALE.md

Revert line 17 removing reference to 24.04

* PD-1430 Fix Link to MigratePrep.md.

* Update MigratePrep.md - copy editing

* Update MigratingFromCORE.md

Copy edit and clean up the Migration Methods text.

* Update MigrateCOREtoSCALE24_04.md

update copy for 24.04 cutoff on update trains.

* Update WhatDoesNotMigrate.md

* Update MigratingFromCORE.md

* Update MigratePrep.md

---------

Co-authored-by: Tim Moore <[email protected]>
  • Loading branch information
micjohnson777 and Mrt134 authored Oct 29, 2024
1 parent 493d3ce commit 94af090
Show file tree
Hide file tree
Showing 8 changed files with 75 additions and 206 deletions.
4 changes: 1 addition & 3 deletions content/GettingStarted/Migrate/ComponentNaming.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,4 @@ TrueNAS SCALE uses **bond** followed by a number (bond1).

{{<include file="/static/includes/addcolumnorganizer.md">}}

See the [TrueNAS Systems](https://www.truenas.com/docs/hardware/) section for lists of the default port names for each platform.


See the [TrueNAS Systems](https://www.truenas.com/docs/hardware/) section for lists of the default port names for each platform.
2 changes: 1 addition & 1 deletion content/GettingStarted/Migrate/MigrateCOREHAtoSCALEHA.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,4 +22,4 @@ The process requires:

Review the [Migration Preparation article]({{< relref "MigratePrep.md" >}}) to see detailed notes and caveats about the migration process.

{{< include file="/static/includes/iXsystemsSupportContact.md" >}}
{{< include file="/static/includes/iXsystemsSupportContact.md" >}}
138 changes: 21 additions & 117 deletions content/GettingStarted/Migrate/MigratePrep.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,52 +2,51 @@
title: "Preparing to Migrate"
description: "Guides CORE users through preparation elements and steps before beginning the one-way CORE to SCALE migration process."
weight: 10
aliases:
tags:
- migrate
keywords:
- nas storage software
- data migration
- enterprise data storage solution
- backup strategies
---

{{< enterprise >}}
CORE Enterprise customers should contact iXsystems Support for assistance with the process of moving from CORE to SCALE, especially customers with HA systems.

{{< expand "Contacting Support" "v" >}}
{{< include file="/static/includes/iXsystemsSupportContact.md" >}}
{{< /expand >}}
{{< /enterprise >}}

{{< include file="/static/includes/MigrateCOREtoSCALEWarning.md" >}}

## What can or cannot migrate?

{{< include file="/static/includes/COREMigratesList.md" >}}
{{< include file="/static/includes/WhatDoesNotMigrate.md" >}}

## Preparing for Migration
Read this article before you attempt to migrate your CORE system to a SCALE major version.

Read this article before you attempt to migrate your 13.0-U6.x system to TrueNAS 24.10.

{{< hint type="warning" title="Using USB Devices for Backups" >}}
We strongly recommend not using USB flash drives or USB-attached drives for backups as these can have issues, including with recovering backed up files.
For more information on using USB drives and devices in general, read the [CORE Hardware Guide](https://www.truenas.com/docs/core/gettingstarted/corehardwareguide/).
If you must use a USB type device, verify you can access files on the device before you upgrade/migrate to SCALE.
{{< /hint >}}
{{< enterprise >}}
Enterprise customers are encouraged to contact Support for assistance with the process of moving from 13.0 to 24.04, especially customers with HA systems.
{{< /enterprise >}}

1. Upgrade your CORE system to either the latest 13.0 or 13.3 release.
TrueNAS Enterprise-licensed (or community systems that haven't switched to 13.3) systems on 12.0x or earlier should upgrade to the latest 13.0 release (e.g 13.0-U6.2 or newer) prior to migration.
Community users with 13.3 installed should update to the latest maintenance release of that version prior to migration.
Either major version can use the [iso upgrade](#migrating-using-an-iso-file-to-upgrade) method for migration.
1. Upgrade your CORE system to the most recent publicly-available CORE major maintenance release version.
CORE systems at the latest 13.0 release can use the [iso upgrade](#migrating-using-an-iso-file-to-upgrade) method to migrate to SCALE.

2. Migrate [GELI-encrypted pools](https://www.truenas.com/docs/core/coretutorials/storage/pools/storageencryption/#geli-pool-migrations) to a non-GELI-encrypted pool before upgrading from CORE 12.0x or earlier releases!
If you do not migrate from GELI to ZFS encryption before upgrading to CORE 13.0-U# or migrating to SCALE you permanently lose access to the data in the GELI encrypted pool(s).

3. Verify the root user is not locked.
Go to **Accounts > Users**, select the root user and click **Edit** to view current settings and confirm **Lock User** is not selected.

4. Write down, copy, or take screenshots of settings to use in the event of a post-upgrade/migration issue or to duplicate in SCALE.
Use the checklist below to guide you through this step:

<input type="checkbox"> Check the release notes for each major release version. Release notes contain information on feature changes and deprecated services you need to be aware of. Record the settings for deprecated services, and take the steps documented in the release notes to deploy an alternate solution if you choose.

<input type="checkbox"> System dataset - Identify your system dataset. If you want to use the same dataset for the system dataset in SCALE, note the pool and system dataset.
When you set up the first required pool on SCALE import this pool first.

<input type="checkbox"> Deprecated services - Record the settings for [services deprecated in SCALE](#deprecated-services-in-scale).

<input type="checkbox"> VMs - If you have virtual machines configured in CORE, write down or screenshot network and other setting information.

<input type="checkbox"> Plugins or jails - Plugins and jails do not migrate. Record settings for each plugin/jail and back up the data associated with each.
Expand All @@ -68,12 +67,7 @@ Enterprise customers are encouraged to contact Support for assistance with the p

<input type="checkbox"> Data protection tasks - Write down or take screenshots of replication, periodic snapshot, cloud sync, or other task settings to reconfigure these in SCALE if you want to duplicate these tasks.

5. Remove all CORE SMB auxiliary parameter settings before migrating to SCALE.
As of 23.10 SCALE COBIA, the SMB **Auxiliary Parameters** option is no longer available in the UI.
Attempting to migrate with these settings can result in broken SMB shares post upgrade that require access to the CLI to fix.
We recommend removing these unsupported settings before migrating from CORE to SCALE.

6. Write down or take screenshots of your network configuration information.
5. Write down or take screenshots of your network configuration information.
Capture the global network settings, interfaces (LAGG, VLAN, bridge settings), static IP addresses, and aliases.

FreeBSD and Linux use different nomenclature for network interfaces, bridges, LAGGs, and VLANs.
Expand All @@ -86,106 +80,16 @@ Enterprise customers are encouraged to contact Support for assistance with the p
If there are issues after a clean install of SCALE from an <file>iso</file> file or you are not using DHCP for network and interface configuration, use the information from your CORE settings to configure your SCALE network settings and to reconfigure your static IPs or aliases.
{{< include file="/static/includes/NetworkInstallRequirementsSCALE.md" >}}

7. Migrate the deprecated S3 MinIO service (if in use). See [services deprecated in SCALE](#migrating-from-deprecated-services).
6. Migrate the deprecated S3 MinIO service (if in use). See [services deprecated in SCALE](#migrating-from-deprecated-services).
This is a lengthy process depending on the amount of data stored while using the S3 service.
Read and follow instructions in [Migrating MinIO Data from CORE to SCALE](https://www.truenas.com/docs/solutions/miniocoretoscale/)!

Make sure S3 MinIO data is backed up as a precaution. The migration process from the S3 service requires first [migrating to the MinIO plugin in TrueNAS CORE](https://www.truenas.com/docs/core/13.0/coretutorials/jailspluginsvms/plugins/minioplugin/#migrating-from-s3-service-to-minio-plugin), migrating from CORE to SCALE, then installing the SCALE MinIO app and importing S3 data.

8. Back up any critical data.
7. Back up any critical data.

9. Download your [system configuration file](https://www.truenas.com/docs/core/coretutorials/systemconfiguration/usingconfigurationbackups/) and a [debug file](https://www.truenas.com/docs/core/uireference/system/advanced/).
8. Download your [system configuration file](https://www.truenas.com/docs/core/coretutorials/systemconfiguration/usingconfigurationbackups/) and a [debug file](https://www.truenas.com/docs/core/uireference/system/advanced/).
After updating to the latest publicly-available release of CORE and making any changes to CORE user accounts or any other settings download these files and keep them in a safe place and where you can access them if you need to revert to CORE with a clean install using the CORE <file>iso</file> file.

After completing the steps that apply to your CORE system listed above, download the [SCALE ISO file](https://www.truenas.com/download-tn-scale/) and save it to your computer.
See [Software Releases](https://www.truenas.com/docs/softwarereleases/#upgrade-paths) for current recommended update paths to make sure you download and migrate to the correct SCALE version.
Burn the iso to a USB drive (see **Installing on Physical Hardware** in [Installing SCALE]({{< relref "InstallingSCALE.md#installing-on-physical-hardware" >}})) when upgrading a physical system.

## Deprecated Services in SCALE
The built-in services listed in this section are available in 13.0, but deprecated in 22.12.3 (Bluefin) and removed in later TrueNAS releases.
They require attention before attempting to migrate to 24.04.

Each of the sections has information that can help you determine the best steps forward to secure any critical data before attempting to migrate from 13.0 to 24.04.
They provide details on transitioning from that service to an application with the functionality of the deprecated service.

TrueNAS SCALE has [apps](https://www.truenas.com/docs/truenasapps/) you can deploy as replacements for these services.
SCALE 24.04 provides the option to force an upgrade without converting deprecated services to apps.
The force option is not recommended for the S3 service as forcing the upgrade results in losing access to and the ability to recover the MinIO S3 data.

See [SCALE Bluefin Deprecated Services](https://www.truenas.com/docs/scale/22.12/gettingstarted/scaledeprecatedfeatures/) for more information.

{{< expand "Migrating from DDNS Service" "v" >}}
Review and write down or take screenshots of your Dynamic DNS service provider, domain, IP address, port number, URL, and credential (username and password) settings to use when you reconfigure in a replacement app.
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 a new non-root administrative user.
Note the UID and GID for this new user to enter in the application configuration screen.

Install a replacement application such as **DDNS-Updater** using the CORE service settings from your notes.
SCALE suggests other applications to consider other than **DDNS-Updater** application.
{{< /expand >}}

{{< expand "Migrating from OpenVPN Service" "v" >}}
Review your OpenVPN client and server service settings.
Take note of all certificate, device type, port, protocol, TLS crypt authentication, and additional parameter settings to use in a replacement app.

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

Install a replacement application such as **WG Easy** using the CORE service settings from your notes.
SCALE suggests other applications to consider other than the **WG Easy** VPN application.
{{< /expand >}}

{{< expand "Migrating from Rsync Service" "v" >}}
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 a replacement application such as **Rsync Daemon** using the CORE service settings from your notes.
SCALE suggests other applications to consider other than the **Rsync Daemon** application.
{{< /expand >}}

{{< expand "Migrating from S3 MinIO" "v" >}}
You must migrate your S3 service and data before you upgrade or migrate from CORE to SCALE!

If you have the S3 service configured in CORE, you must first [migrate to the MinIO plugin](https://www.truenas.com/docs/core/13.0/coretutorials/jailspluginsvms/plugins/minioplugin/#migrating-from-s3-service-to-minio-plugin).
After migrating from CORE to SCALE and then installing the [SCALE MinIO Enterprise app](https://www.truenas.com/docs/scale/scaletutorials/apps/enterpriseapps/minio/), you can import S3 data from the CORE plugin to the SCALE app.

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 MinIO Data from CORE to SCALE](https://www.truenas.com/docs/solutions/miniocoretoscale/).
This is an involved and time-consuming process with specific requirements. The amount of data being migrated determines how long this process takes.
{{< /expand >}}

{{< expand "Migrating from TFTP Service" "v" >}}
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 storage volume for files, create any new dataset in Bluefin before installing the application.
Install the replacement application such as **TFTP Server** (TFTP-HPA) using the CORE service settings from your notes.
SCALE suggests other applications to consider other than the **TFTP Server** (TFTP-HPA) application.
{{< /expand >}}

{{< expand "Migrating from WebDAV Service and Shares" "v" >}}
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 use **Edit** to view any existing configurations.
Take note of the share name, path, and read only settings. Delete the WebDAV share configuration.

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

After disabling the WebDAV service and clearing any existing share configurations from the **Shares > WebDAV** screen in Bluefin, install the **WebDAV** application to recreate your shares using the CORE service settings from your notes. Use the **webdav** user and group in control, and the UID and GID (**666**) in the application.
{{< /expand >}}
Loading

0 comments on commit 94af090

Please sign in to comment.