Skip to content

Commit

Permalink
Apply suggestions from code review
Browse files Browse the repository at this point in the history
Co-authored-by: MicJ <[email protected]>
  • Loading branch information
DjP-iX and micjohnson777 authored Aug 19, 2024
1 parent 50b8811 commit b67c6bf
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 28 deletions.
14 changes: 6 additions & 8 deletions content/SCALE/GettingStarted/Configure/SetUpBackupScale.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,12 +36,12 @@ These providers can charge fees for data transfer and storage, so please review
{{< /hint >}}

You can configure TrueNAS to send, receive, or synchronize data with a cloud storage provider.
The simplest way to set up a TrueCloud Backup task is using an Storj iX account.
The simplest way to set up a TrueCloud backup task is using an Storj iX account.
See [Managing TrueCloud Backup Tasks]({{< relref "TrueCloudTasks.md" >}}) for a full tutorial.

{{< expand "TrueCloud Backup Quickstart with a Storj Account" "v" >}}

1. Create an Storj iX account and link to TrueNAS.
You can create a Storj cloud credential and set up your Storj account from the **Add TrueCloud Backup Task** screen or from the **Credentials > Backup Credentials** screen.
1. Create a Storj iX account and link to TrueNAS.

From the TrueNAS **Dashboard**, find the **Backup Tasks** widget and click **Cloud Sync to Storj or similar provider**.

Expand All @@ -50,15 +50,13 @@ See [Managing TrueCloud Backup Tasks]({{< relref "TrueCloudTasks.md" >}}) for a
The **Storj iX** provider is preselected.
Click **Signup for account** to open a browser tab, then register, select a plan, and activate an Storj iX Account.

After creating the Storj iX account, log in to the Storj portal, create a new bucket, and create new S3 access credentials ([details]({{< relref "TrueCloudTasks.md#adding-storj-cloud-credentials" >}})).
When the new S3 Credentials are created, download the **Access Key** and **Secret Key** and paste each string into the TrueNAS **Access Key ID** and **Secret Access Key** fields, respectively.
After creating the Storj iX account, log in to the Storj portal to create a new bucket and new S3 access credentials ([details]({{< relref "TrueCloudTasks.md#adding-storj-cloud-credentials" >}})).
After the new S3 credentials are created, download the **Access Key** and **Secret Key** and paste each string into the TrueNAS **Access Key ID** and **Secret Access Key** fields, respectively.
Click **Save**.

2. Define the backup targets and schedule.

To add the TrueCloud backup task, go to **Data Protection > TrueCloud Backup Tasks**:

Click **Add** to open the **Add TrueCloud Backup Task** screen.
To add the TrueCloud backup task, go to **Data Protection > TrueCloud Backup Tasks** and click **Add** to open the **Add TrueCloud Backup Task** screen.

Review the fields in the **Local**, **Remote**, **Task Settings**, and **Control** sections.
Select the created Storj **Credentials** and **Bucket** before choosing a **Folder**.
Expand Down
31 changes: 11 additions & 20 deletions content/SCALE/SCALETutorials/DataProtection/TrueCloudTasks.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "Managing TrueCloud Backup Tasks"
description: "Provides instructions on how to set up a TrueCloud Backup Task and how to configure an Storj iX account to work with TrueNAS."
description: "Provides instructions on setting up a TrueCloud backup task and configuring an Storj iX account to work with TrueNAS."
weight: 5
tags:
- TrueCloud
Expand All @@ -15,15 +15,15 @@ aliases:
---

TrueNAS can send, receive, or synchronize data with the cloud storage provider Storj.
TrueCloud Backup Tasks allow for single-time transfers or recurring transfers on a schedule.
TrueCloud backup tasks allow for single-time transfers or recurring transfers on a schedule.
They are an effective method to back up data to a remote location.

{{< hint type=important >}}
To take advantage of the lower-cost benefits of the TrueCloud backup service, you must create your Storj iX account using the link provided on the **Add Cloud Credentials** screen.

You must also create and authorize the storage buckets on Storj for use by SCALE.

iXsystems is not responsible for any charges you incur using a third-party vendor with the TrueCloud Backup feature.
iXsystems is not responsible for any charges you incur using a third-party vendor with the TrueCloud backup feature.
{{< /hint >}}

This procedure provides instructions to set up both Storj and SCALE.
Expand All @@ -40,17 +40,7 @@ To create a TrueCloud Backup task for a TrueCloud transfer:

Adding the cloud credential in SCALE includes using the link to create the Storj iX account, create a new bucket, and obtain the S3 authentication credentials needed to complete the process in SCALE.

2. Create the [Storj iX account](#creating-the-storj-truenas-scale-account).

You must create a new Storj iX account to use SCALE to access a Storj account.

3. Add a new [Storj bucket](#adding-the-storj-truenas-bucket).

4. [Create Storj S3 access](#setting-up-s3-access-to-the-bucket) for the new bucket.

5. Finish creating the SCALE [cloud credential](#adding-storj-cloud-credentials) using the S3 access and secret keys provided by Storj.

6. Create the [TrueCloud Backup task](#setting-up-the-truecloud-backup-task) for one bucket.
2. Create the [TrueCloud Backup task](#setting-up-the-truecloud-backup-task) for one bucket.

### Adding Storj Cloud Credentials

Expand Down Expand Up @@ -191,26 +181,27 @@ To add the TrueCloud backup task, go to **Data Protection > TrueCloud Backup Tas
Click the arrow to the left of the name to expand it, then click on the name to select it.

3. Select the Storj credential on the **Credentials** dropdown list.
You can select **Add New** to create the Storj credential if you skipped the instructions above.

Select the bucket you created in Storj from the **Bucket** dropdown list.
4. Select the bucket you created in Storj from the **Bucket** dropdown list.

If you set the Storj S3 access to only apply to the [new bucket created in Storj](#adding-the-storj-truenas-bucket), you can only use that bucket, selecting **Add New** results in an error.
If you set the Storj S3 **Bucket** access to **All**, you can select the new bucket you created in Storj or **Add New** to create a new Storj bucket.

Click the arrow icon for the **Folder** field to expand the dropdown list and select the desired folder in the Storj bucket or enter a folder path.
Enter `/name`, where *name* is a folder that does not exist, to create a new folder in the Storj bucket.

4. Enter a name for the task under **Task Settings**.
5. Enter a name for the task under **Task Settings**.

5. Enter the number of snapshot copies to retain in **Keep Last**.
6. Enter the number of snapshot copies to retain in **Keep Last**.

6. Enter a password for the backup repository.
7. Enter a password for the backup repository.
Record this password in a secure location.
It is needed to recreate the task using the same bucket/folder, such as in a new TrueNAS install or system, or to restore data from the existing snapshots in another TrueNAS system.

7. Set the task schedule for when to run this task.
8. Set the task schedule for when to run this task.

8. Click **Save**.
9. Click **Save**.

TrueNAS adds the task to the **TrueCloud Backup Tasks** widget with the state **N/A** until the task runs on schedule.
To test the task, click **<i class="fa fa-play" aria-hidden="true" title="Run Job"></i> Run Job** to start the task apart from the scheduled time.
Expand Down

0 comments on commit b67c6bf

Please sign in to comment.