Skip to content

Commit

Permalink
cross-links
Browse files Browse the repository at this point in the history
  • Loading branch information
@pstorz
pstorz committed Nov 27, 2018
1 parent 16e3322 commit 713fd27
Show file tree
Hide file tree
Showing 48 changed files with 9,857 additions and 1,138 deletions.
53 changes: 32 additions & 21 deletions docs/manuals/en/new_main_reference/replace.sh
View file
Expand Up @@ -15,10 +15,41 @@ echo '============================'
###############################################################################



# links
sed -i -E 's|:raw-latex:`\\elink\{(.*)\}\{(.*)\}`|`\1 <\2>`_|g' *.rst
sed -i -E 's|:raw-latex:`\\label\{(.*)\}`|\n\n.. _`\1`: \1|g' *.rst

# link targets
perl -i -pe 's|:raw-latex:`\\ilink\{(.*?)\}\{(.*?)\}`|:ref:`\1 <\2>`|g' *.rst
perl -i -pe 's|:raw-latex:`\\nameref\{(.*?)\}`|:ref:`\1`|g' *.rst



# abbreviations
sed -i 's#:raw-latex:`\\bareosDir\(\s*\)`#\|bareosDir\|\1#g' *.rst
sed -i 's#:raw-latex:`\\bareosFd\(\s*\)`#\|bareosFd\|\1#g' *.rst
sed -i 's#:raw-latex:`\\bareosSd\(\s*\)`#\|bareosSd\|\1#g' *.rst
sed -i 's#:raw-latex:`\\bareosTraymonitor`#\|bareosTraymonitor\|#g' *.rst
sed -i 's#:raw-latex:`\\bareosWebui`#\|bareosWebui\|#g' *.rst
sed -i 's#:raw-latex:`\\mysql`# \|mysql\|#g' *.rst
sed -i 's#:raw-latex:`\\postgresql`# \|postgresql\|#g' *.rst
sed -i 's#:raw-latex:`\\sqlite`#\|sqlite\|#g' *.rst
sed -i 's#:raw-latex:`\\vmware`#\|vmware\|#g' *.rst
sed -i 's#:raw-latex:`\\vSphere`#\|vsphere\|#g' *.rst




perl -i -pe 's#:raw-latex:`\\command\{(.*?)\}`#:program:`\1`#g' *.rst

# rename sec: to sec- as : has special meaning in sphinx
sed -i -E 's#sec:#section-#g' *.rst






#
# DROP SOME STUFF WHICH IS NO LONGER NEEDED
#
Expand All @@ -28,21 +59,6 @@ sed -i -E 's|:raw-latex:`\\label\{(.*)\}`|\n\n.. _`\1`: \1|g' *.rst
#sed -i 's|:raw-latex:`\\hfill`||g' *.rst
#
##
## General substitutions
##
#sed -i 's#:raw-latex:`\\bareosFd\(\s*\)`#\|bareosFd\|\1#g' *.rst
#sed -i 's#:raw-latex:`\\bareosSd\(\s*\)`#\|bareosSd\|\1#g' *.rst
#sed -i 's#:raw-latex:`\\bareosDir\(\s*\)`#\|bareosDir\|\1#g' *.rst
#
#
#sed -i 's#:raw-latex:`\\bareosTraymonitor`#\|bareosTraymonitor\|#g' *.rst
#sed -i 's#:raw-latex:`\\bareosWebui`#\|bareosWebui\|#g' *.rst
#
#sed -i 's#:raw-latex:`\\mysql`# \|mysql\|#g' *.rst
#sed -i 's#:raw-latex:`\\postgresql`# \|postgresql\|#g' *.rst
#sed -i 's#:raw-latex:`\\sqlite`#\|sqlite\|#g' *.rst
#sed -i 's#:raw-latex:`\\vmware`#\|vmware\|#g' *.rst
#sed -i 's#:raw-latex:`\\vSphere`#\|vsphere\|#g' *.rst
#
##
## Bareos path and filenames
Expand All @@ -69,10 +85,8 @@ sed -i -E 's|:raw-latex:`\\label\{(.*)\}`|\n\n.. _`\1`: \1|g' *.rst
## General
##
#
##sed -i 's|:raw-latex:`\\command{bconsole}`|:command:`bconsole`|g' *.rst
#
##sed -i -E 's|:raw-latex:`\\command\{(.*)\}`|:command:`\1`|g' *.rst
#perl -i -pe 's#:raw-latex:`\\command\{(.*?)\}`#:program:`\1`#g' *.rst
#perl -i -pe 's#:raw-latex:`\\bcommand\{(.*?)\}\{(.*?)\}`#:program:`\1 \2`#g' *.rst
#
#
Expand Down Expand Up @@ -142,10 +156,8 @@ sed -i -E 's|:raw-latex:`\\label\{(.*)\}`|\n\n.. _`\1`: \1|g' *.rst
#
##sed -i -E 's|:raw-latex:`\\label\{(.*)\}`|.. _\1: \1|g' *.rst
#
#perl -i -pe 's|:raw-latex:`\\nameref\{(.*?)\}`|:ref:`\1`_|g' *.rst
#
#
#perl -i -pe 's|:raw-latex:`\\ilink\{(.*?)\}\{(.*?)\}`|:ref:`\1 <\2>`_|g' *.rst
#
##
## Warnings
Expand All @@ -158,7 +170,6 @@ sed -i -E 's|:raw-latex:`\\label\{(.*)\}`|\n\n.. _`\1`: \1|g' *.rst
#sed -i -E 's|:raw-latex:`\\resourceDirectiveValue\{(.*)\}\{(.*)\}\{(.*)\}\{(.*)\}`|**\3 = \4** (\1 configuration, \2 resource)|g' *.rst
#
#
#sed -i -E 's#sec:#section_#g' *.rst
#
##
## IMAGES (JUST A FEW, SO MAYBE MANUALLY)
Expand Down
52 changes: 13 additions & 39 deletions docs/manuals/en/new_main_reference/source/always-incremental.rst
View file
@@ -1,4 +1,4 @@
.. _sec-alwaysincremental:
.. _section-alwaysincremental:

Always Incremental Backup Scheme
================================
Expand Down Expand Up @@ -124,8 +124,6 @@ configuration is required:
...
}

bareosConfigResource

:raw-latex:`\linkResourceDirectiveValue{Dir}{Job}{Accurate}{yes}`
is required to detect deleted files and prevent that they are kept
in the consolidated backup jobs.
Expand All @@ -144,7 +142,7 @@ bareosConfigResource

:raw-latex:`\linkResourceDirective{Dir}{Job}{Always Incremental Max Full Age}`
is described later, see
:raw-latex:`\nameref{sec-AlwaysIncrementalMaxFullAge}`.
:ref:`section-AlwaysIncrementalMaxFullAge`.

Consolidate Job
~~~~~~~~~~~~~~~
Expand All @@ -159,8 +157,6 @@ Consolidate Job
JobDefs = "DefaultJob"
}

bareosConfigResource

:raw-latex:`\resourceDirectiveValue{Dir}{Job}{Type}{Consolidate}`
configures a job to be a consolidate job. This type have been
introduced with the Always Incremental feature. When used, it
Expand All @@ -172,7 +168,7 @@ bareosConfigResource

:raw-latex:`\linkResourceDirective{Dir}{Job}{Max Full Consolidations}`
is described later, see
:raw-latex:`\nameref{sec-MaxFullConsolidations}`.
:ref:`section-MaxFullConsolidations`.

The :raw-latex:`\job{Consolidate}` job evaluates all jobs configured
with
Expand All @@ -196,7 +192,7 @@ Storages and Pools
~~~~~~~~~~~~~~~~~~

For the Always Incremental Backup Scheme at least two storages are
needed. See :raw-latex:`\nameref{sec-MultipleStorageDevices}` how to
needed. See :ref:`section-MultipleStorageDevices` how to
setup multiple storages.

::
Expand All @@ -215,8 +211,6 @@ setup multiple storages.
Next Pool = AI-Consolidated # consolidated jobs go to this pool
}

bareosConfigResource

::

{bareosConfigResource}{bareos-dir}{pool}{AI-Consolidated}
Expand All @@ -233,8 +227,6 @@ bareosConfigResource
Next Pool = AI-Longterm # copy jobs write to this pool
}

bareosConfigResource

::

{bareosConfigResource}{bareos-dir}{pool}{AI-Longterm}
Expand All @@ -250,10 +242,8 @@ bareosConfigResource
Storage = File1
}

bareosConfigResource

:raw-latex:`\pool{AI-Longterm}` is optional and will be explained in
:raw-latex:`\nameref{sec-AlwaysIncrementalLongTermStorage}`.
:ref:`section-AlwaysIncrementalLongTermStorage`.

How it works
------------
Expand All @@ -280,8 +270,6 @@ scheduled to run every day.
Full Backup Pool = AI-Consolidated
}

bareosConfigResource

::

{bareosConfigResource}{bareos-dir}{job}{Consolidate}
Expand All @@ -292,8 +280,6 @@ bareosConfigResource
JobDefs = "DefaultJob"
}

bareosConfigResource

The following image shows the available backups for each day:

|image|
Expand Down Expand Up @@ -378,7 +364,7 @@ always incremental scheme.

|image|

.. _sec-AlwaysIncrementalMaxFullAge:
.. _section-AlwaysIncrementalMaxFullAge:

Always Incremental Max Full Age
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Expand Down Expand Up @@ -426,7 +412,7 @@ backups and daily consolidations is

Jobs Available with "Always Incremental Max Full Age"

.. _sec-MaxFullConsolidations:
.. _section-MaxFullConsolidations:

Max Full Consolidations
~~~~~~~~~~~~~~~~~~~~~~~
Expand Down Expand Up @@ -469,8 +455,6 @@ needs to be configured in the
Max Full Consolidations = 1
}

bareosConfigResource

If
:raw-latex:`\linkResourceDirective{Dir}{Job}{Max Full Consolidations}`
is configured, the consolidation job will not start more than the
Expand Down Expand Up @@ -504,7 +488,7 @@ influence the value that makes sense for

Jobs Available with Max Full Consolidations = 1

.. _sec-AlwaysIncrementalLongTermStorage:
.. _section-AlwaysIncrementalLongTermStorage:

Long Term Storage of Always Incremental Jobs
--------------------------------------------
Expand Down Expand Up @@ -545,8 +529,6 @@ just copy all uncopied backups in the
Messages = Standard
}

bareosConfigResource

As can be seen in the plot, the copy job creates a copy of the current
full backup that is available and is already 7 days old.

Expand Down Expand Up @@ -583,8 +565,6 @@ the data should be stored in a long-term pool.
}
}

bareosConfigResource

To make sure the longterm
:raw-latex:`\resourceDirectiveValue{Dir}{Job}{Level}{VirtualFull}` is
not taken as base for the next incrementals, the job type of the copied
Expand Down Expand Up @@ -645,8 +625,6 @@ be used.
{bconsole}{run}
*run job=BackupClient-remote level=Full storage=File-remote

bconsole

Transport the volumes that were used for that backup over to the local
storage daemon and make them available to the local storage daemon. This
can be either by putting the tapes into the local changer or by storing
Expand All @@ -673,8 +651,6 @@ storage:
| 1 | Full-0001 | Append | 1 | 38600329 | 0 | 31536000 | 1 | 0 | 0 | File | 2016-07-28 14:00:47 | File-remote |
+---------+------------+-----------+---------+----------+----------+--------------+---------+------+-----------+-----------+---------------------+-------------+

bconsole

Use :raw-latex:`\bcommand{update}{volume}` to set the right storage and
check with list volumes that it worked:

Expand All @@ -691,8 +667,6 @@ check with list volumes that it worked:
| 1 | Full-0001 | Append | 1 | 38600329 | 0 | 31536000 | 1 | 0 | 0 | File | 2016-07-28 14:00:47 | File |
+---------+------------+-----------+---------+----------+----------+--------------+---------+------+-----------+-----------+---------------------+---------+

bconsole

Now the remote storage daemon can be disabled as it is not needed
anymore.

Expand All @@ -706,11 +680,11 @@ If a network connection between the local director and the remote
storage daemon is not possible, it is also an option to setup a fully
functional Bareos installation remotely and then to import the created
volumes. Of course the network connection between the
:raw-latex:`\bareosDir `and the :raw-latex:`\bareosFd `is needed in any
|bareosDir| and the |bareosFd| is needed in any
case to make the incremental backups possible.

- Configure the connection from local :raw-latex:`\bareosDir `to remote
:raw-latex:`\bareosFd`, give the remote client the same name as it
- Configure the connection from local |bareosDir| to remote
|bareosFd|, give the remote client the same name as it
was when the data was backed up.

- Add the Fileset created on remote machine to local machine.
Expand Down Expand Up @@ -750,9 +724,9 @@ files (e.g. /var/lib/bareos/storage)

Shutdown Director on local director machine.

Import data form volume via :raw-latex:`\command{bscan}`, you need to
Import data form volume via :program:`bscan`, you need to
set which database backend is used:
:raw-latex:`\command{bscan -B sqlite3 FileStorage -V Transfer-0001 -s -S}`
:program:`bscan -B sqlite3 FileStorage -V Transfer-0001 -s -S`

If the import was successfully completed, test if an incremental job
really only backs up the minimum amount of data.
Expand Down

0 comments on commit 713fd27

Please sign in to comment.