Skip to content

Latest commit

 

History

History
104 lines (72 loc) · 5.4 KB

README.md

File metadata and controls

104 lines (72 loc) · 5.4 KB
Raw

YATM Logo

YATM aka Yet Another Tape Manager

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

20230928-023325

20230928-023638@

  • 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. 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. Optimized for linear devices like LTO tapes.
  • Sorted copy order depends on file position on tapes to avoid tape shoe-shining.
  • Hardware envelope encryption for every tape (not properly implemented now, will improve as next step).

Dependency

Hardware

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.

  • Linux system on amd64 platform. There are some other os and arch are experimentally supported (you can download those pre-compile binaries in Releases), but they are not tested. I've only thoroughly tested it on Debian 11/12. If you hit problems while using it on other distributions, please submit an issue. Pull requests are welcomed if you could port it to BSD or other architecture. Windows is not supported because its mount mechanism is hugely different compared to unix-like systems.
  • LTFS, to format and mount LTO tape via LTFS. You can use OpenLTFS, HPE LTFS or IBM 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, to manage hardware encryption on LTO tape drives.

Install

You can run this automatic release install script to install/update to the latest release:

bash <(curl -L https://raw.githubusercontent.com/samuelncui/yatm/main/install-release.sh)

Or you can download binary from releases, and run the following shell commands.

# If you put this to other path, you need to change scripts and systemd service file.
mkdir -p /opt/yatm
tar -xvzf yatm-linux-amd64-${RELEASE_VERSION}.tar.gz -C /opt/yatm

cp /opt/yatm/config.example.yaml /opt/yatm/config.yaml
# change config file depends on your demand.
vim /opt/yatm/config.yaml

systemctl enable /opt/yatm/yatm-httpd.service
systemctl start yatm-httpd.service

Warning!

When a backup job is done (or at least this tape is full), the tape will be ejected after umount by default. I suggest you enable the write-protect switch immediately. There is a possibility that the tape driver writes to the index partition when mounting tape, which can cause index loss. If you know the reason for this weird behavior, please tell me via email or issue.

Nginx Reverse Proxy

YATM is based on GRPC, which needs HTTP2 to be functional. You can reference the following nginx config to reverse proxy YATM.

server {
    # needs http2 to proxy grpc
    listen 443 ssl http2;
    listen [::]:443 ssl http2;

    server_name example.com;
    # if you use basic auth, ssl is critical for protect your password
    include includes/ssl.conf;

    proxy_connect_timeout 60;
    proxy_send_timeout 3600;
    proxy_read_timeout 3600;
    send_timeout 3600;
    client_max_body_size 4g;

    proxy_buffer_size 1024k;
    proxy_buffers 4 2048k;
    proxy_busy_buffers_size 2048k;

    http2_max_requests 10000000;

    location / {
        # you can use basic auth to protect your site
        auth_basic              "restricted";
        auth_basic_user_file    includes/passwd;

        proxy_set_header Host $host;
        proxy_set_header X-Real-IP $remote_addr;
        proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
        proxy_pass http://127.0.0.1:8080;
    }
}

Thanks