Skip to content

Latest commit

 

History

History
46 lines (37 loc) · 1.36 KB

README.md

File metadata and controls

46 lines (37 loc) · 1.36 KB
Raw

fies - A File Extent Streaming Tool

fies is a library and command line tool to stream file extents in a sparse and clone aware fashion, with utilities to export block devices with snapshots from various storages into fiestreams and restore them elsewhere.

For licensing information see the COPYING file. For information on how to contribute see the CONTRIBUTING file.

TODO

There's a TODO file, but the main goals before a first release are:

  • Document the streaming format / protocol properly and get some feedback.
  • Generally write some more / improve the documentation.
  • Add examples for all the tools right here (and to the man pages).
  • Add another mode to fies-dmthin where the metadata is read fully first to free up the reserved metadata snapshot early.

Tools

  • fies create, list and extract contents of a fiestream
  • fies-restore restore a volume/snapshot fiestream to a file or device with snapshots
  • fies-dmthin create a fiestream from dmthin volumes and their snapshots
  • fies-rbd create a fiestream from rbd devices with snapshots
  • fies-zvol create a fiestream from zvols with snapshots
  • libfies library to handle the fies format

Installation

See meson_options.txt for options. Build with meson.

./fies $ meson setup build
./fies $ cd ./build
./fies/build $ meson compile