Skip to content

Commit

Permalink
Merge pull request #2247 from truenas/PD-753-23-10-0-release-notes
Browse files Browse the repository at this point in the history
PD-753: 23.10.0 release notes and other specific docs changes
  • Loading branch information
ericbsd authored Oct 24, 2023
2 parents 91697af + 155818b commit 1698414
Show file tree
Hide file tree
Showing 12 changed files with 1,027 additions and 482 deletions.
34 changes: 31 additions & 3 deletions content/GettingStarted/SCALEReleaseNotes.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ weight: 10
Log in to the web interface and go to **System Settings > Update** to see an option to switch to the **TrueNAS-SCALE-Cobia-BETA** update train and begin downloading the latest BETA release.

Alternately, to download an <file>.iso</file> file or <file>.update</file> for installing or upgrading to SCALE 23.10-BETA.1 (Cobia), go to https://www.truenas.com/truenas-scale/ and click **Download**.
More details are available from [23.10 Upgrades]({{< relref "23.10Upgrades.md" >}})
More details are available from [23.10 Upgrades]({{< relref "23.10Upgrades.md" >}}).

{{< expand "Release Schedule (Click to expand)" "v" >}}

Expand Down Expand Up @@ -84,8 +84,10 @@ More details are available from [23.10 Upgrades]({{< relref "23.10Upgrades.md" >
{{< /expand >}}

* TrueCommand support for TrueNAS SCALE 23.10 (Cobia) system connections is anticipated in the TrueCommand 3.0 release.
Systems using TrueCommand clustering should not upgrade to 23.10 (Cobia) and remain on 22.12 (Bluefin) until compatible TrueCommand and SCALE versions are released at a later date.

### Upgrade Paths (Anticipated)

### Upgrade Paths

See the <a href="https://www.truenas.com/software-status/" target="_blank">TrueNAS Software Status</a> page for recommendations about which software version to use based on your user type.

Expand Down Expand Up @@ -119,7 +121,7 @@ D["23.10.0 (Cobia)"]

```mermaid
flowchart LR
A("Current 22.12 (Bluefin) release") --> B["22.12.4 (Bluefin)"] --> C["23.10.0 (Cobia)"]
A("Current 22.12 (Bluefin) release") --> B["22.12.4.2 (Bluefin)"] --> C["23.10.0 (Cobia)"]
```

{{< /columns >}}
Expand Down Expand Up @@ -159,7 +161,32 @@ 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).
For more details on zpool.features.7 see [OpenZFS zpool-feature.7](https://openzfs.github.io/openzfs-docs/man/7/zpool-features.7.html).

## 23.10.0 Changelog

**October 24, 2023**

iXsystems is pleased to release TrueNAS SCALE 23.10.0!

Notable changes:

* [SMB/NFSv4 multiprotocol sharing]({{< relref "MixedModeShares.md" >}}) of the same dataset is now supported.
* Apps screens improvements. [NAS-124339](https://ixsystems.atlassian.net/browse/NAS-124339) and [NAS-124335](https://ixsystems.atlassian.net/browse/NAS-124335)
* The **Reports Config** form is removed from the **Reporting** screen. [NAS-124345](https://ixsystems.atlassian.net/browse/NAS-124345)

<a href="https://ixsystems.atlassian.net/issues/?filter=10398" target="_blank">Click here for the full changelog</a> of completed tickets that are included in the 23.10.0 release.
{{< include file="_includes/JiraFilterInstructions.md" >}}

### 23.10.0 Ongoing Issues

* Some TrueNAS Enterprise system NICs experience a name change when upgrading from TrueNAS SCALE Bluefin to TrueNAS SCALE Cobia, preventing the NIC configuration from functioning ([NAS-124679](https://ixsystems.atlassian.net/browse/NAS-124679)).
<br>**Workaround:** If this occurs when upgrading to SCALE 23.10 (Cobia), use the SCALE web interface to manually port the configuration from the nonfunctional NIC to the entry for the newly named NIC.
When the system has a single NIC that is affected and web interface access is unavailable, connect to the system serial console and manually port the previous configuration to the newly named NIC.

<a href="https://ixsystems.atlassian.net/issues/?filter=10399" target="_blank">Click here to see the latest information</a> about issues discovered in 23.10.0 that are being resolved in a future TrueNAS SCALE release.

## 23.10-RC.1 Changelog

{{< expand "Click to Expand" "v" >}}
{{< hint type=warning title="Early Release Software" >}}
Early releases are intended for testing and early feedback purposes only.
Do not use early release software for critical tasks.
Expand Down Expand Up @@ -187,6 +214,7 @@ Notes:
When encountered, reconfigure the VM to use a UEFI BIOS to re-enable the **Display** button ([NAS-124296](https://ixsystems.atlassian.net/browse/NAS-124296)).

<a href="https://ixsystems.atlassian.net/issues/?filter=10380" target="_blank">Click here to see the latest information</a> about issues discovered in 23.10-RC.1 that are being resolved in a future TrueNAS SCALE release.
{{< /expand >}}

## 23.10-BETA.1 Changelog

Expand Down
12 changes: 1 addition & 11 deletions content/SCALETutorials/ConfigReportsScale.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,15 +22,6 @@ TrueNAS uses [netdata](https://github.com/netdata/netdata) to gather system metr
Reporting data is saved to permit viewing and monitoring usage trends over time.
This data is preserved across system upgrades and restarts.

## Configuring Report Settings
Click the <i class="material-icons" aria-hidden="true" title="Settings">settings</i> to open the **Reports Configuration** configuration screen where you control how TrueNAS displays the graphs.

![ReportsConfig](/images/SCALE/23.10/ReportsConfig.png "Reports Configuration")

Select the general options you want to use in your TrueNAS.

Click **Save**.

## TrueCommand Enhancement

To increase TrueNAS reporting functionality connect it to our TrueCommand multi-system management software.
Expand All @@ -45,5 +36,4 @@ Click on the <i class="fa fa-search-minus" aria-hidden="true"></i> icon to zoom
Click the <i class="fa fa-forward" aria-hidden="true" title="Forward"></i> to move the graph forward.
Click the <i class="fa fa-backward" aria-hidden="true" title="Backward"></i> to move the graph backward.


{{< taglist tag="scalereports" limit="10" >}}
{{< taglist tag="scalereports" limit="10" >}}
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ Select the **Read**, **Write**, and **Execute** permissions for **User**, **Grou

Select the shell for this admin user from the **Shell** dropdown list. To have **System Settings > Shell** open in the SCALE CLI, select **TrueNAS CLI**.

Select the sude authorization permissions for this admin user.
Select the sudo authorization permissions for this admin user.
Some applications, such as [Nextcloud]({{< relref "InstallNextCloudMedia.md" >}}), require sudo permissions for the administrator account.
For administrator accounts generated during the initial installation process, TrueNAS SCALE sets authorization to **Allow all sudo commands**.

Expand Down
23 changes: 6 additions & 17 deletions content/SCALEUIReference/ReportingScreensSCALE.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,21 +9,10 @@ tags:
- scalereports
---


{{< toc >}}


The **Reporting** screen displays graphs of system information for CPU, disk, memory, network, NFS, partition, target, UPS, ZFS, and system functions. The **CPU** report displays by default.

The <i class="material-icons" aria-hidden="true" title="Settings">settings</i> opens the **[Reports Config](#reports-config-screen)** configuration screen.

## Reports Configuration Screen
**Reports Config** settings specify how TrueNAS displays the graphs and the host name of the Graphite server.

![ReportsConfig](/images/SCALE/23.10/ReportsConfig.png "Reports Config")

{{< include file="content/_includes/SystemReportingFields.md" >}}

## Reporting Screen Display Options

{{< truetable >}}
Expand All @@ -41,7 +30,7 @@ The <i class="material-icons" aria-hidden="true" title="Settings">settings</i> o
The following sections provide examples of each report graph.
### CPU Graphs
{{< expand "Click Here for More Information" "v" >}}
[CPU](https://collectd.org/wiki/index.php/Plugin:CPU) graphs show the amount of time spent by the CPU in various states such as executing user code, executing system code, and being idle.
CPU graphs show the amount of time spent by the CPU in various states such as executing user code, executing system code, and being idle.
Graphs of short-, mid-, and long-term load are shown, along with CPU temperature graphs.

![CPUReportingUsageTemp](/images/SCALE/23.10/CPUReportingUsageTemp.png "CPU Reporting Usage and Temperature")
Expand All @@ -51,7 +40,7 @@ Graphs of short-, mid-, and long-term load are shown, along with CPU temperature
{{< /expand >}}
### Disk Graphs
{{< expand "Click Here for More Information" "v" >}}
[Disk](https://collectd.org/wiki/index.php/Plugin:Disk) graphs shows read and write statistics on I/O, percent busy, latency, operations per second, pending I/O requests, and disk temperature.
Disk graphs shows read and write statistics on I/O, percent busy, latency, operations per second, pending I/O requests, and disk temperature.
Use the **Select Disks** dropdown list to select the disks and the **Select Reports** dropdown to select the report types to display.

![DiskReportingIO](/images/SCALE/23.10/DiskReportingIO.png "Disks Reporting I/O")
Expand Down Expand Up @@ -80,29 +69,29 @@ For example, a system with 18,446,744,073,709,551,615 bytes reports the number a
{{< /expand >}}
### Memory Graphs
{{< expand "Click Here for More Information" "v" >}}
[Memory](https://collectd.org/wiki/index.php/Plugin:Memory) graphs display memory usage and [swap](https://collectd.org/wiki/index.php/Plugin:Swap) graphs display the amount of free and used swap space.
Memory graphs display memory usage and swap graphs display the amount of free and used swap space.

![MemoryReportingPhysSwap](/images/SCALE/23.10/MemoryReportingPhysSwap.png "Memory Reporting Physical and Swap")

{{< /expand >}}
### Network Graphs
{{< expand "Click Here for More Information" "v" >}}
[Network](https://collectd.org/wiki/index.php/Plugin:Interface) graph report received and transmitted traffic in megabytes per second for each configured interface.
Network graph report received and transmitted traffic in megabytes per second for each configured interface.

![NetworkReportingIntTraffic](/images/SCALE/23.10/NetworkReportingIntTraffic.png "Network Reporting")

{{< /expand >}}
### System Graphs
{{< expand "Click Here for More Information" "v" >}}
[System](https://collectd.org/wiki/index.php/Plugin:Processes) graphs display the number of processes grouped by state, sleeping, running, stopped, zombies and blocked, and system uptime.
System graphs display the number of processes grouped by state, sleeping, running, stopped, zombies and blocked, and system uptime.

![SystemReportingProcessUptime](/images/SCALE/23.10/SystemReportingProcessUptime.png "System Reporting")

{{< /expand >}}

### ZFS Graphs
{{< expand "Click Here for More Information" "v" >}}
[ZFS](https://collectd.org/wiki/index.php/Plugin:ZFS_ARC) graphs show compressed physical ARC size, hit ratio, demand data, demand metadata, and prefetch data and metadata.
ZFS graphs show compressed physical ARC size, hit ratio, demand data, demand metadata, and prefetch data and metadata.

![ZFSReportingARCSizeHit](/images/SCALE/23.10/ZFSReportingActualHitsHitsRate.png "ZFS Reporting ARC Actual Cache Hits Rate and and ARC Hit Rate")

Expand Down
14 changes: 5 additions & 9 deletions content/_includes/23.10FeatureList.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,9 @@ There are many new features and continued improvements to the TrueNAS SCALE expe

* Drive count optimizations: SCALE 23.10 allows up to **1255** disks, or more than **25PB** under management on a single system.

* Samba update and speed improvements
* Samba update and speed improvements.

* SMB/NFSv4 multiprotocol dataset sharing.

* Simplified feedback and bug reporting.

Expand All @@ -34,14 +36,8 @@ There are many new features and continued improvements to the TrueNAS SCALE expe

* ZFS dRAID Pool Layouts.

* Simplified SMB cluster expansion via TrueCommand (Coming Soon!).

* Importing of SMB shares from other systems (Coming Soon!).

{{< /columns >}}





* Simplified SMB cluster expansion via TrueCommand is planned with the release of TrueCommand 3.0 (Coming Soon!).

{{< /columns >}}
4 changes: 2 additions & 2 deletions content/_includes/AlertsCategories.md
Original file line number Diff line number Diff line change
Expand Up @@ -102,12 +102,12 @@ You can customize alert settings for when ports are not active on the LAGG inter

### Reporting

**Reporting** alert settings apply to collectd, database size threshold, and syslog processes on your TrueNAS.
**Reporting** alert settings apply to netdata, database size threshold, and syslog processes on your TrueNAS.
{{< expand "Click here for more information" >}}

![AlertSettingsReporting](/images/SCALE/22.12/AlertSettingsReporting.png "Reporting Alert Settings")

You can customize alert settings for when collectd has critical alerts and warnings, the reporting database size exceeds the threshold, and syslog-ng is not running.
You can customize alert settings for when netdata has critical alerts and warnings, the reporting database size exceeds the threshold, and syslog-ng is not running.
{{< /expand >}}

### Sharing
Expand Down
4 changes: 4 additions & 0 deletions content/_includes/JiraFilterInstructions.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
&NewLine;

To switch between detail and list views for the changelog, press `t`.
Open the changelog in Jira to see the <span class="iconify" data-icon="mdi:export-variant"></span> **Export** menu to print or download the changelog in various file formats.
9 changes: 0 additions & 9 deletions content/_includes/SystemReportingFields.md

This file was deleted.

10 changes: 0 additions & 10 deletions layouts/partials/page-header.html
Original file line number Diff line number Diff line change
Expand Up @@ -56,13 +56,3 @@
</div>
{{ end }}
</div>

<!-- Update this warning for RC.1 and remove this warning when 23.10.0 is released -->
<blockquote class="gdoc-hint important">
<div class="gdoc-hint__title flex align-center">
<span class="iconify" data-icon="mdi:alert-circle-outline" style="align-items:center;margin-bottom:2px;margin-right:2px;"></span><span>Early Release Software: 23.10-RC.1</span>
</div>
<div class="gdoc-hint__text">
Early releases are intended for testing and early feedback purposes only.
Do not use early release software for critical tasks.</div>
</blockquote>
2 changes: 1 addition & 1 deletion static/api/scale_rest_api.html
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
<div id="root" class="swagger-ui" />
<script>
const ui = SwaggerUIBundle({
url: 'https://www.truenas.com/docs/files/scale_23.10-rc.1_apiv2.json',
url: 'https://www.truenas.com/docs/files/scale_23.10.0_apiv2.json',
dom_id: '#root'
});
</script>
Expand Down
Loading

0 comments on commit 1698414

Please sign in to comment.