Skip to content

Commit

Permalink
Merge pull request #1856 from truenas/tc-2.3.2
Browse files Browse the repository at this point in the history
TrueCommand 2.3.2 Documentation
  • Loading branch information
ericbsd authored Apr 18, 2023
2 parents 1593801 + 5133a49 commit 9b4e533
Show file tree
Hide file tree
Showing 51 changed files with 501 additions and 195 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ aliases: /core/sharing/iscsi/iscsishare/
tags:
- coreiscsi
- corefibrechannel
- tciscsi
---

{{< toc >}}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ weight: 10
tags:
- coreiscsi
- corefibrechannel
- tciscsi
---

{{< toc >}}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,9 @@ title: "Adding iSCSI Block Shares"
description: "This article provides instructions on setting up iSCSI block shares manually or using the wizard and starting the service."
weight: 30
tags:
- scaleiSCSI
- scaleshares
- scaleiscsi
- scaleshares
- tciscsi
---

{{< toc >}}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,9 @@ title: "Increasing iSCSI Available Storage"
description: "This article provides information on increasing available storage in zvols and file LUNs for iSCSI block shares."
weight: 50
tags:
- scaleiSCSI
- scaleshares
- scaleiscsi
- scaleshares
- tciscsi
---

{{< toc >}}
Expand Down
5 changes: 3 additions & 2 deletions content/SCALE/SCALETutorials/Shares/iSCSI/UsingISCSIShares.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,9 @@ title: "Using an iSCSI Share"
description: "This article provides information on setting up a Linux or Windows system to use a TrueNAS-configured iSCSI block share."
weight: 40
tags:
- scaleiSCSI
- scaleshares
- scaleiscsi
- scaleshares
- tciscsi
---

{{< toc >}}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,9 @@ title: "Block (iSCSI) Share Target Screens"
description: "This article provides information on Block (iSCSI) Share Targets screens and settings."
weight: 30
tags:
- scaleiSCSI
- scaleshares
- scaleiscsi
- scaleshares
- tciscsi
---

{{< toc >}}
Expand Down
2 changes: 1 addition & 1 deletion content/TrueCommand/Administration/Admin/LDAPServers.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ Click the gear icon in the upper toolbar and select **Administration**. Scroll d

![AddLDAPServer](/images/TrueCommand/AddLDAPServer.png "Add LDAP Servers")

| Field | Description |
| Setting | Description |
|---------|-------------|
| **Hostname** | Host name of LDAP/AD server, with optional port. e.g. example.com:636. |
| **Domain** | LDAP base domain. e.g. dc=example,dc=com. |
Expand Down
4 changes: 4 additions & 0 deletions content/TrueCommand/Administration/SystemLog.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,10 @@
---
title: "System Log"
description: "This article provides information on system logs."
weight: 30
aliases:
tags:
- tcsystems
---

{{< toc >}}
Expand Down
13 changes: 10 additions & 3 deletions content/TrueCommand/Administration/Systems.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,10 @@
---
title: "Systems"
description: "This article provides information on the System screens, settings, and options."
weight: 10
aliases:
tags:
- tcsystems
---

{{< toc >}}
Expand Down Expand Up @@ -47,9 +51,12 @@ Click <mat-icon _ngcontent-igf-c221="" role="img" fontset="mdi" class="mat-icon


{{< expand "Update" "v" >}}
If the system has **Available** in the **Updates** column, it has system updates ready to apply.
Click <i class="material-icons" aria-hidden="true" title="Update">update</i> **Update** on the options menu to open a dialog window with information on the update.
Check the **Confirm** box, then click **OK** to update the system.
If the system has updates ready to apply, a green **Update** displays on the system information screen.

![SystenUpdateAvailable](/images/TrueCommand/2.3.2/SystenUpdateAvailable.png "System Update Available")

Click on the green <span class="material-icons">arrow_circle_up</span> icon to open the **Update** dialog with information on the update.
Select **Confirm**, then click **OK** to update the system.
Click **CANCEL** to close the window without updating.

![Systems Update](/images/TrueCommand/2.1/SystemsUpdateNAS.png "Systems Update")
Expand Down
4 changes: 4 additions & 0 deletions content/TrueCommand/Administration/Users.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,10 @@
---
title: "Users"
description: "This article provides information on the User screens and settings, and tutorials on how to create or manage user accounts."
weight: 20
aliases:
tags:
- tcusers
---

{{< toc >}}
Expand Down
3 changes: 3 additions & 0 deletions content/TrueCommand/Administration/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,3 +22,6 @@ Access to some of these areas may require a TrueCommand administrator account.

{{< include file="static/includes/General/MenuNav.md.part" markdown="true" >}}

## Article Summaries

{{< children depth="2" description="true" >}}
5 changes: 3 additions & 2 deletions content/TrueCommand/Alerts/AlertManage.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "Alert Management"
description: "This article provides general information on the alert screens and functions in TrueCommand. It also provides basic instructions on managing alerts, and on configuring alert rules, or services in TrueCommand including SMTP and user email, or PagerDuty."
description: "This article provides information on the alert screens and functions in TrueCommand. It also provides instructions on managing alerts, configuring alert rules, or setting up alert services for SMTP and user email, or PagerDuty in TrueCommand."
weight: 10
aliases:
- /truecommand/alerts/alertmanage/
Expand Down Expand Up @@ -152,14 +152,15 @@ To configure SMTP service:

1. Enter values in all fields on the **SMTP Email** screen and then click **SAVE**:

![AlertServicesSMTPEmailptions](/images/TrueCommand/2.0/AlertServicesSMTPEmailptions.png "Alert Services: SMTP Email options")
![AlertServiceSMTPEmailScreen](/images/TrueCommand/2.3.2/AlertServiceSMTPEmailScreen.png "Alert Services: SMTP Email options")

* **Mailserver** (*smtp.gmail.com* for example)
* **Mailserver port** number the mail service uses
* **Auth user** email address for plain authentication, for example, *[email protected]*
* **Auth pass** password for the plain authentication; for a *No-Auth* SMTP configuration, leave the password field blank
If configuring smtp.gmail.com, create an **App Password** in the gmail account for the gmail account. Enter this passcode here to configure gmail SMTP service authentication,
* **From** is what sends the email (i.e., [email protected]) or allows you to customize the sender field of the email
* **Tls** initiates a connection with TLS, and uses system settings.

Click **Test** on the **SMTP Email** configuration screen to verify that the configuration is correct.
If you did not receive a test alert email, check the values entered for accuracy.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,42 +1,99 @@
---
title: "TrueCommand Snapshots"
description: "This article provides instructions on setting up and running snapshots in TrueCommand."
weight: 40
aliases:
tags:
- tcsnapshots
- scalesnapshots
- coresnapshots
---

{{< toc >}}

## View Snapshots

To view a system's already existing snapshots, click *EXPLORE* in that system's window and select a storage pool. Once the pool loads, select the *Snapshots* tab.
## Viewing Snapshots

![TrueCommandSelectPool](/images/TrueCommand/2.0/TC20TrueCommandSelectPool.png "Select a Pool")
To view a list of snapshots for a system, click **EXPLORE** on the system widget (information card), then select the pool.

![TrueCommandViewSnapshots](/images/TrueCommand/2.0/TC20TrueCommandViewSnapshots.png "View Snapshots")
![ExploreSystemSelectPool](/images/TrueCommand/2.3.2/ExploreSystemSelectPool.png "Select a Pool")

## Create Single Snapshots
Click **Snapshots** to see a list of snapshots for the root or pool-level dataset.
To see a list of snapshots for any other dataset, click on the dataset, then on **Snapshots**.

To create single snapshots, select a pool in the system's *EXPLORE* menu and click *CREATE SNAPSHOTS*, then select *Create One-Time Snapshot*.

![TrueCommandCreateOneTimeSnapshot](/images/TrueCommand/2.0/TC20TrueCommandCreateOneTimeSnapshot.png "Create One-time Snapshot")
![ExploreSystemDatasetSnapshotList](/images/TrueCommand/2.3.2/ExploreSystemDatasetSnapshotList.png "Dataset Snapshot list")

Name the snapshot and click *CONFIRM*.
The header displays the breadcrumb for the system, pool, and dataset. To return to the pool, click the down arrow beside the system name, then select the pool on the dropdown list.

## Create Recurring Snapshot Tasks
## Taking Snapshots
If the dataset does not have existing snapshots, a blue **CREATE SNAPSHOTS** button displays instead of a list of snapshots.

To create recurring snapshot tasks, select a pool in the system's *EXPLORE* menu and click *CREATE SNAPSHOTS*, then select *Create Snapshot Task*.
![CreateSnapshotButtons](/images/TrueCommand/2.3.2/CreateSnapshotButtons.png "Create Snapshot Buttons")

![TrueCommandCreateSnapshotTask](/images/TrueCommand/2.0/TC20TrueCommandCreateSnapshotTask.png "Create Snapshot Task")
You can use this or the white **CREATE SNAPSHOTS** button under the *pool/dataset* path on the left-side panel.
**CREATE SNAPSHOTS** displays two options:

Set the task's schedule and determine the snapshot lifetime, then click *CONFIRM*.
* **Create One-time Snapshot** to take a single snapshot
* **Create Snapshot Task** to create a snapshot task that runs on a schedule


### Creating a Single Snapshot

To create single snapshots:

Click **EXPLORE** on the system card found on the dashboard, then select a pool on that system.

Next, click on a dataset you want to snapshot, then click **CREATE SNAPSHOTS**.


![CreateSnapshotsOptions](/images/TrueCommand/2.3.2/CreateSnapshotsOptions.png "Create One-time Snapshot")

Select **Create One-Time Snapshot** to open the snapshot dialog.

![CreateSnapshotDialog](/images/TrueCommand/2.3.2/CreateSnapshotDialog.png "Create Snapshot Dialog")

Enter a name for the snapshot.
Select **Recursive** if the dataset selected has other datasets nested under it and you want to include those in the snapshot.

Click **OK**.

## Creating a Snapshot Task

To create snapshot tasks that occurs on a schedule:

Find the system card on the dashboard and click **EXPLORE**, then select a pool.

Next, click on a dataset you want to snapshot, then click **CREATE SNAPSHOTS**.


![CreateSnapshotsOptions](/images/TrueCommand/2.3.2/CreateSnapshotsOptions.png "Create Snapshot Task")

Select **Create Snapshot Task** to open the **Create Snapshot Task** configuration screen.
If you did not select a dataset in the pool, you can select one from the dropdown list in the **Dataset** section. Otherwise, this area is not editable.


![CreateSnapshotTaskDataset](/images/TrueCommand/2.3.2/CreateSnapshotTaskDataset.png "Create Snapshot Task Dataset Path")

Set the schedule for the task. Select the frequency from the **Period** dropdown, the day of the week, the hour, and the minute you want to run the task.


![CreateSnapshotTaskScheduleAndLifetime](/images/TrueCommand/2.3.2/CreateSnapshotTaskScheduleAndLifetime.png "Add Snapshot Task Schedule and Lifetime")

Select the task lifetime. Enter a number in **Lifetime Value**, then select the unit from the **Lifetime Unit** dropdown list. Options are **Hour**, **Day**, **Week**, **Month**, and **Year**.


Click **OK** to save the task.

## Timezones

When you create snapshot tasks, TrueCommand uses the system the dataset is mounted in to determine what timezone it will use.
When you create snapshot tasks, TrueCommand uses the system the dataset is mounted in to determine what timezone it uses.

For example, if you are in New York and the dataset is mounted to a system with a Los Angeles timezone, a snapshot task set to run at 12:00 P.M. runs at 3:00 P.M. your time.


For example, if you are in New York and the dataset is mounted to a system with a Los Angeles timezone, a snapshot task set to occur at 12:00 P.M. will actually occur at 3:00 P.M. your time.
To see what timezone a system is in, go to that TrueNAS system UI and navigate to **System > General** for CORE or **System Settings > General** in SCALE, then find the **Localization** widget or section.

To see what timezone a system is in, go to that system's UI and navigate to **System > General** (**System Settings > General** in SCALE).

That system's timezone information is in the *Localization* section. Administrators can change the system's timezone using the drop-down menu.
{{< taglist tag="tcsnapshots" limit="10" >}}

![TrueCommandTimezone](/images/TrueCommand/2.0/TC20TrueCommandTimezone.png "Timezones")
22 changes: 14 additions & 8 deletions content/TrueCommand/SystemManagement/SingleSystem/_index.md
Original file line number Diff line number Diff line change
@@ -1,24 +1,30 @@
---
title: Single System Management
description: ""
weight: 20
geekdocCollapseSection: true
aliases:
tags:
---

While TrueCommand allows users to manage all of their systems on a single dashboard, it also lets users view single systems at a time.

To manage a single system, click on the system name in its card or click on the dashboard drop-down menu, and hover over **Ungrouped** to see the systems list.
TrueCommand allows users to manage all of their systems on a single dashboard that also lets users view single systems at a time.

To manage a single system, either click on the name on a System card or click on the **All** dropdown <span class="material-icons">arrow_drop_down</span> on the left side of the system header at the top of main dashboard. Select or hover over **Ungrouped** to see the list of systems.
Select the system you want to manage.

![TrueCommandSelectSingleSystem](/images/TrueCommand/2.1/DashboardSelectSingleSystem.png "Select Single System")
![MainDashboardSelectUngroupedSystem](/images/TrueCommand/2.3.2/MainDashboardSelectUngroupedSystem.png "Selecting a System")

While viewing a single system, users can see various statistics like CPU, memory, disk, network, and storage usage, as well as existing datasets and [alerts]({{< relref "AlertManage.md" >}}).
Single system cards display various statistics like CPU, memory, disk, network, and storage usage, as well as existing datasets and [alerts]({{< relref "AlertManage.md" >}}).

Users can create and manage storage, snapshots, and shares using the **File Explorer**.
Users can create and manage storage, replication, snapshots, and shares using the **Explore** button.

Users can view expanded TrueNAS information details by clicking on the double arrows located at the lower right corner of the system card. Information includes the system manufacturer, serial numbers, support tier, support expiration date, hostname, CPU, CPU cores, physical memory, OS, and uptime.
Users can view expanded TrueNAS information details by clicking on the double arrows <span class="material-icons">keyboard_double_arrow_down</span> at the lower right corner of the system card.
Information includes the system manufacturer, serial numbers, support tier, support expiration date, host name, CPU, CPU cores, physical memory, OS, and uptime.

![TrueCommandSingleSystemhardware](/images/TrueCommand/2.0/TCHardwareDash.png "Single System Hardware Information")
![SystemInformationCardDetails](/images/TrueCommand/2.3.2/SystemInformationCardDetails.png "Single System Hardware Details")

Users with adequate permissions can update the system, [configure backups]({{< relref "TrueNASConfigManage.md" >}}), and generate system audits and [reports]({{< relref "Creation.md" >}}). If a system update is available, the **Update** label and icon turn green. You can also see which systems have updates pending on the **Systems** screen.

![TrueCommandSingleSystemDashboard](/images/TrueCommand/2.0/TC20TrueCommandSingleSystemDashboard.png "Single System Dashboard")
![SystemUpdateAvailable](/images/TrueCommand/2.3.2/SystemUpdateAvailable.png "Single System Dashboard")

Loading

0 comments on commit 9b4e533

Please sign in to comment.