From 98d254ed16cc557aaa18c4d00f55f1900d669062 Mon Sep 17 00:00:00 2001 From: Eric Bollengier Date: Thu, 4 Feb 2010 15:18:12 +0100 Subject: [PATCH] Update truncate on purge doc --- docs/manuals/en/console/bconsole.tex | 15 +++++- docs/manuals/en/main/dirdconf.tex | 22 ++++++-- docs/manuals/en/main/newfeatures.tex | 77 ++++++++++++++++++++-------- 3 files changed, 88 insertions(+), 26 deletions(-) diff --git a/docs/manuals/en/console/bconsole.tex b/docs/manuals/en/console/bconsole.tex index f090374b..d9cd52c1 100644 --- a/docs/manuals/en/console/bconsole.tex +++ b/docs/manuals/en/console/bconsole.tex @@ -821,7 +821,20 @@ purge volume|volume=\lt{}vol-name\gt{} (of all jobs) For the {\bf purge} command to work on Volume Catalog database records the {\bf VolStatus} must be Append, Full, Used, or Error. -The actual data written to the Volume will be unaffected by this command. +The actual data written to the Volume will be unaffected by this command unless +you are using the \texttt{ActionOnPurge=Truncate} option on those Media. + +To ask Bacula to truncate your \texttt{Purged} volumes, you need to use the +following command in interactive mode or in a RunScript: +\begin{verbatim} +*purge volume action=truncate storage=File allpools +# or by default, action=all +*purge volume action storage=File pool=Default +\end{verbatim} + +This is possible to specify the volume name, the media type, the pool, the +storage, etc\dots (see \texttt{help purge}) Be sure that your storage device is +idle when you decide to run this command. \item[python] \index[general]{python} diff --git a/docs/manuals/en/main/dirdconf.tex b/docs/manuals/en/main/dirdconf.tex index c1223b9b..d0dfa40c 100644 --- a/docs/manuals/en/main/dirdconf.tex +++ b/docs/manuals/en/main/dirdconf.tex @@ -2815,9 +2815,10 @@ The Pool Resource defined in the Director's configuration file \item [Action On Purge = \lt{Truncate}] \index[dir]{actiononpurge} -This directive \textbf{ActionOnPurge=Truncate} instructs Bacula to truncate -the volume when it is purged. It is useful to prevent disk based volumes from -consuming too much space. +This directive \textbf{ActionOnPurge=Truncate} instructs Bacula to truncate the +volume when it is purged with the \texttt{purge volume action=truncate} +command. It is useful to prevent disk based volumes from consuming too much +space. \begin{verbatim} Pool { @@ -2827,6 +2828,21 @@ Pool { } \end{verbatim} +You can schedule the truncate operation at the end of your CatalogBackup job +like in this example: + +\begin{verbatim} +Job { + Name = CatalogBackup + ... + RunScript { + RunsWhen=After + RunsOnClient=No + Console = "purge volume action=all allpools storage=File" + } +} +\end{verbatim} + \label{PoolScratchPool} \item [ScratchPool = \lt{}pool-resource-name\gt{}] \index[dir]{ScrachPool} diff --git a/docs/manuals/en/main/newfeatures.tex b/docs/manuals/en/main/newfeatures.tex index cb063dc9..e00ff47a 100644 --- a/docs/manuals/en/main/newfeatures.tex +++ b/docs/manuals/en/main/newfeatures.tex @@ -1,8 +1,59 @@ -\chapter{New Features in 5.0.0} -\label{NewFeaturesChapter} +\chapter{New Features in 5.0.1} + +This chapter presents the new features that are in the released Bacula version +5.0.1. This version mainly fixes a number of bugs found in version 5.0.0 during +the onging development process. + +\section{Truncate volume after purge} +\label{sec:actiononpurge} + +The Pool directive \textbf{ActionOnPurge=Truncate} instructs Bacula to truncate +the volume when it is purged with the new command \texttt{purge volume + action}.It is useful to prevent disk based volumes from consuming too much +space. + +\begin{verbatim} +Pool { + Name = Default + Action On Purge = Truncate + ... +} +\end{verbatim} + +As usual You can also set this property with the \texttt{update volume} command +\begin{verbatim} +*update volume=xxx actiononpurge=Truncate +*update volume=xxx actiononpurge=None +\end{verbatim} + +To ask Bacula to truncate your \texttt{Purged} volumes, you need to use the +following command in interactive mode or in a RunScript as shown after: +\begin{verbatim} +*purge volume action=truncate storage=File allpools +# or by default, action=all +*purge volume action storage=File pool=Default +\end{verbatim} -This chapter presents the new features that are in the -released Bacula version 5.0.0. +This is possible to specify the volume name, the media type, the pool, the +storage, etc\dots (see \texttt{help purge}) Be sure that your storage device is +idle when you decide to run this command. + +\begin{verbatim} +Job { + Name = CatalogBackup + ... + RunScript { + RunsWhen=After + RunsOnClient=No + Console = "purge volume action=all allpools storage=File" + } +} +\end{verbatim} + +\textbf{Important note}: This feature doesn't work as +expected in version 5.0.0. Please do not use it before version 5.0.1. + +\chapter{New Features in 5.0.0} \section{Maximum Concurent Jobs for Devices} \label{sec:maximumconcurentjobdevice} @@ -439,24 +490,6 @@ to interface to the Director. command (ex: \texttt{help run}). \end{itemize} -\subsubsection*{Truncate volume after purge} -\label{sec:actiononpurge} - -This feature doesn't work as expected in version 5.0.0. Please do not use it -before version 5.0.1. - -%The Pool directive \textbf{ActionOnPurge=Truncate} instructs Bacula to truncate -%the volume when it is purged. It is useful to prevent disk based volumes from -%consuming too much space. -% -%\begin{verbatim} -%Pool { -% Name = Default -% Action On Purge = Truncate -% ... -%} -%\end{verbatim} -% \subsection{Custom Catalog queries} If you wish to add specialized commands that list the contents of the catalog, -- 2.39.5