[DRAFT] Perifery Transporter - User Guide

Overview

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

In the box

The following items are present:

• The Perifery Transporter device.

• A License USB key (*required to operate the Perifery Transporter).

• A sheet with information about connecting to the device.

Set up

The setup requires three steps:

1. Plug in License USB key – Plug the License USB key into the Perifery Transporter device.

2. Plug into the network switch – Plug the Perifery Transporter device into a network switch. The 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. The device is accessible from the network once powered on. Consult the information sheet for the URL to enter into a browser to view the console.

Boot

The boot process for Perifery Transporter can take a few minutes, depending on the amount of data stored. No user action is required.

Perifery Transporter progresses through the following stages during boot:

A confirmation message displays when the boot is complete.

Login

Log in to Perifery using the default username and password once the device is ready. These are also found on the included information sheet.

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 satisfy the following requirements:

• Password length 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. All password checks appear in green if the above password criteria are satisfied.

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 including all the storage devices. The status overview provides information if any hardware or service is not running.

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

• ❗ – This status shows all the hardware and 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 sees 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 all information (access URLs and tokens).

• Click Copy all and paste in a text document to copy all (S3 endpoint URL, bucket name, access key, and secret key). These details are used when moving the bucket content to a remote location.

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

• 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.

Uploading content using S3

This section explains how to upload content to Perifery Transporter using Cyberduck. This is being used for illustrative purposes, but the same information may be used for any application that uses an S3 connection.

1. Launch Cyberduck and click Open Connection.
   

   

2. Choose Amazon S3 from the dropdown list of protocols.
   

   

3. Fill in the following fields:

   • Server – The hostname of the Perifery S3 endpoint URL.

   • Port – A port in the Perifery S3 endpoint URL.

   • Access Key ID – The Perifery S3 Access Key.

   • Secret Access Key – The Perifery S3 Secret Key.
     Verify the URL in Cyberduck matches the Perifery S3 Endpoint URL. It is okay if the port is not shown in the Cyberduck URL.

4. Click Connect.

5. Browse to the target S3 bucket in Cyberduck.

Integrated Apps

This section contains all apps integrated with Perifery. As of April 2023 no apps are integrated with Perifery.

Advanced

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

Content Management

Perifery 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.

Click Manage Content, this navigates to the Content Portal where content (buckets, objects, etc.) can be browsed and searched. 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. See Swarm Content UI to learn about utilizing these capabilities.

See Content UI Release Notes for the latest Content UI release notes.

For Perifery Transporter users, the documentation provided above helps quickly and safely store content.

Status Details

This section helps monitor the 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 can be viewed in a browser or downloaded in raw JSON. This button is enabled after the bucket is moved to the remote location.

The refresh icon is added to refresh the list of bucket names that have been added and are ready for migration.

Move bucket content

Bucket content can bed moved 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 in 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:
   

   

   The S3 target is displayed in the S3 destination column for the corresponding bucket.
   

   

Report generation

The report icon is enabled irrespective of whether the bucket has been moved successfully or failed to move to the remote location. Refer to the following steps to generate the report:

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

   

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

   

   
   The report shows the cause of the migration error in case of a failed migration.

   

2. Click Download. Either it downloads or pops 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 four options:

• About Perifery Transporter

• Change password

• Shut down

• Logout

About Perifery Transporter

This provides versions of the system and services used in Perifery Transporter.

Change password

Refer to the following steps to change the current password:

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

2. Select Change Password. 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: ‘Password changed successfully'.

Shut down

1. Navigate to the user profile > select Shut down. A confirmation message appears to confirm the action.
   

   

2. Click Shut down. It will safely stop all the services from working and power off the Perifery Transporter device.
   

   

   

Logout

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

Learn More

• [DRAFT] Perifery Transporter - Quick Start Guide

• [DRAFT] Factory Reset - Knowledge Base