Skip to content
This repository has been archived by the owner on Mar 19, 2021. It is now read-only.

Commit

Permalink
cleanup bpipe infos
Browse files Browse the repository at this point in the history
  • Loading branch information
joergsteffens committed Jan 30, 2015
1 parent 62d717c commit 12fc68a
Show file tree
Hide file tree
Showing 3 changed files with 16 additions and 16 deletions.
8 changes: 4 additions & 4 deletions manuals/en/main/dirdconf-fileset.tex
Expand Up @@ -349,14 +349,14 @@ \subsection{FileSet Include Ressource}
Thus the plugin writer may define the
meaning of the rest of the string as he wishes.
The program \command{bpluginfo} can be used, to retreive information about a specific plugin, see the \ilink{bpluginfo}{bpluginfo} section.
The program \nameref{bpluginfo} can be used, to retreive information about a specific plugin.
Examples about the bpipe- and the mssql-plugin can be found in the sections about the \ilink{bpipe plugin}{bpipe} and the \ilink{MSSQL plugin}{MSSQL}.
Examples about the bpipe- and the mssql-plugin can be found in the sections about the \nameref{bpipe} and the \nameref{MSSQL}.
Note: It is also possible to define more than one plugin directive in a FileSet to do several database dumps at once.
\directive{dir}{Options}{$\ldots$}{}{}{}
See the \ilink{File Set Options}{fileset-options} section.
See the \nameref{fileset-options} section.
\end{description}
Expand Down Expand Up @@ -839,7 +839,7 @@ \subsubsection{FileSet Options Ressource}
after one minute, Bareos will time out the write to the fifo and move on
to the next file.
If you are planing to use a Fifo for backup, better take a look to the \ilink{bpipe plugin}{bpipe} section.
If you are planing to use a Fifo for backup, better take a look to the \nameref{bpipe} section.
\item [noatime=yes{\textbar}no] \hfill \\
Expand Down
12 changes: 6 additions & 6 deletions manuals/en/main/howto.tex
Expand Up @@ -661,7 +661,7 @@ \subsubsection{Backup of a PostgreSQL Databases by using the bpipe plugin}
FileSet {
Name = "postgresql-all"
Include {
Plugin = "bpipe:/POSTGRESQL/dump.sql:pg_dumpall -U postgres:psql -U postgres"
Plugin = "bpipe:file=/POSTGRESQL/dump.sql:reader=pg_dumpall -U postgres:writer=psql -U postgres"
Options {
signature = MD5
compression = gzip
Expand All @@ -681,7 +681,7 @@ \subsubsection{Backup of a PostgreSQL Databases by using the bpipe plugin}
FileSet {
Name = "postgresql-remote"
Include {
Plugin = "bpipe:/POSTGRESQL/dump.sql:pg_dumpall -h <hostname> -U <username> -W <password>:psql -h <hostname> -U <username> -W <password>"
Plugin = "bpipe:file=/POSTGRESQL/dump.sql:reader=pg_dumpall -h <hostname> -U <username> -W <password>:writer=psql -h <hostname> -U <username> -W <password>"
Options {
signature = MD5
compression = gzip
Expand Down Expand Up @@ -753,13 +753,13 @@ \subsubsection{Backup of a MySQL Databases by using the bpipe plugin}
Instead of creating a temporary database dump file,
the bpipe plugin can be used.
For general information about bpipe, see the \ilink{bpipe plugin}{bpipe} section.
For general information about bpipe, see the \nameref{bpipe} section.
The bpipe plugin is configured inside the Include section of a File Set, e.g.:
\begin{bconfig}{bpipe fileset for MySQL backup}
FileSet {
Name = "mysql-all"
Include = {
Plugin = "bpipe:/MYSQL/dump.sql:mysqldump --user=<user> --password=<password> --opt --all-databases:mysql --user=<user> --password=<password>"
Plugin = "bpipe:file=/MYSQL/dump.sql:reader=mysqldump --user=<user> --password=<password> --opt --all-databases:mysql --user=<user> --password=<password>"
Options {
signature = MD5
compression = gzip
Expand All @@ -773,7 +773,7 @@ \subsubsection{Backup of a MySQL Databases by using the bpipe plugin}
FileSet{
Name = "mysql-all"
Include {
Plugin = "bpipe:/MYSQL/dump.sql:mysqldump --host=<hostname> --user=<user> --password=<password> --opt --all-databases:mysql --host=<hostname> --user=<user> --password=<password>"
Plugin = "bpipe:file=/MYSQL/dump.sql:reader=mysqldump --host=<hostname> --user=<user> --password=<password> --opt --all-databases:mysql --host=<hostname> --user=<user> --password=<password>"
Options {
signature = MD5
compression = gzip
Expand All @@ -788,7 +788,7 @@ \subsubsection{Backup of a MySQL Databases by using the bpipe plugin}
FileSet{
Name = "mysql-all"
Include {
Plugin = "bpipe:/MYSQL/dump.sql:mysqldump --host=<hostname> --user=<user> --password=<password> --opt --all-databases:/usr/lib/bareos/scripts/bpipe-restore.sh"
Plugin = "bpipe:file=/MYSQL/dump.sql:reader=mysqldump --host=<hostname> --user=<user> --password=<password> --opt --all-databases:writer=/usr/lib/bareos/scripts/bpipe-restore.sh"
Options {
signature = MD5
compression = gzip
Expand Down
12 changes: 6 additions & 6 deletions manuals/en/main/plugins.tex
Expand Up @@ -39,7 +39,7 @@ \subsection{bpipe Plugin}
signature = MD5
compression = gzip
}
Plugin = "bpipe:<path>:<backup-command>:<restore-command>"
Plugin = "bpipe:file=<filepath>:reader=<readprogram>:writer=<writeprogram>
}
}
\end{bconfig}
Expand All @@ -49,21 +49,21 @@ \subsection{bpipe Plugin}
meaning of the rest of the string as he wishes. The full syntax of the plugin directive as interpreted by the bpipe plugin is:

\begin{bconfig}{bpipe directive}
Plugin = "<plugin>:<path>:<backup-command>:<restore-command>"
Plugin = "<plugin>:file=<filepath>:reader=<readprogram>:writer=<writeprogram>"
\end{bconfig}
\begin{description}
\item[plugin] is the name of the plugin with the trailing -fd.so stripped off, so in this case, we would put bpipe in the field.
\item[path] specifies the namespace, which for bpipe is the pseudo path and filename under which the backup will be saved. This
\item[filepath] specifies the namespace, which for bpipe is the pseudo path and filename under which the backup will be saved. This
pseudo path and filename will be seen by the user in the restore file tree. For example, if the value is /MySQL/mydump.sql, the data
backed up by the plugin will be put under that "pseudo" path and filename. You must be careful to choose a naming convention that is unique
to avoid a conflict with a path and filename that actually exists on your system.
\item[backup-command] for the bpipe plugin specifies the "reader" program that is called by the plugin during backup to read the data. bpipe
\item[readprogram] for the bpipe plugin specifies the "reader" program that is called by the plugin during backup to read the data. bpipe
will call this program by doing a popen on it.
\item[restore-command] for the bpipe plugin specifies the "writer" program that is called by the plugin during restore to write the data back
\item[writeprogram] for the bpipe plugin specifies the "writer" program that is called by the plugin during restore to write the data back
to the filesystem.
\end{description}
Expand All @@ -73,7 +73,7 @@ \subsection{bpipe Plugin}
backup a file with reader program, when running the writer program during the restore, Bareos will not automatically create the path
to the file. Either the path must exist, or you must explicitly do so with your command or in a shell script.
See the examples about \ilink{Backup PostgreSQL}{backup-postgresql} and \ilink{Backup MySQL}{backup-mysql}.
See the examples about \nameref{backup-postgresql} and \nameref{backup-mysql}.
\subsection{PGSQL Plugin}
Expand Down

0 comments on commit 12fc68a

Please sign in to comment.