Skip to content

Commit

Permalink
warning
Browse files Browse the repository at this point in the history
  • Loading branch information
pstorz committed Nov 28, 2018
1 parent 9630aa9 commit f3a65bb
Show file tree
Hide file tree
Showing 11 changed files with 49 additions and 16 deletions.
1 change: 1 addition & 0 deletions docs/manuals/en/new_main_reference/replace.sh
Expand Up @@ -84,6 +84,7 @@ sed -i -E 's# .. raw:: latex##g' *.rst

# warning
sed -i -E 's|:raw-latex:`\\warning\{(.*)\}`|\n.. warning:: \n \1|g' *.rst
sed -i -E 's|\\warning\{(.*)\}|\n.. warning:: \n \1|g' *.rst

# sinceversion
# raw-latex:`\sinceVersion{dir}{requires!jansson}{15.2.0}`
Expand Down
Expand Up @@ -192,7 +192,9 @@ during the daytime when no backups are executed.



\warning{All Bareos job resources have some required directives, e.g. \linkResourceDirective{Dir}{Job}{Client}.

.. warning::
All Bareos job resources have some required directives, e.g. \linkResourceDirective{Dir}{Job}{Client.
Even so, none other than the mentioned directives are evaluated by a \resourceDirectiveValue{Dir}{Job}{Type}{Consolidate},
they still have to be defined.
Normally all required directives are already set in \resourceDirectiveValue{Dir}{Job}{Job Defs}{DefaultJob}.
Expand Down
4 changes: 3 additions & 1 deletion docs/manuals/en/new_main_reference/source/bconsole.rst
Expand Up @@ -730,7 +730,9 @@ configure
\warning{Don't be confused by the extensive output of \bcommand{help}{configure}. As \bcommand{configure}{add} allows configuring arbitrary resources, the output of \bcommand{help}{configure} lists all the resources, each with all valid directives. The same data is also used for \command{bconsole} command line completion.}
.. warning::
Don't be confused by the extensive output of \bcommand{help}{configure}. As \bcommand{configure}{add} allows configuring arbitrary resources, the output of \bcommand{help}{configure} lists all the resources, each with all valid directives. The same data is also used for \command{bconsole} command line completion.
Available since Bareos
16.2.4.
Expand Down
4 changes: 3 additions & 1 deletion docs/manuals/en/new_main_reference/source/catmaintenance.rst
Expand Up @@ -81,7 +81,9 @@ changes.



\warning{When using the PostgreSQL backend and updating to Bareos $<$ 14.2.3, it is necessary to manually grant database permissions (\command{grant_bareos_privileges}), normally by}

.. warning::
When using the PostgreSQL backend and updating to Bareos $<$ 14.2.3, it is necessary to manually grant database permissions (\command{grant_bareos_privileges}), normally by



Expand Down
4 changes: 3 additions & 1 deletion docs/manuals/en/new_main_reference/source/dataencryption.rst
Expand Up @@ -18,7 +18,9 @@ to unencrypted file contents.



\warning{These feature is only available, if Bareos is build against OpenSSL.}

.. warning::
These feature is only available, if Bareos is build against OpenSSL.

It is very important to specify what this implementation does NOT do:

Expand Down
12 changes: 9 additions & 3 deletions docs/manuals/en/new_main_reference/source/ndmp.rst
Expand Up @@ -629,11 +629,15 @@ Appliance.
\warning{Normally (\linkResourceDirective{Dir}{Client}{Protocol}=Native) Filesets get handled by the \bareosFd. When connecting directly to a NDMP Clients (\linkResourceDirective{Dir}{Client}{Protocol}=NDMP*), no \bareosFd is involved and therefore most Fileset options can't be used. Instead, parameters are handled via \configdirective{Options - Meta} from \linkResourceDirective{Dir}{FileSet}{Include}.}
.. warning::
Normally (\linkResourceDirective{Dir}{Client}{Protocol}=Native) Filesets get handled by the \bareosFd. When connecting directly to a NDMP Clients (\linkResourceDirective{Dir}{Client}{Protocol}=NDMP*), no \bareosFd is involved and therefore most Fileset options can't be used. Instead, parameters are handled via \configdirective{Options - Meta} from \linkResourceDirective{Dir}{FileSet}{Include}.



\warning{Avoid using multiple \linkResourceDirective{Dir}{FileSet}{Include} \configdirective{File} directives.

.. warning::
Avoid using multiple \linkResourceDirective{Dir}{FileSet}{Include} \configdirective{File directives.
The \bareosDir would try to handle them by running multiple NDMP jobs in a single Bareos job.
Even if this is working fine during backup, restore jobs will cause trouble.}

Expand Down Expand Up @@ -1299,7 +1303,9 @@ Now we successfully copied over the NDMP job.
\warning{\bcommand{list}{jobs} will only show the number of main backup files as JobFiles. However, with \bcommand{list}{files jobid=...} all files are visible.}
.. warning::
\bcommand{list}{jobs} will only show the number of main backup files as JobFiles. However, with \bcommand{list}{files jobid=...} all files are visible.
Restore to NDMP Primary Storage System
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Expand Down
4 changes: 3 additions & 1 deletion docs/manuals/en/new_main_reference/source/programs.rst
Expand Up @@ -826,7 +826,9 @@ Extracting Under Windows



\warning{If you use \command{bextract} under Windows, the ordering of the parameters is essential.}

.. warning::
If you use \command{bextract} under Windows, the ordering of the parameters is essential.

To use :program:`bextract`, the Bareos Storage Daemon must
be installed. As bextract works on tapes or disk volumes, these must be
Expand Down
8 changes: 6 additions & 2 deletions docs/manuals/en/new_main_reference/source/recycling.rst
Expand Up @@ -365,7 +365,9 @@ used the defaults for all these items.
**Purge Oldest Volume**:sup:`Dir`:sub:`Pool` =yes
(the Volume with the oldest LastWritten date and VolStatus equal to
Full, Recycle, Purged, Used, or Append is chosen).
:raw-latex:`\warning{We strongly recommend against the use of \configdirective{Purge Oldest Volume} as it can quite easily lead to loss of current backup
:raw-latex:`
.. warning::
We strongly recommend against the use of \configdirective{Purge Oldest Volume as it can quite easily lead to loss of current backup
data.}`

#. Give up and ask operator.
Expand Down Expand Up @@ -799,7 +801,9 @@ If you wish to reuse the tape by giving it a new name, use the



\warning{The \bcommand{delete}{} command can be dangerous. Once it is

.. warning::
The \bcommand{delete}{ command can be dangerous. Once it is
done, to recover the File records, you must either restore your database as it
was before the \bcommand{delete}{} command or use the :ref:`bscan` utility program to
scan the tape and recreate the database entries.}
4 changes: 3 additions & 1 deletion docs/manuals/en/new_main_reference/source/releasenotes.rst
Expand Up @@ -264,7 +264,9 @@ releases are only published on https://download.bareos.com.\|
\item The device spool size calculation when using secure erase was fixed.
\item \bcommand{.bvfs_lsdirs}{} no longer shows empty directories from accurate jobs.
\begin{itemize}
\item \warning{This decreases performance if your environment has a large numbers of directories. Creating an index improves the performance.}
\item
.. warning::
This decreases performance if your environment has a large numbers of directories. Creating an index improves the performance.
%In Bareos 16.2.6 the SQL Query used by \bcommand{.bvfs_lsdirs}{} was changed to not show
%empty directories from accurate jobs. It turned out that that the changed
%query causes performance issues when larger amounts of directories were backed up.\\
Expand Down
4 changes: 3 additions & 1 deletion docs/manuals/en/new_main_reference/source/supportedoses.rst
Expand Up @@ -370,7 +370,9 @@ server-side.



\warning{The configuration file contains passwords and therefore must not be accessible for any users except admin users.}

.. warning::
The configuration file contains passwords and therefore must not be accessible for any users except admin users.

Restart bareos-fd after changing the configuration
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Expand Down
16 changes: 12 additions & 4 deletions docs/manuals/en/new_main_reference/source/update.rst
Expand Up @@ -40,7 +40,9 @@ database scheme.



\warning{If the Bareos catalog database does not have the current schema, the Bareos Director refuses to start.}

.. warning::
If the Bareos catalog database does not have the current schema, the Bareos Director refuses to start.

Detailed information can then be found in the log file
:file:`/var/log/bareos/bareos.log`.
Expand All @@ -50,7 +52,9 @@ see which Bareos updates do require a database scheme update.



\warning{Especially the upgrade to Bareos $\geq$ 17.2.0 restructures the \dbtable{File} database table. In larger installations this is very time consuming and temporarily doubles the amount of required database disk space.}

.. warning::
Especially the upgrade to Bareos $\geq$ 17.2.0 restructures the \dbtable{File} database table. In larger installations this is very time consuming and temporarily doubles the amount of required database disk space.

Debian based Linux Distributions
--------------------------------
Expand All @@ -64,7 +68,9 @@ will be automatically adapted by the Bareos packages.



\warning{When using the PostgreSQL backend and updating to Bareos $<$ 14.2.3, it is necessary to manually grant database permissions, normally by using}

.. warning::
When using the PostgreSQL backend and updating to Bareos $<$ 14.2.3, it is necessary to manually grant database permissions, normally by using



Expand Down Expand Up @@ -99,7 +105,9 @@ different preparations. More details can be found in chapter



\warning{If you're updating to Bareos $<=$ 13.2.3 and have configured the Bareos database during install using Bareos environment variables (\variable{db_name}, \variable{db_user} or \variable{db_password}, see :ref:`CatMaintenanceChapter`), make sure to have these variables defined in the same way when calling the update and grant scripts. Newer versions of Bareos read these variables from the Director configuration file \configFileDirUnix. However, make sure that the user running the database scripts has read access to this file (or set the environment variables). The \user{postgres} user normally does not have the required permissions.}

.. warning::
If you're updating to Bareos $<=$ 13.2.3 and have configured the Bareos database during install using Bareos environment variables (\variable{db_name}, \variable{db_user} or \variable{db_password}, see :ref:`CatMaintenanceChapter`), make sure to have these variables defined in the same way when calling the update and grant scripts. Newer versions of Bareos read these variables from the Director configuration file \configFileDirUnix. However, make sure that the user running the database scripts has read access to this file (or set the environment variables). The \user{postgres} user normally does not have the required permissions.

PostgreSQL
~~~~~~~~~~
Expand Down

0 comments on commit f3a65bb

Please sign in to comment.