-
Notifications
You must be signed in to change notification settings - Fork 4
First steps
To use phobos, a daemon called phobosd needs to be launched. It mainly manages the drive/media allocation and sets up resources to read or write your data.
To launch/stop the daemon:
# systemctl start/stop phobosd
Use the phobos lib scan command to scan a given library. For instance, the
following will give the contents of the /dev/changer library:
phobos lib scan /dev/changer
Use the phobos command line to add new tape drives to be managed by phobos.
It is recommanded to specify a device path which is persistent after reboot (eg. managed by dev mapper).
By default, drives are added in a locked state, so they are not immediatly used in production.
To enable using a drive in production as soon as it is added, specify the '--unlock' option:
phobos drive add --unlock /dev/mapper/LTO6-012345
To add tapes to be managed by phobos, use the phobos command line.
It is mandatory to specify a media type (like LTO8, T10KD...) with option -t:
phobos tape add --type lto6 [073200-073222]L6
Note1: this operation requires no access to the medium.
Note2: the set of supported media types, drive types, and compatibility rules between drives and media are configurable. See section 'Configuring device and media types' below for more details.
Once a media has been added, it needs to be formatted. You can optionally unlock the tape when the operation is done, so it becomes usable in production.
phobos tape format --unlock 073200L6
A device or media can be locked. In this case it cannot be used for subsequent 'put' or 'get' operations:
phobos drive {lock|unlock} <drive_serial|drive_path>
phobos media {lock|unlock} <media_id>
Any device or media can be listed using the 'list' operation. For instance, the following will list all the existing tape identifiers:
phobos tape list
The rest of this document will describe object management using CLI calls. An API is available and is more described here.
When pushing an object you need to specify an identifier that can be later used to retrieve this data.
Phobos also allows specifying an arbitrary set of attributes (key-values) to be attached to the object. They are specified when putting the object using the '-m' option.
# phobos put <file> <id> --metadata <k=v,k=v,...>
phobos put myinput_file foo-12345 --metadata user=$LOGNAME,\
put_time=$(date +%s),version=1
To retrieve the data of an object, use phobos get. Its arguments are the
identifier of the object to be retrieved, as well as a path of target file.
For example:
phobos get obj0123 /tmp/obj0123.back
To retrieve custom object metadata, use phobos getmd:
$ phobos getmd obj0123
cksum=md5:7c28aec5441644094064fcf651ab5e3e,user=foo
To delete an object, use phobos del[ete]:
phobos del obj0123
WARNING: the object will not be completely removed from the phobos system ie. its data will still exist and be accessible. Thus the object is considered as deprecated and basic operations can no longer be executed on it if its uuid/version is not given. A future feature will allow the complete removal of an object.
This deletion can be reverted using phobos undel[ete]:
phobos undel obj0123
To revert an object deletion, the object ID needs not to be used by a living object.
To list objects, use phobos object list:
$ phobos object list --output oid,user_md
| oid | user_md |
|-------|-----------------|
| obj01 | {} |
| obj02 | {"user": "foo"} |
The --output option describes which field will be output. all can be used as
a special field to select them all.