Skip to content

Commit

Permalink
Merge branch 'master' into DOCS-4250-TC-2.2.2-Release-Notes
Browse files Browse the repository at this point in the history
  • Loading branch information
@micjohnson777
micjohnson777 authored Oct 17, 2022
2 parents 919e4f1 + d97d347 commit b2e457c
Show file tree
Hide file tree
Showing 5 changed files with 77 additions and 77 deletions.
151 changes: 76 additions & 75 deletions content/TrueCommand/Clusters.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -27,17 +27,17 @@ To see this screen, log in to TrueCommand and click the <span class="iconify" da
![ClustersScreen](/images/TrueCommand/2.2/ClustersScreen.png "TrueCommand Clusters Screen")

{{< expand "Option descriptions (click to expand)" "v" >}}
When no clusters are created, there is a single option on this screen:
If you have not created a cluster, there is a single option on this screen:

| Setting | Value | Description |
|---------|-------|-------------|
| CREATE CLUSTER | button | Opens the form to create a new cluster. |
| Setting | Description |
|---------|-------------|
| **CREATE CLUSTER** | Button. Opens the form to create a new cluster. |

{{< /expand >}}

### Create Cluster

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

#### Systems

Expand All @@ -47,11 +47,11 @@ The initial form has two fields:

{{< expand "Option descriptions (click to expand)" "v" >}}

| Setting | Value | Description |
|---------|-------|-------------|
| Name | string | Identifies the cluster. |
| Systems | dropdown | Shows all connected TrueNAS SCALE systems available for this cluster. Clusters can consist of between 3 and 20 individual SCALE systems. |
| Next | button | Advances the form to the next screen. |
| Setting | Description |
|---------|-------------|
| **Name** | String. Identifies 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. |
| **Next** | Button. Advances the form to the next screen. |

{{< /expand >}}

Expand All @@ -61,10 +61,10 @@ Making selections in the **Systems** field adds more options.

{{< expand "Option descriptions (click to expand)" "v" >}}

| Setting | Value | Description |
|---------|-------|-------------|
| Delete | button | Clicking the <i class="material-icons" aria-hidden="true" title="Delete">delete</i> **Delete** icon removes the system from the cluster. |
| Network Address | dropdown | Shows available IP addresses to use for cluster traffic. Using private dedicated network addresses is recommended. |
| Setting | Description |
|---------|-------------|
| **Delete** | Clicking the <i class="material-icons" aria-hidden="true" title="Delete">delete</i> **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. |

{{< /expand >}}

Expand All @@ -76,68 +76,69 @@ There is a single option on this page.

{{< expand "Option descriptions (click to expand)" "v" >}}

| Setting | Value | Description |
|---------|-------|-------------|
| CREATE | button | Begins the creation process for a cluster. This restricts the SMB functionality on the SCALE systems. |
| Setting | Description |
|---------|-------------|
| **CREATE** | Button. Begins the creation process for a cluster. This restricts the SMB functionality on the SCALE systems. |

{{< /expand >}}

### 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**.
Successfully creating a cluster adds a cluster widget to the **Clusters** screen and opens options to configure the new cluster.
These options 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.
The SMB Network page has options and fields added for each SCALE system in the cluster.

![ConfigureClusterSMBNetwork](/images/TrueCommand/2.2/ConfigureClusterSMBNetwork.png "Configure Cluster SMB Network")

{{< expand "Option descriptions (click to expand)" "v" >}}

| Setting | Value | Description |
|---------|-------|-------------|
| NEXT | button | Continues to the next page. |
| Skip this step | checkbox | Finalize 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. |
| Interface | dropdown | SCALE 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. |
| Address | dropdown | IP address used for clients to access the SCALE system. |
| Setting | Description |
|---------|-------------|
| **NEXT** | Button. Continues to the next page. |
| **Skip this step** | Checkbox. Finalize the cluster configuration without registering a network to use for SMB sharing. Selecting this permanently removes the ability to share data stored in this cluster. |
| **Interface** | Dropdown list. SCALE 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 client systems that need to access data shared from this cluster. |
| **Address** | Dropdown list. IP address used for clients to access the SCALE system. |
| **Netmask** | Dropdown list. Netmask for the IP address. |

{{< /expand >}}

#### Active Directory

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

![ConfigureClusterActiveDirectory](/images/TrueCommand/2.2/ConfigureClusterActiveDirectory.png "Configure Cluster Active Directory Connection")

{{< expand "Option descriptions (click to expand)" "v" >}}

| Setting | Value | Description |
|---------|-------|-------------|
| NEXT | button | Continues to the next page. |
| Domain Name | string | Microsoft Active Directory (AD) environment host name. Establishes a connection between the entered host and TrueCommand. |
| Username | string | Account credential used to establish the AD connection. Requires an account with administrative access. |
| Password | string | Account credential used to establish the AD connection. Requires an account with administrative access. |
| Setting | Description |
|---------|-------------|
| **NEXT** | Button. Continues to the next page. |
| **Domain Name** | String. Microsoft Active Directory (AD) environment host name. Establishes a connection between the entered host and TrueCommand. |
| **Username** | String. Account credential used to establish the AD connection. Requires an account with administrative access. |
| **Password** | String. Account credential used to establish the AD connection. Requires an account with administrative access. |

{{< /expand >}}

#### Confirmation

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

![ConfigureClusterReview](/images/TrueCommand/2.2/ConfigureClusterReview.png "Configure Cluster: Review and confirm")

{{< expand "Option descriptions (click to expand)" "v" >}}

| Setting | Value | Description |
|---------|-------|-------------|
| CONFIRM | button | Saves the configuration settings and permanently applies them to the cluster. |
| Setting | Description |
|---------|-------------|
| **CONFIRM** | Button. Saves the configuration settings and permanently applies them to the cluster. |

{{< /expand >}}

## Manage Clusters

Clusters are shown as standalone cards.
Clusters display as standalone cards.

![ClusterCard](/images/TrueCommand/2.2/ClusterCard.png "TrueCommand Cluster View")

Expand All @@ -147,33 +148,33 @@ Click the **^** or **v** icons to minimize or expand (respectively) the list of

{{< expand "Option descriptions (click to expand)" "v" >}}

| Setting | Value | Description |
|---------|-------|-------------|
| CREATE VOLUME | button | Opens the form to create new clustered storage. |
| Rename | button | Shows a form to enter a new **Cluster Name**. |
| Delete | button | Disconnects each SCALE system from the cluster and removes the card from TrueCommand. Shows a confirmation popup when clicked. |
| Setting | Description |
|---------|-------------|
| **CREATE VOLUME** | Button. Opens the form to create new clustered storage. |
| **Rename** | Button. Shows a form to enter a new **Cluster Name**. |
| **Delete** | Button. Disconnects each SCALE system from the cluster and removes the card from TrueCommand. Shows a confirmation popup when clicked. |

{{< /expand >}}

## 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**.
The options split into two pages: **Details** and **Confirmation**.

### Details

![ClustersCreateVolumeDetails](/images/TrueCommand/2.2/ClustersCreateVolumeDetails.png "Add Cluster Volume: Details")

{{< expand "Option descriptions (click to expand)" "v" >}}

| Setting | Value | Description |
|---------|-------|-------------|
| NEXT | button | Continues to the next page. |
| Name | string | Identifying label for this cluster volume. |
| Type | dropdown | Layout and behavior for the volume. |
| Cluster | string (disabled) | Shows the cluster that controls the new volume. |
| Brick Size | integer and dropdown | Storage capacity. Accepts numeric values and selecting units of size. |
| Pools | dropdown | Storage pool on the individual SCALE system that provides capacity for the cluster volume. |
| Setting | Description |
|---------|-------------|
| **NEXT** | Button. Continues to the next page. |
| **Name** | String. Identifying label for this cluster volume. |
| **Type** | Dropdown list. Layout and behavior for the volume. |
| **Cluster** | String (disabled). Shows the cluster that controls the new volume. |
| **Brick Size** | Integer and dropdown list. Storage capacity. Accepts numeric values and selecting units of size. |
| **Pools** | Dropdown list. Storage pool on the individual SCALE system that provides capacity for the cluster volume. |

The **Type** field has four options:

Expand All @@ -183,16 +184,16 @@ The **Type** field has four options:

### Confirmation

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

![ClustersCreateVolumeConfirmation](/images/TrueCommand/2.2/ClustersCreateVolumeConfirmation.png "Add Cluster Volume: Review and create")

{{< expand "Option descriptions (click to expand)" "v" >}}

| Setting | Value | Description |
|---------|-------|-------------|
| BACK | button | Goes to the previous configuration page. |
| CREATE | button | Saves the configuration and builds the clustered volume on each system in the cluster. |
| Setting | Description |
|---------|-------------|
| **BACK** | Button. Goes to the previous configuration page. |
| **CREATE** | Button. Saves the configuration and builds the clustered volume on each system in the cluster. |

{{< /expand >}}

Expand All @@ -202,17 +203,17 @@ Created cluster volumes display in the related cluster card.

![ClusterCardwithVolume](/images/TrueCommand/2.2/ClusterCardwithVolume.png "Cluster Volume added to a Cluster")

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

![ClustersClusterVolumeExpanded](/images/TrueCommand/2.2/ClustersClusterVolumeExpanded.png "Cluster Volume Details")

{{< expand "Option descriptions (click to expand)" "v" >}}

| Setting | Value | Description |
|---------|-------|-------------|
| DELETE | button | Removes the volume from the cluster. This destroys any stored data. |
| CREATE SHARE | button | Opens the form to configure a new SMB share. This allows remote access to this cluster volume. |
| Setting | Description |
|---------|-------------|
| **DELETE** | Button. Removes the volume from the cluster. This destroys any stored data. |
| **CREATE SHARE** | Button. Opens the form to configure a new SMB share. This allows remote access to this cluster volume. |

{{< /expand >}}

Expand All @@ -224,14 +225,14 @@ Adding a cluster share shows a few options.

{{< expand "Option descriptions (click to expand)" "v" >}}

| Setting | Value | 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 | string | Label for this new cluster share. |
| ACL | dropdown | Access Control List. Sets permissions for the share. |
| Readonly | checkbox | Disables or allows file management options for connected users. Set to disable. |
| CONFIRM | button | Saves the settings, creates the share, and makes the cluster volume accessible to Active Directory user accounts. |
| 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** | String. Label for this new cluster share. |
| **ACL** | Dropdown list. Access Control List. Sets permissions for the share. |
| **Readonly** | Checkbox. Disables or allows file management options for connected users. Select to disable. |
| **CONFIRM** | Button. Saves the settings, creates the share, and makes the cluster volume accessible to Active Directory user accounts. |

**ACL Options**

Expand All @@ -242,16 +243,16 @@ Adding a cluster share shows a few options.

#### Managing Cluster Volume Shares

Open the **Cluster Volume Details** to see any shares.
Click the <i class="material-icons" aria-hidden="true" title="Options">more_vert</i> **Options** icon to see the share options.
Click the cluster volume name to open the **Cluster Volume Details** and see any shares.

![ClustersClusterVolumeExpandedShareOptions](/images/TrueCommand/2.2/ClustersClusterVolumeExpandedShareOptions.png "Cluster Volume Share Options")

{{< expand "Option descriptions (click to expand)" "v" >}}

| Setting | Value | Description |
|---------|-------|-------------|
| DELETE | button | Remove the share from the Cluster Volume. No data is destroyed in this operation. |
| Setting | Description |
|---------|-------------|
| **DELETE** | Button. Remove the share from the Cluster Volume. No data is destroyed in this operation. |
| **CREATE SHARE** | Button. Opens the form to configure a new SMB share. This allows remote access to this cluster volume. |

{{< /expand >}}

Expand Down
3 changes: 1 addition & 2 deletions content/_includes/ClusterTypes.md
View file
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
* **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**
* **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**.
Binary file modified static/images/TrueCommand/2.2/ClusterCardwithVolume.png
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified static/images/TrueCommand/2.2/ConfigureClusterReview.png
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified static/images/TrueCommand/2.2/ConfigureClusterSMBNetwork.png
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit b2e457c

Please sign in to comment.