Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
samuelncui committed Sep 26, 2023
1 parent 718619c commit e88bdb2
Showing 1 changed file with 12 additions and 3 deletions.
15 changes: 12 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,20 +1,29 @@
# YATM aka Yet Another Tape Manager

YATM is a first-of-its-kind open-source tape manager for LTO tape via LTFS tape format.
YATM is a first-of-its-kind open-source tape manager for LTO tape via LTFS tape format. It performs the following features:

![screenshot-jobs](https://github.com/samuelncui/yatm/assets/7183284/815ccfe7-0f0b-4271-be12-fc13e5442a99)

- Depends on LTFS, an open format for LTO tapes. You don't need to be bundled into a private tape format anymore!
- A frontend manager, based on GRPC, React, and [Chonky file browser](https://github.com/TimboKZ/Chonky). It contains a file manager, a backup job creator, a restore job creator, a tape manager, and a job manager.
- The file manager allows you to organize your files in a virtual file system after backup. Decouples file positions on tapes with file positions in the virtual file system.
- The job manager allows you to select which tape drive to use and tells you which tape is needed while executing a restore job.
- Fast copy with file pointer preload, uses [ACP](https://github.com/samuelncui/acp). Optimized for linear devices like LTO tapes.
- Sorted copy order depends on file position on tapes to avoid tape shoe-shining.

## Dependency

### Hardware

YATM needs at least one LTO tape drive. You may run this software as an offline HDD manager, but the current implementation doesn't support this application yet (pull requests are welcomed).
YATM needs at least one LTO tape drive that supports LTFS (LTO-5 or above). You may run this software as an offline HDD manager, but the current implementation doesn't support this application yet (pull requests are welcomed).

Because of the lack of test devices, this software only supports the amd64 platform.

### Software

YATM will use several software, depending on your hardware. It would be best if you put binaries of the following software in PATH. Or you can modify those shell scripts in `/scripts` to make them run smoothly.

- LTFS, to format and mount LTO tape via LTFS. You can use (OpenLTFS)[https://github.com/LinearTapeFileSystem/ltfs], (HPE LTFS)[https://github.com/nix-community/hpe-ltfs] or (IBM LTFS)[https://www.ibm.com/docs/en/spectrum-archive-le?topic=tools-downloading-ltfs], depending on you tape drive hardware. You may need to change codes to run on your platform.
- LTFS, to format and mount LTO tape via LTFS. You can use [OpenLTFS](https://github.com/LinearTapeFileSystem/ltfs), [HPE LTFS](https://github.com/nix-community/hpe-ltfs) or [IBM LTFS](https://www.ibm.com/docs/en/spectrum-archive-le?topic=tools-downloading-ltfs), depending on you tape drive hardware. You may need to change codes to run on your platform.
- The current script is tested on HPE LTFS. If you use other LTFS software, you may need to modify `/scripts/mkfs` and `/scripts/mount`. If you find those scripts are not appropriate for other LTFS software, please create a pull request.
- (Stenc)[https://github.com/scsitape/stenc], to manage hardware encryption on LTO tape drives.

Expand Down

0 comments on commit e88bdb2

Please sign in to comment.