Skip to content

Commit

Permalink
PD-1607 / 25.04 / Pd 1607 25 04 beta 1 release notes (#3499)
Browse files Browse the repository at this point in the history
* Update SCALEReleaseNotes.md

* Update UseScaleShell.md

* Update SCALEReleaseNotes.md

* Component versions redesign (#3494)

* Update SCALEReleaseNotes.md

* Create component_versions.yaml

* Create component-versions.html

* Update custom.css

* Update SCALEReleaseNotes.md

* Update SCALEReleaseNotes.md

* Update SCALEReleaseNotes.md

* Update scale-releases.yaml

* Create UpgradeNotesBoilerplate.md

* Update SCALEReleaseNotes.md

* Update AddingNFSShares.md

* Update 25.04FeatureList.md

* Feature Flags Table improvements

* Update scale-releases.yaml

* Apply review suggestions

* typo fix

* Update words-to-ignore.txt

* Update custom.css

* Update SCALEReleaseNotes.md

* Update words-to-ignore.txt

* Add config restrictions

* Update SCALEReleaseNotes.md

* Update words-to-ignore.txt

* Update SCALEReleaseNotes.md

* Update SCALEReleaseNotes.md

* Update UIConfigurationSCALE.md

* Update SCALEReleaseNotes.md

---------

Co-authored-by: Tim Moore <[email protected]>
  • Loading branch information
DjP-iX and Mrt134 authored Feb 13, 2025
1 parent 7d3298a commit 1217ea4
Show file tree
Hide file tree
Showing 16 changed files with 248 additions and 60 deletions.
2 changes: 1 addition & 1 deletion content/API/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ Alternatively, append `/api/docs/` to your TrueNAS host name or IP address in a
## API Access

User-linked API access keys allow administrators to configure per-user access to the TrueNAS API.
Keys are revokable and can be configured to automatically expire on a preset date.
Keys are revocable and can be configured to automatically expire on a preset date.

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

Expand Down
10 changes: 7 additions & 3 deletions content/GettingStarted/Configure/UIConfigurationSCALE.md
Original file line number Diff line number Diff line change
Expand Up @@ -144,9 +144,13 @@ See [Managing SMART Tests]({{< relref "SmartTestsScale.md" >}}) for information
After completing your initial system configuration and before you begin day-to-day operations, we recommend configuring the system and data storage backup. Recommended backup options:

1. Saving the [system configuration file]({{< relref "SetUpBackupSCALE.md" >}}).
2. Saving or [creating a new boot environment]({{< relref "ManageBootEnvironSCALE.md" >}}) to use as a restore point if system issues cause you to lose access to the TrueNAS UI.
3. Downloading a system debug to capture system information to use as a comparison against future debug files.
To download a system debug file, go to **System > Advanced Settings** and click **Save Debug** to begin the download.
{{< expand "Downloading a system config file" "v" >}}
{{< include file="/static/includes/DownloadSystemConfigFileSCALE.md" >}}
{{< /expand >}}
3. Saving or [creating a new boot environment]({{< relref "ManageBootEnvironSCALE.md" >}}) to use as a restore point if system issues cause you to lose access to the TrueNAS UI.
4. Downloading a system debug to capture system information to use as a comparison against future debug files.
To download a system debug file, go to **System > Advanced Settings** and click **Save Debug** to begin the download.


Keep both the system configuration file and the initial system debug file in a safe location where important files are regularly backed up.
You can use the boot environment in an SSH session to restore your system to the point where you completed your system configuration, and then import data or pools to recover stored data.
Expand Down
90 changes: 49 additions & 41 deletions content/GettingStarted/SCALEReleaseNotes.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
---
title: "25.04 (Fangtooth) Development Notes"
description: "Highlights, change log, and known issues for the latest TrueNAS nightly development version."
title: "25.04 (Fangtooth) Version Notes"
description: "Highlights, change log, and known issues for TrueNAS 25.04 release versions."
weight: 10
related: false
---
{{< header logo="/images/tn-openstorage-logo.png" logo_alt="TrueNAS Logo" version="25.04 Fangtooth" icon="" icon_alt="" >}}

{{< hint type="tip" title="25.04 Nightly Development Documentation" >}}
This page tracks the latest development roadmap and notes for the future TrueNAS major version 25.04 (Fangtooth).
{{< hint type="tip" title="25.04 Early Release Documentation" >}}
This page tracks the latest development roadmap and early release notes for the future TrueNAS major version 25.04 (Fangtooth).

See the stable [24.10 (Electric Eel)](https://www.truenas.com/docs/scale/24.10/gettingstarted/scalereleasenotes/) release notes for information relating to that version.
{{< /hint >}}
Expand Down Expand Up @@ -37,13 +37,7 @@ More details are available from [Software Releases](https://www.truenas.com/docs

## Upgrade Notes

* TrueNAS is an appliance built from specific Linux packages.
Attempting to update TrueNAS with `apt` or methods other than the TrueNAS web interface can result in a nonfunctional system.

* All auxiliary parameters can experience changes between TrueNAS major versions due to security and development changes.
We recommend removing all auxiliary parameters from TrueNAS configurations before upgrading as these settings can result in SMB share failures after an upgrade.

* {{< include file="/static/includes/UpgradeClearCache.md" >}}
{{< include file="/static/includes/UpgradeNotesBoilerplate.md" >}}

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

Expand All @@ -53,7 +47,7 @@ More details are available from [Software Releases](https://www.truenas.com/docs
Click **API Docs** to view API documentation.

* 25.04 also introduces user-linked API access keys, allowing administrators to configure per-user access to the TrueNAS API.
Keys are revokable and can be configured to automatically expire on a preset date.
Keys are revocable and can be configured to automatically expire on a preset date.

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

Expand All @@ -66,6 +60,8 @@ More details are available from [Software Releases](https://www.truenas.com/docs

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

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

* The default libvirt account UID and GID is changed to to avoid possible clashes with user created Active Directory (AD) users. TrueNAS automatically updates libvirt UID and GIDs when upgraded to 25.04. Users attempting revert to 24.10 or an earlier release must manually review and update libvirt-qemu user and group IDs back to the values that were default in that version (64055:64055 for 24.10).

### Migrating Virtual Machines
Expand All @@ -75,9 +71,8 @@ More details are available from [Software Releases](https://www.truenas.com/docs
{{< include file="/static/includes/MigratingVMs.md" >}}

### Upgrade Paths (Anticipated)
<!--

{{< include file="/static/includes/25.04UpgradeMethods.md" >}}
-->

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

Expand All @@ -104,59 +99,72 @@ Enterprise customers should [contact Support](https://www.truenas.com/docs/scale
-->

## Component Versions
Component version numbers below are updated to reflect the latest TrueNAS 24.05 release.

Click the component version number to see release notes for that component.

{{< truetable >}}
| Component | Version |
|-----------|-------------|
| Linux Kernel | [6.12](https://git.kernel.org/pub/scm/linux/kernel/git/stable/linux.git/tag/?h=v6.12) |
| OpenZFS | [2.3.0-2](https://github.com/openzfs/zfs/tree/zfs-2.3.0-rc3) |
| Docker Engine | [27.3.1](https://docs.docker.com/engine/release-notes/27/#2731) |
{{< /truetable >}}
{{< component-versions "25.04" >}}

### OpenZFS Feature Flags

TrueNAS integrates many features provided by the upstream [OpenZFS project](https://openzfs.org/wiki/Main_Page).
Any new feature flags introduced since the previous OpenZFS version that was integrated into TrueNAS (OpenZFS 2.2.99) are listed below:

{{< truetable >}}
{{< truetable class="tn-blue" >}}
| Feature Flag | GUID | Notes |
|--------------|------|-------|
| fast deduplication | [com.klarasystems:fast_dedup](https://openzfs.github.io/openzfs-docs/man/master/7/zpool-features.7.html#fast_dedup) | This flag is present in 24.10, but is now generally available through the TrueNAS UI. |
{{< /truetable >}}

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).

## 25.04 Nightly Development Changelog

* The TrueNAS REST API is deprecated in TrueNAS 25.04 and replaced with a versioned JSON-RPC 2.0 over WebSocket API ([API Reference]({{< relref "/api/_index.md" >}})). Full removal of the REST API is planned for a future release.
* Improved API key mechanism with support for user-linked API keys ([NAS-131396](https://ixsystems.atlassian.net/browse/NAS-131396)).
* The default libvirt account UID & GID is changed to a less common value to avoid clashing with user created UID/GIDs. See Upgrade Notes above for more information ([NAS-131695](https://ixsystems.atlassian.net/browse/NAS-131695)).

<!--
## 25.04-BETA.1 Changelog
## 25.04-BETA.1

{{< 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 >}}

**Month Day, 2025**
**February 13, 2025**

iXsystems is pleased to release TrueNAS 25.04-BETA.1!
This has software component updates and new features that are in the polishing phase.
Notable changes:
This first public release version of TrueNAS 25.04 (Fangtooth) has software component updates and new features that are in the polishing phase.

*
### Notable changes

<a href="https://ixsystems.atlassian.net/issues/?filter=_____" target="_blank">Click here for the full changelog</a> of completed tickets that are included in the 25.04-BETA.1 release.
* The TrueNAS REST API is deprecated in TrueNAS 25.04 and replaced with a versioned JSON-RPC 2.0 over WebSocket API ([API Reference]({{< relref "/api/_index.md" >}})). Full removal of the REST API is planned for a future release.
* Improved API key mechanism with support for user-linked API keys ([NAS-131396](https://ixsystems.atlassian.net/browse/NAS-131396)).
* The default libvirt account UID & GID is changed to a less common value to avoid clashing with user created UID/GIDs. See Upgrade Notes above for more information ([NAS-131695](https://ixsystems.atlassian.net/browse/NAS-131695)).
* UI login experience improvements ([NAS-130810](https://ixsystems.atlassian.net/browse/NAS-130810)).
* NFS over RDMA support - Enterprise Feature ([NAS-131784](https://ixsystems.atlassian.net/browse/NAS-131784)).
* iSCSI Extensions for RDMA (iSER) support - Enterprise Feature ([NAS-106190](https://ixsystems.atlassian.net/browse/NAS-106190)).
* ZFS Fast deduplication support ([NAS-127088](https://ixsystems.atlassian.net/browse/NAS-127088)).
* iSCSI and ZVOL block cloning support ([NAS-130017](ixsystems.atlassian.net/browse/NAS-130017)).
* Incus Container & VM Support - Experimental Community Feature ([NAS-130251](https://ixsystems.atlassian.net/browse/NAS-130251)).
* Hide SED related options in the UI for non-Enterprise users ([NAS-133442](https://ixsystems.atlassian.net/browse/NAS-133442)).
* Bump nvidia driver version ([NAS-133575](https://ixsystems.atlassian.net/browse/NAS-133575)).
* Remove integrated Netdata web portal from the TrueNAS UI and middleware ([NAS-133629](https://ixsystems.atlassian.net/browse/NAS-133629)).
Default Netdata integration is removed due to STIG security requirements.
Users who want to continue using Netdata monitoring can install Netdata from the TrueNAS Apps catalog.
* Bugfix: "Cache and Spare disks are not recognized post upgrade from 13.0 U6.2 to 24.04.2" ([NAS-130825](https://ixsystems.atlassian.net/browse/NAS-130825)).
* Bugfix: "Unable to start a VM due to insufficient memory" ([NAS-128544](https://ixsystems.atlassian.net/browse/NAS-128544)).

<a href="https://ixsystems.atlassian.net/issues/?filter=11744" target="_blank">Click here for the full changelog</a> of completed tickets that are included in the 25.04-BETA.1 release.
{{< include file="/static/includes/JiraFilterInstructions.md" >}}

### 25.04-BETA.1 Known Issues
### Known Issues

* An issue has been discovered for cloud sync tasks configured with file name encryption, which is available in **Advanced Remote Options** ([NAS-132472](https://ixsystems.atlassian.net/browse/NAS-132472)). As this is an upstream issue in rclone, we recommend that users should not create new cloud sync tasks with the **Filename Encryption** setting enabled. Existing users of this feature must leave it enabled for existing cloud sync tasks to be able to recover backups.
* Unable to Create dataset under disks while configuring a new virtualization Instance ([NAS-134151](https://ixsystems.atlassian.net/browse/NAS-134151)).
* UUID related traceback when activating NVIDIA GPU for Jellyfin app: `base_v2_1_14.error.RenderError: Expected [uuid] to be set for GPU in slot [0000:01:00.0] in [nvidia_gpu_selection]` ([NAS-134152](https://ixsystems.atlassian.net/browse/NAS-134152)).

Users experiencing this error should follow the steps below for a one time fix that should not need to be repeated.

Connect to a shell session and retrieve the UUID for each GPU with the command `midclt call app.gpu_choices | jq`.

For each application that experiences the error, run `midclt call -job app.update APP_NAME '{"values": {"resources": {"gpus": {"use_all_gpus": false, "nvidia_gpu_selection": {"PCI_SLOT": {"use_gpu": true, "uuid": "GPU_UUID"}}}}}}'`
Where:
* `APP_NAME` is the name you entered in the application, for example “plex”.
* `PCI_SLOT` is the pci slot identified in the error, for example "0000:2d:00.0”.
* `GPU_UUID` is the UUID matching the pci slot that you retrieved with the above command.

<a href="https://ixsystems.atlassian.net/issues/?filter=_____" target="_blank">Click here to see the latest information</a> about public issues discovered in 25.04-BETA.1 that are being resolved in a future TrueNAS release.
-->
<a href="https://ixsystems.atlassian.net/issues/?filter=11745" target="_blank">Click here to see the latest information</a> about public issues discovered in 25.04-BETA.1 that are being resolved in a future TrueNAS release.
2 changes: 1 addition & 1 deletion content/SCALETutorials/Shares/AddingNFSShares.md
Original file line number Diff line number Diff line change
Expand Up @@ -148,7 +148,7 @@ NFS over RDMA support requires an active Enterprise license and RDMA capable net
Interested customers should contact Enterprise Support for assistance.

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

{{< /enterprise >}}
Expand Down
2 changes: 1 addition & 1 deletion content/SCALETutorials/SystemSettings/UseScaleShell.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ The TrueNAS **Shell** is convenient for running command line tools, configuring

{{< hint type=warning >}}
Warning! The supported mechanisms for making configuration changes are the TrueNAS WebUI and API exclusively.
All other are not supported and result in undefined behavior that can result in system failure!
All others are not supported and result in undefined behavior that can result in system failure!
{{< /hint >}}

{{< trueimage src="/images/SCALE/CLI/SystemShellSCALE.png" alt="Shell Screen" id="Shell Screen" >}}
Expand Down
2 changes: 1 addition & 1 deletion content/SCALETutorials/TopToolbar/ManagingAPIKeys.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ tags:
TrueNAS 25.04 and later uses a versioned JSON-RPC 2.0 over WebSocket API with support for user-linked API access keys ([API Reference]({{< relref "/api/_index.md" >}})).

User-linked API keys allow administrators to configure per-user access to the TrueNAS API.
Keys are revokable and can be configured to automatically expire on a preset date.
Keys are revocable and can be configured to automatically expire on a preset date.

Click <i class="material-icons" aria-hidden="true" title="laptop" style="vertical-align: top;">laptop</i> **My API Keys** on the top right toolbar <i class="material-icons" aria-hidden="true">account_circle</i> user settings dropdown menu to open the **User API Keys** screen.

Expand Down
33 changes: 33 additions & 0 deletions data/properties/component_versions.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
# Works in conjunction with shortcodes/component-versions.html
# The shortcode generates a table containing ordered component versions for each minor version release.

# Add in component version information for each minor version release of a major version.
# A major version can be individually called in release notes with {{< component-versions "##.##" >}}

# Each list section (major_version, release_order, and release) should start with the latest and move toward older releases.
# Insert new major or minor version release data above existing entries.

major_version:
"25.04":
release_order: # list minor version releases in order, starting with the latest
- "25.04-BETA.1"
component_order: # list components in the order they should appear in the left column
- "linux_kernel"
- "openzfs"
- "docker_engine"
- "nvidia_driver"
release: # include each release with component versions and links
"25.04-BETA.1":
components:
linux_kernel:
version: "6.12.9"
link: "https://git.kernel.org/pub/scm/linux/kernel/git/stable/linux.git/tag/?h=v6.12.9"
openzfs:
version: "2.3.0-1"
link: "https://github.com/openzfs/zfs/releases/tag/zfs-2.3.0"
docker_engine:
version: "27.5.0"
link: "https://docs.docker.com/engine/release-notes/27/#2750"
nvidia_driver:
version: "550.142"
link: "https://www.nvidia.com/en-us/drivers/details/237853/"
14 changes: 7 additions & 7 deletions data/properties/scale-releases.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -26,16 +26,11 @@ majorVersions:
name: "TrueNAS 25.04 - Fangtooth"
releaseName: "Fangtooth"
releases:
- name: "25.04 Nightlies"
type: "Experimental"
link: "https://www.truenas.com/docs/scale/25.04/gettingstarted/scalereleasenotes/"
releaseDate: "2024-08-13"
latest: true
- name: "25.04-BETA.1"
type: "Early"
link: ""
link: "https://www.truenas.com/docs/scale/25.04/gettingstarted/scalereleasenotes/#2504-beta1"
releaseDate: "2025-02-13"
latest: false
latest: true
- name: "25.04-RC.1"
type: "Early"
link: ""
Expand All @@ -46,3 +41,8 @@ majorVersions:
link: ""
releaseDate: "2025-04-15"
latest: false
- name: "25.04 Nightlies"
type: "Experimental"
link: "https://www.truenas.com/docs/scale/25.04/gettingstarted/scalereleasenotes/"
releaseDate: "2024-08-13"
latest: false
31 changes: 31 additions & 0 deletions layouts/shortcodes/component-versions.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
{{- $componentNames := dict "linux_kernel" "Linux Kernel" "openzfs" "OpenZFS" "docker_engine" "Docker Engine" "nvidia_driver" "NVIDIA Driver" -}}

{{- $version := .Get 0 -}}
{{- with .Site.Data.properties.component_versions.major_version -}}
{{- $versionData := index . $version -}}

<table class="component-versions-table">
<thead>
<tr>
<th></th>
{{- range $releaseVersion := $versionData.release_order }}
<th>{{ $releaseVersion }}</th>
{{- end }}
</tr>
</thead>
<tbody>
{{- range $componentName := $versionData.component_order }}
<tr>
<td>{{ index $componentNames $componentName }}</td> <!-- Human-readable name -->
{{- range $releaseVersion := $versionData.release_order }}
<td>
<a href="{{ index (index $versionData.release $releaseVersion) "components" $componentName "link" }}">
{{ index (index $versionData.release $releaseVersion) "components" $componentName "version" }}
</a>
</td>
{{- end }}
</tr>
{{- end }}
</tbody>
</table>
{{- end }}
4 changes: 2 additions & 2 deletions layouts/shortcodes/truetable.html
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
<div class="truetable">
<div class="truetable {{ .Get "class" }}">
{{ print .Inner | markdownify }}
</div>
</div>
Loading

0 comments on commit 1217ea4

Please sign in to comment.