Skip to content

Commit

Permalink
docs: (Sphinx) update doc by running auto conversion script
Browse files Browse the repository at this point in the history
  • Loading branch information
joergsteffens committed Feb 10, 2019
1 parent e288ed5 commit f532d67
Show file tree
Hide file tree
Showing 3 changed files with 29 additions and 78 deletions.
Expand Up @@ -24,14 +24,12 @@ A Bareos Storage Daemon can use various storage backends:
**Rados** (Ceph Object Store)
is used to access a Ceph object store.

Droplet Storage Backend
-----------------------

:index:`[TAG=Backend->Droplet] <pair: Backend; Droplet>` :index:`[TAG=Backend->Droplet->S3] <triple: Backend; Droplet; S3>` :index:`[TAG=Backend->S3|see {Backend->Droplet}] <triple: Backend; S3|see {Backend; Droplet}>`

.. _SdBackendDroplet:

Droplet Storage Backend
-----------------------

:index:`[TAG=Backend->Droplet] <pair: Backend; Droplet>` :index:`[TAG=Backend->Droplet->S3] <triple: Backend; Droplet; S3>` :index:`[TAG=Backend->S3|see {Backend->Droplet}] <triple: Backend; S3|see {Backend; Droplet}>`

The **bareos-storage-droplet** backend (:index:`Version >= 17.2.7 <pair: bareos-17.2.7; Droplet>`) can be used to access Object Storage through **libdroplet**. Droplet support a number of backends, most notably S3. For details about Droplet itself see `<https://github.com/scality/Droplet>`_.

Expand All @@ -42,7 +40,7 @@ Requirements

- Droplet S3:

- The droplet S3 backend can only be used with virtual-hosted-style buckets like `http://<bucket>.<s3_server>/object <http://<bucket>.<s3_server>/object>`__. Path-style buckets are not supported. It has been tested successfully with AWS S3 and CEPH Object Gateway S3.
- The droplet S3 backend can only be used with virtual-hosted-style buckets like http://bucket.s3_server/object. Path-style buckets are not supported. It has been tested successfully with AWS S3 and CEPH Object Gateway S3.

Installation
~~~~~~~~~~~~
Expand Down Expand Up @@ -288,7 +286,7 @@ For performance, **Device Options**:sup:`Sd`:sub:`Device`\ should be configured
New AWS S3 Buckets
^^^^^^^^^^^^^^^^^^

As AWS S3 buckets are accessed via virtual-hosted-style buckets (like `http://<bucket>.<s3_server>/object <http://<bucket>.<s3_server>/object>`__) creating a new bucket results in a new DNS entry.
As AWS S3 buckets are accessed via virtual-hosted-style buckets (like http://bucket.s3_server/object) creating a new bucket results in a new DNS entry.

As a new DNS entry is not available immediatly, Amazon solves this by using HTTP temporary redirects (code: 307) to redirect to the correct host. Unfortenatly, the Droplet library does not support HTTP redirects.

Expand Down
10 changes: 5 additions & 5 deletions docs/manuals/en/new_main_reference/source/chapter24/basejob.rst
@@ -1,15 +1,15 @@
.. ATTENTION do not edit this file manually.
It was automatically converted from the corresponding .tex file
.. _basejobs:

File Deduplication using Base Jobs
==================================

:index:`[TAG=Base Jobs] <single: Base Jobs>` :index:`[TAG=File Deduplication] <single: File Deduplication>`

.. _basejobs:
:index:`[TAG=Base Jobs] <single: Base Jobs>` :index:`[TAG=File Deduplication] <single: File Deduplication>`

A base job is sort of like a Full save except that you will want the FileSet to contain only files that are unlikely to change in the future (i.e. a snapshot of most of your system after installing it). After the base job has been run, when you are doing a Full save, you specify one or more Base jobs to be used. All files that have been backed up in the Base job/jobs but not
modified will then be excluded from the backup. During a restore, the Base jobs will be automatically pulled in where necessary.
A base job is sort of like a Full save except that you will want the FileSet to contain only files that are unlikely to change in the future (i.e. a snapshot of most of your system after installing it). After the base job has been run, when you are doing a Full save, you specify one or more Base jobs to be used. All files that have been backed up in the Base job/jobs but not modified will then be excluded from the backup. During a restore, the Base jobs will be automatically pulled in where
necessary.

Imagine having 100 nearly identical Windows or Linux machine containing the OS and user files. Now for the OS part, a Base job will be backed up once, and rather than making 100 copies of the OS, there will be only one. If one or more of the systems have some files updated, no problem, they will be automatically backuped.

Expand Down
Expand Up @@ -635,86 +635,39 @@ You will note that the File table (containing the file attributes) make up the l
Without proper setup and maintenance, your Catalog may continue to grow indefinitely as you run Jobs and backup Files, and/or it may become very inefficient and slow. How fast the size of your Catalog grows depends on the number of Jobs you run and how many files they backup. By deleting records within the database, you can make space available for the new records that will be added during the next Job. By constantly deleting old expired records (dates older than the Retention period), your
database size will remain constant.

Setting Retention Periods
~~~~~~~~~~~~~~~~~~~~~~~~~

:index:`[TAG=Setting Retention Periods] <single: Setting Retention Periods>` :index:`[TAG=Periods->Setting Retention] <pair: Periods; Setting Retention>`

.. _Retention:

Setting Retention Periods
~~~~~~~~~~~~~~~~~~~~~~~~~

:index:`[TAG=Setting Retention Periods] <single: Setting Retention Periods>` :index:`[TAG=Periods->Setting Retention] <pair: Periods; Setting Retention>`

Bareos uses three Retention periods: the File Retention period, the Job Retention period, and the Volume Retention period. Of these three, the File Retention period is by far the most important in determining how large your database will become.

The File Retention and the Job Retention are specified in each Client resource as is shown below. The Volume Retention period is specified in the Pool resource, and the details are given in the next chapter of this manual.

\begin{description}

\item [File Retention = <time-period-specification>]
:index:`[TAG=File Retention] <single: File Retention>`
:index:`[TAG=Retention->File] <pair: Retention; File>`
The File Retention record defines the length of time that Bareos will keep
File records in the Catalog database. When this time period expires, and if
{\bf AutoPrune} is set to {\bf yes}, Bareos will prune (remove) File records
that are older than the specified File Retention period. The pruning will
occur at the end of a backup Job for the given Client. Note that the Client
database record contains a copy of the File and Job retention periods, but
Bareos uses the current values found in the Director's Client resource to do
the pruning.

Since File records in the database account for probably 80 percent of the
size of the database, you should carefully determine exactly what File
Retention period you need. Once the File records have been removed from
the database, you will no longer be able to restore individual files
in a Job. However, as long as the
Job record still exists, you will be able to restore all files in the
job.

Retention periods are specified in seconds, but as a convenience, there are
a number of modifiers that permit easy specification in terms of minutes,
hours, days, weeks, months, quarters, or years on the record. See the
:ref:`Configuration chapter <Time>` of this manual for additional details
of modifier specification.
File Retention = <time-period-specification>
:index:`[TAG=File Retention] <single: File Retention>` :index:`[TAG=Retention->File] <pair: Retention; File>` The File Retention record defines the length of time that Bareos will keep File records in the Catalog database. When this time period expires, and if AutoPrune is set to yes, Bareos will prune (remove) File records that are older than the specified File Retention period. The pruning will occur at the end of a backup Job for the given Client. Note that the Client database record contains a copy of the
File and Job retention periods, but Bareos uses the current values found in the Director’s Client resource to do the pruning.

Since File records in the database account for probably 80 percent of the size of the database, you should carefully determine exactly what File Retention period you need. Once the File records have been removed from the database, you will no longer be able to restore individual files in a Job. However, as long as the Job record still exists, you will be able to restore all files in the job.

Retention periods are specified in seconds, but as a convenience, there are a number of modifiers that permit easy specification in terms of minutes, hours, days, weeks, months, quarters, or years on the record. See the :ref:`Configuration chapter <Time>` of this manual for additional details of modifier specification.

The default File retention period is 60 days.

\item [Job Retention = <time-period-specification>]
:index:`[TAG=Job->Retention] <pair: Job; Retention>`
:index:`[TAG=Retention->Job] <pair: Retention; Job>`
The Job Retention record defines the length of time that {\bf Bareos}
will keep Job records in the Catalog database. When this time period
expires, and if {\bf AutoPrune} is set to {\bf yes} Bareos will prune
(remove) Job records that are older than the specified Job Retention
period. Note, if a Job record is selected for pruning, all associated File
and JobMedia records will also be pruned regardless of the File Retention
period set. As a consequence, you normally will set the File retention
period to be less than the Job retention period.

As mentioned above, once the File records are removed from the database,
you will no longer be able to restore individual files from the Job.
However, as long as the Job record remains in the database, you will be
able to restore all the files backuped for the Job.
As a consequence, it is generally a good idea to retain the Job
records much longer than the File records.

The retention period is specified in seconds, but as a convenience, there
are a number of modifiers that permit easy specification in terms of
minutes, hours, days, weeks, months, quarters, or years.
See the :ref:`Configuration chapter <Time>` of this manual for additional details of
modifier specification.
Job Retention = <time-period-specification>
:index:`[TAG=Job->Retention] <pair: Job; Retention>` :index:`[TAG=Retention->Job] <pair: Retention; Job>` The Job Retention record defines the length of time that Bareos will keep Job records in the Catalog database. When this time period expires, and if AutoPrune is set to yes Bareos will prune (remove) Job records that are older than the specified Job Retention period. Note, if a Job record is selected for pruning, all associated File and JobMedia records will also be pruned regardless of the File Retention
period set. As a consequence, you normally will set the File retention period to be less than the Job retention period.

As mentioned above, once the File records are removed from the database, you will no longer be able to restore individual files from the Job. However, as long as the Job record remains in the database, you will be able to restore all the files backuped for the Job. As a consequence, it is generally a good idea to retain the Job records much longer than the File records.

The retention period is specified in seconds, but as a convenience, there are a number of modifiers that permit easy specification in terms of minutes, hours, days, weeks, months, quarters, or years. See the :ref:`Configuration chapter <Time>` of this manual for additional details of modifier specification.

The default Job Retention period is 180 days.

\item **Auto Prune**:sup:`Dir`:sub:`Client`\
:index:`[TAG=AutoPrune] <single: AutoPrune>`
:index:`[TAG=Job->Retention->AutoPrune] <triple: Job; Retention; AutoPrune>`
If set to {\bf yes},
Bareos will automatically apply
the File retention period and the Job retention period for the Client at the
end of the Job.
If you turn this off by setting it to {\bf no}, your Catalog will grow each
time you run a Job.
\end{description}
**Auto Prune**:sup:`Dir`:sub:`Client`\
:index:`[TAG=AutoPrune] <single: AutoPrune>` :index:`[TAG=Job->Retention->AutoPrune] <triple: Job; Retention; AutoPrune>` If set to yes, Bareos will automatically apply the File retention period and the Job retention period for the Client at the end of the Job. If you turn this off by setting it to no, your Catalog will grow each time you run a Job.

.. _section-JobStatistics:

Expand Down

0 comments on commit f532d67

Please sign in to comment.