DOCS-3602 Update SMART Test Article

truenas · May 11, 2022 · 2c16087 · 2c16087
1 parent c4b2cb3
commit 2c16087
Show file tree

Hide file tree

Showing 27 changed files with 79 additions and 171 deletions.
diff --git a/content/CORE/CORETutorials/Services/ConfigureDynamicDNS.md b/content/CORE/CORETutorials/Services/ConfigureDynamicDNS.md
@@ -1,6 +1,6 @@
 ---
 title: "Configuring Dynamic DNS"
-weight: 10
+weight: 20
 aliases: /core/services/dynamicdns/
 ---
 

diff --git a/content/CORE/CORETutorials/Services/ConfigureUPS.md b/content/CORE/CORETutorials/Services/ConfigureUPS.md
@@ -1,6 +1,6 @@
 ---
 title: "Configuring UPS Service"
-weight: 80
+weight: 150
 alias: /core/services/ups/
 ---
 

diff --git a/content/CORE/CORETutorials/Services/ConfiguringFTP.md b/content/CORE/CORETutorials/Services/ConfiguringFTP.md
@@ -1,6 +1,6 @@
 ---
 title: "Configuring FTP"
-weight: 20
+weight: 30
 ---
 
 

diff --git a/content/CORE/CORETutorials/Services/ConfiguringLLDP.md b/content/CORE/CORETutorials/Services/ConfiguringLLDP.md
@@ -1,6 +1,6 @@
 ---
 title: "Configuring LLDP"
-weight: 30
+weight: 50
 aliases: /core/services/lldp/
 ---
 

diff --git a/content/CORE/CORETutorials/Services/ConfiguringOpenVPN.md b/content/CORE/CORETutorials/Services/ConfiguringOpenVPN.md
@@ -1,6 +1,6 @@
 ---
 title: "Configuring OpenVPN"
-weight: 40
+weight: 70
 aliases: /core/services/openvpn/
 ---
 

diff --git a/content/CORE/CORETutorials/Services/ConfiguringS3.md b/content/CORE/CORETutorials/Services/ConfiguringS3.md
@@ -1,6 +1,6 @@
 ---
 title: "Configuring S3"
-weight: 50
+weight: 100
 aliases: /core/services/s3/
 ---
 

diff --git a/content/CORE/CORETutorials/Services/ConfiguringSMART.md b/content/CORE/CORETutorials/Services/ConfiguringSMART.md
@@ -0,0 +1,31 @@
+---
+title: "Configuring S.M.A.R.T."
+weight: 90
+aliases: /core/services/smart/
+---
+
+{{< toc >}}
+
+[S.M.A.R.T.](https://en.wikipedia.org/wiki/S.M.A.R.T.) (Self-Monitoring, Analysis and Reporting Technology) is an industry standard for disk monitoring and testing.
+Disks can be monitored for problems using several different kinds of self-tests.
+
+Go to the **Services** page and find the **S.M.A.R.T.** entry.
+Click the <i class="material-icons" aria-hidden="true" title="Configure">edit</i> to configure the service.
+
+![ServicesSMARTOptions](/images/CORE/12.0/ServicesSMARTOptions.png "S.M.A.R.T. Options")
+
+Define a number of minutes for smartd to wake up and check for configured to run in **Check Interval** and select a **Power Mode** (tests only run with *Never*).
+
+Define the **Difference** in degrees of Celsius. S.M.A.R.T. will alert if the temperature of a drive changes by N degrees Celsius since the last report.
+
+Define the **Threshold** in degrees of Celsius. S.M.A.R.T. will message with a log level of LOG_INFO if the temperature exceeds the threshold.
+
+Define the **Threshold** in degrees of Celsius. S.M.A.R.T. will message with a log level of LOG_CRIT if the temperature exceeds
+
+## Service Activation
+
+When finished configuring the server or client service, click **SAVE**.
+Start the service by clicking the related toggle in **Services**.
+To check the current state of the service, hover over the toggle.
+
+Setting **Start Automatically** starts the service whenever TrueNAS completes booting and the network and data pools are running.
diff --git a/content/CORE/CORETutorials/Services/ConfiguringSNMP.md b/content/CORE/CORETutorials/Services/ConfiguringSNMP.md
@@ -1,6 +1,6 @@
 ---
 title: "Configuring SNMP"
-weight: 60
+weight: 120
 aliases: /core/services/snmp/
 ---
 

diff --git a/content/CORE/CORETutorials/Services/ConfiguringSSH.md b/content/CORE/CORETutorials/Services/ConfiguringSSH.md
@@ -1,6 +1,6 @@
 ---
 title: "Configuring SSH"
-weight: 70
+weight: 130
 ---
 
 The SSH service allows connections to TrueNAS with the [Secure SHell Transport Layer Protocol](https://tools.ietf.org/html/rfc4253).

diff --git a/content/CORE/CORETutorials/Services/ConfiguringTFTP.md b/content/CORE/CORETutorials/Services/ConfiguringTFTP.md
@@ -1,6 +1,6 @@
 ---
 title: "Configuring TFTP "
-weight: 20
+weight: 140
 ---
 
 

diff --git a/content/CORE/CORETutorials/Services/FTPTFTP.md b/content/CORE/CORETutorials/Services/FTPTFTP.md
@@ -1,6 +1,6 @@
 ---
 title: "FTP, SFTP, and TFTP"
-weight: 20
+weight: 160
 aliases: /core/services/ftptftp/
 ---
 

diff --git a/content/CORE/CORETutorials/Services/S3forMinIO.md b/content/CORE/CORETutorials/Services/S3forMinIO.md
@@ -1,6 +1,6 @@
 ---
 title: "S3 for MinIO"
-weight: 50
+weight: 105
 ---
 
 MinIO connections and service is configured using the **Services** [S3 screen]({{< relref "/CORE/UIReference/Services/S3Screen.md" >}}).

diff --git a/...nt/CORE/CORETutorials/Tasks/SMARTTests.md → .../CORETutorials/Tasks/RunningSMARTTests.md b/...nt/CORE/CORETutorials/Tasks/SMARTTests.md → .../CORETutorials/Tasks/RunningSMARTTests.md
@@ -1,13 +1,13 @@
 ---
-title: "S.M.A.R.T. Tests"
+title: "Running S.M.A.R.T. Tests"
 weight: 40
 ---
 
 {{< toc >}}
 
 [S.M.A.R.T.](https://en.wikipedia.org/wiki/S.M.A.R.T.) (Self-Monitoring, Analysis and Reporting Technology) is an industry standard for disk monitoring and testing.
 Disks can be monitored for problems using several different kinds of self-tests.
-TrueNAS can adjust when and how [alerts]({{< relref "CORE/UIReference/System/AlertSettings.md" >}}) for S.M.A.R.T. are issued.
+TrueNAS can adjust when and how [alerts]({{< relref "CORE/CORETutorials/SystemConfiguration/CreatingAlerts.md" >}}) for S.M.A.R.T. are issued.
 When S.M.A.R.T. monitoring reports an issue, we recommend you replace that disk.
 Most modern ATA, IDE, and SCSI-3 hard drives support S.M.A.R.T.
 Refer to your respective drive documentation for confirmation.
@@ -17,26 +17,25 @@ Running tests can reduce drive performance, so we recommend scheduling tests whe
 Avoid scheduling disk-intensive tests at the same time!
 For example, S.M.A.R.T. tests should not be scheduled on the same day as a disk [scrub]({{< relref "CORE/CORETutorials/Tasks/CreatingScrubTasks.md" >}}) or [resilver]({{< relref "CORE/CORETutorials/Tasks/UsingResilverPriority.md" >}}).
 
-
-
 {{< expand "How do I check or change S.M.A.R.T. testing for a disk?" "v" >}}
 Go to **Storage > Disks** and click <i class="material-icons" aria-hidden="true" title="Expand">chevron_right</i> to expand an entry.
 *Enable S.M.A.R.T.* shows as *true* or *false*.
 
-To enable or disable testing, click *EDIT DISK(S)* and find the *Enable S.M.A.R.T.* option.
+To enable or disable testing, click **EDIT DISK(S)** and find the *Enable S.M.A.R.T.* option.
 {{< /expand >}}
 
-## Manual S.M.A.R.T. Test
+## Manual S.M.A.R.T. Tests
 
 To quickly test a disk for errors, go to **Storage > Disks** and select the disks to be tested.
-After selecting the desired disks, click *MANUAL TEST*.
+After selecting the desired disks, click **MANUAL TEST**.
 
 ![StorageDisksManualTest Options](/images/CORE/12.0/StorageDisksManualTestOptions.png "Manual Test Options")
 
-Next, select the test *Type*.
+Next, select the test **Type**.
 Each test type can be slightly different based on the drive connection, ATA or SCSI:
-{{< tabs "Tests by Drive Connection" >}}
-{{< tab "ATA" >}}
+
+### ATA Connection
+
 * *Long* - runs SMART Extended Self Test. This will scan the entire disk surface and can take many hours on large-volume disks.
 * *Short* - runs SMART Short Self Test (usually under ten minutes). These are basic disk tests that vary by manufacturer.
 * *Conveyance* - runs a SMART Conveyance Self Test.
@@ -45,48 +44,35 @@ Each test type can be slightly different based on the drive connection, ATA or S
 * *Offline* - runs SMART Immediate Offline Test.
   The effects of this test are visible only in that it updates the SMART Attribute values, and if the test finds errors, they appear in the SMART error log.
 
-{{< /tab >}}
-{{< tab "SCSI" >}}
+### SCSI Connection
 * *Long* - runs the "Background long" self-test.
 * *Short* - runs the "Background short" self-test.
 * *Offline* - runs the default self test in foreground.
   No entry is placed in the self test log.
 
-{{< /tab >}}
-{{< /tabs >}}
-
 For more information, refer to [smartctl(8)](https://www.smartmontools.org/browser/trunk/smartmontools/smartctl.8.in).
 
 Click **START** to begin the test.
 Depending on the test type you choose, the test can take some time to complete.
 TrueNAS generates alerts when tests discover issues.
 
 {{< expand "Where can I view the test results?" "v" >}}
-Go to **Storage > Disks**, expand an entry, and click *S.M.A.R.T. TEST RESULTS*.
+Go to **Storage > Disks**, expand an entry, and click **S.M.A.R.T. TEST RESULTS**.
 From the **[Shell]({{< relref "CORE/CORETutorials/UsingShell.md" >}})**, use `smartctl` and the name of the drive: `smartctl -l selftest /dev/ada0`.
 {{< /expand >}}
 
 ## Automatic S.M.A.R.T. Tests
 
-To schedule recurring S.M.A.R.T. tests, go to **Tasks > S.M.A.R.T. Tests** and click *ADD*.
+Go to **Tasks > S.M.A.R.T. Tests** and click **ADD**.
 
 ![TasksSMARTTestsAdd](/images/CORE/12.0/TasksSMARTTestsAdd.png "Add recurring S.M.A.R.T. test")
 
-{{< expand "Specific Options" "v" >}}
-{{< include file="static/includes/Reference/TasksSMARTAddFields.md.part" markdown="true" >}}
-{{< /expand >}}
-
-Choose the *Disks* to test, *Type* of test to run, and *Schedule* for the task.
+Choose the **Disks** to test, **Type** of test to run, and **Schedule** for the task.
 
 {{< hint warning >}}
-SMART tests can offline disks! Avoid scheduling S.M.A.R.T. tests simultaneously with scrub or resilver operations.
+S.M.A.R.T. tests can offline disks! Avoid scheduling S.M.A.R.T. tests simultaneously with scrub or resilver operations.
 {{< /hint >}}
 
-When the test must run on a very specific *Schedule*, set this to *Custom* to open the advanced scheduler.
-{{< expand "Advanced Scheduler" "v" >}}
-{{< include file="static/includes/CORE/AdvancedScheduler.md.part" markdown="true" >}}
-{{< /expand >}}
-
 Saved schedules appear in the **Tasks > S.M.A.R.T. Tests** list.
 
 {{< expand "CLI" "v" >}}
@@ -95,20 +81,9 @@ To verify the schedule is saved, you can open the [shell]({{< relref "CORE/CORET
 
 ## Service Options
 
-The S.M.A.R.T. service must be enabled for automatic S.M.A.R.T. tests to run.
+You must [enable S.M.A.R.T. service]({{< relref "CORE/CORETutorials/Services/ConfiguringSMART.md" >}}) to run automatic S.M.A.R.T. tests.
 
 {{< expand "RAID controllers?" "v" >}}
 Disable the S.M.A.R.T. service when disks are controlled by a RAID controller.
 The controller monitors S.M.A.R.T. separately and marks disks as a **Predictive Failure** on a test failure.
-{{< /expand >}}
-
-To start the S.M.A.R.T. service, go to **Services** and toggle *S.M.A.R.T.*.
-To start the service during the TrueNAS boot process, set *Start Automatically*.
-
-Configure the S.M.A.R.T. service by clicking <i class="material-icons" aria-hidden="true" title="Configure">edit</i>.
-
-![ServicesSMARTOptions](/images/CORE/12.0/smartoptions12.png "Services SMART Options")
-
-{{< include file="static/includes/Reference/ServicesSMARTFields.md.part" markdown="true" >}}
-
-Don't forget to click *SAVE* after changing any settings.
+{{< /expand >}}
diff --git a/content/CORE/UIReference/Services/DynamicDNSScreen.md b/content/CORE/UIReference/Services/DynamicDNSScreen.md
@@ -1,6 +1,6 @@
 ---
 title: "Dynamic DNS Screen"
-weight: 10
+weight: 20
 aliases: core/services/dynamicdns/
 ---
 

diff --git a/content/CORE/UIReference/Services/FTPScreen.md b/content/CORE/UIReference/Services/FTPScreen.md
@@ -1,6 +1,6 @@
 ---
 title: "FTP Screen"
-weight: 20
+weight: 30
 ---
 
 Use the **FTP** services screen to configure FTP service settings for your TrueNAS system.

diff --git a/content/CORE/UIReference/Services/LLDPScreen.md b/content/CORE/UIReference/Services/LLDPScreen.md
@@ -1,6 +1,6 @@
 ---
 title: "LLDP Screen"
-weight: 30
+weight: 50
 ---
 
 Use the **LLDP** services screen to configure Link Layer Discovery Protocol (LLDP) service on your TrueNAS.

diff --git a/content/CORE/UIReference/Services/NFSScreen.md b/content/CORE/UIReference/Services/NFSScreen.md
@@ -1,6 +1,6 @@
 ---
 title: "NFS Screen"
-weight: 10
+weight: 60
 ---
 
 {{< toc >}}

diff --git a/content/CORE/UIReference/Services/OpenVPNScreen.md b/content/CORE/UIReference/Services/OpenVPNScreen.md
@@ -1,6 +1,6 @@
 ---
 title: "OpenVPN Screen"
-weight: 40
+weight: 70
 ---
 
 {{< toc >}}

diff --git a/content/CORE/UIReference/Services/S3Screen.md b/content/CORE/UIReference/Services/S3Screen.md
@@ -1,6 +1,6 @@
 ---
 title: "S3 Screen"
-weight: 50
+weight: 100
 ---
 
 Use the **S3** screen to configure your TrueNAS S3 service.

diff --git a/content/CORE/UIReference/Services/SMARTScreen.md b/content/CORE/UIReference/Services/SMARTScreen.md
@@ -0,0 +1,8 @@
+---
+title: "S.M.A.R.T."
+weight: 100
+---
+
+![ServicesSMARTOptions](/images/CORE/12.0/ServicesSMARTOptions.png "S.M.A.R.T. Options")
+
+{{< include file="static/includes/Reference/ServicesSMARTFields.md.part" markdown="true" >}}
diff --git a/content/CORE/UIReference/Services/SMBScreen.md b/content/CORE/UIReference/Services/SMBScreen.md
@@ -1,6 +1,6 @@
 ---
 title: "SMB Service Screen"
-weight: 20
+weight: 110
 ---
 
 Use the **Services SMB** screen to configured SMB service settings. 

diff --git a/content/CORE/UIReference/Services/SNMPScreen.md b/content/CORE/UIReference/Services/SNMPScreen.md
@@ -1,6 +1,6 @@
 ---
 title: "SNMP Screen"
-weight: 60
+weight: 120
 aliases: /core/services/snmp/
 ---
 

diff --git a/content/CORE/UIReference/Services/ServicesSSH.md b/content/CORE/UIReference/Services/ServicesSSH.md
@@ -1,6 +1,6 @@
 ---
 title: "SSH Screen"
-weight: 70
+weight: 130
 ---
 
 Use the **SSH** services screen to configure SSH service on your TrueNAS.

diff --git a/content/CORE/UIReference/Services/TFTPScreen.md b/content/CORE/UIReference/Services/TFTPScreen.md
@@ -1,6 +1,6 @@
 ---
 title: "TFTP Screen"
-weight: 20
+weight: 140
 ---
 
 The **TFTP** service screen configures the directory, connection, access and other auxillary parameters for TFPT service on the TrueNAS.

diff --git a/content/CORE/UIReference/Services/UPSScreen.md b/content/CORE/UIReference/Services/UPSScreen.md
@@ -1,6 +1,6 @@
 ---
 title: "UPS Screen"
-weight: 80
+weight: 150
 ---
 
 Use the **UPS** services screen to configure a UPS for your TrueNAS.

diff --git a/content/CORE/UIReference/Services/WebDAVScreen.md b/content/CORE/UIReference/Services/WebDAVScreen.md
@@ -1,6 +1,6 @@
 ---
 title: "WebDAV Services Screen"
-weight: 10
+weight: 160
 ---
 
 Use the **Services WebDAV** screen to enable WebDAV services on your TrueNAS.