[DRAFT] Transporter User Guide

Overview

Transporter is an S3 native portable storage appliance. Featuring state-of-the-art data protection, Transporter is capable of storing data created at the edge and shuttling that content back to a base location. Transporter can be used either as a standalone device or with existing in-facility Perifery or Swarm clusters. Data import from Transporter to a main cluster is possible at the push of a button. Once the data transfer is completed, the system can be reset and made ready to go back out on location.

In the box

The following items should be present:

• The Transporter device

• A USB key (this is required to operate the Transporter)

• A sheet with information about connecting to the device

Set up

The setup requires three steps:

1. Plugin USB key – Plugin the USB key into the Transporter device.

2. Plug into the network switch – Plug the Transporter device into a network switch. Your computer/laptop must also be plugged into the same switch for the local network connection.

3. Power on the device – Press the power button to turn on the device. Once power is on, the device will be accessible via the network. Consult the sheet that came with the device for the URL to enter into your browser to view the console.

Transporter device takes 2-5 mins to boot up.

Login

Once the device is ready, login into Perifery using the default username and password. These are also found on the sheet that came with the device.

1. Enter the default credentials. For the first-time login user, the credentials are:

   1. Username – periferyadmin

   2. Password – password

2. Click Login.

Update your password

The default password is common for all users, hence, it is required to have a new strong password for security, which is unique and memorable for the user. This step is applicable to the first-time login only. The new password must qualify the following requirements:

• Password length should be between 8-64 characters

• Combination of at least one uppercase, lowercase, and number

• One special character (e.g., @, #, $, !, %, etc.)

New password – Enter the updated password. If it qualifies the above password criteria, all password checks appear in green.

Confirm password – Re-enter the same password again.

Click Update password. A message appears ‘Password updated successfully'.

Dashboard

The dashboard screen provides the following information:

Status overview

This section provides an overview of services and hardware (all the disks and drives). If any hardware or services are down, the status overview will provide that information.

• - This status shows all the hardware/services are working fine.

• ❗ – This status shows all the hardware/services are not up and running as expected.

Storage

This section provides total storage space information and how much space has been consumed. The user will see a bar view of consumed space out of the total space available.

How to connect

This section contains access URLs and token information and provides an ability to copy either one by one or the whole information (access URLs and tokens) in one go.

• S3 endpoint URL – A remote service endpoint

• S3 bucket name – A name of the S3 bucket

• S3 access key – An access key for the remote bucket, which must be generated within the remote cloud storage service.

• S3 secret key – An S3 secret key. It is generated with the access key.

To know more about S3 credentials, see https://perifery.atlassian.net/wiki/spaces/DOCS/pages/3134062601#How-to-Use-S3-Credentials?.

There are two ways to copy access URLs and tokens:

• To copy all (S3 endpoint URL, bucket name, access key, and secret key) in one go, click Copy all and save them in a text document. These details will be used in the future while moving the bucket content to a remote location.

• Copy access URLs and tokens one by one and save them.

Integrated Apps

This section contains all the apps integrated with Perifery. Currently, there is no app integrated with Perifery.

Advanced

This section provides two options; one is to view the content portal and another is to monitor the system status.

Manage content

Transporter is designed to make the task of providing basic S3 storage as simple as possible, for cases where a single user and a single domain are sufficient.

Go to Manage Content > click Manage Content. This will navigate to the Content Portal where you can browse and search all the content (buckets, objects, etc.). The Content Portal provides multiple functionalities including:

• Create and manage S3 tokens for security purposes

• Create additional tenants, storage domains, and buckets to support unique business workflows

• Manage content with Collections

• Take advantage of the Partial File Restore functionality

You can learn more about these functionalities here. To know about how to utilize these capabilities, see Swarm Content UI.
For the latest Content UI release notes, see Content UI Release Notes.

For Transporter users, the documentation provided above will help you safely store content in no time.

Status Details

This section will help you monitor the current status of the system, once the Grafana dashboard is integrated.

Data migration

This section helps to move data to the remote location (i.e. S3 destination). Data is available in a tabular format that contains below columns:

• Bucket name – The name of the bucket.

• Object count – The count of objects in numbers.

• S3 destination – The migration target.

• Move content – This action item is used to move the bucket content to the remote location.

• Report generation – This action item is used to generate the bucket report that you can view in the browser or download in raw JSON. This button gets enabled only after the bucket is moved to the remote location.

Move bucket content

You can move the bucket content to the desired remote location using the below steps:

1. Click on the Move icon corresponding to the bucket. It displays a form in the sliding panel.

   

2. Fill up the required fields marked with asterisks (*). An example is shown in the screenshot below:

   1. S3 endpoint URL – Enter a valid target S3 endpoint URL.

   2. S3 region – Enter the S3 region, which is a geographic area of the storage if required by the remote storage vendor.

   3. S3 bucket – Enter the target S3 bucket where the content is to be moved.

   4. Remote folder – Enter a folder path within the remote bucket. This is optional.

   5. Remote S3 access key – Enter an access key for the remote bucket. It must be generated within the remote cloud storage service.

   6. Remote S3 secret key – Enter an S3 secret key. It is generated with the access key.

3. Click Move. A confirmation message appears:

   

Report generation

The report icon gets enabled irrespective of whether the bucket has been moved successfully or got failed to move to the remote location. To generate the report, refer to the following steps:

1. Click on the report icon corresponding to the bucket.

   

   All the objects available in the selected bucket are displayed along with their object name and object status on a successful migration. It gives a preview of the bucket content report:

   

   
   In case the report is generated for a failed migration, the report shows the reason for the migration error.

   

2. Click Download. It will either download or pop up in a browser tab depending on how the browser handles the content type of the JSON file.

User Profile

The user can view the profile from the top-right corner of the screen, which contains two options Change password and Logout.

Change password

This option is available for existing users. If they want to change the current password, refer to the following steps:

1. Click on the username from the top-right corner of the screen.

2. Select Change Password. It shows a form to provide new password details:

   

   1. Enter the current password.

   2. Enter a new password and re-enter it to confirm the same.

   3. Click Change. A confirmation message appears saying that ‘Password changed successfully'.

Logout

Go to the user profile > select Logout to log out of the account.

Learn More

• [DRAFT] Transporter - Quick Start Guide

• [DRAFT] Factory Reset - Knowledge Base