diff --git a/content/AdminGuide/Users.md b/content/AdminGuide/Users.md index 7745e39c2c..9f639b2c6b 100644 --- a/content/AdminGuide/Users.md +++ b/content/AdminGuide/Users.md @@ -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. @@ -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 >}} diff --git a/content/TCGettingStarted/InterfaceOverview.md b/content/TCGettingStarted/InterfaceOverview.md index 6748b38080..833eaa52c7 100644 --- a/content/TCGettingStarted/InterfaceOverview.md +++ b/content/TCGettingStarted/InterfaceOverview.md @@ -18,7 +18,6 @@ The top toolbar switches between the various TrueCommand feature screens and has |------|-------------| | **Home** | Opens the primary TrueCommand Dashboard with live stats and options for connected TrueNAS systems. | | **Fleet Dash** | The expanded [**Fleet Dashboard**]({{< relref "FleetDashboard.md" >}}) collects metrics, notifications, and configuration details for every connected TrueNAS system. | -| **Clusters** | The [**Clusters**]({{< relref "Clusters.md" >}}) page manages configurations of synchronized TrueNAS systems that are functioning as a single data storage cluster. | | **Reports** | The [**Reports**]({{< relref "Creation.md" >}}) page for viewing and creating custom visualizations of connected TrueNAS system statistics. | | **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) | @@ -36,7 +35,6 @@ The **Settings** menu has these options: |--------|-------------| | Dashboard | Opens the primary TrueCommand Dashboard. | | System Inventory | The [**System Inventory**]({{< relref "MultiSystems.md" >}}) screen has expanded license and serial number details about TrueNAS systems that are connected to TrueCommand. | -| Clusters | Opens the [Clusters]({{< relref "Clusters.md" >}}) screen. | | Reports | Opens the [**Reports**]({{< relref "/UserGuide/Reports/Creation.md" >}}) screen. | | 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. | | 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. | diff --git a/content/TCGettingStarted/TCReleaseNotes.md b/content/TCGettingStarted/TCReleaseNotes.md index fc48a06af6..1dfd481607 100644 --- a/content/TCGettingStarted/TCReleaseNotes.md +++ b/content/TCGettingStarted/TCReleaseNotes.md @@ -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. @@ -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 @@ -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 @@ -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)) + +Click here for the full changelog 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. + +Click here to see the latest Jira tickets 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! @@ -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)). Click here to see the latest Jira tickets about known issues in 3.0.1 that are being resolved in a future TrueCommand release. +{{< /expand >}} ## 3.0.0 Changelog diff --git a/content/UserGuide/Alerts/AlertManage.md b/content/UserGuide/Alerts/AlertManage.md index 32de8c77a0..33f931bf2c 100644 --- a/content/UserGuide/Alerts/AlertManage.md +++ b/content/UserGuide/Alerts/AlertManage.md @@ -9,8 +9,8 @@ tags: TrueCommand alerts provide visual warnings for monitored systems that require attention. Monitored TrueNAS systems and TrueCommand alert rules can both generate alerts. -TrueCommand can discover and show TrueNAS system alerts created created in the last two months. -Alerts older than this do not show in TrueCommand. +TrueCommand can discover and show TrueNAS system alerts created created in the last two months. +Alerts older than this do not show in TrueCommand. Administrator accounts can see all system alerts but non-administrator accounts can only see alerts on systems they are permitted to access. @@ -38,14 +38,14 @@ System widgets on the main **Dashboard** and the **Systems** screen display blue ![DashboardSingleSystemview](/images/TrueCommand/Dashboard/DashboardSingleSystemView.png "Dashboard System Widget Alerts") -Click on the system name on a main **Dashboard** system widget to open the detailed single system screen. Each single system detail screen includes an **Alerts** widget that displays alerts for that system. +Click on the system name on a main **Dashboard** system widget to open the detailed single system screen. Each single system detail screen includes an **Alerts** widget that displays alerts for that system. ![DashboardSystemDetailAlerts](/images/TrueCommand/Dashboard/DashboardSystemDetailAlerts.png "Dashboard System Detail Alerts") -Click the arrow icon at the top right corner of the single system **Alerts** widget to open the **Alert Notices** screen. +Click the arrow icon at the top right corner of the single system **Alerts** widget to open the **Alert Notices** screen. Alternatively, click the gear icon on the top toolbar, then click **All Alerts** to open the same **Alert Notices** screen. -To view all alerts from the **Systems** screen system list, click the blue alert bubble to open the single system detail screen with the **Alerts** widget. +To view all alerts from the **Systems** screen system list, click the blue alert bubble to open the single system detail screen with the **Alerts** widget. ### Resolving Alerts To resolve an alert, select the checkbox to the left of the alert, then click **RESOLVE SELECTED**. A green checkmark displays in the **Dismissed** column. @@ -78,7 +78,7 @@ To view all TrueCommand alert rules, click the gear icon, then click **Alert Services**. +To configure an alert service plugin, click the gear icon, then click **Alert Services**. TrueCommand has two alert services: * **PagerDuty** plugin that configures a pager to receive an alert. * **SMTP Email** plugin that configures system SMTP and user email services. @@ -120,12 +120,12 @@ TrueCommand has two alert services: Each plugin has three options: * **Send test alert** -* **Configure plugin** -* **Clear plugin configuration** +* **Configure plugin** +* **Clear plugin configuration** ### Configuring SMTP Email {{< hint type=note >}} -Before proceeding, verify that the sending mail server has TLS enabled. +Before proceeding, verify that the sending mail server has TLS enabled. TrueCommand cannot send emails through a mail server without TLS. The user profile page must have an email address to receive emails. {{< /hint >}} @@ -133,21 +133,23 @@ The user profile page must have an email address to receive emails. To configure SMTP service: 1. Enter values in all fields on the **SMTP Email** screen and then click **SAVE**: - + ![AlertServiceSMTPEmailScreen](/images/TrueCommand/Alerts/AlertServiceSMTPEmailScreen.png "Alert Services: SMTP Email options") Enter the host name for the mail server in **Mailserver** (*smtp.gmail.com* for example). Enter the port number for the mail server in **Mailserver port**. + Use port *465* for best security with SSL/TLS encryption. - Enter the email address for plain authentication in **Auth user**, for example, *adminuser@yourmail.com*, and the password for plain authentication in **Auth pass**. 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. + Enter the email address for plain authentication in **Username**, for example, *adminuser@yourmail.com*, and the password for plain authentication in **Password**. + For a *No-Auth* SMTP configuration, leave the password field blank. + + If configuring smtp.gmail.com, create an **App Password** in the Gmail account. + Enter this password here to configure Gmail SMTP service authentication. - Enter the address that sends the email (i.e., no-reply@TrueCommand.io) or allows you to customize the sender field of the email in **From** + Enter the address that sends the email (i.e., no-reply@TrueCommand.io) or allows you to customize the sender field of the email in **From Address** - Select **Tls** to initiate a connection with TLS. + Select **Enable TLS** to initiate a connection with TLS. Click **Test** on the **SMTP Email** configuration screen to verify that the configuration is correct. If you do not receive a test alert email, check the values entered are accurate. @@ -155,22 +157,22 @@ To configure SMTP service: The system displays pop-up messages to prompt you if the email address for the administration user account (root or admin user) is not added. 2. Click on the avatar to the right of the gear icon, then click **Profile**. - + ![EditUserProfile](/images/TrueCommand/Alerts/EditUserProfile.png "Edit User Profile") 3. Type the email for that user in the **Email** field and click **SAVE CHANGES**. The first time you set up SMTP email, a **VERIFY EMAIL** button displays below the **Email** field to the left of the **Enable 2FA** checkbox. - The system should automatically send a test email to the specified email address. + The system should automatically send a test email to the specified email address. If not, click **VERIFY EMAIL**. Enter or copy/paste the code emailed to verify the email in the **Confirm** dialog. - + ![SMTPSetupVerifyEmail](/images/TrueCommand/Users/SMTPSetupVerifyEmail.png "SMTP Setup Verify Email") ### Configuring PagerDuty Open the **Configure Plugin** for PagerDuty. -Enter the pagerDuty API key in the **Authtoken** field. +Enter the pagerDuty API key in the **Authtoken** field. If you have an active subscription with PagerDuty, the key should be available to you. Click **TEST**. ![AlertServicesPagerDutyOptions](/images/TrueCommand/Alerts/AlertServicesPagerDutyOptions.png "Alert Services: Pager Duty options") diff --git a/content/UserGuide/Clusters.md b/content/UserGuide/Clusters.md deleted file mode 100644 index 5e4064310a..0000000000 --- a/content/UserGuide/Clusters.md +++ /dev/null @@ -1,282 +0,0 @@ ---- -title: "Clusters" -description: "Option descriptions in the TrueCommand Clusters menu." -weight: 30 -geekdocCollapseSection: true -tags: - - clustering ---- - -{{< hint type="warning" title="Deprecated Feature" >}} -{{< include file="/static/includes/ClusterDeprecated.md" >}} -{{< /hint >}} - -This article describes the various screens used for clustering TrueNAS SCALE systems with TrueCommand. -If you want to create and integrate clusters, see [Clustering and Sharing SCALE Volumes with TrueCommand](https://www.truenas.com/docs/solutions/integrations/smbclustering/). - -## Clusters - -The **Clusters** screen contains all options related to the cluster feature. -To see this screen, log in to TrueCommand and click the **Clusters** icon in the upper left. - -{{< trueimage src="/images/TrueCommand/Clusters/ClustersScreen.png" alt="TrueCommand Clusters Screen" id="TrueCommand Clusters Screen" >}} - -{{< expand "Option descriptions (click to expand)" "v" >}} -If you have not created a cluster, there is a single option on this screen: - -{{< truetable >}} -| Setting | Description | -|---------|-------------| -| **CREATE CLUSTER** | Opens the form to create a new cluster. | -{{< /truetable >}} - -{{< /expand >}} - -### Create Cluster - -The cluster creation options split into two pages: **Systems** and **Confirmation**. - -#### Systems - -The initial form has two fields: - -{{< trueimage src="/images/TrueCommand/Clusters/CreateClusterSystems.png" alt="Configuring Systems in the Cluster" id="Configuring Systems in the Cluster" >}} - -{{< expand "Option descriptions (click to expand)" "v" >}} - -{{< truetable >}} -| Setting | Description | -|---------|-------------| -| **Name** | Enter a string to identify the cluster. | -| **Systems** | Dropdown list shows all connected TrueNAS SCALE systems available for this cluster. Clusters can consist of between 3 and 20 individual SCALE systems. | -{{< /truetable >}} - -{{< /expand >}} - -Making selections in the **Systems** field adds more options. - -{{< trueimage src="/images/TrueCommand/Clusters/CreateClusterSystemsNetwork.png" alt="Network Options for Clustered Systems" id="Network Options for Clustered Systems" >}} - -{{< expand "Option descriptions (click to expand)" "v" >}} - -{{< truetable >}} -| Setting | Description | -|---------|-------------| -| **Delete** | Clicking the **Delete** icon removes the system from the cluster. | -| **Network Address** | Dropdown list shows available IP addresses to use for cluster traffic. Using private dedicated network addresses is recommended. | -{{< /truetable >}} - -{{< /expand >}} - -#### Confirmation - -There is a single option on this page. - -{{< trueimage src="/images/TrueCommand/Clusters/CreateClusterReview.png" alt="Review and create page for Clusters" id="Review and create page for Clusters" >}} - -{{< expand "Option descriptions (click to expand)" "v" >}} - -{{< truetable >}} -| Setting | Description | -|---------|-------------| -| **CREATE** | Begins creating the cluster, which restricts the SMB functionality on the SCALE systems. | -{{< /truetable >}} - -{{< /expand >}} - -### Configure Cluster - -Successfully creating a cluster adds a cluster widget to the **Clusters** screen and opens options to configure the new cluster. -These options are split into four screens: **VIPs**, **Associate VIPs**, **Active Directory**, and **Confirmation**. - -#### VIPs - -The VIPs page has options and fields added for each SCALE system in the cluster. - -{{< trueimage src="/images/TrueCommand/Clusters/ConfigureClusterSMBNetwork.png" alt="Configure Cluster SMB Network" id="Configure Cluster SMB Network" >}} - -{{< truetable >}} -| Setting | Description | -|---------|-------------| -| **ADD** | Adds another line under VIPs for IPs and netmasks. | -| **Address** | Virtual IP address for one of the cluster systems. | -| **Netmask** | Netmask for the IP address. | -{{< /truetable >}} - -#### Associate VIPs - -The Associate VIPs page allows you to select interfaces to assign to the VIPs. - -{{< trueimage src="/images/TrueCommand/Clusters/ConfigureClusterAssociateVIPs.png" alt="Configure Associate VIPs" id="Configure Associate VIPs" >}} - -{{< truetable >}} -| Setting | Description | -|---------|-------------| -| **Interface** | Select an interface from the dropdown list of interface options and assign it to the VIP. | -{{< /truetable >}} - -#### Active Directory - -The options on this page let you establish a connection between an Active Directory environment, SCALE systems, and TrueCommand. - -{{< trueimage src="/images/TrueCommand/Clusters/ConfigureClusterActiveDirectory.png" alt="Configure Cluster Active Directory Connection" id="Configure Cluster Active Directory Connection" >}} - -{{< expand "Option descriptions (click to expand)" "v" >}} - -{{< truetable >}} -| Setting | Description | -|---------|-------------| -| **Domain Name** | Enter a string for the Microsoft Active Directory (AD) environment host name. -| **NetBIOS** | Automatically populates with the cluster name. | -| **Username** | Enter a string for the account credential to establish the AD connection. You must use an account with administrative access. | -| **Password** | Enter a string for the account credential to establish the AD connection. You must use an account with administrative access. | -{{< /truetable >}} - -{{< /expand >}} - -#### Confirmation - -All chosen settings display here for you to confirm before being applied to the cluster. - -{{< trueimage src="/images/TrueCommand/Clusters/ConfigureClusterReview.png" alt="Configure Cluster: Review and confirm" id="Review and Confirm" >}} - -{{< expand "Option descriptions (click to expand)" "v" >}} - -{{< truetable >}} -| Setting | Description | -|---------|-------------| -| **CONFIRM** | Saves the configuration settings and permanently apply them to the cluster. | -{{< /truetable >}} - -{{< /expand >}} - -## Manage Clusters - -Clusters display as standalone cards. - -{{< trueimage src="/images/TrueCommand/Clusters/ClusterCard.png" alt="TrueCommand Cluster View" id="TrueCommand Cluster View" >}} - -The card displays the name of the cluster, the current state, and the names of the systems used in the cluster (**Nodes**). -Click the **Options** icon to see management options for the cluster. -Click the **^** or **v** icons to minimize or expand (respectively) the list of nodes. - -{{< expand "Option descriptions (click to expand)" "v" >}} - -{{< truetable >}} -| Setting | Description | -|---------|-------------| -| **CREATE VOLUME** | Opens the form to create new clustered storage. | -| **Rename** | Opens the form to enter a new **Cluster Name**. | -| **Delete** | Disconnects each SCALE system from the cluster and removes the card from TrueCommand. Shows a confirmation popup when clicked. | -{{< /truetable >}} - -{{< /expand >}} - -## Cluster Volumes - -Clicking **CREATE VOLUME** for an existing cluster shows options to configure new clustered storage. -The options split into two pages: **Details** and **Confirmation**. - -### Details - -{{< trueimage src="/images/TrueCommand/Clusters/ClustersCreateVolumeDetails.png" alt="Add Cluster Volume: Details" id="Details" >}} - -{{< expand "Option descriptions (click to expand)" "v" >}} - -{{< truetable >}} -| Setting | Description | -|---------|-------------| -| **Name** | Enter a string as an identifying label for this cluster volume. | -| **Type** | Dropdown list. Select the layout and behavior for the volume. | -| **Cluster** | String (disabled). Shows the cluster that controls the new volume. | -| **Brick Size** | Enter an integer and select from the dropdown list to define storage capacity. Allows numeric values and selecting units of size. | -| **Pools** | Dropdown list. Select a storage pool on the individual SCALE system that provides capacity for the cluster volume. | -{{< /truetable >}} - -The **Type** field has four options: - -{{< include file="/static/includes/ClusterTypes.md" >}} - -{{< /expand >}} - -### Confirmation - -The **Confirmation** page shows details for the chosen volume **Type** and storage makeup of the new clustered volume. - -{{< trueimage src="/images/TrueCommand/Clusters/ClustersCreateVolumeConfirmation.png" alt="Add Cluster Volume: Review and create" id="Review and Create" >}} - -{{< expand "Option descriptions (click to expand)" "v" >}} - -{{< truetable >}} -| Setting | Description | -|---------|-------------| -| **BACK** | Click the button to go to the previous configuration page. | -| **CREATE** | Click the button to save the configuration and build the clustered volume on each system in the cluster. | -{{< /truetable >}} - -{{< /expand >}} - -## Managing Cluster Volumes - -Created cluster volumes display in the related cluster card. - -{{< trueimage src="/images/TrueCommand/Clusters/ClusterCardwithVolume.png" alt="Cluster Volume added to a Cluster" id="Cluster Volume added to a Cluster" >}} - -The card displays the name, used storage, and volume status. -Click the volume name to expand the details and see more management options. - -{{< trueimage src="/images/TrueCommand/Clusters/ClustersClusterVolumeExpanded.png" alt="Cluster Volume Details" id="Cluster Volume Details" >}} - -{{< expand "Option descriptions (click to expand)" "v" >}} - -{{< truetable >}} -| Setting | Description | -|---------|-------------| -| **DELETE** | Click the button to remove the volume from the cluster and destroy stored data. | -| **CREATE SHARE** | Opens the form to configure a new SMB share for remote access to this cluster volume. | -{{< /truetable >}} - -{{< /expand >}} - -### Cluster Volume Sharing - -Adding a cluster share shows a few options. - -{{< trueimage src="/images/TrueCommand/Clusters/ClustersClusterVolumeExpandedCreateShare.png" alt="Add Cluster Share" id="Add Cluster Share" >}} - -{{< expand "Option descriptions (click to expand)" "v" >}} - -{{< truetable >}} -| Setting | Description | -|---------|-------------| -| **Cluster** | String (disabled). Shows the name of the cluster related to this share. | -| **Cluster Volume** | String (disabled). Shows the name of the cluster volume to share. | -| **Name** | Enter a string to create a label for this new cluster share. | -| **ACL** | Dropdown list. Access Control List. Choose permissions for the share. | -| **Readonly** | Checkbox disables or allows file management options for connected users. Select to disable. | -| **CONFIRM** | Click the button to save the settings, create the share, and make the cluster volume accessible to Active Directory user accounts. | -{{< /truetable >}} - -**ACL Options** - -* **POSIX_OPEN** - Grants read, write, and execute permissions to all users. -* **POSIX_RESTRICTED** - Grants read, write, and execute to owner and group, but not others. The template may optionally include the special-purpose 'builtin_users' and 'builtin_administrators' groups and Domain Users and Domain Admins groups in Active Directory environments. - -{{< /expand >}} - -#### Managing Cluster Volume Shares - -Click the cluster volume name to open the **Cluster Volume Details** and see any shares. - -{{< trueimage src="/images/TrueCommand/Clusters/ClustersClusterVolumeExpandedShareOptions.png" alt="Cluster Volume Share Options" id="Cluster Volume Share Options" >}} - -{{< expand "Option descriptions (click to expand)" "v" >}} - -{{< truetable >}} -| Setting | Description | -|---------|-------------| -| **DELETE** | Removes the share from the Cluster Volume. This operation does not destroy data. | -| **CREATE SHARE** | Opens the form to configure a new SMB share for remote access to this cluster volume. | -{{< /truetable >}} - -{{< /expand >}} diff --git a/content/UserGuide/SystemManagement/MultiSystems.md b/content/UserGuide/SystemManagement/MultiSystems.md index d650edb2f5..f582759d86 100644 --- a/content/UserGuide/SystemManagement/MultiSystems.md +++ b/content/UserGuide/SystemManagement/MultiSystems.md @@ -4,11 +4,9 @@ description: "How to find and use TrueNAS fleet management features in TrueComma weight: 30 --- -TrueCommand has several multisystem management capabilities including the [**Fleet Dashboard**}({{< relref "FleetDashboard.md" >}}) with more in development for future releases. +TrueCommand has several multisystem management capabilities including the [**Fleet Dashboard**]({{< relref "FleetDashboard.md" >}}). -TrueCommand cluster capability can apply TrueNAS configurations to multiple systems at once. - -## Mupliptle System Configuration Management +## Multiple System Configuration Management TrueCommand can manage TrueNAS [Config files]({{< relref "ConfigBackups.md" >}}), and restore a single config file to multiple systems. diff --git a/content/UserGuide/_index.md b/content/UserGuide/_index.md index e479a41120..f436f8a055 100644 --- a/content/UserGuide/_index.md +++ b/content/UserGuide/_index.md @@ -5,6 +5,8 @@ weight: 15 cascade: - _target: book: "TrueCmdUG" +aliases: + - /userguide/clusters/ --- TrueCommand supports creating additional user accounts that can log in to the web interface and use some TrueCommand features. diff --git a/data/properties/tc-releases.yaml b/data/properties/tc-releases.yaml index 3f70e28769..90b5f7961f 100644 --- a/data/properties/tc-releases.yaml +++ b/data/properties/tc-releases.yaml @@ -15,10 +15,10 @@ majorVersions: - lifecycle: "Stable" name: "TrueCommand 3.0" releases: - - name: "3.0.1" - type: "Stable" - link: "https://www.truenas.com/docs/truecommand/3.0/tcgettingstarted/tcreleasenotes/" - releaseDate: "2024-03-12" + - name: "3.0.2" + type: "Maintenance" + link: "https://www.truenas.com/docs/truecommand/3.0/tcgettingstarted/tcreleasenotes/#302-changelog" + releaseDate: "2024-08-13" latest: true - lifecycle: "Next" name: "TrueCommand Next" diff --git a/static/images/TrueCommand/Alerts/AlertServiceSMTPEmailScreen.png b/static/images/TrueCommand/Alerts/AlertServiceSMTPEmailScreen.png index 3f0ff38e5e..01f69d737c 100644 Binary files a/static/images/TrueCommand/Alerts/AlertServiceSMTPEmailScreen.png and b/static/images/TrueCommand/Alerts/AlertServiceSMTPEmailScreen.png differ diff --git a/static/includes/TCPermissionsHierarchy.md b/static/includes/TCPermissionsHierarchy.md index ec769f3b3a..06bd4a0b56 100644 --- a/static/includes/TCPermissionsHierarchy.md +++ b/static/includes/TCPermissionsHierarchy.md @@ -2,7 +2,7 @@ It is possible to configure multiple permissions for the same user account and system in different screens within TrueCommand. -When this happens, TrueCommand follows a specific flow to determine which permission settings control the account: +When this happens, TrueCommand follows a specific flow to check permission settings for the account: {{< mermaid class="mermaid_sizing" >}} flowchart TB @@ -10,7 +10,8 @@ flowchart TB A(User settings for individual systems) --> B(User settings for system groups) --> C(Teams settings for individual systems) --> D(Teams settings for system groups) {{< /mermaid >}} -For example, user *A* is configured to have direct read and write access to system *1*. -This permission remains in place, even if user *A* joins a TrueCommand team that is configured with read permission for system *1*. - When a user account has multiple permissions at the same level (user is a member of two teams that have different permissions to the same system), TrueCommand defaults to granting the user account the most permissive option between the conflicting permissions. + +For example, user *A* is configured to have direct read and write access to system *1*. +This permission remains in place, even if user *A* joins a TrueCommand team that is configured with read only permission for system *1*. +If user *A* is configured to have read only access to system *1* and joins a TrueCommand team with read and write permission for system *1*, the more permissive access is granted. diff --git a/words-to-ignore.txt b/words-to-ignore.txt index 50482a73c7..526cc19a7a 100644 --- a/words-to-ignore.txt +++ b/words-to-ignore.txt @@ -1725,3 +1725,5 @@ APIInterface defaultTab dereference bugfix +configuring-smtp-email +userguide \ No newline at end of file