Skip to content

Commit

Permalink
Update EncryptionUISCALE.md
Browse files Browse the repository at this point in the history
  • Loading branch information
tonyriv3 committed Apr 9, 2024
1 parent 974f944 commit 2ea19a3
Showing 1 changed file with 6 additions and 6 deletions.
12 changes: 6 additions & 6 deletions content/SCALE/SCALEUIReference/Datasets/EncryptionUISCALE.md
Expand Up @@ -26,7 +26,7 @@ It downloads a JSON file to your downloads folder.
{{< trueimage src="/images/SCALE/Datasets/DownloadPoolEncryptionKey.png" alt="Download Pool Encryption Key" id="Download Pool Encryption Key" >}}

## Export Key Options
The **ZFS Encryption** widget for root datasets with encryption includes the **Export All Keys** and **Export Key** options but does not include the **Lock** option.
The **ZFS Encryption** widget for root datasets with encryption includes the **Export All Keys** and **Export Key** options. It does not include the **Lock** option.

If a dataset is encrypted using a key, the **ZFS Encryption** widget for that dataset includes the **Export Key** option.

Expand All @@ -46,7 +46,7 @@ The **Edit Encryption Options for *datasetname*** displays the current encryptio
Use to change the encryption type from or to key or passphrase, and the related settings.

The **Edit Encryption Options for *datasetname*** window opens with the current dataset encryption settings displayed.
The encryption setting options are the same as those found on **Add Dataset > Encryption Options**.
The encryption settings options are the same as those on **Add Dataset > Encryption Options**.

{{< trueimage src="/images/SCALE/Datasets/EditEncryptionOptionsKeyTypeWindow.png" alt="Encryption Options Key Type Window" id="Encryption Options Key Type Window" >}}

Expand All @@ -60,15 +60,15 @@ An encrypted child that inherits encryption from a non-root parent does not see
The locked icon for child datasets that inherit encryption is the locked by ancestor icon.

**Lock** opens the **Lock Dataset** confirmation dialog with the option to **Force unmount** and **Lock** the dataset.
**Force unmount** disconnects any client system that is accessing the dataset via sharing protocol. Do not select this option unless you are certain the dataset is not used or accessed by a share, application, or other system services.
**Force unmount** disconnects any client system accessing the dataset via sharing protocol. Do not select this option unless you are certain the dataset is not used or accessed by a share, application, or other system services.

{{< trueimage src="/images/SCALE/Datasets/LockDatasetDialog.png" alt="Lock Dataset Dialog" id="Lock Dataset Dialog" >}}

After locking a dataset, the **ZFS Encryption** screen displays **Locked** as the **Current State** and adds the **Unlock** option.

## Unlock Datasets Screen
**Unlock** on the **ZFS Encryption** widget displays for locked datasets that are not child datasets that inherit encryption from the parent dataset.
**Unlock** opens the **Unlock Datasets** screen that allows you to unlock the selected dataset, and the child datasets simultaneously.
**Unlock** opens the **Unlock Datasets** screen, which allows you to unlock the selected dataset and child datasets simultaneously.

{{< trueimage src="/images/SCALE/Datasets/UnlockDatasetsScreenNonRootParent.png" alt="Unlock Non-Root Parent and Child Datasets Screen" id="Unlock Non-Root Parent and Child Datasets Screen" >}}

Expand All @@ -81,8 +81,8 @@ If you select a child dataset of the root dataset or a non-root parent, the scre
| Setting | Description |
|---------|-------------|
| **Unlock Child Encrypted Roots** | Select to unlock any encrypted dataset stored within this dataset. |
| **Dataset Passphrase**<br> **Dataset Key** | Enter the user-defined string (passphrase) or system-generated or user-created alpha-numeric key you entered at the time you created the dataset. |
| **Force** | Select to add a force flag to the operation. In some cases the provided key/passphrase may be valid but the path where the dataset is supposed to be mounted after being unlocked already exists and is not empty. In this case, the unlock operation fails. Adding the force flag can override this and when selected, the system renames the existing dataset mount directory/file path and it unlocks the dataset. |
| **Dataset Passphrase**<br> **Dataset Key** | Enter the user-defined string (passphrase) or system-generated or user-created alpha-numeric key you entered when you created the dataset. |
| **Force** | Select to add a force flag to the operation. In some cases the provided key/passphrase may be valid but the path where the dataset is supposed to be mounted after being unlocked already exists and is not empty. In this case, the unlock operation fails. Adding the force flag can override this and when selected, the system renames the existing dataset mount directory/file path and unlocks the dataset. |
| **Save** | Starts the unlock process, fetches data, and displays the **Unlock Datasets** dialog with the dataset mount path. Click **Continue** to unlock the dataset. |
| **Save** | Starts the unlock process, fetches data, and displays the **Unlock Datasets** dialog with the dataset mount path. Click **Continue** to unlock the dataset. |
{{< /truetable >}}
Expand Down

0 comments on commit 2ea19a3

Please sign in to comment.