geoserver-loader

CLI utility to load spatial layers to Geoserver.

This loader uses the Geoserver's REST API to load files into a remote Geoserver service. The script attempts to address a couple of issues found with pervious uses of Geoserver in a similar context.

• Files are assumed to be "external" which means they are on the local file system for Geoserver service.
• Files may be local to the script host or known based on metadata information about the file system on the on the remote geoserver.
• Geoserver doesn't have much of a sense of hierachy but models tends tow produce the similarly named output files. This program attempts to provide a simple mechanism to convert filenames into a unique layer name.

usage: load_geoserver.py [-h] [-d] 
                        [--url URL] 
                        [-l LOGIN] [-p PASSWORD] 
                        [-workspace WORKSPACE]
                        [--style STYLE]
                        [--extpath EXTPATH]
                        [--prefix PREFIX]
                        filenames [filenames ...]

positional arguments:
  filenames                local geotiff to be added to remote geoserver

optional arguments:
  --help            show this help message and exit
  --debug           provide verbose processing  
  --url URL             geoserver rest url (default=$GEOSERVER_URL)
  --login LOGIN         geoserver login (default=$GEOSERVER_LOGIN)
  --password PASSWORD   geoserver password (default=$GEOSERVER_PASSWORD)
  --workspace WORKSPACE default workspace (default=$GEOSERVER_WORKSPACE |
                        SKOPE)
  --style STYLE         style to be applied (default=$GEOSERVER_STYLE)
  --layername TEMPLATE  layer name template (default=basename of file)
  --extpath EXTPATH     external path on geoserver prepended to all relative file paths.
  --prefix PREFIX       portion of filename path to remove prior to joining with extpath

Options

Option	Description
url	Geoserver REST API endpoint, i.e. https://staging.openskope.org/geoserver/rest. The url can also be set using the environmental variable GEOSERVER_URL.
login	Geoserver login, defaults to 'admin'. The login can also be set using the environmental variable GEOSERVER_LOGIN.
password	Geoserver password. The password can also be set using the environmental variable GEOSERVER_PASSWORD. Use of the environmental variable is preferred to avoid having the password visible on the command line.
workspace	The Geoserver workspace where the layers will be stored. The workspace can also be set using the environmental variable GEOSERVER_WORKSPACE. The workspace must exist prior to adding the layer.
style	The style to be applied as the default style for the layer. Should be of the form :<style>, for example 'SKOPE:srtm'. The style can also be set using the environmental variable GEOSERVER_STYLE. Failure to specify a style when adding a layer will cause the layer to default to the geoserver default (normally 'raster'). The style must exist prior to adding the layer.
layername	The layer name will be the name used by Geoserver to reference a raster file. The layer name can be either a fixed string or use empty curly braces as a place holder for the raster files basename or some combination of the two, examples include {}, strm, or paleocar_{}. If layername is not specified the default layer name will be the rasters base filename without an extension.
extpath	The extpath is an absolute path based on the Geoserver's file system that is prepended to the relative paths used for filenames. The external path is optional if the filename given on the command line has already an absolute path available to the Geoserver.
prefix	The prefix works in conjunction with the extpath and is the portion of the filename that should be removed prior to joining the filename with the extpath.
filename(s)	The filenames are the list of raster files that should be added to the Geoserver. The files are not copied but should already exist locally to the Geoserver service. Filenames may include absolute or relative path information. The files need not exist on the host where the loader script is running but ultimately the filename, extpath and prefix must combine to create an absolute path accessable to the Geoserver.

Examples

The following examples assume that environmental variables are set.

export GEOSERVER_URL=https://staging.openskope.org/geoserver/rest
export GEOSERVER_LOGIN=admin
export GEOSERVER_PASSWORD=xxxx
export GEOSERVER_WORKSPACE=SKOPE
export GEOSERVER_STYLE=stylename

Load the SRTM dataset with layer name 'srtm_conus'.

load_geoserver.py /projects/skope/datasets/srtm/geoserver/srtm_conus.tif

Load the SRTM dataset with layer name 'srtm'.

load_geoserver.py --layername srtm /projects/skope/datasets/srtm/geoserver/srtm_conus.tif

Load the Paleocar timeseries with multiple datasets. The following 3 examples are equivalent. This assumes the TIFF files are local to the host where the script is running because of the use of the wildcard character. The layer name will be the TIFF filename without the extensions.

load_geoserver.py /projects/skope/datasets/paleocar/geoserver/*tif
cd /projects/skope/datsets/paleocar/geoserver
load_geoserver.py --extpath /projects/skope/datasets/paleocar/geoserver *tif
cd /projects/skope/datasets
load_geoserver.py --extpath /projects/skope/datasets paleocar/geoserver/*tif

Load the Paleocar timeseries with multiple datasets and add paleocar version prepended to the TIFF filename as the layer name. Note the use of curly braces in the layername which is replaced by the TIFF file basename.

load_geoserver.py --layername 'paleocar_v2_{}' --extpath /projects/skope/datasets paleocar_v2/geoserver/*tif

Load the Paleocar timeseries where the script host and the geoserver host don't share the same file system but the data files are local to the script host.

load_geoserver.py --layername 'paleocar_v2_{}' --extpath /projects/skope/datasets/paleocar/geoserver 
    --prefix /local/path/modelrun /local/path/modelrun/*tif