diff --git a/docs/manuals/source/TasksAndConcepts/CatalogMaintenance.rst b/docs/manuals/source/TasksAndConcepts/CatalogMaintenance.rst index dd99b7e3a0b..6b3f29e9732 100644 --- a/docs/manuals/source/TasksAndConcepts/CatalogMaintenance.rst +++ b/docs/manuals/source/TasksAndConcepts/CatalogMaintenance.rst @@ -150,8 +150,8 @@ To view and test the currently configured settings, use following commands: 25-Apr 16:25 bareos-dir ERROR TERMINATION Please correct the configuration in /etc/bareos/bareos-dir.d/*/*.conf -PostgreSQL -^^^^^^^^^^ +PostgreSQL configuration +^^^^^^^^^^^^^^^^^^^^^^^^ On most distributions, PostgreSQL uses ident to allow access to the database system. The database administrator account is the Unix user **postgres**. Normally, this user can access the database without password, as the ident mechanism is used to identify the user. @@ -440,8 +440,8 @@ You can use the following Job resource in your nightly :config:option:`dir/job = } -PostgreSQL ----------- +PostgreSQL Database +------------------- :index:`\ `\ :index:`\ `\ diff --git a/docs/manuals/source/TasksAndConcepts/Plugins.rst b/docs/manuals/source/TasksAndConcepts/Plugins.rst index 7e7d9475190..30786b2d9e5 100644 --- a/docs/manuals/source/TasksAndConcepts/Plugins.rst +++ b/docs/manuals/source/TasksAndConcepts/Plugins.rst @@ -1070,8 +1070,8 @@ It is included in Bareos since :sinceVersion:`19: oVirt Plugin`. .. _oVirtPlugin-status: -Status -^^^^^^ +Status of oVirt Plugin +^^^^^^^^^^^^^^^^^^^^^^ The Plugin can currently only take full backups of VM disks. @@ -1101,8 +1101,8 @@ was adapted to the modernized Bareos Python plugin API. .. _oVirtPlugin-requirements: -Requirements -^^^^^^^^^^^^ +Requirements of oVirt Plugin +^^^^^^^^^^^^^^^^^^^^^^^^^^^^ The plugin is currently only available for Red Hat Enterprise Linux and CentOS 7 and 8. It requires the Python oVirt Engine SDK version 4, Red Hat Subscriptions customers can find the package @@ -1136,8 +1136,8 @@ QEMU GA provides VSS support thus live snapshots attempt to quiesce whenever pos .. _oVirtPlugin-installation: -Installation -^^^^^^^^^^^^ +Installation of oVirt Plugin +^^^^^^^^^^^^^^^^^^^^^^^^^^^^ The installation is done by installing the package **bareos-filedaemon-ovirt-python-plugin**: @@ -1148,8 +1148,8 @@ The installation is done by installing the package **bareos-filedaemon-ovirt-pyt .. _oVirtPlugin-configuration: -Configuration -^^^^^^^^^^^^^ +Configuration of oVirt Plugin +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ As the Plugin needs access to the oVirt API, an account with appropriate privileges must be used. The default **admin@internal** user works, as it has all privileges. Using an account with @@ -1332,8 +1332,8 @@ ovirt_sdk_debug_log .. _oVirtPlugin-backup: -Backup -^^^^^^ +Backup with oVirt Plugin +^^^^^^^^^^^^^^^^^^^^^^^^ To manually run a backup, use the following command in |bconsole|: @@ -1366,8 +1366,8 @@ To manually run a backup, use the following command in |bconsole|: .. _oVirtPlugin-restore: -Restore -^^^^^^^ +Restore with oVirt Plugin +^^^^^^^^^^^^^^^^^^^^^^^^^ An example restore dialogue could look like this: @@ -1536,8 +1536,8 @@ The Libcloud plugin can be used to backup objects from cloud storages via the *S .. _LibcloudPlugin-status: -Status -^^^^^^ +Status of Libcloud Plugin +^^^^^^^^^^^^^^^^^^^^^^^^^ The status of the Libcloud plugin is **experimental**. It can automatically recurse nested Buckets and backup all included Objects on a S3 storage. However, **restore of objects cannot be done directly back to the storage**. A restore will write these objects @@ -1545,8 +1545,8 @@ on a S3 storage. However, **restore of objects cannot be done directly back to t .. _LibcloudPlugin-requirements: -Requirements -^^^^^^^^^^^^ +Requirements of Libcloud Plugin +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ To use the Apache Libcloud backend you need to have the Libcloud module available for Python 2. @@ -1554,16 +1554,16 @@ The plugin needs several options to run properly, the plugin options in the file .. _LibcloudPlugin-installation: -Installation -^^^^^^^^^^^^ +Installation of Libcloud Plugin +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ The installation is done by installing the package **bareos-filedaemon-libcloud-python-plugin**. .. _LibcloudPlugin-configuration: -Configuration -^^^^^^^^^^^^^ +Configuration of Libcloud Plugin +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code-block:: bareosconfig :caption: /etc/bareos/bareos-dir.d/fileset/PluginTest.conf @@ -1719,21 +1719,21 @@ The key features of XtraBackup are: Incremental backups only work for INNODB tables, when using MYISAM, only full backups can be created. -Prerequisites -^^^^^^^^^^^^^ +Prerequisites of percona XtraBackup Plugin +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Install the XtraBackup tool from Percona. Documentation and packages are available here: https://www.percona.com/software/mysql-database/percona-XtraBackup. The plugin was successfully tested with XtraBackup versions 2.3.5 and 2.4.4. For authentication the :file:`.mycnf` file of the user running the |fd| is used. Before proceeding, make sure that XtraBackup can connect to the database and create backups. -Installation -^^^^^^^^^^^^ +Installation of percona XtraBackup Plugin +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Make sure you have met the prerequisites, after that install the package **bareos-filedaemon-percona_XtraBackup-python-plugin**. -Configuration -^^^^^^^^^^^^^ +Configuration of percona XtraBackup Plugin +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Activate your plugin directory in the |fd| configuration. See :ref:`fdPlugins` for more about plugins in general. @@ -1781,8 +1781,8 @@ You can append options to the plugin call as key=value pairs, separated by ’: - :strong:`strictIncremental`: By default (false), an incremental backup will create data, even if the Log Sequence Number (LSN) was not increased since last backup. This is to ensure, that eventual changes to MYISAM tables get into the backup. MYISAM does not support incremental backups, you will always get a full backup of these tables. If set to true, no data will be written into backup, if the LSN was not changed. -Restore -^^^^^^^ +Restore with percona XtraBackup Plugin +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ With the usual Bareos restore mechanism a file-hierarchy will be created on the restore client under the default restore location: @@ -1864,8 +1864,8 @@ The restore basically works like this: #. |postgresql| will restore the latest possible consistent point in time. You can manage to restore to any other point in in time available in the WAL files, please refer to the |postgresql| documentation for more details. -Prerequisites -^^^^^^^^^^^^^ +Prerequisites for the PostgreSQL Plugin +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ This plugin is a Bareos Python plugin. It requires |postgresql| >= 9 and the Python module **pg8000** to be installed. @@ -1900,14 +1900,14 @@ Please refer to the |postgresql| documentation for details. old files are not removed automatically. -Installation -^^^^^^^^^^^^ +Installation of the PostgreSQL Plugin +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Make sure you have met the prerequisites, after that install the package **bareos-filedaemon-postgres-python-plugin**. -Configuration -^^^^^^^^^^^^^ +Configuration of the PostgreSQL Plugin +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Activate your plugin directory in the |fd| configuration. See :ref:`fdPlugins` for more about plugins in general. @@ -1969,8 +1969,9 @@ switchWalTimeout Timeout in seconds to wait for WAL archiving after WAL switch, default 60 seconds. -Restore -^^^^^^^ + +Restore with the PostgreSQL Plugin +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ With the usual Bareos restore mechanism a file-hierarchy will be created on the restore client under the default restore location according to the options set: @@ -2020,8 +2021,8 @@ You might have to adapt your SELINUX configuration for this. Starting the |postgresql| server shall now initiate the recovery process. -Troubleshooting -^^^^^^^^^^^^^^^ +Troubleshooting the PostgreSQL Plugin +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ If things don't work as expected, make sure that @@ -2169,8 +2170,8 @@ The volume label is unencrypted, so a volume can also be recognized by a non-enc .. _configuration-1: -Configuration -^^^^^^^^^^^^^ +Configuration of the scsicrypto-sd plugin +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ SCSI crypto setup ''''''''''''''''' diff --git a/docs/manuals/source/TasksAndConcepts/TransportEncryption.rst b/docs/manuals/source/TasksAndConcepts/TransportEncryption.rst index 718d6a1c3b9..5e689120017 100644 --- a/docs/manuals/source/TasksAndConcepts/TransportEncryption.rst +++ b/docs/manuals/source/TasksAndConcepts/TransportEncryption.rst @@ -345,8 +345,8 @@ However, it is also possible to disable transport encryption and use cleartext t ... } -|bareosFD| configuration -^^^^^^^^^^^^^^^^^^^^^^^^ +|bareosFD| configuration before 18.2 +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code-block:: ini :caption: :file:`/etc/bareos/bareos-fd.d/client/bareos-fd.conf` diff --git a/docs/manuals/source/TasksAndConcepts/UsingTapeDrivesWithoutAutochanger.rst b/docs/manuals/source/TasksAndConcepts/UsingTapeDrivesWithoutAutochanger.rst index a1f66fd68c7..3dfd62cdbab 100644 --- a/docs/manuals/source/TasksAndConcepts/UsingTapeDrivesWithoutAutochanger.rst +++ b/docs/manuals/source/TasksAndConcepts/UsingTapeDrivesWithoutAutochanger.rst @@ -109,8 +109,8 @@ modifications of it based on two week cycles or longer. .. _advantages-1: -Advantages -~~~~~~~~~~ +Advantages of Daily Tape Rotation +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - All the data is stored on a single tape, so recoveries are simple and faster. @@ -118,8 +118,8 @@ Advantages .. _disadvantages-1: -Disadvantages -~~~~~~~~~~~~~ +Disadvantages of Daily Tape Rotation +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - The tape must be changed every day requiring a lot of operator intervention. @@ -135,8 +135,8 @@ Disadvantages .. _practical-details-1: -Practical Details -~~~~~~~~~~~~~~~~~ +Practical Details of Daily Tape Rotation +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ The simplest way to "force" Bareos to use a different tape each day is to define a different Pool for each day of the the week a backup is done. In addition, you will need to specify appropriate Job and File retention periods so that Bareos will relabel and overwrite the tape each week rather than appending to it. Nic Bellamy has supplied an actual working model of this which we include here.