Skip to content

Commit

Permalink
webui: add screenshot, keep update in seperate file
Browse files Browse the repository at this point in the history
  • Loading branch information
joergsteffens committed Nov 24, 2015
1 parent 8f26769 commit 445c6f3
Show file tree
Hide file tree
Showing 4 changed files with 84 additions and 1 deletion.
79 changes: 79 additions & 0 deletions manuals/en/main/update.tex
@@ -0,0 +1,79 @@

In most cases, a Bareos update is simply done by a package update of the distribution.
Please remind, that Bareos Director and Bareos Storage Daemon must always have the same version.
The version of the File Daemon may differ, see chapter about \ilink{backward compatibility}{backward-compability}.

\section{Updating the database scheme}

Sometimes improvements in Bareos make it neccessary to update the database scheme.

\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 \logfileUnix.

Take a look into the \ilink{Release Notes}{releasenotes} to see which Bareos updates do require a database scheme update.


\subsection{Debian based Linux Distributions}

Since Bareos \sinceVersion{dir}{dbconfig-common (Debian)}{14.2.0} the Debian (and Ubuntu) based packages support the \package{dbconfig-common} mechanism to create and update the Bareos database.
If this is properly configured, the database schema 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}
\begin{commands}{}
<command> </command><parameter>su - postgres -c /usr/lib/bareos/scripts/grant_bareos_privileges</parameter>
\end{commands}
For details see \nameref{sec:dbconfig}.

If you disabled the usage of \package{dbconfig-common},
follow the instructions for \nameref{sec:UpdateDatabaseOtherDistributions}.

\subsection{Other Platforms}
\label{sec:UpdateDatabaseOtherDistributions}

This has to be done as database administrator.
On most platforms Bareos knows only about the credentials to access the Bareos database,
but not about the database administrator to modify the database schema.

The task of updating the database schema is done by the script
\command{/usr/lib/bareos/scripts/update_bareos_tables}.

However, this script requires administration access to the database.
Depending on your distribution and your database, this requires different preparations.
More details can be found in chapter \ilink{Catalog Maintenance}{CatMaintenanceChapter}.

\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 \nameref{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.}

\subsubsection{PostgreSQL}
If your are using PostgreSQL and your PostgreSQL administrator is \user{postgres} (default), use following commands:

\begin{commands}{Update PostgreSQL database schema}
su postgres -c /usr/lib/bareos/scripts/update_bareos_tables
su postgres -c /usr/lib/bareos/scripts/grant_bareos_privileges
\end{commands}

The \command{grant_bareos_privileges} command is required, if new databases tables are introduced. It does not hurt to run it multiple times.

After this, restart the Bareos Director and verify it starts without problems.

\subsubsection{MySQL/MariaDB}
Make sure, that \user{root} has direct access to the local MySQL server.
Check if the command \command{mysql} without parameter connects to the database.
If not, you may be required to adapt your local MySQL config file \file{~/.my.cnf}.
It should look similar to this:

\begin{config}{MySQL credentials file .my.cnf}
[client]
host=localhost
user=root
password=<input>YourPasswordForAccessingMysqlAsRoot</input>
\end{config}

If you are able to connect via the \command{mysql} to the database, run the following script from the Unix prompt:
\begin{commands}{Update MySQL database schema}
/usr/lib/bareos/scripts/update_bareos_tables
\end{commands}

Currently on MySQL is it not neccessary to run \command{grant_bareos_privileges}, because access to the database is already given using wildcards.

After this, restart the Bareos Director and verify it starts without problems.
4 changes: 4 additions & 0 deletions manuals/en/main/webui.tex
Expand Up @@ -5,6 +5,10 @@

Since \sinceVersion{dir}{bareos-webui}{15.2.0} bareos-webui is part of the Bareos project and available for a number of platforms.

\begin{center}
\includegraphics[width=0.8\textwidth]{\idir bareos-webui-jobs}
\end{center}


\section{System Requirements}

Expand Down
2 changes: 1 addition & 1 deletion manuals/images/Makefile
Expand Up @@ -15,7 +15,7 @@ COPY_PNG = $(patsubst %.png,conv/%.png,$(ORIG_PNG))
#CONV_FIG_EPS = $(patsubst %.fig,conv/%.eps,$(ORIG_FIG))


all: $(CONV_PNG) $(COPY_PNG) conv/bareos-full-logo.png conv/autoxflate-functionblocks.png conv/blocksize-decisionchart.png conv/Conf-Diagram.png conv/dbconfig-1-enable.png conv/dbconfig-2-select-database-type.png conv/dbconfig-3-postgresql-password.png conv/different_time.png conv/flow.png conv/passive-client-communication.png
all: $(CONV_PNG) $(COPY_PNG) conv/bareos-full-logo.png conv/autoxflate-functionblocks.png conv/bareos-webui-jobs.png conv/blocksize-decisionchart.png conv/Conf-Diagram.png conv/dbconfig-1-enable.png conv/dbconfig-2-select-database-type.png conv/dbconfig-3-postgresql-password.png conv/different_time.png conv/flow.png conv/passive-client-communication.png

# bareos-full-logo: png is of better quality than eps, therefore take that as source
conv/bareos-full-logo.eps: bareos-full-logo.png
Expand Down
Binary file added manuals/images/bareos-webui-jobs.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 445c6f3

Please sign in to comment.