Get a Quote   (408) 943-4100               TrueNAS Discord      VendOp_Icon_15x15px   Commercial Support Toggle between Light and Dark mode

Clusters Screen

  7 minute read.

Last Modified 2022-07-14 15:10 EDT

TrueCommand 2.2, in conjunction with TrueNAS SCALE, can create and manage clusters, cluster volumes, and cluster volume shares.

Clusters are an experimental feature in TrueCommand 2.2. Before using such features, please back up all your data. Do not rely on this for critical data.

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.

ClustersScreen

When no clusters are created, there is a single option on this screen:

SettingValueDescription
CREATE CLUSTERbuttonOpens the form to create a new cluster.

Create Cluster

The cluster creation options are split into two pages: system selection and confirmation.

Systems

The initial form has two fields:

CreateClusterSystems

SettingValueDescription
NamestringIdentifies the cluster.
SystemsdropdownShows all connected TrueNAS SCALE systems available for this cluster. Clusters can consist of between 3 and 20 individual SCALE systems.
NextbuttonAdvances the form to the next screen.

Making selections in the Systems field adds more options.

CreateClusterSystemsNetwork

SettingValueDescription
DeletebuttonClicking the Delete icon removes the system from the cluster.
Network AddressdropdownShows available IP addresses to use for cluster traffic. Using private dedicated network addresses is recommended.

Confirmation

There is a single option on this page.

CreateClusterReview

SettingValueDescription
CREATEbuttonBegins the creation process for a cluster. This restricts the SMB functionality on the SCALE systems.

Configure Cluster

Successfully creating a cluster immediately adds a cluster widget to the Clusters screen and opens options to configure the new cluster. These options are split into three screens: SMB Network, Active Directory, and Confirmation.

SMB Network

The SMB Network page has general options and fields added for each SCALE system in the cluster.

ConfigureClusterSMBNetwork

SettingValueDescription
NEXTbuttonContinues to the next page.
Skip this stepcheckboxFinalize the cluster configuration without registering a network to use for SMB sharing. Setting this permanently removes the ability to share data stored in this cluster.
InterfacedropdownSCALE system network interface to use for SMB traffic. For best functionality, choose an interface that can communicate between the individual SCALE systems, TrueCommand environment, Active Directory, and and client systems that need to access data shared from this cluster.
AddressdropdownIP address used for clients to access the SCALE system.

Active Directory

The options on this page are used to establish a connection between an Active Directory environment, SCALE systems, and TrueCommand.

ConfigureClusterActiveDirectory

SettingValueDescription
NEXTbuttonContinues to the next page.
Domain NamestringMicrosoft Active Directory (AD) environment host name. Establishes a connection between the entered host and TrueCommand.
UsernamestringAccount credential used to establish the AD connection. Requires an account with administrative access.
PasswordstringAccount credential used to establish the AD connection. Requires an account with administrative access.

Confirmation

All chosen settings display here for final confirmation before being applied to the cluster.

ConfigureClusterReview

SettingValueDescription
CONFIRMbuttonSaves the configuration settings and permanently applies them to the cluster.

Manage Clusters

Clusters are shown as standalone cards.

ClusterCard

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.

SettingValueDescription
CREATE VOLUMEbuttonOpens the form to create new clustered storage.
RenamebuttonShows a form to enter a new Cluster Name.
DeletebuttonDisconnects each SCALE system from the cluster and removes the card from TrueCommand. Shows a confirmation popup when clicked.

Cluster Volumes

Clicking CREATE VOLUME for an existing cluster shows options to configure new clustered storage. The options are split into two pages: Details and Confirmation.

Details

ClustersCreateVolumeDetails

SettingValueDescription
NEXTbuttonContinues to the next page.
NamestringIdentifying label for this cluster volume.
TypedropdownLayout and behavior for the volume.
Clusterstring (disabled)Shows the cluster that controls the new volume.
Brick Sizeinteger and dropdownStorage capacity. Accepts numeric values and selecting units of size.
PoolsdropdownStorage pool on the individual SCALE system that provides capacity for the cluster volume.

The Type field has four options:

  • Distributed - Distribute files across the bricks in the volume. You can use distributed volumes where the requirement is to scale storage and the redundancy is either not important or is provided by other hardware/software layers.
  • Replicated - Replicate files across bricks in the volume. You can use replicated volumes in environments where high-availability and high-reliability are critical.
  • Distributed Replicated - Distribute files across replicated bricks in the volume. You can use distributed replicated volumes in environments where the requirement is to scale storage and high-reliability is critical. Distributed replicated volumes also offer improved read performance in most environments. Requires setting an additional Replica Count
  • Dispersed - Dispersed volumes are based on erasure codes, providing space-efficient protection against disk or server failures. It stores an encoded fragment of the original file to each brick in a way that only a subset of the fragments is needed to recover the original file. The number of bricks that can be missing without losing access to data is configured by the administrator on volume creation time. Requires setting an additional Redundancy Count.

Confirmation

The Confirmation page shows details about the chosen volume Type and storage makeup of the new clustered volume.

ClustersCreateVolumeConfirmation

SettingValueDescription
BACKbuttonGoes to the previous configuration page.
CREATEbuttonSaves the configuration and builds the clustered volume on each system in the cluster.

Managing Cluster Volumes

Created cluster volumes display in the related cluster card.

ClusterCardwithVolume

The name, current used storage, and status of the volume show on the card. Click the volume name to expand the details and see more management options.

ClustersClusterVolumeExpanded

SettingValueDescription
DELETEbuttonRemoves the volume from the cluster. This destroys any stored data.
CREATE SHAREbuttonOpens the form to configure a new SMB share. This allows remote access to this cluster volume.

Cluster Volume Sharing

Adding a cluster share shows a few options.

ClustersClusterVolumeExpandedCreateShare

SettingValueDescription
Clusterstring (disabled)Shows the name of the cluster related to this share.
Cluster Volumestring (disabled)Shows the name of the cluster volume to share.
NamestringLabel for this new cluster share.
ACLdropdownAccess Control List. Sets permissions for the share.
ReadonlycheckboxDisables or allows file management options for connected users. Set to disable.
CONFIRMbuttonSaves the settings, creates the share, and makes the cluster volume accessible to Active Directory user accounts.

ACL Options

  • POSIX_OPEN - Template that grants read, write, and execute permissions to all users.
  • POSIX_RESTRICTED - Template that grants read, write, and execute to owner and group, but not other. The template may optionally include the special-purpose ‘builtin_users’ and ‘builtin_administrators’ groups as well as Domain Users and Domain Admins groups in Active Directory environments.

Managing Cluster Volume Shares

Open the Cluster Volume Details to see any shares. Click the Options icon to see the share options.

ClustersClusterVolumeExpandedShareOptions

SettingValueDescription
DELETEbuttonRemove the share from the Cluster Volume. No data is destroyed in this operation.

See Also