Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

PD-1607 / 25.04 / Pd 1607 25 04 beta 1 release notes #3499

Merged
merged 27 commits into from
Feb 13, 2025
Merged
Show file tree
Hide file tree
Changes from 13 commits
Commits
Show all changes
27 commits
Select commit Hold shift + click to select a range
97f174e
Update SCALEReleaseNotes.md
DjP-iX Feb 3, 2025
6e03aed
Merge branch '25.04' into PD-1607-25-04-beta-1-release-notes
DjP-iX Feb 7, 2025
556d142
Update UseScaleShell.md
DjP-iX Feb 10, 2025
b461e34
Update SCALEReleaseNotes.md
DjP-iX Feb 10, 2025
1270ec2
Component versions redesign (#3494)
DjP-iX Feb 10, 2025
ae07334
Update SCALEReleaseNotes.md
DjP-iX Feb 10, 2025
64d81e8
Update scale-releases.yaml
DjP-iX Feb 10, 2025
a735c56
Create UpgradeNotesBoilerplate.md
DjP-iX Feb 10, 2025
49d001b
Update SCALEReleaseNotes.md
DjP-iX Feb 11, 2025
fa8b13c
Update AddingNFSShares.md
DjP-iX Feb 11, 2025
ad3562b
Update 25.04FeatureList.md
DjP-iX Feb 11, 2025
56aab9e
Feature Flags Table improvements
DjP-iX Feb 11, 2025
90fdeae
Update scale-releases.yaml
DjP-iX Feb 11, 2025
080d385
Apply review suggestions
DjP-iX Feb 11, 2025
3c24cfa
typo fix
DjP-iX Feb 11, 2025
c9de342
Update words-to-ignore.txt
DjP-iX Feb 11, 2025
f4aba90
Update custom.css
DjP-iX Feb 11, 2025
8f3c3b4
Update SCALEReleaseNotes.md
DjP-iX Feb 12, 2025
d43cf65
Merge branch '25.04' into PD-1607-25-04-beta-1-release-notes
DjP-iX Feb 12, 2025
80de272
Update words-to-ignore.txt
DjP-iX Feb 12, 2025
6808b6e
Add config restrictions
DjP-iX Feb 12, 2025
7ff551e
Update SCALEReleaseNotes.md
DjP-iX Feb 12, 2025
77538f9
Update words-to-ignore.txt
DjP-iX Feb 12, 2025
28147ac
Update SCALEReleaseNotes.md
DjP-iX Feb 12, 2025
0d0a0fb
Update SCALEReleaseNotes.md
DjP-iX Feb 12, 2025
bd39b69
Update UIConfigurationSCALE.md
Mrt134 Feb 13, 2025
4b4b885
Update SCALEReleaseNotes.md
Mrt134 Feb 13, 2025
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
66 changes: 30 additions & 36 deletions content/GettingStarted/SCALEReleaseNotes.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@

## Obtaining a Release

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

Check failure on line 21 in content/GettingStarted/SCALEReleaseNotes.md

View workflow job for this annotation

GitHub Actions / spellcheck

Misspelled word

Misspelled word "EarlyReleaseWarning". Suggested alternatives: "ReleaseScheduleWarning" If you want to ignore this message, add EarlyReleaseWarning to the ignore file at ./words-to-ignore.txt

For adventurous users that want to experiment with the latest feature development, 25.04 (Fangtooth) nightly images are available from the [the TrueNAS downloads server](https://download.truenas.com/truenas-scale-fangtooth-nightly/).

Expand All @@ -37,13 +37,7 @@

## 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" >}}

Check failure on line 40 in content/GettingStarted/SCALEReleaseNotes.md

View workflow job for this annotation

GitHub Actions / spellcheck

Misspelled word

Misspelled word "UpgradeNotesBoilerplate". Suggested alternatives: "SCALEInstallUpgradeFresh" If you want to ignore this message, add UpgradeNotesBoilerplate to the ignore file at ./words-to-ignore.txt

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

Expand Down Expand Up @@ -75,9 +69,8 @@
{{< 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 +97,60 @@
-->

## 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.
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:
### 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 ([NAS-106190](https://ixsystems.atlassian.net/browse/NAS-106190)).
Mrt134 marked this conversation as resolved.
Show resolved Hide resolved
* ZFS Fast deduplication support ([NAS-127088](https://ixsystems.atlassian.net/browse/NAS-127088)).
* 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)).

<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
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>
42 changes: 42 additions & 0 deletions static/custom.css
Original file line number Diff line number Diff line change
Expand Up @@ -1235,6 +1235,11 @@ pre.chroma {
}
.truetable tr:hover {background-color: var(--accent-color);}
.truetable tr:nth-child(even):hover {background-color: var(--accent-color)!important;}

.truetable thead tr:hover {
background-color: transparent; /* Remove hover effect from header */
}

/* Adjust for tables inside Enterprise shortcode */
.gdoc-hint.note .truenas-enterprise__text .truetable tr {background-color: rgba(134,142,150,.05);}
.gdoc-hint.note .truenas-enterprise__text .truetable tr:hover {background-color: #e6e6e6!important;}
Expand All @@ -1248,8 +1253,44 @@ pre.chroma {
width: unset;
}
/* End Adjust to prevent tables in expand elements overflowing container */

/* Adjust for additional class tn-blue */
.tn-blue table thead {
background-color: #0095d5;
color: white;
}
/* End standardized table styling */

/* Style for the container of tables with class "component-versions-table" */

/* Set background color for the top row and left column */
.component-versions-table th,
.component-versions-table td:first-child {
background-color: #0095d5;
color: white;
font-weight: 600;
}

/* Exclude the first cell (top-left) from the background color */
.component-versions-table th:first-child {
background-color: var(--body-background);
border-top: none;
border-left: none;
}

/* Highlight individual cells (excluding first column and header row) on hover */
.component-versions-table td:not(:first-child):hover {
background-color: var(--accent-color);
color: white;
}

/* Prevent header row from being highlighted on hover */
.component-versions-table thead tr:hover {
background-color: transparent; /* Ensure header row stays unaffected */
}

/* End style for the container of tables with class "component-versions-table" */

/* Standardize image styling */
.trueimg {
justify-content:center;
Expand Down Expand Up @@ -2404,6 +2445,7 @@ pre.gdoc-mermaid.mermaid.mermaid_sizing {
}
/* End style for Logo and Icon*/

/* Styling for Community Edition and Enterprise logos */
.edition-logo {
height: 24px !important;
vertical-align: middle !important;
Expand Down
4 changes: 3 additions & 1 deletion static/includes/25.04FeatureList.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,12 @@ TrueNAS 25.04 (Fangtooth) brings many new features and improvements to the TrueN

{{< columns >}}
* NFS over RDMA support (Enterprise Feature - see [Configuring the NFS Service]({{< relref "/scaletutorials/shares/addingnfsshares.md#configuring-the-nfs-service" >}}))

* iSCSI over RDMA support (Enterprise Feature)
DjP-iX marked this conversation as resolved.
Show resolved Hide resolved

* iSCSI Fibre Channel support (Enterprise Feature)
DjP-iX marked this conversation as resolved.
Show resolved Hide resolved

* Versioned TrueNAS JSON-RPC 2.0 over WebSocket API (see [API Reference]({{< relref "/API/_index.md" >}}))
* Versioned TrueNAS JSON-RPC 2.0 over WebSocket API with new and improved API documentation (see [API Reference]({{< relref "/API/_index.md" >}}))

* User-linked API Keys (see [Managing API Keys]({{< relref "/scaletutorials/toptoolbar/managingapikeys.md" >}}))

Expand Down
12 changes: 12 additions & 0 deletions static/includes/UpgradeNotesBoilerplate.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
&NewLine;

* 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" >}}

* Application maintenance, including version updates, features, and configuration options, is independent from TrueNAS version release cycles.
See the [TrueNAS Apps](https://www.truenas.com/docs/truenasapps/) documentation and the [truenas/apps](https://github.com/truenas/apps/issues) repository for more information.
Loading