Welcome to mirror list, hosted at ThFree Co, Russian Federation.

github.com/bareos/bareos-docs.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJoerg Steffens <joerg.steffens@bareos.com>2017-11-30 20:47:05 +0300
committerJoerg Steffens <joerg.steffens@bareos.com>2017-12-14 20:01:30 +0300
commit0c71d81139df4d127a0fbc5556cd250b4ca0ec76 (patch)
tree55f53f31759f3373acf920ab8aec3d3663f34bac
parent487b3f485105eddb3b565b9ce7ab82785ce4c258 (diff)
updated for bareos-17.2 including release notes
-rw-r--r--manuals/en/main/bareos.sty1
-rw-r--r--manuals/en/main/catmaintenance.tex70
-rw-r--r--manuals/en/main/general.tex11
-rw-r--r--manuals/en/main/howto.tex10
-rw-r--r--manuals/en/main/install.tex88
-rw-r--r--manuals/en/main/plugins-vmware-plugin.tex45
-rw-r--r--manuals/en/main/programs.tex9
-rw-r--r--manuals/en/main/releasenotes.tex39
-rw-r--r--manuals/en/main/supportedoses.tex2
-rw-r--r--manuals/en/main/update.tex5
-rw-r--r--manuals/en/main/webui.tex2
11 files changed, 188 insertions, 94 deletions
diff --git a/manuals/en/main/bareos.sty b/manuals/en/main/bareos.sty
index 18fa4b9..1dc965e 100644
--- a/manuals/en/main/bareos.sty
+++ b/manuals/en/main/bareos.sty
@@ -211,6 +211,7 @@
\newcommand{\configresource}[1]{\path|#1|}
\newcommand{\configline}[1]{\path|#1|}
\newcommand{\directory}[1]{\path|#1|}
+\newcommand{\dbcolumn}[1]{\path|#1|}
\newcommand{\dbtable}[1]{\path|#1|}
\newcommand{\email}[1]{\url{#1}}
\newcommand{\file}[1]{\path|#1|}
diff --git a/manuals/en/main/catmaintenance.tex b/manuals/en/main/catmaintenance.tex
index c8c5df2..27f4c2f 100644
--- a/manuals/en/main/catmaintenance.tex
+++ b/manuals/en/main/catmaintenance.tex
@@ -9,16 +9,16 @@
\section{Catalog Database}
Bareos stores its catalog in a database.
-Different database backends are supported:
+Different database backends are offered:
\begin{itemize}
- \item PostgreSQL
+ \item PostgreSQL (recommended)
\item MariaDB/MySQL (see \nameref{sec:MysqlSupport})
\item Sqlite (only for testing)
\end{itemize}
What database will be used, can be configured in the \bareosDir configuration, see the \nameref{DirectorResourceCatalog}.
-The database often runs on the same server as the Bareos Director.
+The database often runs on the same server as the \bareosDir.
However, it is also possible to run it on a different system.
This might require some more manual configuration.
@@ -261,7 +261,9 @@ The owner of the database may vary. The Bareos database maintance scripts don't
By default, using PostgreSQL ident, a Unix user can access a database of the same name.
Therefore the user \user{bareos} can access the database \path|bareos|.
-\begin{commands}{Verify Bareos database on PostgreSQL as Unix user bareos}
+
+
+\begin{commands}{Verify Bareos database on PostgreSQL as Unix user bareos (bareos-13.2.3)}
root@linux:~# <input>su - bareos -s /bin/sh</input>
bareos@linux:~# <input>psql</input>
Welcome to psql 8.3.23, the PostgreSQL interactive terminal.
@@ -379,7 +381,7 @@ Catalog {
After this, run the Bareos database preparation scripts.
For Bareos $<=$ 13.2.2, the database password must be specified as environment variable \variable{db_password}.
-From \sinceVersion{dir}{MySQL password from configuration file}{13.2.3}
+From \sinceVersion{dir}{MySQL password from configuration file}{13.2.3}
the database password is read from the configuration, if no environment variable is given.
\begin{commands}{Setup Bareos catalog database}
@@ -444,6 +446,40 @@ mysql> <input>show tables;</input>
+--------------------+
30 rows in set (0.00 sec)
+mysql> <input>describe Job;</input>
++-----------------+---------------------+------+-----+---------+----------------+
+| Field | Type | Null | Key | Default | Extra |
++-----------------+---------------------+------+-----+---------+----------------+
+| JobId | int(10) unsigned | NO | PRI | NULL | auto_increment |
+| Job | tinyblob | NO | | NULL | |
+| Name | tinyblob | NO | MUL | NULL | |
+| Type | binary(1) | NO | | NULL | |
+| Level | binary(1) | NO | | NULL | |
+| ClientId | int(11) | YES | | 0 | |
+| JobStatus | binary(1) | NO | | NULL | |
+| SchedTime | datetime | YES | | NULL | |
+| StartTime | datetime | YES | | NULL | |
+| EndTime | datetime | YES | | NULL | |
+| RealEndTime | datetime | YES | | NULL | |
+| JobTDate | bigint(20) unsigned | YES | | 0 | |
+| VolSessionId | int(10) unsigned | YES | | 0 | |
+| VolSessionTime | int(10) unsigned | YES | | 0 | |
+| JobFiles | int(10) unsigned | YES | | 0 | |
+| JobBytes | bigint(20) unsigned | YES | | 0 | |
+| ReadBytes | bigint(20) unsigned | YES | | 0 | |
+| JobErrors | int(10) unsigned | YES | | 0 | |
+| JobMissingFiles | int(10) unsigned | YES | | 0 | |
+| PoolId | int(10) unsigned | YES | | 0 | |
+| FileSetId | int(10) unsigned | YES | | 0 | |
+| PriorJobId | int(10) unsigned | YES | | 0 | |
+| PurgedFiles | tinyint(4) | YES | | 0 | |
+| HasBase | tinyint(4) | YES | | 0 | |
+| HasCache | tinyint(4) | YES | | 0 | |
+| Reviewed | tinyint(4) | YES | | 0 | |
+| Comment | blob | YES | | NULL | |
++-----------------+---------------------+------+-----+---------+----------------+
+27 rows in set (0,00 sec)
+
mysql> <input>select * from Version;</input>
+-----------+
| VersionId |
@@ -487,6 +523,11 @@ export db_password=<input>MyNewSecretPassword</input>
/usr/lib/bareos/scripts/grant_bareos_privileges
\end{commands}
+
+\hide{
+% table and commands have changed in MySQL 5.7.6.
+% As things now get more complicated (different command for different version)
+% we skip this topic here.
... or modify the database users directly:
\begin{commands}{Show Bareos database users}
@@ -520,7 +561,7 @@ mysql> <input>SELECT user,host,password FROM mysql.user WHERE user='bareos';</in
mysql>
\end{commands}
-
+}
\subsubsection{Sqlite}
@@ -537,7 +578,7 @@ Bareos creates this file at \file{/var/lib/bareos/bareos.db}.
Sqlite does not offer access permissions. The only permissions that do apply are the Unix file permissions.
The database is accessable by following command:
-\begin{commands}{Verify Bareos database on Sqlite3}
+\begin{commands}{Verify Bareos database on Sqlite3 (bareos-13.2.3)}
<command>sqlite3</command><input> /var/lib/bareos/bareos.db</input>
SQLite version 3.7.6.3
Enter ".help" for instructions
@@ -971,8 +1012,8 @@ in the BackupCatalog job.
The same considerations apply as for \nameref{RepairingMySQL}.
Consult the PostgreSQL documents for how to repair the database.
-For Bareos specific problems,
-consider using \nameref{bareos-dbcheck} program .
+For Bareos specific problems,
+consider using \nameref{bareos-dbcheck} program.
@@ -989,11 +1030,14 @@ consider using \nameref{bareos-dbcheck} program .
As MariaDB is a fork of MySQL, we use MySQL as synonym for MariaDB and fully support it.
We test our packages against the preferred MySQL fork that a distribution provides.
+\hide{
+supporting MySQL >= 5.7 since bareos-17.2.4
\limitation{MySQL}{MySQL $\geq$ 5.7 not supported}{%
MySQL 5.7 did change it behavior in some respects. The result is, that the Bareos database creation scripts do not work any more.
For the time being, we advise to use MariaDB instead, which is also the default on most Linux distributions.
See \ticket{705}.
}
+}
\subsection{Compacting Your MySQL Database}
\index[general]{Database!MySQL!Compacting}
@@ -1022,6 +1066,7 @@ See
\elink{http://dev.mysql.com/doc/refman/5.5/en/innodb-multiple-tablespaces.html}
{http://dev.mysql.com/doc/refman/5.5/en/innodb-multiple-tablespaces.html} for details.
+\hide{
\footnotesize
\begin{verbatim}
mysqldump -f --opt bareos > bareos.sql
@@ -1032,6 +1077,7 @@ rm -f bareos.sql
Depending on the size of your database, this will take more or less time and a
fair amount of disk space.
+}
\subsection{Repairing Your MySQL Database}
\index[general]{Database!Repairing Your MySQL}
@@ -1042,7 +1088,7 @@ If you find that you are getting errors writing to your MySQL database, or
Bareos hangs each time it tries to access the database, you should consider
running MySQL's database check and repair routines.
-This can be done by running the {\bf mysqlcheck } command:
+This can be done by running the \command{mysqlcheck} command:
\footnotesize
\begin{verbatim}
mysqlcheck --all-databases
@@ -1203,7 +1249,7 @@ maintenance\_work\_mem = 256000 seem to be reasonable values. Make
sure your checkpoint\_segments is set to at least 8.
}
-
+\hide{
\section{Performance Issues Indexes}
\index[general]{Database Performance Issues Indexes}
\index[general]{Performance!Database}
@@ -1315,7 +1361,7 @@ sqlite <path>/bareos.db
CREATE INDEX file_jobid_idx on File (JobId);
\end{verbatim}
\normalsize
-
+}
\section{Backing Up Your Bareos Database}
diff --git a/manuals/en/main/general.tex b/manuals/en/main/general.tex
index ab6bf52..af4b544 100644
--- a/manuals/en/main/general.tex
+++ b/manuals/en/main/general.tex
@@ -160,20 +160,21 @@ Following information can be determined from the Bareos release bareos-16.2.4:
\section{Bareos Packages}
\label{sec:BareosPackages}
-Following Bareos Linux packages are available (release 14.2):
+Following Bareos Linux packages are available (release 17.2.4):
% generated by
% cd bareos:/bareos-13.2/SLE_11_SP3
% rpm -qp --qf '%{NAME} | %{SUMMARY} \\\\\n' */*bareos*.rpm | sed -e 's/&/and/g' -e 's/|/\&/' | sort | uniq
% cd /srv/obs/repos/bareos:/bareos-15.2/RHEL_7
% rpm -qp --qf '%{NAME} | %{SUMMARY} \\\\\n' */*bareos*.rpm | sed -e 's/&/and/g' -e 's/|/\&/' | grep -v debuginfo | sort | uniq
+% cd /srv/obs/repos/bareos:/bareos-17.2/RHEL_7
+% rpm -qp --qf '%{NAME} | %{SUMMARY} \\\\\n' */*bareos*.rpm | sed -e 's/&/and/g' -e 's/|/\&/' | grep -v debuginfo | sort | uniq
\begin{center}
\begin{tabular}{ | l | l | }
\hline
\textbf{Package Name} & \textbf{Description} \\
\hline
bareos & Backup Archiving REcovery Open Sourced - metapackage \\
-bareos-bat & Bareos Admin Tool (GUI) \\
bareos-bconsole & Bareos administration console (CLI) \\
bareos-client & Bareos client Meta-All-In-One package \\
bareos-common & Common files, required by multiple Bareos packages \\
@@ -190,8 +191,10 @@ bareos-filedaemon-ceph-plugin & CEPH plugin for Bareos File daemon \\
bareos-filedaemon-glusterfs-plugin & GlusterFS plugin for Bareos File daemon \\
bareos-filedaemon-ldap-python-plugin & LDAP Python plugin for Bareos File daemon \\
bareos-filedaemon-python-plugin & Python plugin for Bareos File daemon \\
+bareos-regress-config & Required files for bareos-regress \\
bareos-storage & Bareos Storage daemon \\
bareos-storage-ceph & CEPH support for the Bareos Storage daemon \\
+bareos-storage-droplet & Object Storage support (through libdroplet) for the Bareos Storage daemon \\
bareos-storage-fifo & FIFO support for the Bareos Storage backend \\
bareos-storage-glusterfs & GlusterFS support for the Bareos Storage daemon \\
bareos-storage-python-plugin & Python plugin for Bareos Storage daemon \\
@@ -200,8 +203,10 @@ bareos-tools & Bareos CLI tools (bcopy, bextract, bls, bregex, bwild) \\
bareos-traymonitor & Bareos Tray Monitor (QT) \\
bareos-vadp-dumper & VADP Dumper - vStorage APIs for Data Protection Dumper program \\
bareos-vmware-plugin & Bareos VMware plugin \\
+bareos-vmware-plugin-compat & Bareos VMware plugin compatibility \\
bareos-vmware-vix-disklib & VMware vix disklib distributable libraries \\
bareos-webui & Bareos Web User Interface \\
+python-bareos & Backup Archiving REcovery Open Sourced - Python module \\
\hline
\end{tabular}
\end{center}
@@ -217,7 +222,7 @@ These are named differently depending on the distribution (\package{bareos-debug
Not all packages are required to run Bareos.
\begin{itemize}
- \item For the Bareos Director, the package \package{bareos-director} and one of \package{bareos-database-postgresql}, \package{bareos-database-mysql} or \package{bareos-database-sqlite3} are required (use \package{bareos-database-sqlite3} only for testing).
+ \item For the Bareos Director, the package \package{bareos-director} and one of \package{bareos-database-postgresql}, \package{bareos-database-mysql} or \package{bareos-database-sqlite3} are required. It is recommended to use \package{bareos-database-postgresql}.
\item For the \bareosSd, the package \package{bareos-storage} is required. If you plan to connect tape drives to the storage director, also install the package \package{bareos-storage-tape}. This is kept separately, because it has additional dependencies for tape tools.
diff --git a/manuals/en/main/howto.tex b/manuals/en/main/howto.tex
index fb27feb..ca9b6ea 100644
--- a/manuals/en/main/howto.tex
+++ b/manuals/en/main/howto.tex
@@ -759,12 +759,11 @@ in the Git repository \url{https://github.com/bareos/bareos-contrib/tree/master/
\paragraph{Configuration}
% \newline
-Activate your plugin directory in the fd resource conf on the client. See \nameref{fdPlugins} for more about plugins in general.
+Activate your plugin directory in the \bareosFd configuration. See \nameref{fdPlugins} for more about plugins in general.
-\begin{bareosConfigResource}{bareos-fd}{client}{mysql-fd}
+\begin{bareosConfigResource}{bareos-fd}{client}{myself}
Client {
- Name = mysql-fd
- #...
+ ...
Plugin Directory = /usr/lib64/bareos/plugins
Plugin Names = "python"
}
@@ -849,9 +848,8 @@ Following settings must be done on the Bareos client (\bareosFd):
\item disable bacula compatibility (default for Bareos $>=$ 15.2)
\end{itemize}
-\begin{bareosConfigResource}{bareos-fd}{client}{mysql-fd}
+\begin{bareosConfigResource}{bareos-fd}{client}{myself}
Client {
- Name = mysql-fd
...
Plugin Directory = /usr/lib64/bareos/plugins
Plugin Names = "python"
diff --git a/manuals/en/main/install.tex b/manuals/en/main/install.tex
index 591fc88..2e5597f 100644
--- a/manuals/en/main/install.tex
+++ b/manuals/en/main/install.tex
@@ -44,36 +44,41 @@ Section \nameref{sec:InstallBareosPackages} describes how to add the software re
\label{sec:ChooseDatabaseBackend}
Next you have to decide, what database backend you want to use.
-Bareos supports following database backends:
+Bareos offers the following database backends:
\begin{itemize}
- \item PostgreSQL by package \package{bareos-database-postgresql}
+ \item PostgreSQL by package \package{bareos-database-postgresql}. This is the recommended backend.
\item MariaDB/MySQL by package \package{bareos-database-mysql}
\item Sqlite by package \package{bareos-database-sqlite3} \\
\warning{The Sqlite backend is only intended for testing, not for productive use.}
\end{itemize}
-\paragraph{PostgreSQL} is the default backend. If you have no other preferences, you should use this one.
+\paragraph{PostgreSQL} is the default backend.
-\paragraph{MariaDB/MySQL} backend is also supported. If your system offers both, you should use MariaDB, see \nameref{sec:MysqlSupport}.
+\paragraph{MariaDB/MySQL} backend is also included.
\paragraph{Sqlite} backend is intended for testing purposes only.
The Bareos database packages have there dependencies only to the database client packages,
therefore the database itself must be installed manually.
+If you do not explicitly choose a database backend, your operating system installer will choose one for you.
+The default should be PostgreSQL, but depending on your operating system and the already installed packages,
+this may differ.
+
+
\section{Install the Bareos Software Packages}
\label{sec:InstallBareosPackages}
-You will have to install the package \package{bareos}
-and the database backend package (\package{bareos-database-*}) you want to use.
-The corresponding database should already be installed and running, see \nameref{sec:ChooseDatabaseBackend}.
+%You will have to install the package \package{bareos}
+%and the database backend package (\package{bareos-database-*}) you want to use.
+%The corresponding database should already be installed and running, see \nameref{sec:ChooseDatabaseBackend}.
-If you do not explicitly choose a database backend, your operating system installer will choose one for you.
-The default should be PostgreSQL, but depending on your operating system and the already installed packages,
-this may differ.
+%If you do not explicitly choose a database backend, your operating system installer will choose one for you.
+%The default should be PostgreSQL, but depending on your operating system and the already installed packages,
+%this may differ.
-The package \package{bareos} is only a meta package, that contains dependencies to the main components of Bareos, see \nameref{sec:BareosPackages}.
+The package \package{bareos} is only a meta package, that contains dependencies to the main components of Bareos, see \nameref{sec:BareosPackages}.
If you want to setup a distributed environment (like one Director, separate database server, multiple Storage daemons)
you have to choose the corresponding Bareos packages to install on each hosts instead of just installing the \package{bareos} package.
@@ -98,18 +103,14 @@ DIST=RHEL_7
# DIST=Fedora_24
# DIST=CentOS_7
-DATABASE=postgresql
-# or
-# DATABASE=mysql
-
# add the Bareos repository
URL=http://download.bareos.org/bareos/release/latest/$DIST
wget -O /etc/yum.repos.d/bareos.repo $URL/bareos.repo
# install Bareos packages
-yum install bareos bareos-database-$DATABASE
+yum install bareos bareos-database-postgresql
\end{commands}
-\hide{$}
+%\hide{$}
\subsubsection{RHEL 6, CentOS 6}
\index[general]{Platform!RHEL!6}
@@ -132,23 +133,19 @@ rpm -Uhv https://dl.fedoraproject.org/pub/epel/epel-release-latest-6.noarch.rpm
DIST=RHEL_6
# DIST=CentOS_6
-DATABASE=postgresql
-# or
-# DATABASE=mysql
-
# add the Bareos repository
URL=http://download.bareos.org/bareos/release/latest/$DIST
wget -O /etc/yum.repos.d/bareos.repo $URL/bareos.repo
# install Bareos packages
-yum install bareos bareos-database-$DATABASE
+yum install bareos bareos-database-postgresql
\end{commands}
-\hide{$}
+%\hide{$}
-\subsubsection{RHEL 5, CentOS 5}
+\subsubsection{RHEL 5}
\index[general]{Platform!RHEL!5}
-\index[general]{Platform!CentOS!5}
+%\index[general]{Platform!CentOS!5}
yum in RHEL 5/CentOS 5 has slightly different behaviour as far as dependency resolving is concerned: it sometimes install a dependent package after the one that has the dependency defined. To make sure that it works, install the desired Bareos database backend package first in a separate step:
@@ -158,22 +155,16 @@ yum in RHEL 5/CentOS 5 has slightly different behaviour as far as dependency res
#
DIST=RHEL_5
-# or
-# DIST=CentOS_5
-
-DATABASE=postgresql
-# or
-# DATABASE=mysql
# add the Bareos repository
URL=http://download.bareos.org/bareos/release/latest/$DIST
wget -O /etc/yum.repos.d/bareos.repo $URL/bareos.repo
# install Bareos packages
-yum install bareos-database-$DATABASE
+yum install bareos-database-postgresql
yum install bareos
\end{commands}
-\hide{$}
+%\hide{$}
\subsection{Install on SUSE based Linux Distributions}
@@ -186,24 +177,22 @@ yum install bareos
# define parameter
#
-DIST=SLE_12_SP1
+DIST=SLE_12_SP3
# or
+# DIST=SLE_12_SP2
+# DIST=SLE_12_SP1
# DIST=SLE_11_SP4
-# DIST=openSUSE_Leap_42.1
-# DIST=openSUSE_13.2
-
-DATABASE=postgresql
-# or
-# DATABASE=mysql
+# DIST=openSUSE_Leap_42.3
+# DIST=openSUSE_Leap_42.2
# add the Bareos repository
URL=http://download.bareos.org/bareos/release/latest/$DIST
zypper addrepo --refresh $URL/bareos.repo
# install Bareos packages
-zypper install bareos bareos-database-$DATABASE
+zypper install bareos bareos-database-postgresql
\end{commands}
-\hide{$}
+%\hide{$}
@@ -223,17 +212,13 @@ On Ubuntu is it available in Ubuntu Universe. In Debian, is it included in the m
# define parameter
#
-DIST=Debian_8.0
+DIST=Debian_9.0
# or
-# DIST=Debian_7.0
+# DIST=Debian_8.0
# DIST=xUbuntu_16.04
# DIST=xUbuntu_14.04
# DIST=xUbuntu_12.04
-DATABASE=postgresql
-# or
-# DATABASE=mysql
-
URL=http://download.bareos.org/bareos/release/latest/$DIST/
# add the Bareos repository
@@ -244,8 +229,9 @@ wget -q $URL/Release.key -O- | apt-key add -
# install Bareos packages
apt-get update
-apt-get install bareos bareos-database-$DATABASE
+apt-get install bareos bareos-database-postgresql
\end{commands}
+\hide{$}
If you prefer using the versions of Bareos directly integrated into the distributions,
please note that there are some differences, see \nameref{sec:DebianOrgLimitations}.
@@ -264,9 +250,9 @@ the commands described in \nameref{sec:InstallBareosPackagesDebian} will also wo
\label{sec:CreateDatabase}
We assume that you have already your database installed and basically running.
-Currently the database backends PostgreSQL and MySQL are recommended. The Sqlite database backend is only intended for testing purposes.
+Using the PostgreSQL database backend is recommended.
-The easiest way to set up a database is using an system account that have passwordless local access to the database.
+The easiest way to set up a database is using an system account that have passwordless local access to the database.
Often this is the user \user{root} for MySQL and the user \user{postgres} for PostgreSQL.
For details, see chapter \nameref{CatMaintenanceChapter}.
diff --git a/manuals/en/main/plugins-vmware-plugin.tex b/manuals/en/main/plugins-vmware-plugin.tex
index f02a24b..64aafab 100644
--- a/manuals/en/main/plugins-vmware-plugin.tex
+++ b/manuals/en/main/plugins-vmware-plugin.tex
@@ -41,7 +41,7 @@ which requires at least a \vSphere Essentials License.
It is tested against \vSphere Storage APIs for Data Protection of \vmware 5.x.
It does not work with standalone unlicensed \vmware ESXi\trademark.
-Since Bareos \sinceVersion{fd}{VMware Plugin: VDDK 6.5.2}{17.2.4} the Plugin is using
+Since Bareos \sinceVersion{fd}{VMware Plugin: VDDK 6.5.2}{17.2.4} the plugin is using
the Virtual Disk Development Kit (VDDK) 6.5.2, as of the VDDK 6.5 release notes, it
should be compatible with vSphere 6.5 and the next major release (except new features)
and backward compatible with vSphere 5.5 and 6.0, see VDDK release notes at
@@ -77,22 +77,21 @@ For more details regarding users and permissions in vSphere see
\item \url{http://pubs.vmware.com/vsphere-55/topic/com.vmware.vsphere.security.doc/GUID-5372F580-5C23-4E9C-8A4E-EF1B4DD9033E.html}
\end{itemize}
-Make sure to add or enable the following settings in \file{/etc/bareos/bareos-fd.conf}:
+Make sure to add or enable the following settings in your \bareosFd configuration:
-\begin{bconfig}{bareos-fd.conf: Plugin Settings}
-...
-FileDaemon {
-...
+\begin{bareosConfigResource}{bareos-fd}{client}{myself}
+Client {
+ ...
Plugin Directory = /usr/lib/bareos/plugins
Plugin Names = python
-...
+ ...
}
-\end{bconfig}
+\end{bareosConfigResource}
Note: Depending on Platform, the Plugin Directory may also be \path|/usr/lib64/bareos/plugins|
To define the backup of a VM in Bareos, a job definition and a fileset
-resource must be added to the Bareos director confguration.
+resource must be added to the Bareos director configuration.
In vCenter, VMs are usually organized in datacenters and folders.
The following example shows how to configure the backup of the VM
named \textit{websrv1} in the datacenter \textit{mydc1}
@@ -113,7 +112,7 @@ FileSet {
signature = MD5
Compression = GZIP
}
- Plugin = "python:module_path=/usr/lib64/bareos/plugins/vmware_plugin:module_name=bareos-fd-vmware:dc=mydc1:folder=/webservers:vmname=websrv1:vcserver=vcenter.example.org:vcuser=bakadm@vsphere.local:vcpass=Bak.Adm-1234"
+ Plugin = "python:module_path=/usr/lib64/bareos/plugins:module_name=bareos-fd-vmware:dc=mydc1:folder=/webservers:vmname=websrv1:vcserver=vcenter.example.org:vcuser=bakadm@vsphere.local:vcpass=Bak.Adm-1234"
}
}
\end{bconfig}
@@ -121,7 +120,23 @@ FileSet {
For VMs defined in the root-folder, \command{folder=/} must be specified
in the Plugin definition.
-New since Bareos \sinceVersion{fd}{VMware Plugin: vcthumbprint}{17.2.4}: As the Plugin is using
+Since Bareos \sinceVersion{dir}{bareos-vmware-plugin: module\_path without vmware\_plugin subdirectory}{17.2.4}
+the \argument{module\_path} is without \directory{vmware_plugin} directory.
+On upgrades you either adapt your configuration from
+
+\begin{bconfig}{python:module\_path for Bareos $<$ 17.2.0}
+Plugin = "python:module_path=/usr/lib64/bareos/plugins/vmware_plugin:module_name=bareos-fd-vmware:...
+\end{bconfig}
+
+to
+
+\begin{bconfig}{python:module\_path for Bareos $\geq$ 17.2.0}
+Plugin = "python:module_path=/usr/lib64/bareos/plugins:module_name=bareos-fd-vmware:...
+\end{bconfig}
+
+or install the \package{bareos-vmware-plugin-compat} package which includes compatibility symbolic links.
+
+Since \sinceVersion{fd}{VMware Plugin: vcthumbprint}{17.2.4}: as the Plugin is using
the Virtual Disk Development Kit (VDDK) 6.5, it is required to pass the thumbprint
of the vCenter SSL Certificate, which is the SHA1 checksum of the SSL Certificate.
The thumbprint can be retrieved like this:
@@ -141,7 +156,7 @@ be added. It must be given without colons like in the following example:
\begin{bconfig}{bareos-dir.conf: VMware Plugin Options with vcthumbprint}
...
- Plugin = "python:module_path=/usr/lib64/bareos/plugins/vmware_plugin:module_name=bareos-fd-vmware:dc=mydc1:folder=/webservers:vmname=websrv1:vcserver=vcenter.example.org:vcuser=bakadm@vsphere.local:vcpass=Bak.Adm-1234:vcthumbprint=56F597FE60521773D073A2ED47CE07282CE6FE9C"
+ Plugin = "python:module_path=/usr/lib64/bareos/plugins:module_name=bareos-fd-vmware:dc=mydc1:folder=/webservers:vmname=websrv1:vcserver=vcenter.example.org:vcuser=bakadm@vsphere.local:vcpass=Bak.Adm-1234:vcthumbprint=56F597FE60521773D073A2ED47CE07282CE6FE9C"
...
\end{bconfig}
@@ -165,7 +180,7 @@ be used, for example
\begin{bconfig}{bareos-dir.conf: VMware Plugin options with transport}
...
- Plugin = "python:module_path=/usr/lib64/bareos/plugins/vmware_plugin:module_name=bareos-fd-vmware:dc=mydc1:folder=/webservers:vmname=websrv1:vcserver=vcenter.example.org:vcuser=bakadm@vsphere.local:vcpass=Bak.Adm-1234:transport=nbdssl"
+ Plugin = "python:module_path=/usr/lib64/bareos/plugins:module_name=bareos-fd-vmware:dc=mydc1:folder=/webservers:vmname=websrv1:vcserver=vcenter.example.org:vcuser=bakadm@vsphere.local:vcpass=Bak.Adm-1234:transport=nbdssl"
...
\end{bconfig}
@@ -338,7 +353,7 @@ Storage: File
When: 2016-02-25 15:06:48
Catalog: MyCatalog
Priority: 10
-Plugin Options: python: module_path=/usr/lib64/bareos/plugins/vmware_plugin: module_name=bareos-fd-vmware: dc=dass5:folder=/: vmname=stephand-test02: vcserver=virtualcenter5.dass-it:vcuser=bakadm@vsphere.local: vcpass=Bak.Adm-1234: localvmdk=yes
+Plugin Options: python: module_path=/usr/lib64/bareos/plugins:module_name=bareos-fd-vmware: dc=dass5:folder=/: vmname=stephand-test02: vcserver=virtualcenter5.dass-it:vcuser=bakadm@vsphere.local: vcpass=Bak.Adm-1234: localvmdk=yes
OK to run? (yes/mod/no): <input>yes</input>
Job queued. JobId=639
\end{commands}
@@ -348,7 +363,7 @@ Note: Since Bareos \sinceVersion{fd}{Add additional python plugin options}{15.2.
\argument{python:localvmdk=yes}
Before, all Python plugin must be repeated and the additional be added, like:
-\path|python:module_path=/usr/lib64/bareos/plugins/vmware_plugin:module_name=bareos-fd-vmware:dc=dass5:folder=/:vmname=stephand-test02:vcserver=virtualcenter5.dass-it:vcuser=bakadm@vsphere.local:vcpass=Bak.Adm-1234:localvmdk=yes|
+\path|python:module_path=/usr/lib64/bareos/plugins:module_name=bareos-fd-vmware:dc=dass5:folder=/:vmname=stephand-test02:vcserver=virtualcenter5.dass-it:vcuser=bakadm@vsphere.local:vcpass=Bak.Adm-1234:localvmdk=yes|
After the restore process has finished, the restored VMDK files can be found
diff --git a/manuals/en/main/programs.tex b/manuals/en/main/programs.tex
index 09862f3..bb2b375 100644
--- a/manuals/en/main/programs.tex
+++ b/manuals/en/main/programs.tex
@@ -94,13 +94,18 @@ Please refer to chapter \nameref{sec:bconsole}.
\subsection{bareos-webui}
-For further information regarding the Bareos Webui, please refer to the chapter \nameref{sec:webui}.
+For further information regarding the Bareos Webui, please refer to \nameref{sec:webui}.
\subsection{bat}
\index[general]{Command!bat}
\label{bat}
-The Bacula/Bareos Administration Tool (\command{bat}) is a native GUI for Bareos. Please note that, although \command{bat} is still a part of Bareos and still receives maintenance bugfixes, the main development effort will be spent on \bareosWebui. For \sinceVersion{dir}{bat vs. bareos-webui}{15.2.0} we therefore encourage the use of \bareosWebui.
+The Bacula/Bareos Administration Tool (\command{bat}) has been a native GUI for Bareos.
+It has been marked deprecated since \sinceVersion{dir}{bat vs. bareos-webui}{15.2.0}.
+Since \sinceVersion{dir}{bat: removed from core distribution}{17.2.0} it is no longer part of Bareos.
+We encourage the use of \bareosWebui instead.
+
+
\section{Volume Utility Commands}
\index[general]{Volume Utility Tools}
diff --git a/manuals/en/main/releasenotes.tex b/manuals/en/main/releasenotes.tex
index d34d3b4..8be3210 100644
--- a/manuals/en/main/releasenotes.tex
+++ b/manuals/en/main/releasenotes.tex
@@ -16,10 +16,10 @@ This chapter concentrates on things to do when updating an existing Bareos insta
\releasenoteSection{Bareos-17.2}
-\releasenoteUnstable{17.2.4-rc}{
+\releasenote{17.2.4}{
\begin{tabular}{p{0.2\textwidth} p{0.8\textwidth}}
-Code Release & \\
+Code Release & 2017-12-14\\
Database Version & 2171\\
Release Ticket & \ticket{861}\\
Url & \releaseUrlDownloadBareosOrg{17.2} \\
@@ -28,13 +28,46 @@ Url & \releaseUrlDownloadBareosOrg{17.2} \\
This release contains several enhancements. Excerpt:
\begin{itemize}
+ \item Bareos Distribution (packages)
+ \begin{itemize}
+ \item \package{python-bareos} is included in the core distribution.
+ \item \package{bareos-storage-droplet} is a storage backend for the droplet library.
+ Most notably it allows backup and restores to a S3 environment.
+ \betaSince{sd}{bareos-storage-droplet}{17.2.4}.
+ \item \package{bat} has been removed, see section \nameref{bat}.
+ \item platforms:
+ \begin{itemize}
+ \item Windows Clients are still supported since Windows Vista.
+ \item MacOS: added to build chain.
+ \item \bareosFd is ready for HP-UX 11.31 (ia64).
+ \item Linux Distribution: Bareos tries to provide packages for all current platforms. For details, refer to \nameref{sec:packages}.
+ \end{itemize}
+ \item Linux RPM packages: allow read access to /etc/bareos/ for all users (however, relevant files are still only readable for the user \user{bareos}).
+ This allows other programs associated with Bareos to also use this directory.
+ \end{itemize}
+
\item Denormalization of the \dbtable{File} database table
\begin{itemize}
- \item The denormalization of the \dbtable{File} database table leads to enormous performance improvements in installation, which covering a lot of file (millions).
+ \item The denormalization of the \dbtable{File} database table leads to enormous performance improvements in installation, which covering a lot of file (millions and more).
\item For the denormalization the database schema must be modified.
\warning{Updating the database to schema version $\geq$ 2170 will increase the required disk space.
Especially it will require around twice the amount of the current database disk space during the migration.}
+ \item The \dbtable{Filename} does no longer exists. Therefore the \bcommand{.bvfs_*}{} commands do no longer output the \dbcolumn{FilenameId} column.
\end{itemize}
+
+ \item NDMP\_NATIVE support has been added. This include the NDMP features DAR and DDAR. For details see \nameref{sec:NdmpNative}.
+ \item Updated the package \package{bareos-vmware-plugin} to utilize the Virtual Disk Development Kit (VDDK) 6.5.x. This includes support for \vSphere 6.5 and the next major release (except new features) and backward compatible with \vSphere 5.5 and 6.0. For details see \nameref{VMwarePlugin}.
+ \item Soft Quota: automatic quota grace period reset if a job does not exceed the quota.
+ \item \command{bareos-dbcheck}: disable all interactive questions in batch mode.
+ \item \bcommand{list}{files}: also show deleted files (accurate mode).
+ \item \bcommand{list}{jobstatastics}: added.
+ \item \bcommand{purge}{}: added confirmation.
+ \item \bcommand{list}{volumes}: fix limit and offset handling.
+ \item \ticket{629} Windows: restore directory attributes.
+ \item \ticket{639} tape: fix block size handling, AWS VTL iSCSI devices
+ \item \ticket{705} support for MySQL 5.7
+ \item \ticket{719} allow long JSON messages (has been increased from 100KB to 2GB).
+ \item \ticket{793} Virtual Backups: skip jobs with no files.
\end{itemize}
}
diff --git a/manuals/en/main/supportedoses.tex b/manuals/en/main/supportedoses.tex
index 28e4ad4..de1a649 100644
--- a/manuals/en/main/supportedoses.tex
+++ b/manuals/en/main/supportedoses.tex
@@ -117,6 +117,8 @@ However, you might still find the packages on our download servers.
Bareos tries to provide all packages for all current platforms.
For extra packages, it depends if the distribution contains the required dependencies.
+For general information about the packages, see \nameref{sec:BareosPackages}.
+
Packages names not containing the word \name{bareos} are required packages where we decided to include them ourselves.
{
diff --git a/manuals/en/main/update.tex b/manuals/en/main/update.tex
index 319d2ed..e54fb3c 100644
--- a/manuals/en/main/update.tex
+++ b/manuals/en/main/update.tex
@@ -8,7 +8,7 @@ The version of the File Daemon may differ, see chapter about \ilink{backward com
When updating Bareos through the distribution packaging mechanism,
the existing configuration kept as they are.
-If you don't want to modify the bahaviour,
+If you don't want to modify the behavior,
there is normally no need to modify the configuration.
However, in some rare cases, configuration changes are required.
@@ -33,6 +33,9 @@ Detailed information can then be found in the log file \logfileUnix.
Take a look into the \ilink{Release Notes}{releasenotes} to 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.}
+
+
\subsection{Debian based Linux Distributions}
diff --git a/manuals/en/main/webui.tex b/manuals/en/main/webui.tex
index f4430e1..5902269 100644
--- a/manuals/en/main/webui.tex
+++ b/manuals/en/main/webui.tex
@@ -407,7 +407,7 @@ The new \resourcename{Dir}{Profile}{webui-admin} allows all commands, except of
\subsection{directors.ini}
-Since 16.2 it is possible to work with different catalogs. Therefore the catalog parameter has been introduced. If you don't set a catalog explicitly the default \resourcename{Dir}{Catalog}{MyCatalog} will be used. Please see \nameref{sec:webui-configuration-files} for more details.
+Since \sinceVersion{general}{Webui offers limited support for multiple catalogs}{16.2.0} it is possible to work with different catalogs. Therefore the catalog parameter has been introduced. If you don't set a catalog explicitly the default \resourcename{Dir}{Catalog}{MyCatalog} will be used. Please see \nameref{sec:webui-configuration-files} for more details.
\subsection{configuration.ini}