DATAGUARD T5R/R4 5-Bay+1/1U 4-bay Desktop High-performance Network Attached Storage

Transcription

1 DATAGUARD T5R/R4 5-Bay+1/1U 4-bay Desktop High-performance Network Attached Storage RDX Software Engineering Specification Document (ESD) Version 0.3 Date: 10/21/2011 Document Control # Copyright 2011, Promise Technology, Inc. All Rights Reserved

2 This document is intended for Promise Technology, Inc. internal usage. It is not intended for OEM reference or external consumption. This draft is not the final version of the specification and is subject to change without notice. Copyright 2011, Promise Technology, Inc. Revision History Revision Date Author Description /06/11 Ivan Chen Initial Document /17/11 Ivan Chen Modified by Imation s feedback /21/11 Ivan Chen Change to Rsync backup solution Page 2 Promise Technology, Inc. Confidential

3 Table of Contents 1. INTRODUCTION SCOPE OVERVIEW DEVICE DETECTING RDX BACKUP PAGE DATA BACKUP BACKUP SETTING START TO BACKUP BACKUP FAILED RDX EJECTION DAEMON SYSTEM EVENT LIST DESIGN CHECK LIST Promise Technology, Inc. Confidential Page 3

4 1. Introduction 1.1 Scope The purpose of this document is to describe how software engineer implement the RDX backup function for DATAGUARD projects. This is a communication window between IMATION and PROMISE design engineers to make sure the design specification. 1.2 Overview In 5+1 bay model, the 6 th drive carrier is embedded RDX port. User could also connect external USB RDX docks. In other models, we just support USB RDX. RDX A8 is not included in this spec. USB 2.0 RDX Embedded RDX USB 3.0 RDX Page 4 Promise Technology, Inc. Confidential

5 2. Device detecting There are 2 kinds of connections of RDX devices, embedded and USB. Embedded RDX is only supported in 5+1 bay model. Besides, the users can use external USB RDX connection. When RDX cartridge is inserted, the NAS system will be aware that a SCSI storage device is inserted. Then the software can check the device model name. If RDX string appears in anywhere of the model name, this device is judged as RDX device. Otherwise, system will treat it as a general external drive. For example, the model name RDX-USB is one of the RDX devices. RDX string supported: **RDX**, (Imation will provide other strings) When the storage device is detected as RDX, software just needs to mount its file system, but DO NOT share the folder to NAS services. Supported file system: FAT(32), NTFS, XFS, EXT3, HFS+ 2.1 RDX Backup page The should create an additional tab in backup page for embedded RDX and USB RDX. The RDX backup page includes: 1. RDX device list table 2. View button: To display the device information of RDX. 3. Setting button: To start the backup procedure. Backup devices Direction Backup Method Source/Destination Status Mounted (button) Path Embedded RDX To NAS Synchronize PICTURE,MUSIC Idle Yes [View] [Setting] RDX front USB To RDX Add Directory N/A Idle No [View] [Setting] RDX USB 2 N/A N/A N/A Idle No [View] [Setting] RDX USB 3 N/A N/A N/A Idle No [View] [Setting] RDX USB 4 N/A N/A N/A Idle No [View] [Setting] RDX USB 5 N/A N/A N/A Idle No [View] [Setting] If the model did not have embedded RDX, the 1 st row will be invisible. Backup devices: List embedded RDX and all USB ports. Embedded RDX USB RDX Direction Promise Technology, Inc. Confidential Page 5

6 To RDX To NAS Backup Method Add Directory: Add another folder to put the backup data. It needs extra space. Copy: Copy to current folder. Synchronize: Delete the destination file if it is deleted in source. Source/Destination path Backup to RDX: The selected folders that user want to backup. Backup to NAS: Which NAS folder to backup RDX. Status: Idle: When the RDX is standby, this field is Idle. Running: When the RDX is working on backup or restore, the field is Running. Mounted Yes: RDX file system is mounted successfully No: No file system is mounted Schedule Once Hourly Daily Weekly Page 6 Promise Technology, Inc. Confidential

7 3. Data backup The RDX supports backup into or from NAS shared folders. Only Backup from NAS supports schedule backup. 3.1 Backup setting When setting button is clicked, the enters the setting page: Backup NAS folders to RDX: Backup RDX to NAS folders: 3.2 Start to backup The status change to Running Opened file backup Software creates snapshot automatically before backup. If LD does not have enough size to create snapshot, bypass this step. We use "rsync" command to do RDX backup. message: RDX backup When backup finish, go back to main menu. System buzzer also beeps a short sound. The status change to Idle. If backup is failed, message: RDX backup fail. Promise Technology, Inc. Confidential Page 7

8 Eject RDX manually. (considering schedule backup, so we don t eject RDX automatically.) 3.3 Backup failed The following situation is known condition to backup failed. The RDX cartridge is switch to read only. The backup size is larger than current RDX cartridge free capacity. The RDX cartridge is crashed. USB RDX connection failed Page 8 Promise Technology, Inc. Confidential

9 4. RDX ejection daemon Create a Linux daemon for ejection handling. Scan the SCSI devices to check the RDX status. Polling the eject button every 5 seconds. If eject button is pressed Un-mount file system after 5 seconds. If RDX is busy, un-mount will be failed. Then wait for a while and retry. If retry 3 times still failed, abort this ejection command. Eject RDX cartridge Support Embedded RDX and USB RDX. Promise Technology, Inc. Confidential Page 9

10 5. System event list System event Extra info Corrective Action Severity RDX Backup starts None Normal. Info Yes RDX Backup success RDX Backup failed None Normal. Info Yes Without snapshot No snapshot space. Info Yes No space RDX Space is not enough to backup. Connection failed RDX connection failed. Warning Yes Warning Yes Logged NVRAM We removed restore events because we supports bi-direction backup. We called it backup to RDX or backup to NAS. Restore term is not used anymore. Page 10 Promise Technology, Inc. Confidential

11 6. Design check list No. Check item Check Result 1 Detection: Insert empty USB RDX cartridge RDX RDX can be detected in RDX page There are 2 buttons: View, Setting Backup devices field shows RDX USB N or Embedded RDX Embedded RDX is invisible in R4 model Push View button and display information Push setting button to configure backup setting 2 Select direction as Backup to RDX, set the backup setting; Push save button to see if the configure is saved. Push Run button to execute backup. log: RDX Backup starts Local backup shows the status is Running display RDX backup After backup finished, go back to main menu. log: RDX Backup success System beeps a short sound. Local backup status change to Idle. If backup is failed, the shows RDX Backup fail. log: Backup to RDX failed. Schedule backup setting: once/hourly/daily/weekly Check event to see if schedule backup works. Buzzer 3 Select direction as Backup to NAS, set the backup setting. Push Run button to execute backup. log: RDX Backup starts Local backup shows the status is Running display RDX backup After backup finished, go back to main menu. log: RDX Backup success System beeps a short sound. Buzzer Local backup status change to Idle. If backup is failed, the shows RDX Backup fail. log: Backup to RDX failed. Promise Technology, Inc. Confidential Page 11