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

Backport Resilvering Updates to 13.3 #2704

Merged
merged 9 commits into from
May 1, 2024
Merged
Show file tree
Hide file tree
Changes from 8 commits
Commits
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
14 changes: 2 additions & 12 deletions content/CORETutorials/Tasks/UsingResilverPriority.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,18 +7,8 @@ tags:
- resilver
---

Resilvering is a process that copies data to a replacement disk. You should complete it as quickly as possible.
Increasing the priority of resilvers helps them finish faster.
The **Resilver Priority** menu allows you to schedule when a resilver can become a higher priority for the system.
You should schedule resilvers when the additional I/O or CPU use does not affect normal usage.

Go to **Tasks > Resilver Priority** to configure the priority to the best time for your environment.
{{< include file="/static/includes/ResilverPriority.md" >}}

![TasksResilverPriority](/images/CORE/Tasks/TasksResilverPriority.png "Scheduling Resilver Priority Times")

Set **Enabled**, then use the drop-down menus to select a **Begin** and **End** time and what days of the week you want the priority to run.

{{< hint type=note >}}
A resilver process running during the time frame defined between "Begin Time" and "End Time" will likely work faster.
We advise you avoid putting the system under any intensive activity or heavy loads (replications, SMB transfers, NFS transfers, Rsync transfers, S.M.A.R.T. tests, pool scrubs, etc) during a resilver process.
{{< /hint >}}
{{< include file="/static/includes/ResilverPrioritySetWhen.md" >}}
6 changes: 3 additions & 3 deletions content/GettingStarted/SharingStorage.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ Click <i class="fa fa-ellipsis-v" aria-hidden="true" title="Options"></i> and *E

![StoragePoolsEditACL](/images/CORE/Storage/StoragePoolsEditACL.png "Editing SMB dataset permissions")

Click *SELECT AN ACL PRESET*, open the drop down, and choose *OPEN*.
Click *SELECT AN ACL PRESET*, open the dropdown, and choose *OPEN*.
Click *SAVE*.

### Create the Share
Expand All @@ -39,7 +39,7 @@ Go to **Sharing > Windows Shares (SMB)** and click *ADD*.

Only the *Path* and *Name* are initially required.
The *Path* is the directory tree on TrueNAS that is shared using the SMB protocol.
The *Name* forms part of the "full share pathname" when SMB clients connect.
The *Name* forms part of the "full share path name" when SMB clients connect.

![SharingSMBAddBasicExample](/images/CORE/Sharing/SharingSMBAddBasicExample.png "SMB Share Example")

Expand Down Expand Up @@ -107,5 +107,5 @@ A simple configuration is beyond the scope of this getting started guide, but de
{{< /tab >}}
{{< /tabs >}}

With simple sharing done, TrueNAS is now installed, accessible, and capable to receive or share data over your network.
With simple sharing done, TrueNAS is now installed, accessible, and able to receive or share data over your network.
Now it is time to protect the TrueNAS storage by setting up [data backups]({{< relref "DataBackups.md" >}}).
20 changes: 10 additions & 10 deletions content/UIReference/ReportingGraphs.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ tags:
- reporting
---

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

{{< expand "What does TrueNAS use for reporting?" "v" >}}
TrueNAS uses [Graphite](https://graphiteapp.org/ "Graphite Homepage") for metric gathering and visualizations.
Expand Down Expand Up @@ -35,7 +35,7 @@ Because reporting data is frequently written it should not be stored on the boot
| **Disk** | Displays graphs for each disk in the system. |
| **Memory** | Displays both the **Physical memory utilization** and **Swap utilization** graphs. |
| **Network** | Displays an **Interface Traffic** graph for each interface in the system. |
| **NFS** | Displays the **NFS Stats (Operations)** and **NFS Stats (Byptes)** graphs. |
| **NFS** | Displays the **NFS Stats (Operations)** and **NFS Stats (Bytes)** graphs. |
| **Partition** | Displays graphs showing disk space allocations. |
| **System** | Displays both the **Processes** and **Uptime** graphs. |
| **Target** | Displays graphs only for systems with iSCSI ports configured and shows the bandwidth statistics for iSCSI ports. |
Expand All @@ -53,14 +53,14 @@ Click the <i class="fa fa-backward" aria-hidden="true" title="Backward"></i> to

## Graphs
{{< expand "CPU Graphs" "v" >}}
[CPU](https://collectd.org/wiki/index.php/Plugin:CPU) graphs shows the amount of time spent by the CPU in various states such as executing user code, executing system code, and being idle.
[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.
Graphs of short-, mid-, and long-term load are shown, along with CPU temperature graphs.

![ReportingCPUTab](/images/CORE/Reporting/ReportingCPUTab.png "CPU Reporting")

{{< /expand >}}
{{< expand "Disk Graphs" "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](https://collectd.org/wiki/index.php/Plugin:Disk)graphs show read and write statistics on I/O, percent busy, latency, operations per second, pending I/O requests, and disk temperature.
Use the **Devices** dropdown list to select one or all system disks for which you want to display a graph. Use the **Metrics** dropdown list to select one or all disk measurements to display.

![ReportingDisksTab](/images/CORE/Reporting/ReportingDisksTab.png "Disks Reporting")
Expand All @@ -71,10 +71,10 @@ Use the **Devices** dropdown list to select one or all system disks for which yo
| Setting | Description |
|---------|-------------|
| **Select All** | Displays all available graphs for any or all disks selected on the **Devices** dropdown list. |
| **Disk Temperature** | Diplays the minimum, maximum and mean temperature reading for the disk selected. |
| **Disk Busy** | Displays the percent the selected disk is busy. |
| **Disk Temperature** | Displays the minimum, maximum, and mean temperature readings for the disk selected. |
| **Disk Busy** | Displays what percentage of the selected disk is busy. |
| **Disk Latency** | Displays the disk latency in time (msec) for read, write and delete operations. |
| **Disk Operations detailed** | Displays the read, write and delete operations for the selected disk. |
| **Disk Operations detailed** | Displays the read, write, and delete operations for the selected disk. |
| **Pending I/O** | Displays then length of pending I/O requests for the selected disk. |
| **Disk I/O** | Displays the disk read and write I/O stats in bytes/s. |
{{< /truetable >}}
Expand Down Expand Up @@ -103,13 +103,13 @@ Temperature monitoring for the disk is disabled if **HDD Standby** is enabled. C
{{< /expand >}}
{{< expand "Partition Graphs" "v" >}}

[Partition](https://collectd.org/wiki/index.php/Plugin:DF) graphs displays free, used, and reserved space for each pool and dataset. However, the disk space used by an individual zvol is not displayed as it is a block device.
[Partition](https://collectd.org/wiki/index.php/Plugin:DF) graphs display free, used, and reserved space for each pool and dataset. However, the disk space used by an individual zvol is not displayed as it is a block device.

![ReportingPartitionTab](/images/CORE/Reporting/ReportingPartitionTab.png "Partition Reporting")

{{< /expand >}}
{{< expand "System Graphs" "v" >}}
[System](https://collectd.org/wiki/index.php/Plugin:Processes) graphs displays the number of processes. It is grouped by state.
[System](https://collectd.org/wiki/index.php/Plugin:Processes) graphs display the number of processes. It is grouped by state.

![ReportingSystemTab](/images/CORE/Reporting/ReportingSystemTab.png "System Reporting")

Expand All @@ -126,7 +126,7 @@ Temperature monitoring for the disk is disabled if **HDD Standby** is enabled. C

{{< /expand >}}
{{< expand "ZFS Graphs" "v" >}}
[ZFS](https://collectd.org/wiki/index.php/Plugin:ZFS_ARC) graphs shows compressed physical ARC size, hit ratio, demand data, demand metadata, and prefetch data.
[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.

![ReportingZFSTab](/images/CORE/Reporting/ReportingZFSTab.png "ZFS Reporting")

Expand Down
12 changes: 6 additions & 6 deletions content/UIReference/Storage/SnapshotsScreen.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,9 @@ Use the **Storage > Snapshots** screens to create and manage snapshots on your T

![StorageSnapshotsScreen](/images/CORE/Storage/StorageSnapshotsScreen.png "Stprage Snapshots Screen")

Use the <span class="iconify" data-icon="ci:settings-filled"></span> to display the **Show Extra Columns** dialog, and after clickng **SHOW**, the **Snapshot** screen changes to dipslay the blue **COLUMNS** button with options to modify the table information.
Use the <span class="iconify" data-icon="ci:settings-filled"></span> to display the **Show Extra Columns** dialog, and after clicking **SHOW**, the **Snapshot** screen changes to display the blue **COLUMNS** button with options to modify the table information.
It also changes the individual snapshots listed to show the individual snapshot action options from the <span class="material-icons">more_vert</span> rather than the <span class="material-icons">navigate_next</span> expand symbol that, after clicking on it, expands the selected snapshot to show details with the action options on the bottom of the expanded view of the snapshot.
To return to the previous display click the <span class="iconify" data-icon="ci:settings-filled"></span> to display the **Hide Extra Columns** dialog, and after clickng **HIDE**, the blue **COLUMNS** button no longer displays and the list of snapshots displays the <span class="material-icons">navigate_next</span> expand symbol.
To return to the previous display click the <span class="iconify" data-icon="ci:settings-filled"></span> to display the **Hide Extra Columns** dialog, and after clicking **HIDE**, the blue **COLUMNS** button no longer displays and the list of snapshots displays the <span class="material-icons">navigate_next</span> expand symbol.

Use **ADD** to display the **Snapshot > Add** screen.

Expand All @@ -33,7 +33,7 @@ Use **SUBMIT** to save settings.
Use **CANCEL** to exit without saving and display the **Snapshots** screen.

## Snapshot Details Screen
The expanded snapshot view includes date created, space used, and the amount of data accessible by this dataset.
The expanded snapshot view includes the creation date, the space used, and the amount of data accessible by this dataset.

![StorageSnapshoExpandedtInfoScreen](/images/CORE/Storage/StorageSnapshoExpandedtInfoScreen.png "Snapshot Expanded Screen")

Expand All @@ -57,9 +57,9 @@ Do not roll back until all desired data and snapshots are backed up.
{{< truetable >}}
| Name | Description |
|---------|-------------|
| **Stop Roolback if Snapshot Exists** | Select the safety level for the rollback action. Select the radio button that best fits. Rollback is cancelled when the safety check finds additional snapshots that are directly related to the dataset being rolled back. |
| **Newer intermeidate, Child, and clone** | Select to stop rollback when the safety check finds any related intermediate, child dataset, or clone snapshots that are newer than the rollback snapshots. |
| **Newer Clone** | Select to stop rollbck when the safety check finds any related clone snapshots that are newer than the rollback snapshot. |
| **Stop Rollback if Snapshot Exists** | Select the safety level for the rollback action. Select the radio button that best fits. Rollback is canceled when the safety check finds additional snapshots that are directly related to the dataset being rolled back. |
| **Newer intermediate, Child, and clone** | Select to stop rollback when the safety check finds any related intermediate, child dataset, or clone snapshots that are newer than the rollback snapshots. |
| **Newer Clone** | Select to stop rollback when the safety check finds any related clone snapshots that are newer than the rollback snapshot. |
| **No Safety Check (CAUTION)** | Select to stop rollback if snapshot exists. The rollback destroys any related intermediate, child dataset, and cloned snapshots that are newer than the rollback snapshot. |
| **Confirm** | Select to confirm the selection and activate the **ROLLBACK** button. |
{{< /truetable >}}
Expand Down
8 changes: 8 additions & 0 deletions static/includes/ResilverPriority.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
&NewLine;

Resilvering is a process that copies data to a replacement disk. Complete it as quickly as possible.
Resilvering is a high-priority task.
It can run in the background while performing other system functions. However, this can put a higher demand on system resources.
Increasing the priority of resilvers helps them finish faster as the system runs tasks with higher priority ranking.

Use the **Resilver Priority** screen to schedule a time when a resilver task can become a higher priority for the system and when the additional I/O or CPU use does not affect normal usage.
9 changes: 9 additions & 0 deletions static/includes/ResilverPrioritySetWhen.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
&NewLine;

Select **Enabled**, then use the dropdown lists to select a start time in **Begin** and time to finish in **End** to define a priority period for the resilver.
To select the day(s) to run the resilver, use the **Days of the Week** dropdown to select when the task can run with the priority given.

{{< hint type=note >}}
A resilver process running during the time frame defined between the beginning and end times likely runs faster than during times when demand on system resources is higher.
We advise you to avoid putting the system under any intensive activity or heavy loads (replications, SMB transfers, NFS transfers, Rsync transfers, S.M.A.R.T. tests, pool scrubs, etc.) during a resilver process.
{{< /hint >}}
70 changes: 70 additions & 0 deletions words-to-ignore.txt
Original file line number Diff line number Diff line change
Expand Up @@ -1886,3 +1886,73 @@ MinIODatasetPermissions
MinIOAppStorage
MinIOBucketVisible
MinIOAppInstalled

COREUIReference
msec
Diskgraphs
COREGettingStarted
SharingStorage
DataBackups
iSCSIShare
StoringData
CORETopMenu
Javascript
LoggingIn
VMX
vmx
ConsoleSetupMenu
bootable
VirtualMachinesJailNetworking
EFI
KillDisk
Citrix
xpt
EFI
SecureBoot
SCALEAngelfish
SUPERMICRO
bootable
gpg
COREHardwareGuide
OpenPGP
openpgp
edu
mit
pgp
Gpg
gnupg
cryptographically
UpdatingSoftwareforaMajorVersion
databackup
CommunityGuides
MinIOPlugin
updatingcore
corereleasenotes
COREPlexPlugin
SMBv
Esc
taskmanager
topmenu
ActiveDirectory
DirectoryServices
COREshellOptions
ChangingDefaultShell
CORERequiredFields
DirectoryServices
ActiveDirectory
RGBA
prebuilt
COREUIPreferencesIntro
TLSv
uitlsciphers
SystemSupportContactEnterprise
SystemSupportProactiveEnterprise
SLA
Reddit
CommunityForums
CreateJiraSuggestion
CreateDebugCORE
UIBugReport
COREshellOptions
Javascript
javascript