Skip to content

Commit

Permalink
doc: Create own chapter for Storage Backends
Browse files Browse the repository at this point in the history
Rework chapter about Droplet Storage Backend.

Fixes #949: S3 Droplet backend documentation missing
  • Loading branch information
joergsteffens committed Jul 16, 2018
1 parent fcfab89 commit 96a8725
Show file tree
Hide file tree
Showing 7 changed files with 346 additions and 181 deletions.
3 changes: 3 additions & 0 deletions docs/manuals/en/main/bareos-manual-main-reference.tex
Expand Up @@ -192,6 +192,9 @@ \chapter{Volume Management}
%tape
\include{tape-without-autochanger}

\include{storage-backends}


\include{spooling}
\include{migration}
\include{always-incremental}
Expand Down
36 changes: 13 additions & 23 deletions docs/manuals/en/main/bareos-sd-resource-device-definitions.tex
Expand Up @@ -322,27 +322,9 @@
Some \linkResourceDirective{Sd}{Device}{Device Type} require additional configuration.
This can be specified in this directive, e.g. for
\begin{description}
\item [\sdBackend{GFAPI}{GlusterFS}]
A GlusterFS Storage can be used as Storage backend of Bareos.
Prerequistes are a working GlusterFS storage system and the package \package{bareos-storage-glusterfs}.
See \url{http://www.gluster.org/} for more information regarding GlusterFS installation and configuration
and specifically \url{https://gluster.readthedocs.org/en/latest/Administrator Guide/Bareos/}
for Bareos integration.
You can use following snippet to configure it as storage device:
\bconfigInput{config/SdDeviceDeviceOptionsGfapi1.conf}
Adapt server and volume name to your environment.

\sinceVersion{sd}{GlusterFS Storage}{15.2.0}

\item [\sdBackend{Rados}{Ceph Object Store}]
Here you configure the Ceph object store, which is accessed by the SD using the Rados library. Prerequistes are a
working Ceph object store and the package \package{bareos-storage-ceph}. See \url{http://ceph.com} for more information regarding Ceph installation and configuration.
Assuming that you have an object store with name \file{poolname}
and your Ceph access is configured in \file{/etc/ceph/ceph.conf},
you can use following snippet to configure it as storage device:
\bconfigInput{config/SdDeviceDeviceOptionsRados1.conf}

\sinceVersion{sd}{Ceph Storage}{15.2.0}
\item [\nameref{SdBackendDroplet}]
\item [\nameref{SdBackendGfapi}]
\item [\nameref{SdBackendRados}]
\end{description}

Before the Device Options directive have been introduced,
Expand All @@ -363,12 +345,20 @@
USB. All files must be random access devices.
\item [\sdBackend{Fifo}{}] is a first-in-first-out sequential access read-only
or write-only device.
\item [\sdBackend{GFAPI}{GlusterFS}] \label{SdBackendGfapi} is used to access a GlusterFS storage.
\item [\sdBackend{GFAPI}{GlusterFS}] is used to access a GlusterFS storage.
It must be configured using \linkResourceDirective{Sd}{Device}{Device Options}.
For details, refer to \nameref{SdBackendGfapi}.

\sinceVersion{sd}{GlusterFS (gfapi)}{14.2.2}
\item [\sdBackend{Rados}{Ceph Object Store}] \label{SdBackendRados} is used to access a Ceph object store.
\item [\sdBackend{Rados}{Ceph Object Store}] is used to access a Ceph object store.
It must be configured using \linkResourceDirective{Sd}{Device}{Device Options}.
For details, refer to \nameref{SdBackendRados}.

\sinceVersion{sd}{Ceph (Rados)}{14.2.2}
\item [\sdBackend{Droplet}{}] is used to access an object store supported by \package{libdroplet}, most notably S3.
For details, refer to \nameref{SdBackendDroplet}.

\sinceVersion{sd}{Droplet}{17.2.7}
\end{description}

The Device Type directive is not required in all cases.
Expand Down
4 changes: 4 additions & 0 deletions docs/manuals/en/main/bareos.sty
Expand Up @@ -180,6 +180,10 @@
\elink{Bareos Regression Testing Base Configuration}{https://github.com/bareos/bareos-regress/tree/master/configs/BASE/}\xspace%
}

\newcommand{\externalReferenceDroplet}{%
\url{https://github.com/scality/Droplet}\xspace%
}

\newcommand{\externalReferenceIsilonNdmpEnvironmentVariables}{%
\elink{Isilon OneFS 7.2.0 CLI Administration Guide}{https://www.emc.com/collateral/TechnicalDocument/docu56048.pdf}, section \bquote{NDMP environment variables}\xspace%
}
Expand Down
155 changes: 0 additions & 155 deletions docs/manuals/en/main/plugins-droplet-plugin.tex

This file was deleted.

3 changes: 0 additions & 3 deletions docs/manuals/en/main/plugins.tex
Expand Up @@ -445,9 +445,6 @@ \subsection{python-sd Plugin}
The \name{python-sd} plugin behaves similar to the \nameref{director-python-plugin}.
\subsucetion{bareos-storage-droplet}
\input{plugins-droplet-plugin}
\section{Director Plugins}
\label{dirPlugins}
Expand Down

0 comments on commit 96a8725

Please sign in to comment.