Skip to content

Commit

Permalink
PD-1080: update reporting text for netdata ui inclusion
Browse files Browse the repository at this point in the history
  • Loading branch information
Mrt134 committed Mar 21, 2024
1 parent 862e58f commit 042e0cd
Show file tree
Hide file tree
Showing 5 changed files with 21 additions and 17 deletions.
14 changes: 8 additions & 6 deletions content/SCALE/SCALETutorials/Apps/UsingCatalogs.md
Expand Up @@ -49,16 +49,18 @@ Click **CONTINUE** to open the **Add Catalog** screen.

{{< trueimage src="/images/SCALE/Apps/AppsAddCatalogScreen.png" alt="Apps Add Catalog Screen" id="Apps Add Catalog Screen" >}}

Fill out the **Add Catalog** form. As an example, the data below to add the Truecharts catalog to SCALE.
Fill out the **Add Catalog** form.

Enter the name in **Catalog Name**, for example, type *truecharts*.
Enter the name in **Catalog Name**, for example, type *mycatalog*.

Leave the **Force Create** checkbox clear. Selecting this option allows adding a catalog to the system even if some trains are unhealthy, so this option is not recommended.
Leave the **Force Create** checkbox clear.
Selecting this option allows adding a catalog to the system even if some trains are unhealthy, so this option is not recommended.

Select a valid git repository in **Repository**. For example, *https://github.com/truecharts/catalog* for TrueCharts.
Select a valid git repository in **Repository**.
For example, *https://github.com/mycatalog/catalog*.

Now select the train TrueNAS should use to retrieve available application information of the catalog. For example, select *stable* or *incubator* for the TrueCharts example.
Now select the train TrueNAS should use to retrieve available application information of the catalog.

Finally, enter the git repository branch TrueNAS should use for the catalog in **Branch**. For example, for TrueCharts, enter *main*.
Finally, enter the git repository branch TrueNAS should use for the catalog in **Branch**.

Click **Save**.
6 changes: 1 addition & 5 deletions content/SCALE/SCALETutorials/ConfigReportsScale.md
Expand Up @@ -11,11 +11,7 @@ tags:

TrueNAS has a built-in reporting engine that provides helpful graphs and information about the system.

{{< trueimage src="/images/SCALE/Reporting/CPUReportingUsageTemp.png" alt="Reporting Screen" id="Reporting Screen" >}}

{{< expand "What does TrueNAS use for reporting?" "v" >}}
TrueNAS uses [Netdata](https://github.com/netdata/netdata) to gather system metrics and present them in the **Reporting** screens.
{{< /expand >}}
{{< include file="static/includes/netdatareporting.md" >}}

Reporting data is saved to permit viewing and monitoring usage trends over time.
This data is preserved across system upgrades and restarts.
Expand Down
4 changes: 2 additions & 2 deletions content/SCALE/SCALEUIReference/Apps/_index.md
Expand Up @@ -349,9 +349,9 @@ Click **Continue** to open the **Add Catalog** screen.
{{< truetable >}}
| Field | Description |
|---------|-------|
| **Catalog Name** | enter the name the TrueNAS uses to look up the catalog. For example, *truecharts*. |
| **Catalog Name** | enter the name the TrueNAS uses to look up the catalog. For example, *mycatalog*. |
| **Force Create** | Select to add the catalog to the system even if some trains are unhealthy. |
| **Repository** | Enter the valid git repository URL. For example, *https://github.com/truecharts/catalog*. |
| **Repository** | Enter the valid git repository URL. For example, *https://github.com/mycatalog/catalog*. |
| **Preferred Trains** | The trains TrueNAS uses to retrieve available applications for the catalog. The default is **stable** (and optionally: **incubator**). |
| **Branch** | Specify the git repository branch TrueNAS should use for the catalog. The default is **main**. |
{{< /truetable >}}
Expand Down
6 changes: 2 additions & 4 deletions content/SCALE/SCALEUIReference/ReportingScreensSCALE.md
Expand Up @@ -13,10 +13,7 @@ The **Reporting** screen displays graphs of system information for CPU, disk, me
Use the dropdown in the upper right corner to select between reporting graph display options.
The **CPU** report displays by default.

{{< expand "What does TrueNAS SCALE use for reporting?" "v" >}}
TrueNAS SCALE uses [Netdata](https://www.netdata.cloud/) to gather metrics, create visualizations, and provide reporting statistics. The full Netdata
UI can be reached by navigating to **Reporting -> Netdata**.
{{< /expand >}}
{{< include file="static/includes/netdatareporting.md" >}}

To configure a third-party reporting integration, such as Graphite, click **Exporters** to open the [**Reporting Exporters**](#reporting-exporters-screen) screen.

Expand Down Expand Up @@ -96,6 +93,7 @@ System graphs display the number of processes grouped by state, sleeping, runnin

### UPS Graphs
Displays the **UPS Charging** percentage, **UPS Runtime**, **UPS Voltage - Battery**, **UPS Voltage - Input**, **UPS Voltage - Output**, **UPS Input Current**, **UPS Input Frequency**, **UPS Input Load**, and **UPS Temperature**.

The **UPS** service must be [configured]({{< relref "upsservicesscale.md" >}}) with a compatible Uninterruptible Power Supply (UPS) device.

{{< trueimage src="/images/SCALE/Reporting/UPSReportingChargingRuntime.png" alt="UPS Reporting" id="UPS Reporting" >}}
Expand Down
8 changes: 8 additions & 0 deletions static/includes/netdatareporting.md
@@ -0,0 +1,8 @@
&NewLine;

{{< expand "What does TrueNAS SCALE use for reporting?" "v" >}}
TrueNAS SCALE uses [Netdata](https://www.netdata.cloud/) to gather metrics, create visualizations, and provide reporting statistics.

Click **Netdata** from the **Reporting** page to see the built-in netdata UI.
This UI bases metrics off your local system and browser time, which might be different from the default TrueNAS system time.
{{< /expand >}}

0 comments on commit 042e0cd

Please sign in to comment.