FS3 User Guide (Cloud Version)

Here is the tutorial how to use your FS3 on Swan.

Instruction

1. Access to FS3

2. Creating a bucket

To get started, you can click the red button with a plus sign on the bottom right corner. It will pop up 2 yellow icons (upload files and create buckets) by clicking the red button. Files can not be uploaded without a bucket. The first thing is to choose the "Create buckets" button in yellow, name it and press Enter/Return key to confirm.

3. Uploading files

Within a bucket, you can upload your files by choosing the "Upload files" button in yellow which is right above the "create bucket" button. Same as before, to appear the "upload files" button, you need to click the red button with the plus sign on it.

4. Backup plan

Users can backup the entire volume with customized schedulers by choosing Backup plan (Backup Daily/ Backup Weekly) or Snapshot backup (Backup immediately) to Filecoin Network.

Backup plan

  • Create a backup plan by choosing "Backup Plan" page.

Price: It is valued as GiB/epoch

Duration: Duration for keeping the backup needs to be in the range of 180 to 540.

  • You can view your created backup plans on "My Backup Plans" page.

  • As soon as the creation is complete, FS3 is sending volume backup task to the assigned storage provider automatically using Swan Autobid module (click Autobid to know how it works).

  • If you choose to backup daily, FS3 will compress the entire data volume into a car. file and upload it to the Filecoin Network every 24 hours. You can check all your backup jobs by choosing "My Backup Jobs" page, and here shows you all the information about your jobs.

  • Once the backup process has completed, the status under backup jobs on the "My Backup Jobs" page will change to "Completed".

Snapshot backup

  • Create a backup plan by choosing "Snapshot Backup" page.

  • You can view your created backup plans on "My Snapshot Jobs" page.

  • As soon as the creation is complete, FS3 is sending volume backup task to the assigned storage provider automatically using Swan Autobid module (click Autobid to know how it works).

  • If you choose to backup daily, FS3 will compress the entire data volume into a car. file and upload it to the Filecoin Network every 24 hours. You can check all your backup jobs by choosing "Backup Jobs" page, and here shows you all the information about your jobs.

  • Once the backup process has completed, the status under backup jobs on the "Backup Jobs" page will change to "Completed".

6. Rebuild backup volume

Rebuild image is accessible only when backup job status is completed. Users can not rebuild image when backup process is still running.

To store your entire FS3 instance from one of your backups, you can use the FS3 rebuild service. FS3 will fetch an entire backup from Filecoin Network and overwrite your existing system. You can rebuild from Backup plan or Snapshot backup

Rebuild from Backup plan

  • First, go to "My Backup Jobs" page and all your backup jobs are listed here.

  • Second, make sure you are under "Backup Jobs" for rebuilding an image (restore a backup). You can switch to rebuild jobs below the backup jobs to view all your rebuild history.

  • Third, on the very right side of each jobs, you should be able to click "Rebuild Image" when the status is "Completed".

  • Next, after clicking "Rebuild Image", a pop up window will show as above. Please check your information and make sure you are rebuilding from the correct backup. Your backup name will show in bold font.

  • Finally, choose "OK" to confirm your rebuild process and choose "Cancel" to quit from rebuilding backup.

Rebuild from Snapshot backup

  • First, go to "Snapshot Backup" page and all your backup jobs are listed here.

  • Second, make sure you are under "Backup Jobs" for rebuilding an image (restore a backup). You can switch to rebuild jobs below the backup jobs to view all your rebuild history.

  • Third, on the very right side of each jobs, you should be able to click "Rebuild Image" when the status is "Completed".

  • Next, after clicking "Rebuild Image", a pop up window will show as above. Please check your information and make sure you are rebuilding from the correct backup. Your backup name will show in bold font.

  • Finally, choose "OK" to confirm your rebuild process and choose "Cancel" to quit from rebuilding backup.

Last updated