Skip to content

Commit

Permalink
Merge pull request #2942 from truenas/PD-1289-tc-3-0-2-docs
Browse files Browse the repository at this point in the history
Pd 1289 tc 3 0 2 docs
  • Loading branch information
ericbsd authored Aug 13, 2024
2 parents 4e452d2 + 2d93d52 commit 5715086
Show file tree
Hide file tree
Showing 11 changed files with 109 additions and 329 deletions.
4 changes: 2 additions & 2 deletions content/AdminGuide/Users.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ tags:
- accounts
---

TrueCommand has a robust user management system that lets administrators personalize the experience for each user account.
TrueCommand has a robust user management system that lets administrators tune system permissions for each user account.
You can create user accounts in the TrueCommand interface.
Alternately, LDAP can automatically create new user accounts when someone logs into TrueCommand with their LDAP credentials.

Expand Down Expand Up @@ -58,7 +58,7 @@ To revert to the original field contents, click **RESET FORM** before you click
| **Email** | Enter or change the user email. If [SMTP]({{< relref "AlertManage.md" >}}) is not set up, an error message displays at the bottom of the screen stating **Failed to send email. Are your SMTP settings configured?**. Admins can click the **CONFIGURE** button to open the SMTP settings window. Before adding a user email, go to **Alert Services** and verify you have set up the SMTP service. |
| **Phone** | Enter or change the user phone number. |
| **Two Factor Authentication** | Enables [Two Factor Authentication]({{< relref "/tcgettingstarted/useraccounts.md" >}}), which requires the user to enter a validation code emailed to them after they enter their username, password, and click **SIGN IN** on the login screen. |
| **TrueCommand Administrator** | Designates the account as an administrator. |
| **TrueCommand Administrator** | Designates the account as an administrator. This gives the user full permissions to every connected TrueNAS system, as well as the ability to configure TrueCommand. |
| **Password** | New user password. |
| **Password Confirm** | Confirms new user password. |
{{< /truetable >}}
Expand Down
2 changes: 0 additions & 2 deletions content/TCGettingStarted/InterfaceOverview.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,6 @@ The top toolbar switches between the various TrueCommand feature screens and has
|------|-------------|
| <span class="iconify" data-icon="mdi:home"></span> **Home** | Opens the primary TrueCommand Dashboard with live stats and options for connected TrueNAS systems. |
| <span class="iconify" data-icon="mdi:heart-pulse"></span> **Fleet Dash** | The expanded [**Fleet Dashboard**]({{< relref "FleetDashboard.md" >}}) collects metrics, notifications, and configuration details for every connected TrueNAS system. |
| <span class="iconify" data-icon="mdi:server-network"></span> **Clusters** | The [**Clusters**]({{< relref "Clusters.md" >}}) page manages configurations of synchronized TrueNAS systems that are functioning as a single data storage cluster. |
| <span class="iconify" data-icon="mdi:chart-line-stacked"></span> **Reports** | The [**Reports**]({{< relref "Creation.md" >}}) page for viewing and creating custom visualizations of connected TrueNAS system statistics. |
| <span class="iconify" data-icon="mdi:content-copy"></span> **Replication** | The [**Replication**]({{< relref "ReplicationManagement.md" >}}) shows created replication tasks between connected TrueNAS systems and allows creating new ZFS snapshot automated replication schedules. |
| ![iXsystemsLogo](/images/ixsystemsbw.png) | Opens a new browser tab to the [iXsystems website](https://www.ixsystems.com) |
Expand All @@ -36,7 +35,6 @@ The **Settings** menu has these options:
|--------|-------------|
| <span class="iconify" data-icon="mdi:view-dashboard"></span> Dashboard | Opens the primary TrueCommand Dashboard. |
| <span class="iconify" data-icon="mdi:chip"></span> System Inventory | The [**System Inventory**]({{< relref "MultiSystems.md" >}}) screen has expanded license and serial number details about TrueNAS systems that are connected to TrueCommand. |
| <span class="iconify" data-icon="mdi:server-network"></span> Clusters | Opens the [Clusters]({{< relref "Clusters.md" >}}) screen. |
| <span class="iconify" data-icon="mdi:chart-line-stacked"></span> Reports | Opens the [**Reports**]({{< relref "/UserGuide/Reports/Creation.md" >}}) screen. |
| <span class="iconify" data-icon="mdi:playlist-check"></span> All Alerts | The [**All Alerts**]({{< relref "AlertManage.md#all-notices-screens-and-functions" >}}) screen shows every TrueNAS system notification that TrueCommand has collected or generated. |
| <span class="iconify" data-icon="ic:round-notification-important"></span> Alert Rules | The [**Alert Rules**]({{< relref "AlertManage.md#alert-rules-screens-and-functions" >}}) screen has options for viewing and creating new monitoring routines that create TrueCommand notifications when specific parameters are met. |
Expand Down
73 changes: 66 additions & 7 deletions content/TCGettingStarted/TCReleaseNotes.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ Here are the major changes in this release:

* New multi-system ZFS replication quickly backs up storage snapshots across connected TrueNAS systems.
<--->
* The experimental clustering feature is deprecated and scheduled for removal in a future TrueCommand version.
* The experimental clustering feature is deprecated and UI screens disabled in TrueCommand 3.0.2.

* The experimental iSCSI management feature is permanently removed. iSCSI shares previously created by TrueCommand continue to live on the individual TrueNAS systems.

Expand All @@ -24,9 +24,9 @@ Here are the major changes in this release:
TrueCommand is primarily offered as a Software as a Service (SaaS) solution from iXsystems, but can be self-hosted as a container deployment.

TrueCommand Cloud registrations are available from https://portal.ixsystems.com.
A valid email address and credit card is required ([signup instructions]({{< relref "InstallTCCloud.md" >}})).
A valid email address and credit card is required ([sign up instructions]({{< relref "InstallTCCloud.md" >}})).

A self-hosted TrueCommand container is available from https://hub.docker.com/r/ixsystems/truecommand/tags under the tag **release-3.0.1** ([deployment instructions]({{< relref "InstallTCDocker.md" >}})).
A self-hosted TrueCommand container is available from https://hub.docker.com/r/ixsystems/truecommand/tags under the tag **release-3.0.2** ([deployment instructions]({{< relref "InstallTCDocker.md" >}})).

## Upgrade Notes

Expand All @@ -42,28 +42,38 @@ Updating from TrueCommand v1.3 to v2.0 or later involves a database migration pr
This preserves all configuration data, but does not preserve old performance statistics.
Additionally, it is not possible to roll back to TrueCommand v1.3 from v2.1 or later.

An issue is found with High Availability (HA) TrueNAS SCALE 23.10.0.1 systems connected to TrueCommand 3.0.0-BETA.1.
An issue is found with High Availability (HA) TrueNAS SCALE 23.10.0.1 systems connected to TrueCommand 3.0.
Update SCALE HA systems to TrueNAS SCALE version 23.10.1 or later before connecting to TrueCommand 3.0.

After upgrading to TrueCommand 3.0, you might need to edit and re-apply connected TrueNAS system passwords to ensure connectivity.

Starting in version 3.0.2, TrueCommand does not support STARTTLS or port 587 for SMTP email configuration.
Users with SMTP configured on port 587 should use port *465* and select **Enable TLS** for full SSL/TLS encryption.
See [Configuring SMTP Email]({{< relref "AlertManage.md #configuring-smtp-email" >}}) for more information.

In version 3.0.2 administrative users no longer appear on the list of users available to be assigned to a team.
Administrative users have full admin permissions for all connected systems, so manual team assignment is not needed.

After updating, clear the browser cache (CTRL+F5) before logging in to TrueCommand. This ensures stale data doesn't interfere the TrueCommand UI.

### TrueNAS Compatibility

TrueCommand 3.0 is tested and compatible with these TrueNAS versions:

* CORE 13.0
* SCALE 22.12
* SCALE 23.10 - High Availability systems are not yet fully supported.
* SCALE 23.10
* SCALE 24.04

### Paths

Self-hosted Containers:
```mermaid
flowchart LR
A["Legacy (Pre 1.2"] --> B
A["Legacy (Pre 1.2)"] --> B
B["1.3"] --> C
C["2.3.3"] --> D
D["3.0.1"]
D["3.0.2"]
```

## Release Schedule
Expand All @@ -77,8 +87,56 @@ D["3.0.1"]
{{< include file="/static/includes/SoftwareStatusPage.md" >}}
{{< /expand >}}

## 3.0.2 Changelog

**August 13, 2024**

iXsystems is pleased to release TrueCommand 3.0.2!

This is a maintenance release to address issues found in the 3.0.1 version.

Notable changes:

* Fix Cloud SMTP email configuration for authentication ([TC-3186](https://ixsystems.atlassian.net/browse/TC-3186)).
* Investigate detached NAS connections ([TC-3188](https://ixsystems.atlassian.net/browse/TC-3188)).
* Disable TrueNAS UI proxy ([TC-3190](https://ixsystems.atlassian.net/browse/TC-3190)).
* Do not try to decrypt text between 1 and 15 bytes ([TC-3198](https://ixsystems.atlassian.net/browse/TC-3198)).
* UI refreshes token too often ([TC-3200](https://ixsystems.atlassian.net/browse/TC-3200)).
* Job "config.save" does not finish and constantly yields error 32 ([TC-3202](https://ixsystems.atlassian.net/browse/TC-3202)).
* User alert creator status reset on migration ([TC-3177](https://ixsystems.atlassian.net/browse/TC-3177)).
* Stale sessions appear as active users ([TC-3180](https://ixsystems.atlassian.net/browse/TC-3180)).
* Enable HSTS on web server ([TC-3196](https://ixsystems.atlassian.net/browse/TC-3196)).
* Disable SWEET32 cipher suite support ([TC-3195](https://ixsystems.atlassian.net/browse/TC-3195)).
* Increase temp password timeout for Cloud to 48 hours ([TC-3187](https://ixsystems.atlassian.net/browse/TC-3187)).
* Do not check for upgrade_pending status if connected via the passive controller ([TC-3182](https://ixsystems.atlassian.net/browse/TC-3182)).
* Paused internal alerts do not persist past reboot ([TC-3181](https://ixsystems.atlassian.net/browse/TC-3181)).
* The deprecated Clusters screen has been disabled in the TrueCommand UI ([TC-3223](https://ixsystems.atlassian.net/issues/TC-3223))

<a href="https://ixsystems.atlassian.net/issues/?filter=10580" target="_blank">Click here for the full changelog</a> of completed tickets that are included in the TrueCommand 3.0.2 release.

{{< include file="/static/includes/JiraFilterInstructions.md" >}}

### 3.0.2 Ongoing Issues

{{< enterprise >}}
We recommend that TrueNAS Enterprise High Availability (HA) systems be updated from the TrueNAS UI.

If TrueCommand 3.0.2 is used to upgrade HA systems, the standby controller might fail to activate the updated boot environment, resulting in a version mismatch error between the controllers. If you encounter this issue, manually activate the updated boot environment on the active controller and then failover to complete the upgrade.
{{< /enterprise >}}

* The **Explore > Snapshots** tab can timeout when selected for datasets with high numbers of stored snapshots ([TC-3078](https://ixsystems.atlassian.net/browse/TC-3078)).

* Changes made to SMTP email configuration after initial setup might not apply for new users created after created after the configuration updates.
If you have previously updated your SMTP configuration, create new user accounts as described in [Creating User Accounts]({{< relref "UserAccounts.md" >}}).
Log in as the new user and review settings in **Alert Services > SMTP Email** to confirm they are correct.

* Removing all the systems from a group doesn't automatically delete the group. However, the system group is still manually removable.

<a href="https://ixsystems.atlassian.net/issues/?filter=10581" target="_blank">Click here to see the latest Jira tickets</a> about known issues in 3.0.2 that are being resolved in a future TrueCommand release.

## 3.0.1 Changelog

{{< expand "Click to Expand" "v" >}}
**March 12, 2024**

iXsystems is pleased to release TrueCommand 3.0.1!
Expand Down Expand Up @@ -108,6 +166,7 @@ If TrueCommand 3.0.1 is used to upgrade HA systems, the standby controller might
* The **Explore > Snapshots** tab can timeout when selected for datasets with high numbers of stored snapshots ([TC-3078](https://ixsystems.atlassian.net/browse/TC-3078)).

<a href="https://ixsystems.atlassian.net/issues/?filter=10510" target="_blank">Click here to see the latest Jira tickets</a> about known issues in 3.0.1 that are being resolved in a future TrueCommand release.
{{< /expand >}}

## 3.0.0 Changelog

Expand Down
Loading

0 comments on commit 5715086

Please sign in to comment.