TrueNAS Core

Learn how to use TrueNAS Core to store data on the ScPrime distributed datacenter using the XNS Relayer

Overview

TrueNAS Core is an open-source network-attached storage operating system produced by iXsystems that allows for flexible data storage and access to that data. TrueNAS Core is also able to copy data to S3 protocol destinations, so it makes a good match for XNS storage.

Read this guide for how to configure TrueNAS Core to store data with XNS.

Prerequisites

A working instance of TrueNAS Core
Have or configure a Storage Pool the desired data scope configured on TrueNAS Core
A working instance of the XNS Relayer
Configure the XNS Relayer’s Endpoint Access Key and Endpoint Secret Key

Considerations

TrueNAS Core requires a valid SSL certificate to use the XNS Relayer as an HTTPS endpoint. Please configure the XNS Relayer with a valid SSL certificate or change the Endpoint Certificate Type to not require SSL. These settings can be accessed in the Relayer UI by going to Configuration > General Configuration and editing the Select Endpoint Certificate Type setting to ‘No SSL’.
Curation of data in the Storage Pool is the primary method of backup scoping. TrueNAS Tasks also allow additional backup scoping by explicitly excluding files and directories as defined in the Task.

Operating System Version Used in Guide

TrueNAS-13.0-U4

Guide Revision Date

2023-03-18

Setup Guide

Two workflows must be performed in TrueNAS Core to store data to XNS:

Configure the Cloud Credentials of the XNS Relayer
Create the Task that will store data to XNS

Workflow 1: Configure the Cloud Credentials of the XNS Relayer

Step 1.1: Open System menu

Use the Navigation Menu of TrueNAS Core to click on System to expand its options.

Step 1.2: Open Cloud Credentials

Click on the Cloud Credentials.

Step 1.3: Add a Cloud Credential

Click Add.

Step 1.4: Configure Cloud Credential Settings

Configure the Cloud Credential Settings so that is is available for TrueNAS Core when a Task is created. Click on Advanced Settings to configure necessary options. Then click Verify Credential.

Name	[Your XNS Relayer Name]	This is the name if the credential that you will reference in the TrueNAS Core UI when adding credentials to Tasks.
Provider	Amazon S3	This is the type of service that the credential applies to. ‘Amazon S3’ is used for S3 protocol compatible services.
Access Key ID	[Endpoint Access Key (Username)]	This is defined in the XNS Relayer General Configuration.
Secret Access Key	[Endpoint Secret Key (Password)]	This is defined in the XNS Relayer General Configuration.
Maximum Upload Parts		Maximum number of chunks for a multipart upload.
Endpoint URL	http://[Your IP]:[MinIO Port]/	The use of HTTP and HTTPS must align to the settings on the XNS Relayer. TrueNAS Core requires a valid SSL certificate. If you do not have a valid SSL certificate, you can configure the ‘No SSL’ option in XNS Relayer and use HTTP in TrueNAS Core as this example shows. n.b., TrueNAS Core can be configured to encrypt data prior to sending over the network to mitigate the usage of HTTP.
Region		This can be left blank.
Disable Endpoint Region		This can be left unchecked.
Use Signature Version 2		Do not check this box. Signature v4 must be used.

Step 1.5: Verify that the Cloud Credential is functional

If TrueNAS is able to interface with the XNS Relayer, you will see a message that says ‘The Credential is Valid’. Click Close and then Submit.

Your XNS Relayer Cloud Credential is now stored by TrueNAS Core

Workflow 2: Create the Task that will store data to XNS

Step 2.1: Open Tasks menu

Use the Navigation Menu of TrueNAS Core to click on Tasks to expand its options.

Step 2.2: Open Cloud Sync Tasks

Click on the Cloud Sync Tasks.

Step 2.3: Add a Cloud Sync Task

Click Add.

Step 2.4: Configure the Cloud Sync Task

Configure your Cloud Sync Task per attributes of the XNS Relayer and your data storage requirements.

Transfer
Name	[Your Task Name]	This is the name if the task being created.
Direction	PUSH	‘PUSH’ will send data to XNS Relayer.
Transfer Mode	COPY	‘COPY’ will copy files to the XNS Relayer.
Directory/Files	[Your Dataset]	These are the initial scope of files and directories that will be sent to XNS Relayer.

Remote
Credential	[Your Cloud Credential]	This is the name of the Cloud Credential that was created in Operation 1.
Bucket	[Your Bucket Name]	This is the name of the bucket where the dataset will be sent to on the XNS Relayer. n.b., the bucket must be created on the XNS Relayer for it to populate here. TrueNAS Core cannot create a new bucket for you on the XNS Relayer.
Folder	[Your Folder]	This is the name of the folder where the dataset will be sent to on the XNS Relayer. n.b., the folder can be selected or created through TrueNAS Core.

Other settings can be configured per your requirements on this screen. When complete, click Dry Run to test your Task.

Step 2.5: Verify Dry Run of Task is Successful

Review the results of the Dry Run. If it was successful, click Close and then Submit to save the Task.

Step 2.6: Review Task

Now that your Task has been saved, it is time to run it or the first time. Click on the arrow (>) of the Task to expand it.

Step 2.7: First Run of Task

To run your Task for the first time, click Run Now.

Step 2.8: Verify Run of Task is Successful

TrueNAS Core will indicate that the task was successful by showing a status of ‘SUCCESS’.

Backup and Restore

Business Process

Data Controller

Storage Infrastructure

System Administration

Tools and Utilities

TrueNAS Core