Skip to content

Commit

Permalink
Merge branch 'master' into PD-1135-Add-Enclosure-Options-to-Pool-Crea…
Browse files Browse the repository at this point in the history
…tion-Wizard
  • Loading branch information
tonyriv3 authored Aug 28, 2024
2 parents 75748a2 + cabf33d commit 0261015
Show file tree
Hide file tree
Showing 121 changed files with 514 additions and 458 deletions.
30 changes: 15 additions & 15 deletions content/Archive.md
Original file line number Diff line number Diff line change
Expand Up @@ -58,20 +58,20 @@ Documentation for previous releases, that are no longer recommended for any user
All documentation provided here is end-of-life (EoL), intended for reference only, and no longer receives *any* updates.
{{< /hint >}}

Software releases after TrueNAS SCALE 22.12 (Bluefin) are available as navigable website branches.
Software releases after TrueNAS 22.12 (Bluefin) are available as navigable website branches.
Earlier releases are available only in PDF.

## TrueNAS SCALE

{{< expand "TrueNAS SCALE 22.12 (Bluefin)" "v" >}}
[TrueNAS SCALE 22.12 (Bluefin)](https://www.truenas.com/docs/scale/22.12/)
{{< expand "TrueNAS 22.12 (Bluefin)" "v" >}}
[TrueNAS 22.12 (Bluefin)](https://www.truenas.com/docs/scale/22.12/)

Release notes for each minor release of 22.12 are available in the [SCALE 22.12 Bluefin Release Notes](https://www.truenas.com/docs/scale/22.12/gettingstarted/scalereleasenotes/).
{{< /expand >}}

{{< expand "TrueNAS SCALE 22.02 (Angelfish)" "v" >}}
{{< expand "TrueNAS 22.02 (Angelfish)" "v" >}}
Release notes for each minor release of 22.02 Angelfish are included in the archived docs.
<a href="https://www.truenas.com/docs/files/SCALE22.02Docs.pdf">TrueNAS SCALE 22.02 (Angelfish)</a>
<a href="https://www.truenas.com/docs/files/SCALE22.02Docs.pdf">TrueNAS 22.02 (Angelfish)</a>
{{< /expand >}}

## TrueNAS CORE
Expand All @@ -84,16 +84,16 @@ Some TrueNAS M-Series systems installed with 12.0 releases with some 16GB 2666mh
![NvdimmFirmwareAlert](/images/CORE/Dashboard/NvdimmFirmwareAlert.png "NVDIMM Firmware Alert")

This can be a false positive that has been fixed in TrueNAS 13.0-U1 (see [NAS-116986](https://ixsystems.atlassian.net/browse/NAS-116986)).
Upgrading to an Enterprise-recommended release of TrueNAS CORE 13.0 resolves this alert.
To help determine if the deployment is ready to upgrade to TrueNAS CORE 13.0, please refer to the current TrueNAS [Software Status](https://www.truenas.com/software-status/) and, when your use case matches a recommended 13.0 release, contact iXsystems Support to schedule an upgrade.
Upgrading to an Enterprise-recommended release of TrueNAS 13.0 resolves this alert.
To help determine if the deployment is ready to upgrade to TrueNAS 13.0, please refer to the current TrueNAS [Software Status](https://www.truenas.com/software-status/) and, when your use case matches a recommended 13.0 release, contact iXsystems Support to schedule an upgrade.
{{< expand "Contacting iX Support" >}}
{{< include file="/static/includes/iXsystemsSupportContact.md" >}}
{{< /expand >}}
{{< /hint >}}

{{< expand "TrueNAS CORE 12.0" "v" >}}
{{< expand "TrueNAS 12.0" "v" >}}

<a href="https://www.truenas.com/docs/files/CORE12.0Docs.pdf">TrueNAS CORE 12.0</a>
<a href="https://www.truenas.com/docs/files/CORE12.0Docs.pdf">TrueNAS 12.0</a>

Release Notes:
* [12.0-U8.1]({{< ref "/_archive/COREReleaseNotes/12.0/12.0U8.1.md" >}})
Expand Down Expand Up @@ -269,8 +269,8 @@ Notices:

### Legacy TrueNAS

{{< expand "TrueNAS CORE 11.3" "v" >}}
<a href="https://www.truenas.com/docs/files/TrueNAS-11.3-U5-User-Guide.pdf">TrueNAS CORE 11.3</a></li>
{{< expand "TrueNAS 11.3" "v" >}}
<a href="https://www.truenas.com/docs/files/TrueNAS-11.3-U5-User-Guide.pdf">TrueNAS 11.3</a></li>

11.3 Release Notes:
* [11.3-U5]({{< ref "/_archive/COREReleaseNotes/TrueNAS/11.3/11.3U5.md" >}})
Expand All @@ -282,9 +282,9 @@ Notices:
* [11.3-RC1]({{< ref "/_archive/COREReleaseNotes/TrueNAS/11.3/11.3RC1.md" >}})

{{< /expand >}}
{{< expand "TrueNAS CORE 11.2" "v" >}}
{{< expand "TrueNAS 11.2" "v" >}}

<a href="https://www.ixsystems.com/documentation/truenas/11.2-U8-legacy/TrueNAS-11.2-U8-Legacy-User-Guide_screen.pdf">TrueNAS CORE 11.2</a>
<a href="https://www.ixsystems.com/documentation/truenas/11.2-U8-legacy/TrueNAS-11.2-U8-Legacy-User-Guide_screen.pdf">TrueNAS 11.2</a>

11.2 Release Notes:
* [11.2-U8.1]({{< ref "/_archive/COREReleaseNotes/TrueNAS/11.2/11.2U8.1.md" >}})
Expand All @@ -296,9 +296,9 @@ Notices:
* [11.2-U5]({{< ref "/_archive/COREReleaseNotes/TrueNAS/11.2/11.2U5.md" >}})

{{< /expand >}}
{{< expand "TrueNAS CORE 11.1" "v" >}}
{{< expand "TrueNAS 11.1" "v" >}}

<a href="https://www.ixsystems.com/documentation/truenas/11.1/TrueNAS.pdf">TrueNAS CORE 11.1</a>
<a href="https://www.ixsystems.com/documentation/truenas/11.1/TrueNAS.pdf">TrueNAS 11.1</a>

11.1 Release Notes:
* [11.1-U7.1]({{< ref "/_archive/COREReleaseNotes/TrueNAS/11.1/11.1U7.1.md" >}})
Expand Down
6 changes: 3 additions & 3 deletions content/CORE/API/_index.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "CORE API Reference"
description: "Describes how to access the API documentation in TrueNAS CORE."
title: "API Reference"
description: "Describes how to access the API documentation in TrueNAS 13."
geekdocCollapseSection: true
weight: 160
aliases:
Expand All @@ -9,7 +9,7 @@ aliases:
related: false
---

TrueNAS CORE API documentation is available from the web interface by clicking **<i class="material-icons" aria-hidden="true" title="Settings">settings</i>&nbsp;> API Keys > DOCS**.
TrueNAS API documentation is available from the web interface by clicking **<i class="material-icons" aria-hidden="true" title="Settings">settings</i>&nbsp;> API Keys > DOCS**.

![SettingsAPIKeys](/images/CORE/Settings/SettingsAPIKeysDocsButton.png "API Docs location")

Expand Down
2 changes: 1 addition & 1 deletion content/CORE/CORETutorials/DirectoryServices/LDAP.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ See [Kerberos]({{< relref "/CORE/CORETutorials/DirectoryServices/Kerberos.md" >}
To configure LDAP certificate-based authentication for the LDAP provider to sign, see [Certificate Signing Requests]({{< relref "CORE/CORETutorials/SystemConfiguration/CreatingCAsandCertificates/CreatingCertificates.md" >}}).

{{< hint type=important >}}
Support for LDAP **Samba Schema** is deprecated in TrueNAS CORE 13.0 or later.
Support for LDAP **Samba Schema** is deprecated in TrueNAS 13.0 or later.
Users with LDAP and SMB shares configured should begin to migrate legacy Samba domains to Active Directory.
{{< /hint >}}

Expand Down
2 changes: 1 addition & 1 deletion content/CORE/CORETutorials/Sharing/SMB/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,7 @@ It is not required to access an SMB server.

{{< expand "What about LDAP users?" "v" >}}
{{< hint type=important >}}
Support for LDAP **Samba Schema** is deprecated in TrueNAS CORE 13.0 or later.
Support for LDAP **Samba Schema** is deprecated in TrueNAS 13.0 or later.
Users with LDAP and SMB shares configured should begin to migrate legacy Samba domains to Active Directory.
{{< /hint >}}

Expand Down
4 changes: 2 additions & 2 deletions content/CORE/CoreSecurityReports/SMB1Advisory.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "SMB1 Security Advisory"
description: "Contains advisory information on the deprecated SMB1 file-sharing protocol and TrueNAS CORE."
description: "Contains advisory information on the deprecated SMB1 file-sharing protocol."
weight: 10
---

Expand All @@ -12,6 +12,6 @@ Microsoft maintains a list of [older products that still require SMB1](https://b

Windows Explorer (File Explorer) does not need SMB1, or a separate protocol called NetBIOS (sometimes called "NetBIOS over TCP/IP"), to discover and list SMB shares from a TrueNAS server. All modern versions of Windows use a newer protocol called WS-Discovery, which is more reliable and faster. TrueNAS automatically enables WS-Discovery to allow discovery of SMB shares by client devices.

**Do not enable SMB1 on FreeNAS or TrueNAS without understanding the security implications and taking measures to protect the network from those risks.** Contact the vendor of older products for upgrades to support newer, more secure versions of SMB, or replace older products with ones that do not require the security risks of SMB1.
**Do not enable SMB1 on TrueNAS without understanding the security implications and taking measures to protect the network from those risks.** Contact the vendor of older products for upgrades to support newer, more secure versions of SMB, or replace older products with ones that do not require the security risks of SMB1.

**Do not enable SMB1** unless it is absolutely required for essential equipment that cannot be upgraded or replaced, the security implications are understood, and steps have been taken to protect the network from those security risks.
2 changes: 1 addition & 1 deletion content/CORE/UIReference/DirectoryServices/LDAPScreen.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ Click **REBUILD DIRECTORY SERVICE CACHE** to resync the cache if it becomes out
{{< /truetable >}}

{{< hint type=important >}}
Support for LDAP **Samba Schema** is deprecated in TrueNAS CORE 13.0 or later.
Support for LDAP **Samba Schema** is deprecated in TrueNAS 13.0 or later.
Users with LDAP and SMB shares configured should begin to migrate legacy Samba domains to Active Directory.
{{< /hint >}}

Expand Down
4 changes: 2 additions & 2 deletions content/Contributing/Documentation/ContentUpdate.md
Original file line number Diff line number Diff line change
Expand Up @@ -78,10 +78,10 @@ TrueNAS documentation uses branches to organize content related to specific soft
Do not make changes directly to the TrueNAS **master** branch of the Documentation Hub repository.

+ To make content changes in the ***24.04*** branch, select the ***24.04*** as the **base**, then create a fork of that main repository.
This ensures approved modifications are added to the TrueNAS SCALE 24.04 (Dragonfish) Documentation content.
This ensures approved modifications are added to the TrueNAS 24.04 (Dragonfish) Documentation content.

+ To make content changes in the ***23.10*** branch, select the ***23.10*** as the **base**, then create a fork of that main repository.
This ensures that approved modifications are added to the TrueNAS SCALE 23.10 (Cobia) Documentation content.
This ensures that approved modifications are added to the TrueNAS 23.10 (Cobia) Documentation content.

## Fork the Repo
To submit a change or a new article, create a *fork* (local copy) of the main repository, edit your local copy, and then propose merging your changes back into the main repository.
Expand Down
2 changes: 1 addition & 1 deletion content/Contributing/IssueReporting/JiraIssueReporting.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ Enter specific issue details in the **Description** field.

![JiraSummaryDescription](/images/Contribute/JiraSummaryDescription.png "Summary and Description Field")

Select the CORE or SCALE release from the **Affects Version** dropdown list. If you cannot locate the version of software installed on the dropdown list, include it in the **Description** field.
Select a TrueNAS release from the **Affects Version** dropdown list. If you cannot locate the version of software installed on the dropdown list, include it in the **Description** field.

A good bug report includes these elements:

Expand Down
2 changes: 1 addition & 1 deletion content/Contributing/IssueReporting/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ related: false
{{< include file="/static/includes/ProposeArticleChange.md" >}}
{{< /hint >}}

We encourage all users to help us make the open source TrueNAS project the best NAS by reporting issues with CORE or SCALE releases, requesting potentially helpful features, and relaying security vulnerabilities.
We encourage all users to help us make the open source TrueNAS project the best NAS by reporting issues with TrueNAS releases, requesting potentially helpful features, and relaying security vulnerabilities.

The articles listed below provide information on reporting issues or to request changes or new content.

Expand Down
2 changes: 1 addition & 1 deletion content/Hardware/MSeries.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ keywords:
icon1="IconTrueNAS.png" cell1title="The Industry’s Fastest ZFS Storage is now Upgradeable" cell1text="Best for: Larger Projects / Enterprise, Virtualization, File Share, Backup."
icon2="IconSpeed.png" cell2title="Over 20 GB/s & 1 Million IOPS" cell2text="10,000+ VMs, and thousands of SMB/NFS Clients. Up to 64 Cores, 1.5 TB RAM, 4 NVDIMMs."
icon3="IconHA.png" cell3title="Maximum Storage Density with HA" cell3text="Up to 20 PB capacity, 8 PB All-Flash Capacity in a Rack. Fusion pools (with NVMe) increase performance."
icon4="IconGraph.png" cell4title="Upgradeable with Common Chassis" cell4text="In-service Upgrades to M40, M50 and M60. Compatible with TrueNAS CORE or SCALE." >}}
icon4="IconGraph.png" cell4title="Upgradeable with Common Chassis" cell4text="In-service Upgrades to M40, M50 and M60." >}}

Visit the [M Series product page](https://www.truenas.com/m-series/) for more details.

Expand Down
2 changes: 1 addition & 1 deletion content/Hardware/Notices/WDSMR.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ At least one of the WD Red DM-SMR models (the 4TB WD40EFAX with firmware rev 82.
In the faulty state, the WD Red DM-SMR drive returns IDNF errors, becomes unusable, and is treated as a drive failure by ZFS. In this state, data on that drive can be lost. Data within a vdev or pool can be lost if multiple drives fail.
ZFS incompatibility causing drive failure is a rare event. While we have shipped approximately one hundred FreeNAS Mini systems with the DM-SMR 2TB and 6TB drives, we have had only one reported issue. More testing will be done to understand the ZFS compatibility issues and how to avoid them.
Of iXsystems products, the FreeNAS Mini Series is the only product line that uses WD Red drives. Most of the FreeNAS Mini systems shipped have not used DM-SMR drives. Only systems shipped with 2TB or 6TB drives since September 2019 may have the DM-SMR drives.
Both iXsystems and Western Digital treat data loss as a serious event. We will be doing more work with them to identify and resolve the drive ZFS compatibility issue. Any solution will then be validated with some heavy ZFS workloads with FreeNAS 11.3 and TrueNAS CORE 12.0 before we report back to the community. Follow [Western Digital’s blog](https://blog.westerndigital.com/wd-red-nas-drives/) for more information.
Both iXsystems and Western Digital treat data loss as a serious event. We will be doing more work with them to identify and resolve the drive ZFS compatibility issue. Any solution will then be validated with some heavy ZFS workloads with FreeNAS 11.3 and TrueNAS 12.0 before we report back to the community. Follow [Western Digital’s blog](https://blog.westerndigital.com/wd-red-nas-drives/) for more information.
Any existing systems with these drives should have a backup strategy, as should all systems with valuable data. If anyone experiences the IDNF errors with FreeNAS, please [contact us](https://www.ixsystems.com/contact-us/) and we will advise on how best to handle the situation. Any FreeNAS Mini users will be covered under the standard warranty. There will be more communication when we understand how best to mitigate or resolve the ZFS compatibility issues.

In the meantime, iXsystems will not ship Minis with the impacted WD Red DM-SMR drives. We will instead be using other WD Red drives or WD Red Pro drives. None of the Mini systems available on Amazon use these DM-SMR drives. It is also recommended that the FreeNAS community avoid using these WD Red DM-SMR drives in their own FreeNAS builds until further information is available.
Expand Down
2 changes: 1 addition & 1 deletion content/References/dRAIDprimer.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ tags:
- storage
---

Introduced in OpenZFS version 2.1.0 and initially supported in TrueNAS SCALE 23.10 (Cobia), declustered RAID (dRAID) is an alternate method for creating OpenZFS data virtual devices (vdevs).
Introduced in OpenZFS version 2.1.0 and initially supported in TrueNAS 23.10 (Cobia), declustered RAID (dRAID) is an alternate method for creating OpenZFS data virtual devices (vdevs).

Intended for storage arrays with numerous attached disks (>100), the primary benefit of a dRAID vdev layout is to reduce resilver times.
It does this by building the dRAID vdev from multiple internal raid groups that have their own data and parity devices, using precomputed permutation maps for the rebuild IO, and using a fixed stripe width that fills storage capacity with zeroes when necessary.
Expand Down
6 changes: 3 additions & 3 deletions content/SCALE/GettingStarted/DataMigrationSyncthing.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,16 +17,16 @@ keywords:
- Enterprise NAS storage
---

Users of TrueNAS SCALE 24.04 (Dragonfish) or newer can migrate data from a third-party NAS solution onto TrueNAS SCALE using the [Syncthing Enterprise application]({{< relref "/scale/scaletutorials/apps/enterpriseapps/syncthing.md" >}}).
Users of TrueNAS 24.04 (Dragonfish) or newer can migrate data from a third-party NAS solution onto TrueNAS SCALE using the [Syncthing Enterprise application]({{< relref "/scale/scaletutorials/apps/enterpriseapps/syncthing.md" >}}).
The Syncthing Enterprise application can mount remote SMB shares in a manner that preserves relevant metadata.
TrueNAS SCALE 24.10 (Electric Eel) also adds migration support for SMB alternate data streams (ADS), used to store application-specific metadata.
TrueNAS 24.10 (Electric Eel) also adds migration support for SMB alternate data streams (ADS), used to store application-specific metadata.

{{< expand "Syncthing Overview" "v" >}}
{{< include file="/static/includes/SyncthingOverview.md" >}}
{{< /expand >}}

{{< enterprise >}}
Third-party data ingest is available to TrueNAS Enterprise customers with TrueNAS SCALE 24.04 (Dragonfish) and newer deployed, as well as the appropriate applications license.
Third-party data ingest is available to TrueNAS Enterprise customers with TrueNAS 24.04 (Dragonfish) and newer deployed, as well as the appropriate applications license.
iXsystems Support staff are available to assist with deploying the Syncthing Enterprise Application and migrating data.
Please contact iXsystems Support to learn more and schedule a time to deploy the app and begin migration.

Expand Down
2 changes: 1 addition & 1 deletion content/SCALE/GettingStarted/Install/InstallingSCALE.md
Original file line number Diff line number Diff line change
Expand Up @@ -148,7 +148,7 @@ Slots available for boot differs by hardware. For optimal performance, consider

#### Using the TrueNAS Installer
{{< hint type=important >}}
If you are doing a clean install from the SCALE <kbd>.iso</kbd> file as part of migrating from a different version of TrueNAS CORE or SCALE, or to recover from a serious issue that requires you to re-install SCALE from the <kbd>.iso</kbd>, have your network configuration information ready to use after the installation completes.
If you are doing a clean install from the SCALE <kbd>.iso</kbd> file as part of migrating from a different TrueNAS version, or to recover from a serious issue that requires you to re-install SCALE from the <kbd>.iso</kbd>, have your network configuration information ready to use after the installation completes.
Also have your SCALE system configuration file and data backups handy, so you can recover your system settings and import your data into the recovered SCALE clean-install system.
{{< /hint >}}

Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "ZFS Feature Flags Removed"
description: "Provides legacy information for users of a deprecated ZFS feature flag merged into TrueNAS SCALE 22.02 and removed in 22.12."
description: "Provides legacy information for users of a deprecated ZFS feature flag merged into TrueNAS 22.02 and removed in 22.12."
weight: 40
aliases:
- /scale/notices/scalezfsflagremoval/
Expand Down
2 changes: 1 addition & 1 deletion content/SCALE/GettingStarted/SCALEReleaseNotes.md
Original file line number Diff line number Diff line change
Expand Up @@ -128,7 +128,7 @@ Do not use early-release software for critical tasks.
**August 29, 2024**
iXsystems is pleased to release TrueNAS SCALE 24.10-BETA.1!
iXsystems is pleased to release TrueNAS 24.10-BETA.1!
This has software component updates and new features that are in the polishing phase.
Notable changes:
Expand Down
Loading

0 comments on commit 0261015

Please sign in to comment.