Skip to content

Commit 0861e9c

Browse files
author
afabiani
committed
Update backup/restore docs with the new filering options
1 parent d6ecc1b commit 0861e9c

File tree

1 file changed

+21
-2
lines changed

1 file changed

+21
-2
lines changed

intermediate/backup/index.rst

Lines changed: 21 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -118,17 +118,30 @@ Settings: [geoserver] Section
118118
119119
[geoserver]
120120
datadir = /opt/gs_data_dir
121+
datadir_exclude_file_path =
121122
dumpvectordata = yes
122123
dumprasterdata = yes
124+
data_dt_filter =
125+
data_layername_filter =
126+
data_layername_exclude_filter =
123127
124128
This section allows to enable / disable a full data backup / restore of GeoServer.
125129

126130
* *datadir*: the full path of GeoServer Data Dir, by default ``/opt/gs_data_dir``. The path **must** be accessible and **fully writable** by the ``geonode`` and / or ``httpd server`` users when executing a backup / restore command.
127131

132+
* *datadir_exclude_file_path*: comma separated list of paths to exclude from ``geoserver_catalog.zip``; This list will be sent and managed directly by the GeoServer Backup REST API.
133+
128134
* *dumpvectordata*: a boolean flag enabling or disabling creation of a vector data dump from GeoServer (shapefiles or DB tables). If ``false`` (or ``no``) vector data won't be stored / re-stored.
129135

130136
* *dumprasterdata*: a boolean flag enabling or disabling creation of a raster data dump from GeoServer (geotiffs). If ``false`` (or ``no``) raster data won't be stored / re-stored.
131137

138+
* *data_dt_filter*: {cmp_operator} {ISO8601} e.g. > 2019-04-05T24:00 which means "include on backup archive only the files that have been modified later than 2019-04-05T24:00
139+
140+
* *data_layername_filter*: comma separated list of ``layer names``, optionally with glob syntax e.g.: tuscany_*,italy; Only ``RASTER`` original data and ``VECTORIAL`` table dumps matching those filters will be **included** into the backup ZIP archive
141+
142+
* *data_layername_exclude_filter*: comma separated list of ``layer names``, optionally with glob syntax e.g.: tuscany_*,italy; The ``RASTER`` original data and ``VECTORIAL`` table dumps matching those filters will be **excluded** from the backup ZIP archive
143+
144+
132145
.. warning:: Enabling these options **requires** the GeoServer Data Dir to be accessible and **fully writable** for the ``geonode`` and / or ``httpd server`` users when executing a backup / restore command.
133146

134147
Settings: [fixtures] Section
@@ -204,14 +217,20 @@ Restore
204217

205218
The ``restore`` command has a number of arguments, modifying its execution:
206219

207-
# ``-c`` / ``--config``: path to the ``settings.ini`` configuration file
220+
# ``-c`` / ``--config``: path to the ``settings.ini`` configuration file. If the Backup archive is provided with his settings, the latter will be used by the restore command and this option won't be mandatory anymore
221+
222+
#. ``--skip-geoserver``: the GeoServer backup restoration won't be performed
208223

209-
#. ``--skip-geoserver``: the Geoserver backup restoration won't be performed
224+
#. ``--skip-geoserver-info``: {Default: True} Skips GeoServer Global Infos, like the proxy base url and other global GeoServer metadata info
225+
226+
#. ``--skip-geoserver-security``: {Default: True} Skips GeoServer all the Security Settings
210227

211228
#. ``--backup-file``: (exclusive together with ``--backup-files-dir``) path to the backup ``.zip`` archive
212229

213230
#. ``--backup-files-dir``: (exclusive together with ``--backup-file``) directory containing backup archives. The directory may contain a number of files, but **only** backup archives are allowed with a ``.zip`` extension. In case multiple archives are present in the directory, the newest one, created after the last already restored backup creation time, will be restored. This option was implemented with a thought of automated restores.
214231

232+
#. ``--recovery-file``: Backup archive containing GeoNode data to restore in case of failure.
233+
215234
#. ``-l`` / ``--with-logs``: the backup file will be checked against the restoration logs (history). In case this backup has already been restored (MD5 based comparision), RuntimeError is raised, preventing restore execution.
216235

217236
#. ``-n`` / ``--notify``: the restore procedure outcome will be send by an e-mail notification to the superusers of the instance (note: notification will be sent to the superusers of the instance before restoration).

0 commit comments

Comments
 (0)