Skip to content

Commit 5ba0942

Browse files
committed
DOCS-3298 (part 2) updated Clusters.md
Changed descriptions to incorporate active voice / directives now that value field is part of description. Bolded some field names.
1 parent d97d347 commit 5ba0942

File tree

1 file changed

+36
-36
lines changed

1 file changed

+36
-36
lines changed

content/TrueCommand/Clusters.md

Lines changed: 36 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ If you have not created a cluster, there is a single option on this screen:
3131

3232
| Setting | Description |
3333
|---------|-------------|
34-
| **CREATE CLUSTER** | Button. Opens the form to create a new cluster. |
34+
| **CREATE CLUSTER** | Click button to open the form to create a new cluster. |
3535

3636
{{< /expand >}}
3737

@@ -49,9 +49,9 @@ The initial form has two fields:
4949

5050
| Setting | Description |
5151
|---------|-------------|
52-
| **Name** | String. Identifies the cluster. |
53-
| **Systems** | Dropdown list. Shows all connected TrueNAS SCALE systems available for this cluster. Clusters can consist of between 3 and 20 individual SCALE systems. |
54-
| **Next** | Button. Advances the form to the next screen. |
52+
| **Name** | Enter a string to identify the cluster. |
53+
| **Systems** | Dropdown list shows all connected TrueNAS SCALE systems available for this cluster. Clusters can consist of between 3 and 20 individual SCALE systems. |
54+
| **Next** | Click button to advance the form to the next screen. |
5555

5656
{{< /expand >}}
5757

@@ -64,7 +64,7 @@ Making selections in the **Systems** field adds more options.
6464
| Setting | Description |
6565
|---------|-------------|
6666
| **Delete** | Clicking the <i class="material-icons" aria-hidden="true" title="Delete">delete</i> **Delete** icon removes the system from the cluster. |
67-
| **Network Address** | Dropdown list. Shows available IP addresses to use for cluster traffic. Using private dedicated network addresses is recommended. |
67+
| **Network Address** | Dropdown list shows available IP addresses to use for cluster traffic. Using private dedicated network addresses is recommended. |
6868

6969
{{< /expand >}}
7070

@@ -78,7 +78,7 @@ There is a single option on this page.
7878

7979
| Setting | Description |
8080
|---------|-------------|
81-
| **CREATE** | Button. Begins the creation process for a cluster. This restricts the SMB functionality on the SCALE systems. |
81+
| **CREATE** | Click button to begin the creation process for a cluster. This restricts the SMB functionality on the SCALE systems. |
8282

8383
{{< /expand >}}
8484

@@ -97,11 +97,11 @@ The SMB Network page has options and fields added for each SCALE system in the c
9797

9898
| Setting | Description |
9999
|---------|-------------|
100-
| **NEXT** | Button. Continues to the next page. |
101-
| **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. |
102-
| **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. |
103-
| **Address** | Dropdown list. IP address used for clients to access the SCALE system. |
104-
| **Netmask** | Dropdown list. Netmask for the IP address. |
100+
| **NEXT** | Click button to continue to the next page. |
101+
| **Skip this step** | Select checkbox to 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. |
102+
| **Interface** | Dropdown list shows 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. |
103+
| **Address** | Dropdown list shows IP address used for clients to access the SCALE system. |
104+
| **Netmask** | Dropdown list shows netmask for the IP address. |
105105

106106
{{< /expand >}}
107107

@@ -115,10 +115,10 @@ The options on this page let you establish a connection between an Active Direct
115115

116116
| Setting | Description |
117117
|---------|-------------|
118-
| **NEXT** | Button. Continues to the next page. |
119-
| **Domain Name** | String. Microsoft Active Directory (AD) environment host name. Establishes a connection between the entered host and TrueCommand. |
120-
| **Username** | String. Account credential used to establish the AD connection. Requires an account with administrative access. |
121-
| **Password** | String. Account credential used to establish the AD connection. Requires an account with administrative access. |
118+
| **NEXT** | Click button to continue to the next page. |
119+
| **Domain Name** | Enter a string for the Microsoft Active Directory (AD) environment host name. Establishes a connection between the entered host and TrueCommand. |
120+
| **Username** | Enter a string for the account credential used to establish the AD connection. Requires an account with administrative access. |
121+
| **Password** | Enter a string for the account credential used to establish the AD connection. Requires an account with administrative access. |
122122

123123
{{< /expand >}}
124124

@@ -132,7 +132,7 @@ All chosen settings display here for you to confirm before being applied to the
132132

133133
| Setting | Description |
134134
|---------|-------------|
135-
| **CONFIRM** | Button. Saves the configuration settings and permanently applies them to the cluster. |
135+
| **CONFIRM** | Click the button to save the configuration settings and permanently apply them to the cluster. |
136136

137137
{{< /expand >}}
138138

@@ -150,9 +150,9 @@ Click the **^** or **v** icons to minimize or expand (respectively) the list of
150150

151151
| Setting | Description |
152152
|---------|-------------|
153-
| **CREATE VOLUME** | Button. Opens the form to create new clustered storage. |
154-
| **Rename** | Button. Shows a form to enter a new **Cluster Name**. |
155-
| **Delete** | Button. Disconnects each SCALE system from the cluster and removes the card from TrueCommand. Shows a confirmation popup when clicked. |
153+
| **CREATE VOLUME** | Click the button to open the form to create new clustered storage. |
154+
| **Rename** | Click the button to open the form to enter a new **Cluster Name**. |
155+
| **Delete** | Click the button to disconnect each SCALE system from the cluster and remove the card from TrueCommand. Shows a confirmation popup when clicked. |
156156

157157
{{< /expand >}}
158158

@@ -169,12 +169,12 @@ The options split into two pages: **Details** and **Confirmation**.
169169

170170
| Setting | Description |
171171
|---------|-------------|
172-
| **NEXT** | Button. Continues to the next page. |
173-
| **Name** | String. Identifying label for this cluster volume. |
174-
| **Type** | Dropdown list. Layout and behavior for the volume. |
172+
| **NEXT** | Click the button to continue to the next page. |
173+
| **Name** | Enter a string as an identifying label for this cluster volume. |
174+
| **Type** | Dropdown list. Select layout and behavior for the volume. |
175175
| **Cluster** | String (disabled). Shows the cluster that controls the new volume. |
176-
| **Brick Size** | Integer and dropdown list. Storage capacity. Accepts numeric values and selecting units of size. |
177-
| **Pools** | Dropdown list. Storage pool on the individual SCALE system that provides capacity for the cluster volume. |
176+
| **Brick Size** | Enter integer and select from dropdown list to define storage capacity. Accepts numeric values and selecting units of size. |
177+
| **Pools** | Dropdown list. Select storage pool on the individual SCALE system that provides capacity for the cluster volume. |
178178

179179
The **Type** field has four options:
180180

@@ -192,8 +192,8 @@ The **Confirmation** page shows details for the chosen volume **Type** and stora
192192

193193
| Setting | Description |
194194
|---------|-------------|
195-
| **BACK** | Button. Goes to the previous configuration page. |
196-
| **CREATE** | Button. Saves the configuration and builds the clustered volume on each system in the cluster. |
195+
| **BACK** | Click button to go to the previous configuration page. |
196+
| **CREATE** | Click button to save the configuration and build the clustered volume on each system in the cluster. |
197197

198198
{{< /expand >}}
199199

@@ -212,8 +212,8 @@ Click the volume name to expand the details and see more management options.
212212

213213
| Setting | Description |
214214
|---------|-------------|
215-
| **DELETE** | Button. Removes the volume from the cluster. This destroys any stored data. |
216-
| **CREATE SHARE** | Button. Opens the form to configure a new SMB share. This allows remote access to this cluster volume. |
215+
| **DELETE** | Click button to remove the volume from the cluster. This destroys any stored data. |
216+
| **CREATE SHARE** | Click button to open the form to configure a new SMB share. This allows remote access to this cluster volume. |
217217

218218
{{< /expand >}}
219219

@@ -229,15 +229,15 @@ Adding a cluster share shows a few options.
229229
|---------|-------------|
230230
| **Cluster** | String (disabled). Shows the name of the cluster related to this share. |
231231
| **Cluster Volume** | String (disabled). Shows the name of the cluster volume to share. |
232-
| **Name** | String. Label for this new cluster share. |
233-
| **ACL** | Dropdown list. Access Control List. Sets permissions for the share. |
234-
| **Readonly** | Checkbox. Disables or allows file management options for connected users. Select to disable. |
235-
| **CONFIRM** | Button. Saves the settings, creates the share, and makes the cluster volume accessible to Active Directory user accounts. |
232+
| **Name** | Enter string to create label for this new cluster share. |
233+
| **ACL** | Dropdown list. Access Control List. Choose permissions for the share. |
234+
| **Readonly** | Checkbox disables or allows file management options for connected users. Select to disable. |
235+
| **CONFIRM** | Click button to save the settings, creates the share, and makes the cluster volume accessible to Active Directory user accounts. |
236236

237237
**ACL Options**
238238

239-
* POSIX_OPEN - Template that grants read, write, and execute permissions to all users.
240-
* 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.
239+
* **POSIX_OPEN** - Template that grants read, write, and execute permissions to all users.
240+
* **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.
241241

242242
{{< /expand >}}
243243

@@ -251,8 +251,8 @@ Click the cluster volume name to open the **Cluster Volume Details** and see any
251251

252252
| Setting | Description |
253253
|---------|-------------|
254-
| **DELETE** | Button. Remove the share from the Cluster Volume. No data is destroyed in this operation. |
255-
| **CREATE SHARE** | Button. Opens the form to configure a new SMB share. This allows remote access to this cluster volume. |
254+
| **DELETE** | Click button to remove the share from the Cluster Volume. No data is destroyed in this operation. |
255+
| **CREATE SHARE** | Click button to open the form to configure a new SMB share. This allows remote access to this cluster volume. |
256256

257257
{{< /expand >}}
258258

0 commit comments

Comments
 (0)