diff --git a/content/CORETutorials/UpdatingTrueNAS/UpdatingCORE.md b/content/CORETutorials/UpdatingTrueNAS/UpdatingCORE.md deleted file mode 100644 index a3bb2dca2c..0000000000 --- a/content/CORETutorials/UpdatingTrueNAS/UpdatingCORE.md +++ /dev/null @@ -1,155 +0,0 @@ ---- -title: "Updating CORE" -description: "Provides information on how to update TrueNAS CORE." -geekdocCollapseSection: true -weight: 10 -tags: -- configbackup -- update ---- - -TrueNAS CORE has an integrated update system to make it easy to keep up to date. - -## Prepare the System - -We recommend performing updates when the TrueNAS system is idle, with no clients connected and no scrubs or other disk activity happening. -Most updates require a system reboot. -Plan updates around scheduled maintenance times to avoid disrupting user activities. - -The update process does not proceed unless there is enough free space in the boot pool for the new update files. -If a space warning displays, go to **System > Boot** to remove unneeded boot environments. - -{{< expand "Updates and Trains" "v" >}} -TrueNAS uses cryptographically signed update files to update. -Update files provide flexibility in deciding when to upgrade the system. -TrueNAS installs updates in a new Boot Environment, allowing you to install and test an update, but revert to a previous Boot Environment in **System > Boot** if anything goes wrong. - -TrueNAS defines software branches known as trains. -We have several trains available for updates, but the web interface only displays trains you can select as an upgrade. - -Update trains have a numeric version followed by a short description. -The current version receives regular bug fixes and new features. -Supported older versions of TrueNAS only receive maintenance updates. -See the [Software Development Life Cycle]({{< relref "SofDevLifecycle.md" >}}) for more details about the development and support timeline for TrueNAS versions. - -We use three different terms to describe train types: - -**STABLE**: Bug fixes and new features are available from this train. Upgrades available from a STABLE train are tested and ready to apply to a production environment. - -**Nightlies**: Experimental train used for testing future versions of TrueNAS. - -**SDK**: Software Developer Kit train has additional tools for testing and debugging TrueNAS. - -{{< hint type=important >}} -The UI shows a warning when the selected train does not suit production use. -Before using a non-production train, be prepared to experience bugs or problems. -Testers are encouraged to submit bug reports at https://ixsystems.atlassian.net. -{{< /hint >}} -{{< /expand >}} - -### Check for Updates - -![System Update](/images/CORE/System/SystemUpdate.png "System Update") - -The system checks daily for updates and downloads an update if one is available. -An alert is issued when a new update becomes available. -The automatic check and download of updates are disabled by unsetting **Check for Updates Daily and Download if Available**. -Click (Refresh) to perform another check for updates. -To change the train, use the drop-down menu to make a different selection. - -{{< hint type=note >}} -The train selector does not allow downgrades. -For example, you cannot select the STABLE train while booted into a Nightly boot environment or a 9.10 train while booted into an 11 boot environment. -To go back to an earlier version after testing or running a more recent version, reboot and select a boot environment for that earlier version. -{{< /hint >}} - -Information about the update displays with a link to the release notes. -Alwys read the release notes before updating to determine if any of the changes in that release impact system use. - -### Save the Configuration File - -A dialog to save the system configuration file appears before installing updates. - -![Save Config](/images/CORE/System/SaveConfig.png "Save Config") - -{{< hint type=important >}} -Keep the system configuration file secure after saving it. -The security information in the configuration file can grant unauthorized access to your TrueNAS system. -{{< /hint >}} - -## Update the System - -Ensure the system is in a low-usage state as described above in [Preparing for Updates](#prepare-the-system). -Click **DOWNLOAD UPDATES** to download and install an update. - -The **Save Configuration** dialog appears so you can save the current configuration to external media. - -A confirmation window appears before installing the update. -If you set **Apply updates and reboot system after downloading**, clicking **CONTINUE** downloads and applies the update, then reboots the system. -The update can be downloaded for a later manual installation by unsetting **Apply updates and reboot system after downloading**. - -**APPLY PENDING UPDATE** displays when an update is downloaded and ready to install. -Setting **Confirm** and clicking **CONTINUE** updates and reboots the system. - -{{< hint type=important >}} -Each update creates a boot environment. -If the update process needs more space, it attempts to remove old boot environments. -TrueNAS does not remove boot environments marked with the *Keep* attribute as shown in **System > Boot**. -The upgrade fails if your system does not have space for a new boot environment. -Space on the operating system device can be manually freed by going to **System > Boot** and removing the *Keep* attribute or deleting any boot environments that are no longer needed. -{{< /hint >}} - -{{< expand "Can I force a full update?" "v" >}} -TrueNAS defaults to delta packages for updates. -While updating, TrueNAS only downloads files that changed in the base operating system since the previous update. -Delta update packages are more efficient than full update packages, providing a faster update and taking less bandwidth. -By contrast, a full update package downloads all the files included in the base system, even if those files have not changed. - -While the full package might require more time to install, there are some rare cases where it is necessary, such as when aplying a patch as a temporary fix to a local system. -A patch fixes a bug within the main codebase. -While software patches often fix bugs, they can also repair security issues or add new features. - -To force a full update, open the shell and enter this command: - -`freenas-update -C /tmp/update-$$ –no-delta –reboot update` - -The updater downloads the full package containing all the files from the latest software release. -When the download completes, the system reboots with the standard configuration. -{{< /expand >}} - -### Manual Updates - -You can manually download and apply updates in **System > Update**. - -{{< hint type=note >}} -You cannot use manual updates to upgrade from older major versions. -{{< /hint >}} - -Go to https://download.freenas.org/ and find an update file of the desired version. -Manual update file names end with manual-update.tar. - -Download the desired update file to your local system. -Log in to the TrueNAS web interface and go to **System > Update**. -Click **INSTALL MANUAL UPDATE FILE**. - -The **Save Configuration** dialog opens. -You can save a copy of the current configuration to external media for backup in case of an update problem. - -After the dialog closes, the manual update screen displays. - -The current version of TrueNAS displays for verification. - -![Update Manual](/images/CORE/System/UpdateManual.png "Manual Update") - -Select the manual update file saved to your local system using **Browse**. -Set **Reboot After Update** to reboot the system after the update installs. -Click **APPLY UPDATE** to begin the update. - -{{< hint type=important >}} -**Update in Progress** - -Starting an update shows a progress dialog. -When an update is in progress, the web interface shows an animated icon in the top row. -Dialogs also appear in every active web interface session to warn that a system update is in progress. -**Do not** interrupt a system update. -{{< /hint >}} diff --git a/content/CORETutorials/UpdatingTrueNAS/UpdatingENTERPRISE.md b/content/CORETutorials/UpdatingTrueNAS/UpdatingENTERPRISE.md index c4a48e350d..46e0fcc9e6 100644 --- a/content/CORETutorials/UpdatingTrueNAS/UpdatingENTERPRISE.md +++ b/content/CORETutorials/UpdatingTrueNAS/UpdatingENTERPRISE.md @@ -1,5 +1,5 @@ --- -title: "Updating CORE ENTERPRISE" +title: "Updating CORE Enterprise" description: "Describes how to update Enterprise-licensed TrueNAS CORE deployments." geekdocCollapseSection: true weight: 20 @@ -11,8 +11,6 @@ tags: This is Enterprise content that specifically applies to High Availability (HA) systems with a TrueNAS Enterprise license active. {{< /enterprise >}} - - Updating a TrueNAS Enterprise system configured for High Availability (HA) has a slightly different flow from non-HA systems or TrueNAS Core. The system downloads the update to both controllers, updates and reboots the standby TrueNAS controller, and finally fails over from and updates the active TrueNAS controller. diff --git a/content/CORETutorials/UpdatingTrueNAS/UpdatingSoftwareforaMajorVersion.md b/content/CORETutorials/UpdatingTrueNAS/UpdatingSoftwareforaMajorVersion.md deleted file mode 100644 index bf8f85ac9d..0000000000 --- a/content/CORETutorials/UpdatingTrueNAS/UpdatingSoftwareforaMajorVersion.md +++ /dev/null @@ -1,121 +0,0 @@ ---- -title: "Updating Software for a Major Version" -description: "Describes options for keeping TrueNAS updated." -geekdocCollapseSection: true -weight: 30 -tags: -- update ---- - -TrueNAS provides flexibility for keeping the operating system up-to-date:
- -1. You can upgrade to major releases (ex. 9.3 to 9.10) using either an ISO or the web interface unless the Release Notes for the new major release indicate that the current version requires an ISO upgrade. -2. Minor releases are replaced with signed updates, meaning you do not need to wait for a minor release to update with a system update or newer versions of drivers and features. - It is also no longer necessary to manually download an upgrade file and its associated checksum to update the system. -3. The updater automatically creates a boot environment, making updates a low-risk operation. - Boot environments provide the option to return to the previous version of the operating system by rebooting the system and selecting the previous boot environment from the **System > Boot** menu. - -The [upgrade instructions](#upgrade-via-iso) instructions describe how to use an .iso file to perform a major version upgrade from an earlier version of FreeNAS/TrueNAS. -See the [Updating CORE]({{< relref "/CORETutorials/UpdatingTrueNAS/UpdatingCORE.md" >}}) or [Updating Enterprise]({{< relref "/CORETutorials/UpdatingTrueNAS/UpdatingENTERPRISE.md" >}}) articles for instructions about using the web interface to keep the system updated. - -The upgrade path for major versions of FreeNAS/TrueNAS is **9.3 > 9.10 > 11.1 > 11.3 > 12.0**. -We always recommend upgrading to a [supported version]({{< relref "SofDevLifecycle.md" >}}) of the software. - -## Caveats - -Be aware of these caveats before attempting a major version upgrade: - -* **Upgrading a data storage pool can make it impossible to go back to a previous version.** - For this reason, the update process does not automatically upgrade storage pools, though the system shows an alert when a pool is upgradable. - Unless new ZFS feature flags are needed, you can safely leave the pool at the current version. - If you upgrade the pool, you cannot boot into a previous TrueNAS version that does not support the newer feature flags. -* Upgrading the firmware of Broadcom SAS HBAs to the latest version is recommended. -* When upgrading from 9.3.x to 9.10, read this 9.3 to 9.10 FAQ first. -* **Upgrades from FreeNAS 0.7x are not supported.** - The system cannot import configuration settings from FreeNAS 0.7x versions. - You must manually recreate the configuration. - If supported, you must manually import the FreeNAS 0.7x pools or disks. -* **Upgrades on 32-bit hardware are not supported.** - However, if the system is currently running a 32-bit version of FreeNAS/TrueNAS and the hardware supports 64-bit, you can upgrade the system. - Any archived reporting graphs delete during upgrades. -* **UFS is not supported.** - If the data resides on one UFS-formatted disk, [create a ZFS pool]({{< relref "/CORETutorials/Storage/Pools/_index.md" >}}) using other disks after upgrading, then use the instructions in [Importing a Disk]({{< relref "ImportDisk.md" >}}) to mount the UFS-formatted disk and copy the data to the ZFS pool. - With only one disk, back up its data to another system or media before the upgrade, format the disk as `ZFS` after the upgrade, then restore the backup. - If the data resides on a UFS RAID of disks, you cannot directly import that data to the ZFS pool. - Instead, back up the data before the upgrade, create a ZFS pool after upgrading, then restore the data from the backup. -* **If you have GELI-encrypted pools and are upgrading to TrueNAS 12.0 or newer**, you might want to migrate data from the GELI-encrypted pools into ZFS-encrypted pools. - You CANNOT CONVERT the GELI pools. You must migrate the data to a new ZFS pool. - See the [Encryption article]({{< relref "StorageEncryption.md" >}}) for more details. - -## Prepare the System - -Before upgrading the operating system, follow these steps: - -1. Back up the TrueNAS configuration in **System > General > Save Config**. -2. Back up any encrypted data keys or passphrases and have them available. -3. Warn users that TrueNAS shared data is unavailable during the upgrade. - We recommend scheduling the upgrade for a time that will least impact users. -4. Stop all system **Services**. - -{{< hint type=important >}} -All auxiliary parameters are subject to change between major versions of TrueNAS due to security and development issues. We recommend removing all auxiliary parameters from TrueNAS configurations before upgrading. -{{< /hint >}} - -## Upgrade Via ISO - -To upgrade TrueNAS using an .iso file, go to https://www.truenas.com/download-truenas-core/ (TrueNAS CORE latest release) or https://download.freenas.org to download the .iso to the computer that prepares the installation media. -For example, this is the path to download an .iso of the latest FreeNAS 11.3 release: - -![DownloadLatest](/images/CORE/DownloadLatest.png "Path to latest 11.3 release") - -Burn the downloaded .iso file to a CD or USB stick. Refer to the [Prepare the Install File]({{< relref "/GettingStarted/Install.md#prepare-the-install-file" >}}) instructions in the Installation article for tips about burning the .iso to media using different Operating Systems. - -Insert the prepared media into the system and boot from it. -The installer waits ten seconds in the installer boot menu before booting the default option. -If needed, press Spacebar to stop the timer and choose another boot option. -After the media finishes booting into the installation menu, press Enter to select the default option `1 Install/Upgrade`. -The installer presents a screen showing all available drives. - -{{< hint type=important >}} -All drives display, including boot drives and storage drives. -Only choose boot drives when upgrading. -**Choosing the wrong drives to upgrade or install causes data loss.** -If you are unsure which drives contain the TrueNAS operating system, reboot and remove the install media. -Log in to the TrueNAS web interface and go to **System > Boot > ACTIONS > Boot Pool Status** to identify the boot drives. -More than one drive displays when using a mirror. -{{< /hint >}} - -Highlight the drive where TrueNAS is installed and press Spacebar to mark it with a star. -If using a mirror for the operating system, mark all the drives where the TrueNAS operating system is installed. -Press Enter when done. - -The installer recognizes earlier versions of FreeNAS/TrueNAS installed on the boot drives and asks to either upgrade or do a fresh install: - -![InstallerUpgradeChoice](/images/CORE/Install/InstallerUpgradeChoice.png "Upgrade Choice") - -To perform an upgrade, press Enter to accept the default Upgrade Install. -The installer displays another reminder that you should install the operating system on a disk you are not using for storage. - -![InstallerUpgradeMethod](/images/CORE/Install/InstallerUpgradeMethod.png "Upgrade Method") - -You can install the updated system in a new boot environment or format the entire operating system device to start fresh. -Installing into a new boot environment preserves the old code, allowing a roll-back to previous versions if necessary. -Formatting the boot device is usually not necessary but can reclaim space. -TrueNAS preserves user data and settings when installing in a new boot environment and formatting the operating system device. -Move the highlight to one of the options and press Enter to start the upgrade. - -The installer unpacks the new image and checks for upgrades to the existing database file. -The database file that is preserved and migrated contains your TrueNAS configuration settings. - -![Installer Upgrade Preserved Database](/images/CORE/Install/InstallerUpgradePreservedDatabase.png "Preserved Database") - -Press Enter. -TrueNAS indicates that the upgrade is complete and a reboot is required. -Press *OK*, highlight `3 Reboot System`, then press Enter to reboot the system. -If the upgrade installer was booted from CD, remove the CD. - -During reboot, the previous configuration database can convert to the new version. -The conversion happens during the reboot `Applying database schema changes` line. -The conversion can take a long time to finish, sometimes fifteen minutes or more, and can cause the system to reboot again. -The system boots normally afterwards. -If database errors display but the web interface is accessible, log in, go to **System > General**, and use the **UPLOAD CONFIG** button to upload the configuration backup you downloaded before starting the upgrade. diff --git a/content/CORETutorials/UpdatingTrueNAS/_index.md b/content/CORETutorials/UpdatingTrueNAS/_index.md index ac2bd7d0c0..f6612ac4cf 100644 --- a/content/CORETutorials/UpdatingTrueNAS/_index.md +++ b/content/CORETutorials/UpdatingTrueNAS/_index.md @@ -1,9 +1,219 @@ --- -title: "Updating TrueNAS" +title: "Updating CORE" description: "Tutorials for updating or upgrading a TrueNAS CORE system." geekdocCollapseSection: true weight: 900 related: false +tags: +- configbackup +- update +aliases: + - /coretutorials/updatingtruenas/updatingcore/ + - /coretutorials/updatingtruenas/updatingsoftwareforamajorversion/ --- -{{< children depth="2" description="true" >}} +TrueNAS CORE has an integrated update system to make it easy to keep up to date. + +{{< enterprise >}} +TrueNAS CORE Enterprise High Availability (HA) customers should see [Updating CORE Enterprise]({{< relref "/CORETutorials/UpdatingTrueNAS/UpdatingENTERPRISE.md" >}}) for additional considerations. +{{< /enterprise >}} + +## Prepare the System + +We recommend performing updates when the TrueNAS system is idle, with no clients connected and no scrubs or other disk activity happening. +Most updates require a system reboot. +Plan updates around scheduled maintenance times to avoid disrupting user activities. + +The update process does not proceed unless there is enough free space in the boot pool for the new update files. +If a space warning displays, go to **System > Boot** to remove unneeded boot environments. + +{{< expand "Updates and Trains" "v" >}} +TrueNAS uses cryptographically signed update files to update. +Update files provide flexibility in deciding when to upgrade the system. +TrueNAS installs updates in a new Boot Environment, allowing you to install and test an update, but revert to a previous Boot Environment in **System > Boot** if anything goes wrong. + +TrueNAS defines software branches known as trains. +We have several trains available for updates, but the web interface only displays trains you can select as an upgrade. + +Update trains have a numeric version followed by a short description. +The current version receives regular bug fixes and new features. +Supported older versions of TrueNAS only receive maintenance updates. +See the [Software Development Life Cycle]({{< relref "SofDevLifecycle.md" >}}) for more details about the development and support timeline for TrueNAS versions. + +We use three different terms to describe train types: + +**STABLE**: Bug fixes and new features are available from this train. Upgrades available from a STABLE train are tested and ready to apply to a production environment. + +**Nightlies**: Experimental train used for testing future versions of TrueNAS. + +**SDK**: Software Developer Kit train has additional tools for testing and debugging TrueNAS. + +{{< hint type=important >}} +The UI shows a warning when the selected train does not suit production use. +Before using a non-production train, be prepared to experience bugs or problems. +Testers are encouraged to submit bug reports at https://ixsystems.atlassian.net. +{{< /hint >}} +{{< /expand >}} + +### Check for Updates + +![System Update](/images/CORE/System/SystemUpdate.png "System Update") + +The system checks daily for updates and downloads an update if one is available. +An alert is issued when a new update becomes available. +The automatic check and download of updates are disabled by unsetting **Check for Updates Daily and Download if Available**. +Click (Refresh) to perform another check for updates. +To change the train, use the drop-down menu to make a different selection. + +{{< hint type=note >}} +The train selector does not allow downgrades. +For example, you cannot select the STABLE train while booted into a Nightly boot environment or a 9.10 train while booted into an 11 boot environment. +To go back to an earlier version after testing or running a more recent version, reboot and select a boot environment for that earlier version. +{{< /hint >}} + +Information about the update displays with a link to the release notes. +Always read the release notes before updating to determine if any of the changes in that release impact system use. + +### Save the Configuration File + +A dialog to save the system configuration file appears before installing updates. + +![Save Config](/images/CORE/System/SaveConfig.png "Save Config") + +{{< hint type=important >}} +Keep the system configuration file secure after saving it. +The security information in the configuration file can grant unauthorized access to your TrueNAS system. +{{< /hint >}} + +## Update the System + +Ensure the system is in a low-usage state as described above in [Preparing for Updates](#prepare-the-system). +Click **DOWNLOAD UPDATES** to download and install an update. + +The **Save Configuration** dialog appears so you can save the current configuration to external media. + +A confirmation window appears before installing the update. +If you set **Apply updates and reboot system after downloading**, clicking **CONTINUE** downloads and applies the update, then reboots the system. +The update can be downloaded for a later manual installation by unsetting **Apply updates and reboot system after downloading**. + +**APPLY PENDING UPDATE** displays when an update is downloaded and ready to install. +Setting **Confirm** and clicking **CONTINUE** updates and reboots the system. + +{{< hint type=important >}} +Each update creates a boot environment. +If the update process needs more space, it attempts to remove old boot environments. +TrueNAS does not remove boot environments marked with the *Keep* attribute as shown in **System > Boot**. +The upgrade fails if your system does not have space for a new boot environment. +Space on the operating system device can be manually freed by going to **System > Boot** and removing the *Keep* attribute or deleting any boot environments that are no longer needed. +{{< /hint >}} + +{{< expand "Can I force a full update?" "v" >}} +TrueNAS defaults to delta packages for updates. +While updating, TrueNAS only downloads files that changed in the base operating system since the previous update. +Delta update packages are more efficient than full update packages, providing a faster update and taking less bandwidth. +By contrast, a full update package downloads all the files included in the base system, even if those files have not changed. + +While the full package might require more time to install, there are some rare cases where it is necessary, such as when applying a patch as a temporary fix to a local system. +A patch fixes a bug within the main codebase. +While software patches often fix bugs, they can also repair security issues or add new features. + +To force a full update, open the shell and enter this command: + +`freenas-update -C /tmp/update-$$ –no-delta –reboot update` + +The updater downloads the full package containing all the files from the latest software release. +When the download completes, the system reboots with the standard configuration. +{{< /expand >}} + +### Manual Updates + +You can manually download and apply updates in **System > Update**. + +{{< hint type=note >}} +You cannot use manual updates to upgrade from older major versions. +{{< /hint >}} + +Go to https://download.freenas.org/ and find an update file of the desired version. +Manual update file names end with manual-update.tar. + +Download the desired update file to your local system. +Log in to the TrueNAS web interface and go to **System > Update**. +Click **INSTALL MANUAL UPDATE FILE**. + +The **Save Configuration** dialog opens. +You can save a copy of the current configuration to external media for backup in case of an update problem. + +After the dialog closes, the manual update screen displays. + +The current version of TrueNAS displays for verification. + +![Update Manual](/images/CORE/System/UpdateManual.png "Manual Update") + +Select the manual update file saved to your local system using **Browse**. +Set **Reboot After Update** to reboot the system after the update installs. +Click **APPLY UPDATE** to begin the update. + +{{< hint type=important >}} +**Update in Progress** + +Starting an update shows a progress dialog. +When an update is in progress, the web interface shows an animated icon in the top row. +Dialogs also appear in every active web interface session to warn that a system update is in progress. +**Do not** interrupt a system update. +{{< /hint >}} + +## Upgrade Via ISO + +To upgrade TrueNAS to a new major version using an .iso file, use the [Release List](https://www.truenas.com/docs/truenasupgrades/) to download the .iso to the computer that prepares the installation media. + +Burn the downloaded .iso file to a CD or USB stick. Refer to the [Prepare the Install File]({{< relref "/GettingStarted/Install.md#prepare-the-install-file" >}}) instructions in the Installation article for tips about burning the .iso to media using different Operating Systems. + +Insert the prepared media into the system and boot from it. +The installer waits ten seconds in the installer boot menu before booting the default option. +If needed, press Spacebar to stop the timer and choose another boot option. +After the media finishes booting into the installation menu, press Enter to select the default option `1 Install/Upgrade`. +The installer presents a screen showing all available drives. + +{{< hint type=important >}} +All drives display, including boot drives and storage drives. +Only choose boot drives when upgrading. +**Choosing the wrong drives to upgrade or install causes data loss.** +If you are unsure which drives contain the TrueNAS operating system, reboot and remove the install media. +Log in to the TrueNAS web interface and go to **System > Boot > ACTIONS > Boot Pool Status** to identify the boot drives. +More than one drive displays when using a mirror. +{{< /hint >}} + +Highlight the drive where TrueNAS is installed and press Spacebar to mark it with a star. +If using a mirror for the operating system, mark all the drives where the TrueNAS operating system is installed. +Press Enter when done. + +The installer recognizes earlier versions of FreeNAS/TrueNAS installed on the boot drives and asks to either upgrade or do a fresh install: + +![InstallerUpgradeChoice](/images/CORE/Install/InstallerUpgradeChoice.png "Upgrade Choice") + +To perform an upgrade, press Enter to accept the default Upgrade Install. +The installer displays another reminder that you should install the operating system on a disk you are not using for storage. + +![InstallerUpgradeMethod](/images/CORE/Install/InstallerUpgradeMethod.png "Upgrade Method") + +You can install the updated system in a new boot environment or format the entire operating system device to start fresh. +Installing into a new boot environment preserves the old code, allowing a rollback to previous versions if necessary. +Formatting the boot device is usually not necessary but can reclaim space. +TrueNAS preserves user data and settings when installing in a new boot environment and formatting the operating system device. +Move the highlight to one of the options and press Enter to start the upgrade. + +The installer unpacks the new image and checks for upgrades to the existing database file. +The database file that is preserved and migrated contains your TrueNAS configuration settings. + +![Installer Upgrade Preserved Database](/images/CORE/Install/InstallerUpgradePreservedDatabase.png "Preserved Database") + +Press Enter. +TrueNAS indicates that the upgrade is complete and a reboot is required. +Press *OK*, highlight `3 Reboot System`, then press Enter to reboot the system. +If the upgrade installer was booted from a CD, remove the CD. + +During reboot, the previous configuration database can convert to the new version. +The conversion happens during the reboot `Applying database schema changes` line. +The conversion can take a long time to finish, sometimes fifteen minutes or more, and can cause the system to reboot again. +The system boots normally afterward. +If database errors display but the web interface is accessible, log in, go to **System > General**, and use the **UPLOAD CONFIG** button to upload the configuration backup you downloaded before starting the upgrade. diff --git a/content/GettingStarted/COREReleaseNotes.md b/content/GettingStarted/COREReleaseNotes.md index 4452573996..8f06b3e826 100644 --- a/content/GettingStarted/COREReleaseNotes.md +++ b/content/GettingStarted/COREReleaseNotes.md @@ -1,26 +1,23 @@ --- -title: Nightly Version Notes -description: "Highlights and change log for the next major version of TrueNAS CORE." +title: 13.3 Version Notes +description: "Highlights and change log for each TrueNAS CORE 13.3 release." weight: 3 aliases: - - /releasenotes/core/13.0beta1/ - - /releasenotes/core/13.0rc1/ - - /core/13.0/gettingstarted/corereleasenotes/ - - /releasenotes/core/ - - /core/corereleasenotes/ - - /core/13.3/gettingstarted/corereleasenotes/ related: false --- + {{< header logo="/images/truenas-core-logo.png" logo_alt="TrueNAS CORE Logo" version="13.3" icon="" icon_alt="" >}} -{{< hint type="tip" >}} -This page is being rebuilt with notes from the latest TrueNAS CORE **nightly** development versions. -The latest [TrueNAS CORE **13.0** version release notes](https://www.truenas.com/docs/core/13.0/gettingstarted/corereleasenotes/) are now available from the TrueNAS CORE 13.0 documentation section. -Release notes for all the latest major versions are also linked from the [Docs Hub Home](/) + +{{< hint type="tip" title="13.3 Early Release Documentation">}} +This page tracks the latest development roadmap and release notes for the next upcoming TrueNAS CORE major version, 13.3. +The latest [TrueNAS CORE **13.0** version release notes](https://www.truenas.com/docs/core/13.0/gettingstarted/corereleasenotes/) are available from the TrueNAS CORE 13.0 documentation section. {{< /hint >}} +{{< include file="/static/includes/13.3Overview.md" >}} + ## Obtaining a Release -{{< include file="archive/NightlyTestWarning.md" >}} +{{< include file="/static/includes/EarlyReleaseWarning.md" >}} To download a .tar file for installing or upgrading to a CORE 13.3 nightly version, go to https://www.truenas.com/download-truenas-core/ and click **Download Future Previews**. Select the latest .tar file and click **Download**. @@ -31,43 +28,48 @@ Select **SAVE CONFIGURATION** when prompted. Select an **Update File Temporary Storage Location** then click **Chose File** and browse to select the .tar file. Click **APPLY UPDATE**. -More details are available from [Updating Core]({{< relref "updatingcore.md" >}}). +More details are available from [Updating Core]({{< relref "/CORETutorials/UpdatingTrueNAS/_index.md" >}}). + +## Release Schedule -{{< expand "Release Schedule (Click to expand)" "v" >}} +{{< include file="/static/includes/ReleaseScheduleWarning.md" >}} -## Software Lifecycle +{{< releaselist name=core-releases defaultTab=3 >}} +{{< expand "Software Lifecycle" "v" >}} {{< include file="/static/includes/LifecycleTable.md" >}} - {{< include file="/static/includes/SoftwareStatusPage.md" >}} +{{< /expand >}} -## Schedule +## Upgrade Notes -{{< include file="/static/includes/ReleaseScheduleWarning.md" >}} +* Due to security vulnerabilities and maintainability issues, the S3 service is deprecated in TrueNAS CORE 13.0 and removed in CORE 13.3 ([NAS-127694](https://ixsystems.atlassian.net/browse/NAS-127694)). + Beginning in CORE 13.0-U6, the CORE web interface generates an alert when the deprecated service is either actively running or is enabled to start on boot. + Users should migrate to a separately maintained [MinIO plugin]({{< relref "MinIOPlugin.md" >}}) or otherwise move any production data away from the S3 service storage location before upgrading to 13.3. + See the CORE 13.0 tutorial for [detailed migration instructions](http://www.truenas.com/docs/core/13.0/coretutorials/jailspluginsvms/plugins/minioplugin/). + See also [Feature Deprecations]({{< relref "Deprecations.md" >}}). -{{< releaselist name=core-releases defaultTab=3 >}} -{{< /expand >}} - + +{{< UpgradePaths product="CORE" >}} + ## Component Versions Click the component version number to see the latest release notes for that component. - - - - - - - - - - - -
ComponentVersion
FreeBSD13.2-RELEASE-p6
OpenZFS2.2.2-1
+{{< truetable >}} +| Component | Version | +|-----------|-------------| +| FreeBSD | [13.3-RELEASE-1](https://www.freebsd.org/releases/13.3R/relnotes/) | +| OpenZFS | [2.2.3-1](https://github.com/openzfs/zfs/releases/tag/zfs-2.2.3) | +{{< /truetable >}} ### New OpenZFS Feature Flags The items listed here represent new feature flags implemented since the previous update to the built-in OpenZFS version. @@ -85,11 +87,18 @@ The items listed here represent new feature flags implemented since the previous For more details on feature flags see [OpenZFS Feature Flags](https://openzfs.github.io/openzfs-docs/Basic%20Concepts/Feature%20Flags.html) and [OpenZFS zpool-feature.7](https://openzfs.github.io/openzfs-docs/man/7/zpool-features.7.html). -## Nightly Changelog +## 13.3-BETA.1 Changelog + +{{< include file="/static/includes/EarlyReleaseWarning.md" >}} + +**May 7, 2024** + +iXsystems is pleased to release TrueNAS CORE 13.3-BETA.1! +This has software component updates and security fixes that are in the polishing phase. Notable changes: -* Due to security vulnerabilities and maintainability issues, the S3 service is deprecated in TrueNAS CORE 13.0 and scheduled for removal in CORE 13.3. +* Due to security vulnerabilities and maintainability issues, the S3 service is deprecated in TrueNAS CORE 13.0 and removed in CORE 13.3 ([NAS-127694](https://ixsystems.atlassian.net/browse/NAS-127694)). Beginning in CORE 13.0-U6, the CORE web interface generates an alert when the deprecated service is either actively running or is enabled to start on boot. Users should migrate to a separately maintained [MinIO plugin]({{< relref "MinIOPlugin.md" >}}) or otherwise move any production data away from the S3 service storage location before upgrading to a 13.3 pre-release version. See the CORE 13.0 tutorial for [detailed migration instructions](http://www.truenas.com/docs/core/13.0/coretutorials/jailspluginsvms/plugins/minioplugin/). @@ -97,6 +106,23 @@ Notable changes: * The web UI **Shell** is removed in CORE 13.3. Users can continue to access the shell using [SSH]({{< relref "ConfiguringSSH.md" >}}) or a physical system connection with serial cable or other direct method ([NAS-124392](https://ixsystems.atlassian.net/browse/NAS-124392)). -* The Plugins, Jails, and Virtual Machines features are in maintenance mode and are offered to the TrueNAS community "as-is". - [TrueNAS Enterprise](https://www.truenas.com/truenas-enterprise/) customers with a critical need for virtualization features should consider TrueNAS SCALE for officially tested and supported virtualization features. - \ No newline at end of file +* The Plugins, Jails, and Virtual Machines features are untested and provided without support to the TrueNAS Community. + Users with a critical need to use containers or virtualization solutions in production should migrate to the tested and supported virtualization features available in [TrueNAS SCALE](https://www.truenas.com/download-truenas-scale/). + [TrueNAS Enterprise customers](https://www.truenas.com/truenas-enterprise/) can contact iXsystems to schedule a TrueNAS SCALE deployment. + See [CORE to SCALE Migrations](https://www.truenas.com/docs/scale/gettingstarted/migrate/) for more information. + +* Update SAMBA to version 4.19 ([NAS-120600](https://ixsystems.atlassian.net/browse/NAS-120600)). +* Update rsync to version 3.2.7 ([NAS-124036](https://ixsystems.atlassian.net/browse/NAS-124036)). +* Fix macOS Time Machine backup and snapshot issues ([NAS-125197](https://ixsystems.atlassian.net/browse/NAS-125197) and [NAS-125218](https://ixsystems.atlassian.net/browse/NAS-125218)). +* Bugfix for zettarepl memory leak ([NAS-125338](https://ixsystems.atlassian.net/browse/NAS-125338)). +* Allow ampersand (&) character in user email addresses ([NAS-125483](https://ixsystems.atlassian.net/browse/NAS-125483)). +* SNMP agent bugfix ([NAS-125904](https://ixsystems.atlassian.net/browse/NAS-125904)). +* Pagination offset and limit improvements for /api/v2.0/certificate ([NAS-126080](https://ixsystems.atlassian.net/browse/NAS-126080)). + +Click here for the full changelog of completed tickets that are included in the 13.3-BETA.1 release. +{{< include file="/static/includes/JiraFilterInstructions.md" >}} + +### 13.3-BETA.1 Ongoing Issues + +Click here to see the latest information about public issues discovered in 13.3-BETA.1 that are being resolved in a future TrueNAS CORE release. +This list also includes issues that are not to be fixed in CORE and are resolved in TrueNAS SCALE. diff --git a/content/GettingStarted/Deprecations.md b/content/GettingStarted/Deprecations.md index 8f543726b6..ef9a21b6f3 100644 --- a/content/GettingStarted/Deprecations.md +++ b/content/GettingStarted/Deprecations.md @@ -19,3 +19,15 @@ Begin planning migrations from these features immediately and note the TrueNAS u SAS Multipath is supported *as-is* and receives no further maintenance updates. While multipath situations might be detected and be generally functional in TrueNAS CORE, there is a possibility this is not available in a future TrueNAS CORE major version. Users should avoid creating and managing SAS multipath scenarios with TrueNAS. + +## Virtualization + +The Plugins, Jails, and Virtual Machines features are untested and provided without support to the TrueNAS Community. +Users with a critical need to use containers or virtualization solutions in production should migrate to the tested and supported virtualization features available in [TrueNAS SCALE](https://www.truenas.com/download-truenas-scale/). +[TrueNAS Enterprise customers](https://www.truenas.com/truenas-enterprise/) can contact iXsystems to schedule a TrueNAS SCALE deployment. +See [CORE to SCALE Migrations](https://www.truenas.com/docs/scale/gettingstarted/migrate/) for more information. + +## Web Shell + +The web UI **Shell** is removed in CORE 13.3. +Users can continue to access the shell using [SSH]({{< relref "ConfiguringSSH.md" >}}) or a physical system connection with serial cable or other direct method. diff --git a/content/GettingStarted/Install.md b/content/GettingStarted/Install.md index 7e3ce056a0..21177f5d3e 100644 --- a/content/GettingStarted/Install.md +++ b/content/GettingStarted/Install.md @@ -11,7 +11,7 @@ Now that the .iso file is [downloaded](https://www.truenas.com/down {{< expand "Major Upgrades" "v" >}} The install process can be repeated with newer installation files when the system already has TrueNAS installed. -This is used for [major version upgrades]({{< relref "UpdatingSoftwareforaMajorVersion.md" >}}) +This is used for [major version upgrades]({{< relref "/CORETutorials/UpdatingTrueNAS/_index.md#upgrade-via-iso" >}}) {{< /expand >}} {{< expand "ISO Verification" "v" >}} diff --git a/content/_index.md b/content/_index.md index 27386e5d38..246c97326d 100644 --- a/content/_index.md +++ b/content/_index.md @@ -1,5 +1,5 @@ --- -title: "TrueNAS CORE" +title: "TrueNAS CORE 13.3" geekdocCollapseSection: true weight: 10 aliases: @@ -16,54 +16,36 @@ div.docs-read_mod {display: none;} h1 {display:none;} -{{< columns size="small" >}} -

-TNCORELogo -

-<---> -**TrueNAS CORE** is free and Open Source and is the successor to the wildly popular FreeNAS. -It runs on virtually any x86_64 system and provides a broad set of features for many users. -Plugin applications like Plex, NextCloud, and Asigra allow the functionality of a system to be customized for many use cases. -{{< /columns >}} +{{< header logo="/images/truenas-core-logo.png" logo_alt="TrueNAS CORE Logo" version="TrueNAS CORE 13.3" icon="" icon_alt="" >}} -
+{{< include file="/static/includes/13.3Overview.md" >}} -{{< columns size="small" >}} -

-TNCORELogo -

-<---> -**TrueNAS CORE Enterprise** is provided as part of an [iXsystems hardware](/hardware) purchase or extended iXsystems Support Contract. -Systems can have either single or dual controllers to enable High Availability (HA). -It can also be provided with Enterprise-grade support from iXsystems. -{{< /columns >}} - -## Nightly Development Featured Content +## TrueNAS CORE 13.3 Featured Content To view documentation for historical or the latest stable TrueNAS CORE major versions, use the **Version** dropdown at the top of this page.

Getting Started Guide -
Release Notes -
Community Hardware Guide -
Software Install +
Release Notes +
Community Hardware Guide +
Software Install

Tutorials -
Networking -
Storage -
Sharing +
Networking +
Storage +
Sharing

UI Reference Guide -
System -
Network -
Storage +
System +
Network +
Storage

Additional Content -
API Reference -
Security Reports +
API Reference +
Security Reports

diff --git a/data/properties/core-releases.yaml b/data/properties/core-releases.yaml index c5987dfdb7..f34d1e473e 100644 --- a/data/properties/core-releases.yaml +++ b/data/properties/core-releases.yaml @@ -26,16 +26,21 @@ majorVersions: name: "TrueNAS CORE 13.3" releaseName: "13.3" releases: + - name: "13.3-BETA.1" + type: "Early" + link: "https://www.truenas.com/docs/core/13.3/gettingstarted/corereleasenotes/#133-beta1-changelog" + releaseDate: "2024-05-07" + latest: true - name: "13.3 Nightlies" type: "Experimental" link: "https://www.truenas.com/docs/core/13.3/gettingstarted/corereleasenotes/" releaseDate: "2024-01-01" - latest: true + latest: false - name: "13.3-RC.1" type: "Early" - releaseDate: "2024-05-07" + releaseDate: "2024-06-18" latest: false - name: "13.3.0" type: "Stable" - releaseDate: "2024-06-18" + releaseDate: "" latest: false diff --git a/layouts/shortcodes/UpgradePaths.html b/layouts/shortcodes/UpgradePaths.html new file mode 100644 index 0000000000..33c8695aeb --- /dev/null +++ b/layouts/shortcodes/UpgradePaths.html @@ -0,0 +1,35 @@ +{{/* layouts/shortcodes/UpgradePaths.html */}} +{{- $product := .Get "product" -}} +{{- $upgradePathFile := printf "/static/includes/%sUpgradePaths.md" $product -}} +{{- $logo := "" -}} +{{- $title := "" -}} + +{{- if eq $product "CORE" -}} + {{- $logo = "/images/truenas-core-logo.png" -}} + {{- $title = "TrueNAS CORE" -}} +{{- else if eq $product "SCALE" -}} + {{- $logo = "/images/tn-scale-logo.png" -}} + {{- $title = "TrueNAS SCALE" -}} +{{- end }} + +{{- $content := readFile $upgradePathFile -}} + +{{- with $content }} + + + +
+
+ {{ $title }} +
+
+ {{ . | markdownify }} +
+
+ +{{- end }} diff --git a/static/api/core_rest_api.html b/static/api/core_rest_api.html index 19583bc7d9..f568c3c347 100644 --- a/static/api/core_rest_api.html +++ b/static/api/core_rest_api.html @@ -12,7 +12,7 @@
diff --git a/static/images/CORE/DownloadLatest.png b/static/images/CORE/DownloadLatest.png deleted file mode 100644 index 39f07002d8..0000000000 Binary files a/static/images/CORE/DownloadLatest.png and /dev/null differ diff --git a/static/includes/13.3Overview.md b/static/includes/13.3Overview.md new file mode 100644 index 0000000000..f39c4850de --- /dev/null +++ b/static/includes/13.3Overview.md @@ -0,0 +1,15 @@ + + +TrueNAS CORE 13.3, the latest version of the most reliable and [highest-quality](https://www.truenas.com/blog/gartner-peer-insights-customer-choice-for-primary-storage-in-2024/) platform for traditional primary storage use cases, continues to focus on ensuring storage reliability, stability, and security for existing users. + +With this release, TrueNAS CORE is now entering a sustaining engineering phase within the TrueNAS project. Users can expect to receive maintenance updates for many years still to come. + +TrueNAS CORE 13.3 will include the following updates: + +* [FreeBSD 13.3](https://www.freebsd.org/releases/13.3R/relnotes/) +* [OpenZFS 2.2.3](https://github.com/openzfs/zfs/releases/tag/zfs-2.2.3) +* [Samba 4.19](https://www.samba.org/samba/history/samba-4.19.0.html) +* Updates to SMART, Network UPS Tools (NUT), and other services +* Various security and bug fixes + +TrueNAS CORE 13.3 will continue to receive bug fixes related to stability and security. These updates will ensure that 13.3 is a reliable platform for both homelab and enterprise customers, as well as a staging version for those users who wish to [migrate to SCALE](https://www.truenas.com/docs/scale/gettingstarted/migrate/) at a later date. diff --git a/static/includes/COREUpgradePaths.md b/static/includes/COREUpgradePaths.md new file mode 100644 index 0000000000..bc6e828cae --- /dev/null +++ b/static/includes/COREUpgradePaths.md @@ -0,0 +1,50 @@ + + +{{< mermaid class="mermaid_sizing" >}} +%%{ + init: { + 'theme': 'base', + 'themeVariables': { + 'primaryColor': '#FFFFFF', + 'primaryTextColor': '#000000', + 'primaryBorderColor': '#0095d5', + 'secondaryColor': '#70d4ff', + 'lineColor': '#0095d5', + 'secondaryTextColor': '#FFFFFF', + 'tertiaryColor': '#0095d5' + } + } +}%% + +flowchart LR + +A["11.0-U7"] -->|update| B["11.2-U8"] +B -->|update| C["11.3-U5"] +C -->|update| D["13.0-U6.1"] +D -->|"(anticipated)"| E["13.3.0"] +{{< /mermaid >}} + +TrueNAS CORE Enterprise + +{{< mermaid class="mermaid_sizing" >}} +%%{ + init: { + 'theme': 'base', + 'themeVariables': { + 'primaryColor': '#FFFFFF', + 'primaryTextColor': '#000000', + 'primaryBorderColor': '#0095d5', + 'secondaryColor': '#70d4ff', + 'lineColor': '#0095d5', + 'secondaryTextColor': '#FFFFFF', + 'tertiaryColor': '#0095d5' + } + } +}%% + +flowchart LR + +A["11.0-U7"] -->|update| B["11.2-U8"] +B -->|update| C["11.3-U5"] +C -->|update| D["13.0-U6.1"] +{{< /mermaid >}} diff --git a/static/includes/EarlyReleaseWarning.md b/static/includes/EarlyReleaseWarning.md new file mode 100644 index 0000000000..644d45c228 --- /dev/null +++ b/static/includes/EarlyReleaseWarning.md @@ -0,0 +1,6 @@ + + +{{< hint type=warning title="Early Release Software" >}} +Early releases are intended for testing and feedback purposes. +Do not use early release software for critical tasks. +{{< /hint >}} diff --git a/words-to-ignore.txt b/words-to-ignore.txt index 8f24276556..5c5b6406de 100644 --- a/words-to-ignore.txt +++ b/words-to-ignore.txt @@ -2022,4 +2022,10 @@ pathname iSCSIShare SharingStorage Diskgraphs -msec \ No newline at end of file +msec +EarlyReleaseWarning +UpdatingTrueNAS +UpgradePaths +Bugfix +zettarepl +bugfix