Skip to content

Latest commit

 

History

History
71 lines (56 loc) · 2.33 KB

pgsql.md

File metadata and controls

71 lines (56 loc) · 2.33 KB

BareOS FileDaemon PostgreSQL Plugin

This plugin makes backup of any database found in a PostgreSQL. Each databases is stored in an individual files. To restore select the needed database file, found in /@PGSQL in the catalog.

Prerequisites

The pg_dump and psql command must be installed and user postgres must have read-access to the databases. See below, if you want to use another user.

You need the packages bareos-filedaemon-python-plugin installed on your client.

Installation

  1. Make sure you have met the prerequisites.
  2. Install the files BareosFdTaskClass.py, psql/BareosFdPgSQLClass.py and psql/bareos-fd-pgsql.py in your Bareos plugin directory (usually /usr/lib/bareos/plugins)

Configuration

Activate your plugin directory in the fd resource configuration on the client

FileDaemon {                          
    Name = client-fd
    ...
    Plugin Directory = /usr/lib/bareos/plugins
}

Include the Plugin in the fileset definition on the director

FileSet {
    Name = "client-data"
        Include  {
            Options {
                compression = LZ4
                signature = MD5
            }
            File = /etc
            #...
            Plugin = "python:module_path=/usr/lib/bareos/plugins:module_name=bareos-fd-pgsql"
        }
    }
}

Options

You can append options to the plugin call as key=value pairs, separated by ':'. Please read more about the BareOS Python Plugin Interface here: http://doc.bareos.org/master/html/bareos-manual-main-reference.html#Python-fdPlugin

Example plugin options:

    Plugin = "python:module_path=/usr/lib/bareos/plugins:module_name=bareos-fd-pgsql:databases=db001,db002"

folder

Virtual folder used in catalog. Default: @PGSQL

psql

Command (with or without full path) to psql tool. Default: psql

pg_dump

Command (with or without full path) to pg_dup tool. Default: pg_dump

pg_dump_options

Options to be used with the pg_dump tool. Default: --no-owner --no-acl

pg_user

Username of the system user running the psql and pg_dump tools. Default: postgres

databases

Comma separated list of database names to backup, if unset all databases (except 'postgres', 'template1' and 'template0') are dumped. Default: unset

exclude

Comma separated list of database names exclude from backup. Default: unset