diff --git a/docs/administration-guide.rst b/docs/administration-guide.rst index 91124418..3463bac7 100644 --- a/docs/administration-guide.rst +++ b/docs/administration-guide.rst @@ -4,6 +4,69 @@ Administration Guide The administartion guide. +Terminology +----------- + +Backup Type +~~~~~~~~~~~ + +The backup server groups backups by *type*, where *type* is one of: + +``vm`` + This type is use for :term:`virtual machine`\ s. Typically + contains the virtual machine configuration and an image archive + for each disk. + +``ct`` + This type is use for :term:`container`\ s. Contains the container + configuration and a single file archive for the container content. + +``host`` + This type is used for physical host, or if you want to run backup + manually from inside virtual machines or containers. Such backup + may contains file and image archives (no restrictions here). + + +Backup ID +~~~~~~~~~ + +An unique ID. Usually the virtual machine or container ID. ``host`` +type backups normally use the hostname. + + +Backup Time +~~~~~~~~~~~ + +The time when the backup was made. + + +Backup Snapshot +~~~~~~~~~~~~~~~ + +We call the triplet ``//